Prev Next glossary

Glossary

Children
Complete Path Specification
Cross Reference Tag
     Automatic Tags
Delimiter Sequence
Directory Separator Character
The Dollar Sign Character
File Extension
Input File Searching
Parent
Pre-formatted Font
Section
Siblings
Uniformly Spaced Font
White Space

Children
The children of the current section are the sections directly following in the contents tree that are indented more than the current section. The children of the current section are specified by the contents , childtable, or children command for the current section.

Complete Path Specification
A complete path specification is a directory specification that begins with a forward slash, /, begins with a back slash, \, or has a colon, :, as its second character. (Note that a disk specification should precede the colon.)

Cross Reference Tag
Each section has a cross reference tag that is specified in its begin command. This tag is used to link to the section; e.g., using the cref command. It should be an abbreviated version of the title for the corresponding section (similar to a variable name being short hand for a concept with in a program). It must be unique for each section. Upper and lower case versions of the same letter are considered equal when comparing cross reference tags.

Automatic Tags
The following cross reference tags begin with the underbar character _ and are for automatically generated sections: _search , _external , _index , _contents , and _reference .

Delimiter Sequence
Some commands use a delimiter sequence. The first character in a delimiter sequence cannot be a letter. In addition, there can be no occurrences of the character $ in any delimiter sequence; i.e., there can not be any commands embedded in a delimiter sequence. If the first character in the sequence is a white space character, there is only one argument and it is the entire sequence except for the first character. If the first character in the sequence is not a white space character, any character equal to the first is called a delimiter for the sequence. In this case, the last character in the sequence must also be a delimiter. The characters between each pair of delimiters are called arguments. The number of arguments in a delimiter sequence is one less than the number of delimiters in the sequence.

Directory Separator Character
Both file names and directory names can use either the forward slash character, /, or the back slash character, \, to separate directories. For example,
     $include directory/file
 has the same meaning as
     $include directory\file
The Dollar Sign Character
The character $ is used to signal the start of a text processing command. This character is referred to at the dollar sign.

File Extension
The term file extension refers to the characters that follow and include the last period in the file name. The extension for the HTML files written by omhelp is .htm.

Input File Searching
If an input file name is not a complete path specification , it is relative to the directory where the file containing the root section is located. If it cannot be found there, the extension of the file name is used to determine which directories to search (as specified by the path command).

Parent
The parent of the current section is the previous section in the contents tree that is indented less than the current section. The parent of the current section specified the input file for the current section in a contents , childtable, or children command.

Pre-formatted Font
A Pre-formatted font displays text with a uniformly spaced font . In addition, white space characters in the input are preserved in the output. This enables you to line up text between different lines. If you use an editor that displays the input text in a uniformly spaced font, a visual inspection will enable you to see the characters that will line up between different lines.

Section
A section of an OMhelp web site is the information between a begin and the corresponding end command. Each section corresponds to one browser window and can be divided into headings and subheadings .

Siblings
A siblings of the current section is a section indented the same amount in the contents tree and that has the same parent . If siblings are in the same input file, they have the same order as in the input file. If siblings are in different input files, they have the order of their input files in the corresponding contents , childtable, or children command.

Uniformly Spaced Font
A uniformly spaced font is a character font in which all character use the same amount of horizontal space.

White Space
The following ascii characters are considered white space: space, form feed, new line, carriage return, horizontal tab, vertical tab.
Input File: omh/glossary.omh