Contents 
 Index 
 "TPT User's Guide" 
 < Previous 
 Next > 

Chapter 21 Common Files

Several files generally copied into the directories before Doxygen or Mif2Go is run. Although laziness is part of the reason they are copied instead of referenced to a single location, having them in those directories facilitates testing and makes each directory a stand-alone system.

Default HTML Files for Doxygen

Doxygen only generates the files that it needs for the system. However, in order to create a comprehensive system that spans Doxygen projects, consistent navigation is required.

Hence these default files are copied by the shell scripts into the Doxygen code reference directories before Doxygen is run. Doxygen overwrites these files if appropriate.

files.html

classes.html

annotated.html

functions.html

globals.html

hierarchy.html

modules.html

Navigation GIF files

The following files are used in the generated tree.html files and in the m_tree_ navigation files. To facilitate operation, they are copied by the shell scripts into the directories. These files could be referenced to a single location, but copying them makes each directory a complete system in and of itself.

clear.gif

voyant.gif

nav_folderopen.gif

nav_folderclosed.gif

nav_doc.gif

voyant-mdblu.gif

Cascading Style Sheet

In order to provide a consistent look and feel, the voyant_fm.css cascading style sheet is employed. Although it could be referenced in a specific location, laziness in implementation and testing has the shell script copy this into the directories of the project. Copying this file makes each directory a complete system in and of itself.

• Part of the voyant_fm.css was created by Mif2Go with the first manual that it exported. Voyant’s Technical Publications Department has templates that its documents consistently follow.

• Part of the voyant_fm.css was copied from doxygen.css, which was created by Doxygen.

• A final part of the voyant_fm.css was defined during the development of the Perl tools that generate the table of contents and index files.

The resulting voyant_fm.css was then modified and streamlined to tailor it for our needs.



 "TPT User's Guide" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-hug-02