Description of the Structure Application Files

The structure application files provided with DITA-FMx do more than your typical DITA structure applications.

After installation of the DITA-FMx structure applications, the FrameMaker\Structure\xml\DITA-FMx_1.2 folder contains a number of files, some are specific to the structure applications, and some are used for other purposes.

Important: The DITA-FMx structure applications are provided in FM8 format. This should work fine for FM8 and later versions of FrameMaker. FM7.2 users willl need to downsave to the FM7 format. If you are unable to do this, contact Leximation.
DITA-FMx_1.2\

map-from-outline_template.fm - Template file used by the New DITA File > New Map from Outline command.

DITA-FMx_1.2\Book\

book_1.2.edd.fm - The Book application EDD. Defines the data model structure and provides the element definitions. Remember to import this into the template (below) if you make and changes to the EDD.

book_1.2.rules.txt - The Book application read/write rules file.

book_1.2.template.fm - The Book application template file. Defines the page layout and formatting as well as the character and paragraph styles used by the EDD.

bookmap2fmbook.xsl - The Book application XSL import file. Controls the process that aggregates all of the topic files into the book and chapter FM files.

expandOrig.xsl - A support file for the Book XSL import process. Performs initial aggregation of all topic files before passing control off to the bookmap2fmbook.xml file.

structapps-stub_book_1.2.fm - The Book application definition stub file. Inserted into the structure application definitions file.

structapps-stub_book_1.2_13.0.1.fm - The Book application definition stub file for FM13.0.1 and later. Inserted into the structure application definitions file.

DITA-FMx_1.2\Book\component-templates\

gentpl~indexlist.fm - A sample template for generating an Index (indexlist). Referenced by the ditafmx-bookbuild.ini file.

gentpl~toc.fm - A sample template for generating a TOC (toc). Referenced by the ditafmx-bookbuild.ini file.

tpl~appendix.fm - A sample template for an Appendix map element. Referenced by the ditafmx-bookbuild.ini file.

tpl~chapter.fm - A sample template for a Chapter map element. Referenced by the ditafmx-bookbuild.ini file. The default Chapter template is actually just a copy (and rename) of the default Book template. It can be convenient to use a Chapter template to make adjustments to the output without modifying the core Book template.

tpl~part.fm - A sample template for a Part map element. Referenced by the ditafmx-bookbuild.ini file.

tpl~topicref.fm - A sample template for a topicref map element. Referenced by the ditafmx-bookbuild.ini file. The default topicref template is actually just a copy (and rename) of the default Book template (same as the Chapter template). It can be convenient to use a topicref template to make adjustments to the output without modifying the core Book template.

tpl~topicref-HAZALT.fm - An alternate version of the tpl~topicref.fm file that defines the hazard table objects for a full-width header table. For details, see Hazard Statement Publishing Options.

DITA-FMx_1.2\common\

Because the EDD structure is mostly identical between the Topic and Book applications, we have set up groups of element definitions as text insets. The common folder contains these files. A book file is provided as an easy way to search through the files.

DITA-FMx_1.2\dtd-fmx\

In order to speed up processing of the complex DITA DTD structure, single-file versions of the DITA DTDs have been created for use with the default DITA-FMx structure applications. This is particularly important if you are using FM7.2 or FM8, but is beneficial for all versions of FM. You are free to reference the standard versions of the DITA DTDs if preferred.

fmx-ditabase_1.2.dtd - Used by the default Topic application.

fmx-map_1.2.dtd - Used by the default Map application.

fmx-learning_1.2.dtd - Used by the default Learning application.

fmx-book_1.2.dtd - Used by the default Book application.

DITA-FMx_1.2\Map\

map_1.2.edd.fm - The Map application EDD. Defines the data model structure and provides the element definitions. Remember to import this into the template (below) if you make and changes to the EDD.

map_1.2.rules.txt - The Map application read/write rules file.

map_1.2.template.fm - The Map application template file. Defines the page layout and formatting as well as the character and paragraph styles used by the EDD.

structapps-stub_map_1.2.fm - The Map application definition stub file. Inserted into the structure application definitions file.

DITA-FMx_1.2\Topic\

topic_1.2.edd.fm - The Topic application EDD. Defines the data model structure and provides the element definitions. Remember to import this into the template (below) if you make and changes to the EDD.

topic_1.2.rules.txt - The Topic application read/write rules file.

topic_1.2.template.fm - The Topic application template file. Defines the page layout and formatting as well as the character and paragraph styles used by the EDD.

structapps-stub_topic_1.2.fm - The Topic application definition stub file. Inserted into the structure application definitions file.

DITA-FMx_1.2\Topic\element-templates\

new~reference~simple ref.fm - A sample “reference” element template named “simple ref”.

new~task~simple task.fm - A sample “task” element template named “simple task”.

new~topic~simple ref.fm - A sample “topic” element template named “simple topic”.