|
|
|
|
|
The TechPubTools start where Mif2Go and Doxygen left-off. Alternative products are available for both of these that can get you to the same point.
Mif2Go is the tool that exports HTML from FrameMaker documents.
Doxygen is the tool that extracts prototypes and specially flagged comments from the source files.
Assuming that you have figured out how to get HTML output from both Doxygen and Mif2Go, the only additional pieces of information you need are how the configuration/INI files insert the tags that are needed for later processing. These are covered in Chapter 3, FrameMaker and Mif2Go, and Chapter 4, Doxygen.
From there and because youre reading this, you probably already unzipped this project and have the template directory structure that you need. It is just a template. Copy it (or unzip the zip file) into a new location that becomes your new build area.
Look into the 00_build_tp_tools.b UNIX shell script file. You may never have reason to use this script because it uses CVS.
What is important about the 00_build_tp_tools.b script is that it calls the other scripts in the proper order. Hence, look at what this script is calling and open those script files in sequence to see what they are doing. Copy those scripts and edit as needed to match your directories. Remember to include their call in 00_build_tp_tools.b for the sake of completeness.
You will need master files (HTML) that reflect what you want to output. You can modify the voyant_master...html or make copies of these. (If you copy them to new names, the associated scripts will need to be updated.) These master files need information about your project. This is embedded in HTML comments.
Once you have your source (HTML) in the proper directories, updated master files, and updated scripts, run your scripts.
The output is placed in the doc_publish directory. Click on _start_here.html to see what youve done.
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02