Voyant TechPubs Tools Documentation
2000
Technical Publications (TechPubs) Tools are Perl programs that are used to create a comprehensive HTML system from mini-HTML systems created by Doxygen and Mif2Go.
These tools describes one possible solution to tackle two major tasks associated with application programming interface (API) technical publications:
- Multiple output formats (HTML and PDF) that are single-sourced from (FrameMaker) documentation in a modular way.
- API reference documentation that is single-sourced from the (C/C++) source code into multiple output formats.
Although the TechPubTools and techniques were designed specifically for C/C++ API documentation, they can be adopted and modified:
- to produce large online documentation systems from multiple FrameMaker books.
- to produce large online documentation systems from multiple Doxygen directories.
- to handle (imperfectly) other programming languages.
-
Warning:
-
The Perl Reference portion of this documentation has imperfections stemming from running Perl files through Doxygen, which was designed to handle C/C++.
-
Limitations and Caveats:
-
Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) for more details.
-
Note:
-
Documents produced by these tools are derivative works derived from the input used in their production; they are not affected by this license.
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-perl-hcr-02