Build structure files

Learn how you can build a Structured Application in FrameMaker.

Decide whether to use an existing standard or create your own structure.

Create structure files without using an existing standard

  1. In FrameMaker, create an EDD that matches your structure requirements.

  2. Test the EDD to verify that the structure definitions are correct.

  3. Add formatting to the EDD, and test the EDD to verify that the formatting works correctly.

  4. Create a DTD from the EDD.

You now have the two structure definition files you need—one for FrameMaker (EDD) and one for XML (DTD).

Use an existing standard

  1. Obtain a copy of the standard files, and modify the provided DTD or schema file to match your requirements.

  2. Open the completed structure file in FrameMaker to create an EDD, and add formatting to the EDD.

Once you have your structure definitions, you need to set up the Structured Application.

Set up the Structured Application

  1. Choose Structure > Application Definition > Edit Application Definitions to open the structapps.fm.

  2. Add a new application definition to the file with pointers to your EDD and DTD/schema files.

After setting up the application, you’ll want to fine-tune the import/export settings.

Using the Structured Application Designer

The Structured Application Designer allows you to create a Structured Application.

To launch the Structured Application Designer, click Structure > Structured Application Designer. The Structured Application Designer is displayed:

Structured Application Designer
Using the StructuredApplication Designer in FrameMaker

  1. Select a base Application on which the new application is based. To load a new set of base applications, click Load Applications and select the relevant Structured Application file. The list of applications is automatically populated from the selected Structured Application file.

  2. Optionally, enter the DTD, the RW Rules (Read/Write Rules) file, the EDD, and the Template file, along with the DOCTYPES specifications.

  3. Enter the new Application Name.

  4. By default, the application is saved in the structapps.fm file in your application directory. To change the filename, click Save As and select or enter a new filename.

  5. Optionally, to set advanced settings, click Advanced Settings and make your desired selections.

To create a Read/Write Rules file, based on an existing DTD, specify the DTD and click New from the RW Rules section. The Rule File Maker… is displayed.

Note: If you do not specify a DTD, an empty Read/Write Rules file is created. You can then add rules using the Rule File Maker.

Fine-tune the import/export settings

  1. Set up a Read/Write Rules file with the necessary mappings, and set up XSL transformation files with any additional changes.

  2. Add a reference in the Structured Application definition to the Read/Write Rules file and the XSL transformation files.

  3. Add any other required configuration settings, such as handling of conditional text and external cross-references, in the Structured Application definition.

Using the read/write Rule File Maker

FrameMaker includes a powerful read/write Rule File Maker that helps you author rules easily. This helps simplify rule generation, since you have all the settings at one place, and do not have to remember any rule syntax.

To launch the read/write Rule File Maker, choose Structure > Read/Write Rules > New Read/Write Rules. Select the Launch Rule File Maker option and click OK.

Note: Optionally, you can specify the DTD to be used when creating the rules.

The Rule File Maker dialog is displayed as follows:

Rule File Maker
Using the read/writeRule File Maker in FrameMaker

The Rule File Maker has two basic sections:

The Import-Export Settings section is divided into four sections:

  1. Markup Elements: Allows editing of all markups present in the specified DTD. To see a list of all elements, select select from DTD from the value drop-down. FrameMaker then displays a list of elements. You can select multiple elements from the list and click OK to insert the selected elements into the read/write Rule File Maker.

  2. Global Settings: Displays the list of settings that are applied to ALL elements globally.

  3. Entities: Displays the list of all entities that are present in the DTD.

  4. Advanced Settings: Contains advanced settings for Books and Character Maps.

The Export Only Settings section is divided into three sections:

  1. FrameMaker Objects: Lists the type of FrameMaker Objects present. In addition, each FrameMaker Object category lists the markups mapped as that object. For example, if you map markup M1 to the FrameMaker table object in the Import-Export Settings section, the table list in the "Export Only Settings" section displays the markup M1.

  2. Global Settings: Displays the list of settings that are applied to ALL elements globally.

  3. Advanced Settings: Contains advanced settings for SGML, DITA, Variables, and Character Maps.

When saving the rules, FrameMaker saves only the elements and the rules that have been modified (modified elements have their values marked in bold, on the right pane). Default behaviors are not saved.