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

Directory Structure

tp_tools The top-level directory used in the creation of the online HTML system and contains the UNIX Shell script files (given with “b” extensions) and the master template files for the navigation, table of contents, and index. It also contains the Doxygen project files and other files used in the generation of HTML.

common_files Contains GIF and CSS files that are used in all subdirectories of doc_publish. Also contains default HTML files that are part of the code reference sections. Depending upon the content of the source code, Doxygen overwrites these files.

doc_publish Contains all files in the HTML system intended for distribution to readers. Moreover, everything from this level down is either under source control (CVS) or can be re-generated. This level contains the series of HTML files that make up the table of contents and index, as well as the introductory topic and PDF overview.

book_help_on_help Contains all HTML and GIF files associated with the how to use the help system. The source FM files are located elsewhere. This directory also contains copies of the Mif2Go INI files that configured the HTML output generation.

book_tp_tools Contains all HTML and GIF files associated with the description of TechPubTools. The source FM files are located elsewhere (in src_fm). This directory also contains copies of the Mif2Go INI files that configured the HTML output generation.

book_... Other directories can be created with information that is maintained in FrameMaker and exported to HTML using a tool. In order to support additional book directories, the master files need to be updated accordingly as well as the controlling shell scripts.

cref_tp_tools Contains all HTML and GIF files associated with the API source code being documented. The files are generated using Doxygen or another tool. The source code files are located elsewhere.

cref_... Other directories can be created for information that is extracted from the source code into HTML using a tool. In order to support additional cref directories, the master files need to be updated accordingly as well as the controlling shell scripts. When using Doxygen, the respective Doxygen project files need to be created which generate their output here.

DevaSearch Contains all HTML and JS files associated with the full text search. The files in this directory are generated after all other aspects of the system have been created.

print_pdf Contains all PDF files associated with the other directories. The PDF files could reside elsewhere, but a design decision was made to collect them all here for the user.

src_fm A directory containing the FrameMaker documents used in generating an HTML system. In the case of this TechPubTools project, this is the source directory the Mif2Go INI files that then generates HTML in book_tp_tools.

src_perl (Actually a symbolic link to) a directory containing the Perl code used in generating an HTML system. Refer to the perl directory. This was included here to simplify the creation of the zip file.

zdoc_merge A temporary directory used in the generation of the series of HTML files for the index and table of contents. The temporary directory provides more control over what is included and excluded and facilitates testing.

zlx_tp_tools A temporary directory used by Doxygen to hold the LaTex files one API source code project and to generate associated PDF files.

zlx_... Other temporary directories can be created for API source code. They are used by Doxygen to hold the LaTex files and to generate associated PDF files.

perl A directory containing the Perl code used in generating an HTML system. In the case of this TechPubTools project, this is also the source code directory for the tp_tools.dox Doxygen project. Doxygen generates HTML in cref_tp_tools and LaTex/PDF in zlx_tp_tools.



 "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