Overrides the heading for all subsequent uses of a template tag.

Syntax

<SET_TEMPLATE_HEADING> (element keyword
\default heading)

ARGUMENTS

element keyword

Specifies the standard reference template element whose default heading you want to override. The reference element keywords, the related template tags, and the system default headings are listed in the following table.

related tags

• <SET_TEMPLATE_LIST>
• <SET_TEMPLATE_PARA>
• The global <LIST> tag

---

DESCRIPTION

The <SET_TEMPLATE_HEADING> tag overrides the heading for all subsequent uses of a template tag.

---

Example

The following example shows how to use the <SET_TEMPLATE_HEADING> tag to change the Command template so that the default heading of the keyword FORMAT is changed from Format to Syntax.

<COMMAND_SECTION>(FDL Commands) <SET_TEMPLATE_HEADING>(FORMAT\Syntax)

---

<SET_TEMPLATE_LIST>

Creates a user-defined set of tags for listing information.

---

Syntax

<SET_TEMPLATE_LIST> (list tag name
\default list heading
\list item tag name
\list type
[\heading level])

---

ARGUMENTS

list tag name

Specifies the name of the tag that will introduce the list of items in the list template being defined. This tag name must be a valid tag name less than 28 characters; it must not be the same as an existing SDML tag name.

default list heading

Specifies the default text heading to be output by the list template being defined.

item tag name

Specifies the name of the tag to be used to indicate individual items in the list being defined. This name must be a valid tag name.

list type

Specifies the keyword that indicates the type of list the list being defined is based on. These keywords create the same list format as the same keywords used with the global <LIST> tag. These keywords are as follows:

• SIMPLE
• NUMBERED
• UNNUMBERED

heading level

This is an optional argument. It specifies the template heading level to be associated with the tag. Valid values are 1 and 2, indicating a primary template heading or a secondary template heading. If you do not specify this argument, the value defaults to 2, and the secondary template heading is used.

related tags

• <SET_TEMPLATE_HEADING>
• <SET_TEMPLATE_PARA>
• <SET_TEMPLATE_TABLE>
• The global <LIST> tag

restrictions

Valid only in the context of a <COMMAND_SECTION>, <ROUTINE_SECTION>, <STATEMENT_SECTION>, or <TAG_SECTION> tag.

DESCRIPTION

The <SET_TEMPLATE_LIST> tag creates a user-defined set of tags for listing information.

Examples

The following examples in this section assume that the following tag has been specified to enable the <SHOPPING_LIST>, <SITEM>, and <ENDSHOPPING_LIST> tags.

<SET_TEMPLATE_LIST>(SHOPPING_LIST\Shopping List\SITEM\NUMBERED)

The following example generates the default heading Shopping List, and starts a numbered list. Each <SITEM> tag generates another numeric item in the list, as follows:

<SHOPPING_LIST> 
<SITEM>one item 
<SITEM>second 
<ENDSHOPPING_LIST> 
 

This example produces the following output:

Shopping List

1. one item
2. second

The following example shows how to override the default heading shopping list heading and produce the text None.

<SHOPPING_LIST>(Bloomingdales\NONE) 
 

This example produces the following output:

Bloomingdales

Defines a set of template tags for setting the format of a paragraph of information.

Syntax

<SET_TEMPLATE_PARA> (tag name
\default heading
[\heading level])

ARGUMENTS

tag name

Specifies the user-defined name of the tag that begins the paragraph template and marks the beginning of the text in that paragraph. This tag name must be a valid tag name less than 28 characters; it must not be the same as an existing SDML tag name.

default heading

Specifies a default heading to be associated with the paragraph template. You can override this default heading in the tag invocation, if needed.

heading level

This is an optional argument. It specifies the template heading level to be associated with the tag. Valid values are 1 and 2, indicating a primary template heading or a secondary template heading. If you do not specify this argument, it defaults to 2 and the secondary template heading is used.

related tags

• <SET_TEMPLATE_HEADING>
• <SET_TEMPLATE_LIST>
• <SET_TEMPLATE_TABLE>

restrictions

Valid only in the context of a reference template.

DESCRIPTION

The <SET_TEMPLATE_PARA> tag defines a set of template tags for setting the format of a paragraph of information.

Examples

The following examples show how to use the <SET_TEMPLATE_PARA> tag.

The <SET_TEMPLATE_PARA> tag in the following example creates the template tags <SIDE_EFFECTS> and <ENDSIDE_EFFECTS> as the beginning and ending tags of a paragraph template with a default heading of Side Effects:.

Note that this definition of the <SIDE_EFFECTS> tag is the one used in the following examples.

<SET_TEMPLATE_PARA>(SIDE_EFFECTS\Side Effects:) 
   . 
   . 
   . 
<SIDE_EFFECTS> 
Modifying the arguments to the PLACE command changes the positioning of the 
page number. 
<ENDSIDE_EFFECTS> 
 

The following example shows how to specify the template tag <SIDE_EFFECTS> with the alternate heading Desired Effect=.

<SIDE_EFFECTS>(Desired Effect=) 
Modifying the arguments to the PLACE command changes the positioning of the 
page number. 
<ENDSIDE_EFFECTS> 
 

The following example shows how to specify the NONE keyword to the <SIDE_EFFECTS> template tag.

<SIDE_EFFECTS>(NONE) 
 

Defines a new reference element tag name to use in the routine template, and specifies the formatting attributes for the new tag.

Syntax

<SET_TEMPLATE_ROUTINE> (tag name

• [\DOUBLE-
• RUNNINGHEADS]
• [\NONEWPAGE]
• [\STACK]

[\symbol name])

ARGUMENTS

tag name

Specifies the name of the template tag being defined. This tag name must be a valid tag name less than 31 characters and must not be the same as an existing tag name other than ROUTINE (the default tag name).

DOUBLERUNNINGHEADS

This is an optional keyword argument. It specifies that the routine descriptions will have two running titles at the top of every page. The top running title is either the title you set with the <ROUTINE_SECTION> tag, or the heading set in the most recent <CHAPTER> or <APPENDIX> tag. By default, if a doctype does not call for running top titles, only the current routine name is placed at the top of each page.

NONEWPAGE

This is an optional keyword argument. Routine descriptions are not to start on new pages. By default, each tag name template tag begins a routine description on a new page.

STACK

This is an optional keyword argument. It specifies that when you give multiple arguments to the tag name tag, the arguments are stacked at the beginning of the page.

By default, when you give multiple arguments, the second and third arguments are assumed to be optional descriptive information, and output as shown in the examples in the <ROUTINE> tag description.

symbol name

This is an optional argument for printed output, but is required for using the file in a bookbuild for Bookreader. This argument specifies the name of the symbol used in all references to this tag.

Symbol names must not exceed 31 characters and must only contain alphabetic letters, numbers, or underscores. Do not begin a symbol name with an underscore.

related tags

• <ROUTINE>
• <ROUTINE_SECTION>

restrictions

Valid only in the context of the <ROUTINE_SECTION> tag in the Routine template.

DESCRIPTION

The <SET_TEMPLATE_ROUTINE> tag defines a new reference element tag name to use in the routine template, and specifies the formatting attributes for the new tag.

This tag also changes the default attributes associated with the <ROUTINE> tag or your new tag.

Examples

The following two examples show how to use the <SET_TEMPLATE_ROUTINE> tag.

The first tag sequence begins a routine section and defines the <FDL_ROUTINE> tag as the routine descriptor tag. The attributes set are as follows:

• Routines do not start on new pages. However, because NEWPAGE is specified to the <ROUTINE_SECTION> tag, the first reference description begins on a new page.
• When two arguments are specified to the <FDL_ROUTINE> tag, the arguments are stacked; that is, the second argument is placed under the first on output.
• Each page carries a 2-line running title. The top line is FDL Routines and the second line is the name of the routine description that is current at the top of the page.

Note that this routine sequence is most appropriate for a series of routine descriptions that occur in a chapter.

<ROUTINE_SECTION>(FDL Routines\\NEWPAGE) 
<SET_TEMPLATE_ROUTINE>(FDL_ROUTINE\NONEWPAGE\STACK\DOUBLERUNNINGHEADS) 
<FDL_ROUTINE>($STARTUP_FILE\$STF) 
 

The second tag sequence begins a document part in which only routine descriptions occur. The RENUMBER argument on the <ENDPART_PAGE> tag specifies that the first page of the new part (the part page itself) is numbered page 1. The <ROUTINE_SECTION> tag sets the folio prefix to XYZ; that is, pages will be numbered XYZ--3, XYZ--4, and so on.

No attributes are specified for the routine descriptions produced by the <XYZ_ROUTINE> tag. These routines will have default attributes. The first routine will start on a new page. Because RENUMBER was specified on the <ENDPART_PAGE> tag, the first routine will be on the page numbered XYZ--3.

<PART> 
<PART_PAGE> 
<TITLE>(PART II\XYZ Routines) 
<ENDPART_PAGE>(RENUMBER) 
 

Defines a new reference element tag name to use in the statement template and specifies the formatting attributes for the new tag.

Syntax

<SET_TEMPLATE_STATEMENT> (tag name

• [\DOUBLE-
• RUNNINGHEADS]
• [\NONEWPAGE]
• [\STACK]

[\symbol name])

ARGUMENTS

tag name

Specifies the name of the template tag being defined. This tag name must be a valid tag name less than 31 characters and must not be the same as an existing tag name other than STATEMENT or FUNCTION (which are the default tag names).

DOUBLERUNNINGHEADS

This is an optional keyword argument. It specifies that the statement descriptions will have two running titles at the top of every page. The top running title is set by the <STATEMENT_SECTION> tag or by the heading of the most recent <CHAPTER> or <APPENDIX> tag. By default, if a doctype does not call for running top titles, only the current statement name is placed at the top of each page.

NONEWPAGE

This is an optional keyword argument. It specifies that statement descriptions are not to start on new pages. By default, each tag name template tag begins a statement description on a new page.

STACK

This is an optional keyword argument. It specifies that when multiple arguments are specified for the tag name tag, the arguments should be stacked at the beginning of the page.

By default, when multiple arguments are specified, the second and third arguments are assumed to be optional descriptive information, and are output on the same line as the statement name.

symbol name

This is an optional argument for printed output, but is required for using the file in a bookbuild for Bookreader. This argument specifies the name of the symbol used in all references to this tag.

Symbol names must not exceed 31 characters and must only contain alphabetic letters, numbers, or underscores. Do not begin a symbol name with an underscore.

related tags

• <FUNCTION>
• <STATEMENT>
• <STATEMENT_SECTION>

restrictions

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

DESCRIPTION

The <SET_TEMPLATE_STATEMENT> tag defines a new reference element tag name to use in the statement template and specifies the formatting attributes for the new tag.

This tag also lets you change the default attributes associated with the <STATEMENT> tag or your new tag.

Examples

The following tag sequence begins a statement section and defines the tag <BASIC_STATEMENT> as the statement descriptor tag. The attributes set are as follows:

• Statements do not start on new pages.
• Each page carries a 2-line running title. The top line is BASIC Statements and the second line is the name of the statement description that is current at the top of the page.

Note that this statement sequence is most appropriate for a series of statement descriptions that occur in a chapter.

<STATEMENT_SECTION>(BASIC Statements\\NEWPAGE) 
<SET_TEMPLATE_STATEMENT>(BASIC_STATEMENT\NONEWPAGE\DOUBLERUNNINGHEADS) 
<BASIC_STATEMENT>(STARTUP_FILE\STF) 
 

The following tag sequence begins a document part in which only statement descriptions occur. The RENUMBER argument on the <ENDPART_PAGE> tag specifies that the first page of the new part (the part page itself) should be numbered page 1. The <STATEMENT_SECTION> tag sets the folio prefix to XYZ; that is, pages will be numbered XYZ--3, XYZ--4, and so on.

No attributes are specified for the statement descriptions produced by <XYZ_STATEMENT>; these statements have default attributes. The first statement will start on a new page. Because RENUMBER was specified on the <ENDPART_PAGE> tag, the first statement will be on the page numbered XYZ--3.

<PART> 
<PART_PAGE> 
<TITLE>(PART II\XYZ Statements) 
<ENDPART_PAGE>(RENUMBER) 
<STATEMENT_SECTION>(XYZ Statements\XYZ) 
<SET_TEMPLATE_STATEMENT>(XYZ_STATEMENT) 
 

Changes the name of the <SUBCOMMAND> tag to the name you specify, and specifies formatting attributes for the new tag.

Syntax

<SET_TEMPLATE_SUBCOMMAND> (tag name
[\NONEWPAGE])

ARGUMENTS

tag name

Specifies the name of the template tag being defined. This tag name must be a valid tag name less than 31 characters; it must not be the same as an existing SDML tag name other than SUBCOMMAND (which is the default tag name).

NONEWPAGE

This is an optional argument. It specifies that the corresponding subcommand reference description does not start on a new page of output.

related tags

• <COMMAND_SECTION>
• <SUBCOMMAND>
• <SUBCOMMAND_SECTION>

restrictions

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

DESCRIPTION

The <SET_TEMPLATE_SUBCOMMAND> tag changes the name of the <SUBCOMMAND> tag to the name you specify, and specifies formatting attributes for the new tag. This helps you customize your source file coding.

Example

The following example shows how to create a subcommand section in a command section. The subcommand section is used to describe keywords associated with the command.

<SUBCOMMAND_SECTION>(Qualifiers) 
<SET_TEMPLATE_SUBCOMMAND>(QUALIFIER) 
<QUALIFIER>(/OUTPUT) 
<overview> 
   . 
   . 
   . 
 

 

The following default attributes are set in the previous example:

• Each subcommand description that begins with the <QUALIFIER> tag starts on a new page of output.
• Each page carries a 2-line running title. The top line is Qualifiers and the second line is the name of the subcommand description that is current at the top of the page.

Defines a set of template tags for setting information in 2- or 3-column lists.

Syntax

<SET_TEMPLATE_TABLE> (table tag name
\default table heading
\table row tag name
\column count
\column widths
[\table column headings])

ARGUMENTS

table tag name

Specifies the user-defined name of the tag that begins the user-defined table. This tag name must be a valid tag name less than 28 characters; it must not be the same as an existing SDML tag name.

default table heading

Specifies a default heading to be output over the entire user-defined table.

table row tag name

Specifies the name of the tag to be used to indicate individual table rows in the table being defined. This name must be a valid tag name. For example, if the table row tag name argument is specified as SAMP_ROW, the individual table row tag will be <SAMP_ROW>. The user-defined tag created by this argument is similar to the global <TABLE_ROW> tag.

column count

Specifies the number of columns in the user-defined table. The accepted arguments are as follows:

• 2 --- Specifies that the table is to have two columns.
• 3 --- Specifies that the table is to have three columns.

column widths

Specifies the approximate widths of the table columns. The width of the last table column is determined by DECdocument. If you specify a 2-column table, you must specify only a single column width argument, as shown in the following code example:

<SET_TEMPLATE_TABLE>(KEYVALS\Keyword Values\KEYVAL\2\10\Keyword\Value)

If you specify a 3-column table, you must specify two column-width arguments, as shown in the following code example:

<SET_TEMPLATE_TABLE>(KEYVAL_TABLE\Keyword Ranges \KEYVAL\3\10\10\Keyword\High\Lower)

table column headings

This is an optional argument. It specifies the default headings for each column in the user-defined table. If you specify a 2-column table, you can specify up to two heading arguments. If you specify a 3-column table, you can specify up to three heading arguments.

related tags

• <SET_TEMPLATE_LIST>
• <SET_TEMPLATE_PARA>

restrictions

Valid only in the context of a reference template.

DESCRIPTION

The <SET_TEMPLATE_TABLE> tag defines a set of template tags for setting information in 2- or 3-column lists. Tables created using this tag may have either two or three columns. This tag requires five arguments and accepts the optional table column headings argument.

If you choose to omit the table column headings argument, then the table will not have any column headings and will not output rules in the table.

Examples

In the following example, the <SET_TEMPLATE_TABLE> tag sets the default heading to be Best Songs, enables a 2-column table, sets the text supplied to the two <45RPM> tags in the table, and then terminates the table.

<SET_TEMPLATE_TABLE>(RECORDTABLE_2\Best Songs\45RPM\2\12\Performer\Song Title) 
<RECORDTABLE_2> 
<45RPM>(Sinatra\Strangers in the Night) 
<45RPM>(Moody Blues\Nights in White Satin) 
<ENDRECORDTABLE_2> 
 

This example produces the following output.

Best Songs

Performer||Song Title	Sinatra
Strangers in the Night	Moody Blues
Nights in White Satin

The following example shows how to specify the NONE keyword to the <RECORDTABLE_2> tag.

<RECORDTABLE_2>(NONE) 
 

This example produces the following output.

Best Songs

The following example shows how to define a 3-column table with headings. The tags defined are the <OPCODES>, <ENDOPCODES>, and <OPS> tags.

<SET_TEMPLATE_TABLE>(OPCODES\codes\OPS\3\6\6\2-byte\3-byte\4-byte) 
<OPCODES> 
<OPS>(abc\def\ghi) 
<ENDOPCODES> 
 

---

Previous

Next

Contents

Index