Specifying Children in Contents Tree

Specifying Children in Contents Tree
Syntax
See Also
Description
Contents Command
Contents
Childtable Command
Children Command

Syntax

$contents%file1%file2%...%fileN%$$

$childtable%file1%file2%...%fileN%$$

$children%file1%file2%...%fileN%$$

See Also
get started , include , verbatim , image

Description
These commands provide different ways to specify which sections are children of the current section in the table of contents . (You can link to the overall table of contents using the _contents cross reference tag .) These commands also specify which files are processed by omhelp. The name of each file referenced in this way is printed on standard output .

The contents, childtable and children commands determine the order of the children of the current section. The navigation frame in the left hand column will contain links that are relative to the current section. These include links to its parent, grand parent, and all nodes above the current section in the help tree. It include links to all the siblings of the current section. In addition, it includes links to the previous and next section as determined by the table of contents (which in turn is determined by the contents, childtable and children commands).





%file1%file2%...%fileN%

is a delimiter sequence and % can be any character that is not a letter. The characters in file1 specify the input file containing the omhelp commands for the first set of children for this section. The characters in fileN specify the input file containing the omhelp commands for the last set of children for this section.

Leading white space in the file names is ignored and can be used to help separate them.

Both the forward and back slash can be used for a directory separator character in the file names.

Contents Command
If the contents command is used, a Contents heading will be included in the current section. This will be followed by a list of the title for each of the subsections together a link to the corresponding subsection.

Contents

Link to Next Section
Link to Previous Section
Standard Output Information

The table of contents directly above is generated with the following command

 
     $contents%
          omh/next.omh%
          omh/previous.omh%
          omh/stdout.omh%$$

Childtable Command
The table of Contents in the Cross Reference Linking section is generated with the following childtable command:

$childtable%
 
     	omh/keyword.omh%
     	omh/cref.omh%
     	omh/href.omh%
     	omh/rref.omh%
     	omh/tref.omh%
     	omh/mref.omh%
     	omh/navigate.omh
     %$$

Children Command
The children command does not automatically generate a table of contents. The format section uses the following commands to specify its children and corresponding jump tables.

$children%
 
     	omh/nobreak.omh%
     	omh/pre.omh%
     	omh/codep.omh%
     	omh/codei.omh%
     	omh/color.omh%
     	omh/hilite.omh%
     	omh/th.omh%
     	omh/center.omh%
     	omh/table.omh%
     	omh/list.omh%
     	omh/special.omh%
     	omh/font.omh%$$
     
     $head Command Limited$$
     The effect of the following commands
     is limited to the command itself:
     $table
     $rref nobreak$$
     $rref pre$$
     $rref codep$$
     $rref codei$$
     $rref color$$
     $rref hilite$$
     $rref th$$
     $tend
     
     $head Not Command Limited$$
     The effect of the following commands may extend across other commands:
     $table
     $rref center$$
     $rref table$$
     $rref list$$
     $rref special$$
     $rref font$$
     $tend

Note that the order of the files specified by the children command determines order of the corresponding sections in the contents tree . This does not need to be the same as the order of the sections in the corresponding jump tables.

Input File: omh/children.omh