|
|
|
|
|
00001 // This file has been modified on-the-fly with an input filter 00002 // to change it from shell syntax to C++ strictly for the purposes 00003 // of faking out Doxygen. Modifications include: 00004 00005 // - changing # comments to C++ comments. 00006 // - ... 00007 00008 // If you see other strangeness in the HTML version of the script file, 00009 // it comes from getting it to look more C++ like. 00010 00011 00012 /*****************************************************************************/ 00013 /** @file 00014 ** @mainpage 00015 ** 00016 ** 00017 ** Technical Publications (TechPubs) Tools are Perl programs 00018 ** that are used to create a comprehensive HTML system from mini-HTML systems 00019 ** created by Doxygen and Mif2Go. 00020 ** 00021 ** These tools describes one possible solution to tackle two major tasks 00022 ** associated with application programming interface (API) technical 00023 ** publications:<ul> 00024 ** 00025 ** <li>Multiple output formats (HTML and PDF) that are single-sourced from 00026 ** (FrameMaker) documentation in a modular way.</li> 00027 ** 00028 ** <li>API reference documentation that is single-sourced from the (C/C++) 00029 ** source code into multiple output formats.</li></ul> 00030 ** 00031 ** Although the TechPubTools and techniques were designed specifically for 00032 ** C/C++ API documentation, they can be adopted and modified:<ul> 00033 ** 00034 ** <li>to produce large online documentation systems from multiple FrameMaker 00035 ** books.</li> 00036 ** <li>to produce large online documentation systems from multiple Doxygen 00037 ** directories.</li> 00038 ** <li>to handle (imperfectly) other programming languages.</li></ul> 00039 ** 00040 ** @warning The Perl Reference portion of this documentation has imperfections 00041 ** stemming from running Perl files through Doxygen, which was designed to 00042 ** handle C/C++. 00043 ** 00044 ** @lim Permission to use, copy, modify, and distribute this software and its 00045 ** documentation under the terms of the GNU General Public License is hereby 00046 ** granted. No representations are made about the suitability of this software 00047 ** for any purpose. It is provided "as is" without express or implied warranty. 00048 ** See the GNU General Public License 00049 ** (<a target="blank" href="http://www.gnu.org/copyleft/gpl.html">http://www.gnu.org/copyleft/gpl.html)</a> 00050 ** for more details. 00051 ** 00052 ** @note Documents produced by these tools are derivative works derived 00053 ** from the input used in their production; they are not affected by this 00054 ** license. 00055 ** 00056 ** 00057 ** <center><a target="top" href="http://www.voyanttech.com"> 00058 ** <img src="voyant.gif" ALT="Open new window to www.voyanttech.com." border="0"> 00059 ** </a></center> 00060 ** 00061 ** @ingroup tp_tools 00062 **/ 00063 /*****************************************************************************/ 00064 00065 00066 00067 00068 /*****************************************************************************/ 00069 // Standard Coding groups 00070 /*****************************************************************************/ 00071 /** @defgroup tp_tools TechPubs Tools 00072 ** @brief Tools for technical publications departments. 00073 **/ 00074 00075 /** @defgroup tp_idx Indexer Tools 00076 ** @brief Creates a comprehensive index from previously generated index_ files. 00077 ** @ingroup tp_tools 00078 **/ 00079 00080 /** @defgroup tp_nav Navigation Tools 00081 ** @brief Swaps out navigation, creates temporary TOC files and index_ files. 00082 ** @ingroup tp_tools 00083 **/ 00084 00085 /** @defgroup tp_dox Doxygen Filter Tools 00086 ** @brief Provides input filter to "fake-out" Doxygen into thinking it has 00087 ** C code. 00088 ** @ingroup tp_tools 00089 **/ 00090 00091 /** @defgroup tp_toc Table of Contents Tool 00092 ** @brief Generates master tree files from previously generated tree files 00093 ** to get master table of contents. 00094 ** @ingroup tp_tools 00095 **/ 00096 00097 /** @defgroup tp_latex Latex Tool 00098 ** @brief Provides minor updating to LaTex files. 00099 ** @ingroup tp_tools 00100 **/ 00101 00102 /** @defgroup tp_shell Unix Shell Scripts 00103 ** @brief Script files that control building and generating the system. 00104 ** @ingroup tp_tools 00105 **/ 00106 00107
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-script-hcr-02