|
|
|
|
|
The mif2htm.ini file specifies how to chunk the information coming from FrameMaker into individual HTML files. The Voyant style guide for FrameMaker has:
Five (5) paragraph formats that define the chapter chunks:
TitleChapter
TitleAppendix
TitleFront
TitleIndex
TitleIntro
Three (3) paragraph formats that define the section chunks:
Head1
Head2
Head3
All eight (8) of these paragraph formats are used in the mif2htm.ini file in the [HtmlStyle] section to define the exported stand-alone HTML files.
[HtmlStyles]
TitleChapter=Split Title Filename
TitleAppendix=Split Title Filename
TitleFront=Split Title Filename
TitleIndex=Split Title Filename
TitleIntro=Split Title Filename
Head1=Split Title Filename
Head2=Split Title Filename
Head3=Split Title Filename
Split - specifies that the paragraph format to the left of the equals (=) is to be used to start a new HTML file.
Title - specifies that the contents of the paragraph format is to be used in the <title></title> tags of the HTML file.
Filename - specifies that the contents of the paragraph format is to be used as part of the HTML filename. Mif2Go removes whitespace and punctuation in the name.
Note: If you do not supply the Filename parameter in the [HtmlStyle] section for a given FrameMaker format, Mif2Go creates a name from tags that are internal to FrameMaker. This is the method that the makers of Mif2Go recommend, because FrameMaker assures that these tags are unique.
The advantage of using the Filename parameter in the [HtmlStyle] section is that your HTML filenames are more meaningful.
The disadvantage of using the Filename parameter in the [HtmlStyle] section is that you have to assure that the titles of your paragraph formats (e.g., Title<...>, Headn) are unique within your chapter (or book). If they are not unique, the HTML files get overwritten by any subsequent paragraph formats in the chapter (or book) with the same name that Mif2Go generates.
As will be discussed later, Mif2Go supports chapter INI files. These can be used to append a prefix or suffix to the generated HTML filenames. Hence, generated HTML filenames coming from different chapters do not conflict, although they do have to be unique within a chapter. Whereas it is admittedly more difficult to assure uniqueness of titles throughout a book, reducing the title uniqueness requirement to within the chapter is not as much of a burden on the technical writer.
For other technical reasons (ordering of the table of contents), chapter INI files are employed to assign two-digit prefixes that provide a clue as to which chapter the HTML topic belongs and at the same time resolve overlap in potential HTML filenames from different chapters. A further advantage is that, together with the Filename parameter, the readers (and technical writers) can orient themselves within the documentation just from the HTML filename.
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02