TekDoc



Home

Map

Index


TekDoc 1.0
GrayHill Systems Todd R. Hill

Notes and Caveats


Source: TekDoc.pl

1. It -IS- possible to create nodes (pages) that are "orphaned"; that is, are not linked from anywhere. It depends on the combination of named and unnamed nodes, and your choice of the -l or linkMode option.

2. Various combinations of tags in the source text have NOT been tested. Things such as nested and overlapping begin/end tags, missing end tags, and other strange usages may cause errors or unpredictable results.

3. The e-mail component of this script has been written for Windows 95 and Windows NT. Some simple modifications would also allow other e-mail systems to be used. The e-mail subroutine is alert().

4. This documentation was generated with TekDoc from the TekDoc.pl source code using the default configuration file and the command line: perl TekDoc.pl -f -l 3 TekDoc.pl, which is equivelent to: perl TekDoc.pl -l 3 -f -- TekDoc.pl. All other options and variables were default values.

5. It is possible to embed HTML tags directly in the source text processed by the script. Care must be taken to avoid conflicts with HTML sequences generated by the script. The most common thing to embed is a line break < BR > (with no spaces). HTML tags may also be embedded in the Footer configuration variable.

6. If HTML is generated, then node names are changed or sub-page are reorganized, any old pages are left in the output directory. The script has no way of knowing about the changes, therefore it cannot remove old pages. The easiest method is to remove all pages before regenerating the new pages.


BUILT-IN RULES

1. HTML inherently removes all whitespace in content, including newlines. This script has some built-in rules to make formatting easier. Hopefully these rules make basic common sense. Some have command-line options and/or configuration file variables to control their behavior.

2, Source text lines containing all uppercase letters, numbers, and special characters only (no lowercase characters, but at least one alphabetic or numeric character) are considered paragraph titles and are followed by a line break. These lines may also be bold, see the -b option and boldUpper variable.