TPT User's Guide
Contents
Scope of TechPubTools
TechPub Tools Features
Jump Start
Chapter 1 Single-Sourcing and API Documentation
The Naysayers Argument
Single-Sourcing Naysayers
API Documentation Naysayers
Reality Check
Single-Sourcing Rant
Dont let perfect be the enemy of the good.
Time Heals
Give the Readers Credit
Analog Not Anal
Dysfunctional Online
Online Disadvantages
Lots of Plumbing but Little Water
Three Strikes and Youre Out
Pop-Up Happy Hell
Context-Sensitive Suggestion
Tried and True Printed Manuals
The Best of Both Worlds
Foundation and Structure
Plumbing with Water
Moving Day
Withholding Tax
API Documentation Rant
Software Engineering
Information Repository and Tools
Reusability
Send in the Tech Writer
What You Get
Source Code Extraction Tools
Concerns about Auto-Documentation Tools
Writing Quality in the API Documentation
Auto-Documentation Benefits
The Code Can Contain More Information
Software Engineers as Technical Writers
The Future of API Documentation
Code Generation
Software Public Libraries
Get More Thinkers Involved
Royalties for Their Efforts
New Copyright Protection
What You Get
Chapter 2 Environment and Tools
My Environment
Home-Grown Tools
Directory Structure
Chapter 3 FrameMaker and Mif2Go
FrameMaker
FM Formats
Mapping FM Formats to HTML Constructs
Online Use and Conditional Text
Cascading Style Sheet
Mif2Go
Fonts Mapping
File Splitting
Post-Processing Tags in Splitting
Chapter Ordering
[FileIDs] in the mif2go.ini
[FileSequence] in the mif2htm.ini
[HTMLStyles] in the mif2htm.ini
[HTMLStyleFilePrefix] in the mif2htm.ini
[HTMLOptions] in the mif2htm.ini
Index Tokens
Chapter 4 Doxygen
Preparation for Using Doxygen
The Doxygen Project File
Input Filters
HTML Output
PDF Output
Chapter 5 Java TOC Applet
Chapter 6 Shell Scripts
00_build_tp_tools.b
20_cp_com_files.b
30_tp_tools.b
31_perl.b and 31_script.b
32_perl.b and 32_script.b
35_gen_dox.b
40_latex_build.b
45_latex_build.b
50_nav_update.b
55_nav_gen.b
55_nav_cp.b
56_nav_index.b
56_nav_script.b
Chapter 7 globe.pm
Overview
Variable and Data Structures
Common Routines
Chapter 8 voyant_nav.pl
Overview
The Beginnings
The Extensions
CYA
Data Structures
Topic Browsing
Index Tokens
Input
Output
Chapter 9 voyant_mt_app.pl
Overview
The Beginnings
The Extensions
Input
Output
Chapter 10 voyant_indexer.pl
Overview
The Beginnings
The Extensions
Building on the Java TOC Applet
Input
Output
Chapter 11 voyant_latex.pl
Input
Output
Chapter 12 find_extract.pl
Overview
Input
Output
Implementation Details
Chapter 13 tree_js_2_script.pl
Overview
Input
Output
Chapter 14 html_look_integrate.pl
Overview
Input
Output
Chapter 15 ini_html_gen.pl
Overview
Input
Output
Chapter 16 log_html_gen.pl
Overview
Input
Output
Chapter 17 Input Filters to Doxygen
dox_bug_filter.pl
dox_ive_filter.pl
dox_chg_not.pl
dox_comment_chg.pl
pl_comment_change.pl
csh_comment_change.pl
Chapter 18 voyant_master_nav.html
Overview
Minimum Master Definition
Variables
Chapter 19 TOC Implementation
m_tree.script
m_toc.html
Logical Extensions of the Applet
Chapter 20 voyant_master_index.html
Chapter 21 Common Files
Default HTML Files for Doxygen
Navigation GIF files
Cascading Style Sheet
Index
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# ##doc_number##