Begins a subcommand reference section for subordinate commands in the command section.

Syntax

<SUBCOMMAND_SECTION> [(running title [\NEWPAGE ])]

ARGUMENTS

running title

This is an optional argument. It specifies text to be placed at the top of each page of the subcommand section.

NEWPAGE

This is an optional keyword argument. It specifies that the subcommand section is to start on a new page. Note that this argument is required only if subcommands themselves do not start on new pages, or if you use the <SUBCOMMAND_SECTION_HEAD> tag to provide introductory text for the subcommand section.

related tags

• <COMMAND_SECTION>
• <SET_TEMPLATE_SUBCOMMAND>
• <SUBCOMMAND>
• <SUBCOMMAND_SECTION_HEAD>

restrictions

Valid only in the context of the <COMMAND_SECTION> tag.

required terminator

<ENDSUBCOMMAND_SECTION>

DESCRIPTION

The <SUBCOMMAND_SECTION> tag begins a subcommand reference section for subordinate commands in the command section.

Example

The following example illustrates a subcommand section in a command section. The subcommand section is used to describe subordinate commands.

<SUBCOMMAND_SECTION>(File System Subcommands) <SUBCOMMAND>(CLOSE) <overview> . . .

Specifies the heading for text that precedes a subcommand section.

Syntax

<SUBCOMMAND_SECTION_HEAD> (heading)

ARGUMENTS

heading

Specifies a heading that precedes introductory text for the subcommand section.

related tags

• <SET_TEMPLATE_SUBCOMMAND>
• <SUBCOMMAND>

restrictions

Valid only in the context of the <SUBCOMMAND_SECTION> tag.

DESCRIPTION

The <SUBCOMMAND_SECTION_HEAD> tag specifies the heading for text that precedes a subcommand section. This tag lets you provide introductory text for a section of command descriptions that are subordinate to a specific command description.

Example

The following example illustrates a subcommand section in a command section. The subcommand section is used to describe subordinate commands.

<SUBCOMMAND_SECTION>(File System Subcommands\NEWPAGE) 
<SUBCOMMAND_SECTION_HEAD>(Subcommand Descriptions) 
<p>This section provides information about each of the subcommands 
you can enter while you are conversing with the file subsystem. 
<SUBCOMMAND>(CLOSE) 
<overview> 
   . 
   . 
   . 
 

Lets you use special characters to describe language syntaxes.

Syntax

<SYNTAX> [(

• heading text [\WIDE]
• WIDE

)]

ARGUMENTS

heading text

This is an optional argument. It specifies a heading. The doctype controls the font used to display the heading. By default, this tag has no heading. You may want to create a heading using the <SYNTAX_DEFAULT_HEAD> tag.

WIDE

This is an optional keyword argument. It specifies that the syntax statement can exceed the normal right margin of the text. If you are using doctype designs that indent the text body, a wide syntax example will extend into the left margin.

related tags

• <DISPLAY>
• <SYNTAX_DEFAULT_HEAD>
• The global <CODE_EXAMPLE> tag
• The global <FORMAT> tag

restrictions

You cannot use tab characters, index tags (such as the <X> and <Y> tags), or text element tags (such as <P>, <LIST>, or <NOTE>) in this type of example.

required terminator

<ENDSYNTAX>

DESCRIPTION

The <SYNTAX> tag lets you use special characters to describe language syntaxes. Languages can include programming languages, command languages, application-defined languages, and so forth. This tag also separates the syntax example from the remaining text, retains blank spaces and open lines, and labels the example (if you specified one) using a doctype-specific font different from the current text font.

Example

The following example shows how to use the <SYNTAX> tag to describe a language's syntax.

<P>The COPY command has the following syntax: 
<SYNTAX> 
              COPY input_file output_file 
<ENDSYNTAX> 
 

This example produces the following output.

The COPY command has the following syntax:

COPY input_file output_file

Creates a default heading for the <SYNTAX> tag.

Syntax

<SYNTAX_DEFAULT_HEAD> (

• heading text
• OFF

)

ARGUMENTS

heading text

Specifies a heading to be used by all subsequent <SYNTAX> tags. The doctype controls the font used to display this heading. By default, the <SYNTAX> tag has no heading.

OFF

Disables any heading established by a previous use of the <SYNTAX_DEFAULT_HEAD> tag.

related tags

• <SYNTAX>

---

DESCRIPTION

The <SYNTAX_DEFAULT_HEAD> tag creates a default heading for the <SYNTAX> tag. Use the <SYNTAX_DEFAULT_HEAD> tag to create the same default heading above each use of the <SYNTAX> tag.

To disable all subsequent default headings, specify the OFF argument to the <SYNTAX_DEFAULT_HEAD> tag.

---

Examples

The following example shows how to use the <SYNTAX_DEFAULT_HEAD> tag to create a default heading for all subsequent <SYNTAX> tags.

#1

<P> The COPY command has the following general syntax: <SYNTAX> COPY input-file output-file <ENDSYNTAX> <COMMENT>(Set up default headings for syntax statements....) <SYNTAX_DEFAULT_HEAD>(What the User Types) <P> An actual user would type the following: <SYNTAX> $ COPY MYFILE.TXT NEWFILE.TXT <ENDSYNTAX>

This example produces the following output:

The COPY command has the following general syntax:

COPY input-file output-file

An actual user would type the following:

$ COPY MYFILE.TXT NEWFILE.TXT

The following example shows how to disable the <SYNTAX_DEFAULT_HEAD> tag for all subsequent <SYNTAX> tags.

#2

<COMMENT>(Set up default headings for syntax statements....) <SYNTAX_DEFAULT_HEAD>(What the User Types) <P> An actual user would type the following: <SYNTAX> $ COPY MYFILE.TXT NEWFILE.TXT <ENDSYNTAX> <COMMENT>(Disable default headings for syntax statements....) <SYNTAX_DEFAULT_HEAD>(OFF) <P>The following is a semantic statement of the COPY operation. <SYNTAX> COPY [the existing file specification to] [the new file specification] <ENDSYNTAX>

This example produces the following output:

An actual user would type the following:

$ COPY MYFILE.TXT NEWFILE.TXT

The following is a semantic statement of the COPY operation.

COPY [the existing file specification to] [the new file specification]

---

<TAG_SECTION>

Begins a tag reference section, enables tags reserved for use in tag sections, and sets paging attributes.

---

Syntax

<TAG_SECTION> [([running title]
[\number-prefix]
[\NEWPAGE])]

---

ARGUMENTS

running title

This is an optional argument. It specifies a top-level running heading to be used throughout the tag section. If this argument is not specified, the running headings are determined as described in .

number prefix

This is an optional argument. It specifies a character-string prefix to be used to construct page numbers (folios) and formal figure, table, and example numbers. If this argument is not specified, the page and formal element numbering are determined as described in .

NEWPAGE

This is an optional keyword argument. It indicates that the tag section should begin on a new page. This argument is only meaningful in two cases:

• When you have previously entered the <SET_TEMPLATE_TAG> tag with the NONEWPAGE keyword to specify that each new tag in this tag section should not begin on a new page.
• When you want to place one or more pages of text between the end of a part page and the beginning of a tag section.

related tags

• <DESCRIPTION>
• <EXAMPLE_SEQUENCE>
• <FORMAT>
• <FTAG>
• <OVERVIEW>
• <PARAMDEFLIST>
• <RELATED_ITEM>
• <RELATED_TAG>
• <RELATED_TAGS>
• <RESTRICTIONS>
• <RITEM>
• <SDML_TAG>
• <SET_TEMPLATE_HEADING>
• <SET_TEMPLATE_LIST>
• <SET_TEMPLATE_PARA>
• <SET_TEMPLATE_ROUTINE>
• <SET_TEMPLATE_TABLE>
• <SET_TEMPLATE_TAG>
• <TERMINATING_TAG>

required terminator

<ENDTAG_SECTION>

DESCRIPTION

The <TAG_SECTION> tag begins a tag reference section, enables tags reserved for use in tag sections, and sets paging attributes. You can locate a tag section in a chapter or an appendix, or following a part page (that is, in a document section begun with the <PART_PAGE> tag). You code a tag section in a chapter or an appendix in the same manner; tag sections in parts are handled differently.

If your tag section follows a part page, and you include text between the part page and the tag section, specify the NEWPAGE keyword as the third argument to the <TAG_SECTION> tag. This causes the tag section to begin on a new page. The following code fragment shows a tag section that begins on a new page:

<TAG_SECTION>(\TD\NEWPAGE) <HEAD1>(Tag Dictionary\46_TagDictionary)

When you use the <TAG_SECTION> tag in a chapter or an appendix, and want to place text after the tag section in that chapter or appendix, you must end the tag section with the <ENDTAG_SECTION> tag and place the text after that tag. By default, this text begins on a new page of output.

Specify the NONEWPAGE argument to the <ENDTAG_SECTION> tag if you do not want the text to begin on a new page of output. The following code fragment shows the end of a tag section that specifies that the subsequent text not be placed on a new page:

<ENDTAG_SECTION>(NONEWPAGE)

When the <ENDTAG_SECTION> tag is specified in the context of a chapter or appendix, it resets the default running titles to those in effect for the chapter or appendix, so the last page of the last tag description in the tag section may not carry the last tag's name as the running heading. Instead it may carry the running title used by the chapter or appendix.

Examples

The following example shows how to begin a tag section in a document part.

<PART> 
<PART_PAGE> 
<TITLE>(Part III\Tag Dictionary) 
<ENDPART_PAGE>(RENUMBER) 
<TAG_SECTION>(Tag Dictionary\TD) 
<SET_TEMPLATE_TAG>(LOCAL_TAG) 
 
<LOCAL_TAG>(SITETAG) 
 
<OVERVIEW> 
This is a site-specific tag. 
<ENDOVERVIEW> 
. 
. 
. 
<ENDTAG_SECTION> 
 

The tags in the previous example perform the following functions:

• The global <PART> tag begins the part.
• The global <PART_PAGE> tag creates a part page.
• The global <TITLE> tag is used in the context of the <PART_PAGE> tag to create a title on the part page.
• The RENUMBER argument to the global <ENDPART_PAGE> tag specifies that the pages should be renumbered beginning with the part page. This causes the first page of text following the part page to be numbered page 3 (page 1 is the unnumbered page the part page title is placed on, page 2 is the back of page 1, and page 3 is the first numbered page after the part page).
• The <TAG_SECTION> tag begins the tag section and specifies the running title Tag Dictionary as the running title for the tag section. If the <SET_TEMPLATE_TAG> tag were used with the DOUBLERUNNINGHEADS argument, the title Tag Dictionary would be used as the top running title.
  The <TAG_SECTION> tag also specifies that the prefix TD should be used to construct numbers for pages and for formal figures, tables, and examples in the tag section (for example, TD--11, TD--32, Table TD--1, Example TD--2, and so on).
• The <SET_TEMPLATE_TAG> tag specifies that all tag descriptions in this tag section will be identified using the <LOCAL_TAG> tag rather than the default <TAG> tag. The <LOCAL_TAG> tag will have the default attributes of the <TAG> tag.

The following example shows how you can create a tag section in which each tag description (begun with an <SDML_TAG> tag) is in a separate SDML file, and all these descriptions are included into a primary routine description file. For example, the file MYTAGS.SDML contains the following SDML tags:

<INCLUDE>(CLOSE_FILE.SDML) <INCLUDE>(OPEN_FILE.SDML) <INCLUDE>(READ_FILE.SDML) <INCLUDE>(WRITE_FILE.SDML)

Each of the included files contains one tag reference description begun with an <SDML_TAG> tag. For these files to process correctly, they must be preceded with the <TAG_SECTION> tag that enables the <SDML_TAG> tag. These files can have the necessary tags processed before them by specifying the /INCLUDE qualifier on the command line to include a startup definition file. This startup file might include the following tags.

<TAG_SECTION>(File Handling Tags\TAGS) 
<SET_TEMPLATE_TAG>(SDML_TAG\DOUBLERUNNINGHEADS) 
 

If this startup file were named FILE_TAG_STARTUP.SDML, it could be included using the DOCUMENT /INCLUDE qualifier as in the following example:

$ DOCUMENT mytags SOFT.REF LN03 /INCLUDE=FILE_TAG_STARTUP.SDML

When each individual file in MYTAGS.SDML is processed, the correct sequence of tags will be read in to begin the tag section.

You can process multiple files together by using the <INCLUDE> tag to include them into a single master file (such as MYTAGS.SDML), or you can include them into a bookbuild profile.

You use the <ELEMENT> tags to include multiple files into a profile. For example, the bookbuild profile file TAGPRO.SDML could contain the following tags:

<PROFILE> <ELEMENT>(CLOSE_FILE.SDML) <ELEMENT>(OPEN_FILE.SDML) <ELEMENT>(READ_FILE.SDML) <ELEMENT>(WRITE_FILE.SDML) <COMMENT>(contains <ENDTAG_SECTION> tag) <ENDPROFILE>

Note that the PROFILE file should include the <ENDTAG_SECTION> tag in the appropriate file, so that the template will be terminated and the bookbuild will process correctly.

Specifies the required terminator for a tag.

Syntax

<TERMINATING_TAG> (

• tag name[\additional text]
• NONE

)

ARGUMENTS

tag name

Specifies the name of the terminating tag.

additional text

This is an optional argument. It specifies additional text you can insert to briefly explain the terminating tag.

NONE

Indicates that there is no terminating tag.

related tags

• <RELATED_TAG>
• <TAG_SECTION>

restrictions

Valid only in the context of the <TAG_SECTION> tag.

DESCRIPTION

The <TERMINATING_TAG> tag specifies the required terminator for a tag. Provide additional information about the terminating tag by specifying this text as the second argument to the <TERMINATING_TAG> tag.

Use the NONE keyword argument to explicitly specify that no terminating tag is needed. This keyword places the text None beneath the heading output by this tag.

Examples

The following example shows a terminating tag specified with both the tag name argument and the additional text argument.

<TERMINATING_TAG>(ENDRECORDLIST\
<p> 
Omit this tag if you use the 
NONE keyword with the <TAG>(RECORDLIST) tag.) 
 

This example produces the following output:

required terminator

<ENDRECORDLIST>

Omit this tag if you use the NONE keyword with the <RECORDLIST> tag.

The following example shows the <TERMINATING_TAG> tag used with the NONE keyword.

<TERMINATING_TAG>(NONE) 
 

This example produces the following output:

required terminator

None.