|
Formatting TagsSource: TekDoc.pl Formatting tags are placed in the source text files to control HTML page generation. Some tags are required for this script to recognize what content is to be extracted, and to identify those sections by name. Tags may be placed anywhere on a line, but all characters appearing before the tag are discarded. So, it is generally best to place tags at the beginning of a line. Tags are not case sensitive. To place a tag name in the source text two tag trigger characters (`) are placed in a row before the tag word (e.g. ``Node). The following tags are available: `Node and `End mark the content to be extracted, with optional sequencing and sub-pages. `Title gives a node a one line description used in the alphabetical index. `Footer defines footer text for the node(s) in a source file. `Security defines the security level of nodes(s) in a source file. `Table, `Row, `Column and `EndTable define the name and data for tables. `Code and `EndCode denote blocks of highlighted literal text. `Tie and `Link provide for hyperlinks. `Index creates additional entries for the alphabetical index. See the Tag Summary page for a quick reference, or the detailed descriptions below. `NODE, `END TAGS A Node is similar in concept to an output filename, with the addition of a sub-page linkage hierarchy specification. Node names may be any text, with whitespace, with the exception of 1) characters excluded by the local operating system for filenames, or 2) a number (see the node sequencing discussion below). The `Node tag begins general text extraction, and must appear before other tags. At least one named node must be defined for the first node of each source text file. The `End tag ends general text extraction. Sub-page linkage is specified by placing a forward slash (/) between node names. Depending on the -l or linkMode option, forward and backward links may be generated at the bottom of output pages in a variety of ways. Different node names made be interspersed in the same or different input files. Nodes with the same name are placed in the same output file, and separated by an HTML horizontal rule (line). Unnamed nodes are placed in the most recent named node's output file, without a horizontal rule. Nodes may optionally include a sequence number to allow the user to control the order that nodes are placed in an output file. This points out the node naming rule: if the first whitespace-delimited word of a node name is all numeric, it is taken as a sequence number and removed. Node sequence numbers may be 1 to 99,999. Node names are used in the generated forward and backward links at the bottom of output pages, in the document map, and in Tie tags. Bear in mind that node names are used as output filenames. The total length of nodes + sub-nodes may not exceed the limit of the local operating system, e.g. Node One/Node Two/Node Three/Node Four/Node Five ... etc. A `Node tag begins general text extraction. The `End tag ends extraction. See the Formatting Tags page for addition information. Output filenames are derived from node names by removing all whitespace and replacing any forward slashes (/) with underscores, e.g. "Index/Detailed Information" would become "Index_DetailedInformation". The output file extension is html by default. The extension may be changed with the -o or outExtension options. * IMPORTANT Note * The "Home" link on the navigation bar on the left side of the generated pages is a hardcoded link to a page named "Index". The script does not force the user to have a page named Index, but if one does not exist the "Home" link will not work. This is not checked or enforced to allow the user to easily create an Index page with a different run of the script or a different HTML tool, without that file always being overwritten. SYNTAX `Node [sequence] [name] Node tag examples `TITLE TAG Titles are simply strings used to describe a node's content. The title of the first (possibly sequenced) node in an output file is used as the title of the HTML page. Titles are used in the alphabetical index page. Nodes without titles are not listed in the index. See the `Index tag for another way to create index entries. SYNTAX `Title title-text `FOOTER TAG A footer text line may be placed at the bottom of HTML pages. If not specified the Footer variable in the configuration file will be used. Any `Footer tag in the source text overrides the Footer configuration variable. Handy for adding copyrights or other information at the bottom of pages. SYNTAX `Footer footer-text `SECURITY TAG Security is the simple notion that different information is intended for different audiences. Some information may be for customers, while other information is for internal purposes only. The security implementation has three parts. The first part is the definition of what security level denotes "secure" information. This is defined using either the -S command line option, or the Secure configuration variable. Secure information extracted from source text is marked with a bar on the left side of the page showing it's security level. The second part is the definition of the security level for specific information. The `Security tag is placed in the source text to set the security level of the node(s). Security levels may be 0-254. The third part is the specification of the security level to be processed for a particular run of the script. This is done with the -s command line option, or the Security configuration variable. Only content marked with a `Security tag level less than or equal to the process level will be extracted. SYNTAX `Security [0-254] `TABLE, `ROW, `COLUMN, `ENDTABLE TAGS Tables may be created using the `Table, `Row, `Column and `EndTable tags. A complete table specification looks like this:
`Table [table-name] `Row row-data `Column column-data `EndTable `CODE, `ENDCODE TAGS A code block is a section of content that will be highlighted in a black on white block. Code block content is taken literally and not reformatted. SYNTAX `Code `EndCode `TIE TAG A Tie tag creates a link to a named node's output HTML page, and bookmark if available. A Tie link is not generated if the named node exceeds the -s or Security option of this run of the script. In this case the node name is inserted as normal text in the output HTML page. The surrounding text is flowed with the `Tie node-to-link text. An optional sequence number may be used to tie to a specific sub-node within a page. SYNTAX `Tie [sequence] node-to-link `LINK TAG A Link tag creates an HTML link to any appropriate target. Unlike `Tie tags, a `Link tag defines both the descriptive text and the HREF URL. No checking is done to see that the referenced URL is valid. The surrounding text is flowed with the `Link description text. The description may be any text. The URL may be any target the browser is capable of viewing or executing. SYNTAX `Link description = URL `INDEX TAG The Index tag creates an additional entry for the alphabetical index page. Any descriptive text may be used. A bookmark is generated at the current location of the output HTML page. The `Index descriptive-text is ONLY used in the index page, and not included in the HTML output of the current node. SYNTAX `Index descriptive-text RELATED LINKS |