|
|
|
|
|
Your master files are required to have a certain comment tags defined. Your master file does not have to a functional HTML file, but may be easier to work with and modify if it is completely specified. The comment tags can appear in any order.
<!-- begin voy_header --><!-- end voy_header --> used for definitions such as the cascading style sheet and hyperlink options.
<!-- begin voy_common_top --><!-- end voy_common_top --> used for system-wide common navigation.
<!-- begin voy_fm_book --><!-- end voy_fm_book --> used for navigation that is specific to a FrameMaker book. In particular, this means buttons or hyperlinks for previous and next topics.
<!-- begin voy_dox --><!-- end voy_dox --> used for navigation that is specific to the Doxygen output. This is not specified in the mif2htm.ini files, but does appear in files used by Doxygen. Also, the post-processing tools need to know about this.
<!-- begin voy_footer --><!-- end voy_footer --> used for system-wide common footer material. In particular, this can contain the copyright information, date of generation, and document numbers.
<!-- begin voy_html_zap --><!-- end voy_html_zap --> used for defining HTML syntax that is troublesome in the individual files. Typically, this is hard-coded font information that defies control by the cascading style sheet. Hence, each line of information between the voy_html_zap tags in the master file contains:
The opening HTML syntax that you want to remove. This is something like <font face. This can have incomplete HTML syntax.
This is the closing syntax to the HTML code that you want to remove. This is usually >. Everything between that opening syntax and very next occurrence of the closing syntax is removed.
In addition, sometimes the HTML tag being removed is part of paired tags. This could be something like </font>. If present, the very next occurrence of this HTML tag after the closing syntax is removed.
<!-- begin voyant_variables --> is a single comment created by Mif2Go. It is used to store information about the FrameMaker topic. This HTML comment contains a ## separated list of paired items (a flag, ## separator, and content) needed for navigation.
Note: The tag names in the comment can be changed. However, the change needs to be propagated into global.pm, mif2htm.ini, the voyant_master.html files, and the main header files used by Doxygen (voyant_head.txt and voyant_foot.txt).
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02