top | previous | next

Step 6: Create an SGML application

Defining the right SGML application is vital

In F+S you got to declare a SGML application in some special central place. The place depends on your system (I have both a Windoze individual and a Solaris site installation). The purpose of this is to identify the SGML declaration file, the Root Element, the Doctype, etc.

(1) Open the SGML application file

Menu: File->Developer Tools->Edit SGML Application File

This will automatically open your central "SGML applications" configuration file. It is called (probably). It might be a good idea to first make a COPY of this file since it is read on startup (see below where you can find it).

Under Windows you can find this file in the SGML installation directory: [probably]. Warning: If you are 2 people using F+S on the same machine, coordinate a bit here

Under Unix, the procedure is a bit more complicated when you do it the first time, because each user can have his own SGML application file (as it should be). Here are the steps:

Menu: File->Developer Tools->Edit SGML Application File

It will complain that you can't write (at least with our site thing) because you are dealing with a system-wide installation. So you have to save the file to your own "fminit" directory in something like the following way (roughly). It must go to:

E.g.    /home/schneide/fminit/ukenglish/sgml/    /home/schneide/fminit/usenglish/sgml/

If the xxx/sgml directory does not exist you have to make it of course. Before you do so figure out what language version of F+S you use. A good test to know what language version you have got is to create a fminit/xxx/Templates directory, put a file there, then click on "New" in FrameMaker main menu and see if the file is there.

 E.g.    home/schneide/fminit/usenglish/Templates/

(2) Make sure you master editing with F+S (user level)

Now it is really time to learn how to edit with FrameMaker. Consult companion document "fm-user-quick-guide" and look at the printed FrameMaker+SGML doc and play a bit (unlike the developer doc its sort of usable, though much to verbose ...). The authoring interface is quite intuitive and can be learnt quite fast. Note that you can use the structure view to kill and move around elements and that you need the Element menu to insert elements. I suggest that you configure the elements menu (see the Options) to "valid elements for working start to finish"

(3) Define a new SGML application

This is an important step. If you don't do it right, you will suffer later! You can kill or leave the existing definition for DocBook. Since and only this file will hold all your future SGML applications I suggest that you leave it. Ok, now let's edit this file:

Insert your mouse after "Application Definition Version". This will show a SOLE SGML "Application" element in the Element menu. Select SGMLApplication and click on insert Then add a few definitions. IMHO the following ones are good enough for starters. Replace ALL the values (text after ":") in the following example with your preferences:

Application name:	StepbystepRead/write rules:	/home/schneide/xml/frame-sgml/Stepbystep.rulesXML character encoding: 	ISO Latin1SGML character encoding: 	ISO Latin1DOCTYPE:	StepbystepDTD:	/home/schneide/xml/dtd/Stepbystep.dtdSGML declaration:	/home/schneide/xml/frame-sgml/Stepbystep-sgmldcl

Note: On a PC use PC style for this filename, e.g.

E.g. 	i:\web\guides\xml\frame-sgml\fc-ex\formcont-sgml.dtd

For your application name, you can just choose any name. See See +++ draft +++ Edit the read/write rules file.. for explanations on Read/Write rules (you can add these later). The DocType corresponds to the root of your XML DTD. Defining SGML declaration has been shown in See Make your own SGML declaration..

(4) Validate and set SGML application

The following steps are needed:

Menu: Element->Validate   (will validate your entries)

Each F+S document (include the SGML application file), the Edd file (see below) and your own SGML/XML files can and must be validated. If validation is ok, save the file, then set your new SGML application.

Menu: File->Developer Tools->ReRead SGML Application File

Your application should be in the menu, select it:

Menu: File->Set SGML Application

If you can not see your application in your Set SGML application menu, you did something wrong. Fix it, or else forget about the rest!