|
TekDoc HTML Documentation GeneratorSource: TekDoc.pl The TekDoc utility extracts text from files to generate HTML documentation. An alphabetical index and hierarchical document map are also generated. A variety of options are available for controlling specific behaviors. The script uses a simple tag extraction approach for extracting and formatting text into HTML documentation. It does not parse any specific programming language syntax. Therefore, any text input file may be processed such as text files and C, C++, Perl or Java source code. USAGE perl TekDoc.pl [-option(s)] pattern1 pattern2 ... The patterns may be directories, specific files, or wildcard patterns. Each is processed and the results are combined as specified by the Node tags within the input files. All files processed are combined into the alphabetical index and document map. Both Command Line Options and Configuration File Variables are used to control the behavior of the script. SEQUENCE The general process is: 1. Edit the configuration file to set default values for those variables that do not change often; 2. Place the various tags in your source text files; 3. Then run the script with the command line options set as needed. Formatting tags control the generation of the HTML documentation. See Formatting Tags or Tag Summary for details. RETURNS 0 on success, 1 on warning(s), 2 on failure RELATED LINKS |