Prev Next begin

Begin and End A Section

Syntax
See Also
Purpose
Example
tag

Syntax
$begin tag$$
. . .
$end
See Also
getting started

Purpose
OMhelp ignores all input in a file except between a begin command and a matching end command. The cross reference tag for the corresponding section is specified by tag . Leading and trailing white space is ignored and there can be no $ characters in tag .

Example
The following input file contains two sections. The first is named "First Subject" and is cross referenced as "one". The second is named "Second Subject" and is cross referenced as "two". In addition, each of the sections has a cross references to the other.
     /*
     $begin one$$
     $section First Subject$$
     This section is similar to
     $cref/the second section/two/$$.
     ...
     $end
     */

     Other text

     /*
     $begin two$$
     $section Second Subject$$
     This section is similar to
     $cref/the first section/one/$$.
     ...
     $end
     */

     Other text
tag
No two sections can have the same cross reference tag . (Note that upper and lower case letters are considered equal when comparing cross reference tags).

Cross reference tag cannot begin with the underbar character _, and the dot character ., (these tags are reserved for use by OMhelp). The tag cannot contain any white space characters, the sub-string _links, the sub-string _frame or the sub-string __ (two underbars).
Input File: omh/title.omh