| Previous | Contents | Index |
Begins a summary of interactive prompts.
<PROMPTS> [(alternate heading [\NONE])]
alternate heading
This is an optional argument. It specifies a heading to override the current default text heading for this use of the <PROMPTS> tag. The default heading provided by DECdocument is Prompts. If you want to use a different heading, specify it here. Also see the <SET_TEMPLATE_HEADING> tag description for information on modifying the default headings for all the <PROMPTS> tags.NONE
This is an optional keyword argument. It indicates that there are no prompts for this command. If you use the NONE keyword, do not use the <ENDPROMPTS> tag to end the <PROMPTS> list.
- <COMMAND_SECTION>
- <PROMPT>
- <SET_TEMPLATE_HEADING>
<ENDPROMPTS>
The <PROMPTS> tag begins a summary of interactive prompts.
The following example illustrates a command with a single prompt.
| #1 |
|---|
<PROMPTS>(Prompt) <PROMPT>(File:\filespec) <ENDPROMPTS> |
This example produces the following output:
prompt
File: filespec The following example illustrates a command with no prompts. Note that the terminator, <ENDPROMPTS>, is not specified.
| #2 |
|---|
<PROMPTS>(NONE) |
This example produces the following output:
prompts
<QPAIR>
Labels a qualifier pair in a qualifier format list.
Syntax
<QPAIR> (qualifier name\default qualifier name)
ARGUMENTS
qualifier name
The command qualifier to be listed. A common convention indicates the negative form of the qualifier by placing brackets around the negative prefix, as in [NO]CHECK.default qualifier name
The default value of the qualifier.related tags
- <QUAL_LIST>
- <QUAL_LIST_HEADS>
restrictions
Valid only in the context of a <QUAL_LIST> tag.
DESCRIPTION
The <QPAIR> tag labels a qualifier pair in a qualifier format list.
Example
See the example in the <QUAL_LIST> tag description.
<QUALDEF>
Begins the text that defines an item in a qualifier definition list.
Syntax
<QUALDEF>
ARGUMENTS
None.related tags
- <QUALDEFLIST>
- <QUALITEM>
restrictions
Valid only in the context of a <QUALDEFLIST> tag.
DESCRIPTION
The <QUALDEF> tag begins the text that defines an item in a qualifier definition list. This text describes the item listed by the previous <QUALITEM> tag. The text begun by the <QUALDEF> tag is terminated by the next <QUALITEM> or <ENDQUALDEFLIST> tag.
Example
See the example in the <QUALDEFLIST> tag description.
<QUALDEFLIST>
Begins a definition list describing command qualifiers.
Syntax
<QUALDEFLIST> [(
)]
- alternate heading
- NOHEAD
- NONE
ARGUMENTS
alternate heading
This is an optional argument. It specifies a heading to override the current default text heading. The default heading provided by DECdocument for the <QUALDEFLIST> tag can vary. See the DESCRIPTION section for more information on default qualifier definition list headings.NOHEAD
This is an optional keyword argument. It suppresses the output of the default heading for the <QUALDEFLIST> tag.NONE
This is an optional keyword argument. It causes the text None to be output beneath the heading for the qualifier definition list to indicate that no qualifiers are available. Note that when you use the NONE keyword, you do not use the <ENDQUALDEFLIST> tag.related tags
- <ARGDEFLIST>
- <PARAMDEFLIST>
- <QUALDEF>
- <QUALITEM>
- <SET_TEMPLATE_ARGITEM>
- <SET_TEMPLATE_HEADING>
- The global <DEFINITION_LIST> tag
required terminator
<ENDQUALDEFLIST> Required unless you specify the NONE keyword as an argument to the <QUALDEFLIST> tag.
DESCRIPTION
The <QUALDEFLIST> tag begins a definition list describing command qualifiers. It is similar in format and syntax to the global <DEFINITION_LIST> tag. See Using Global TagsUsing Global Tags for more information.The <QUALDEFLIST> tag enables two tags to create a qualifier definition list. The <QUALITEM> tag labels the list item being defined, and the <QUALDEF> tag begins the definition of the list item. These tags are functionally the same as the <DEFLIST_ITEM> and <DEFLIST_DEF> tags enabled by the global <DEFINITION_LIST> tag. A default heading is provided when the <QUALDEFLIST> tag is used in a reference template; no default heading is provided when the <QUALDEFLIST> tag is used outside a reference template.
Create your own heading for an individual qualifier definition list by specifying that heading as the alternate heading argument. A heading specified in this way overrides any existing default headings.
Use the <SET_TEMPLATE_HEADING> tag to alter the default headings used by all subsequent <QUALDEFLIST> tags. See the description of the <SET_TEMPLATE_HEADING> tag for more information.
The following informal table lists the default headings for the <QUALDEFLIST> by their context.
Context Default Heading Command Template Qualifiers Tag Template Qualifiers Routine Template No default heading Statement Template No default heading Outside a Template No default heading
Example
The following example shows a qualifier definition list in the context of the Command template.
<COMMAND_SECTION) . . . <QUALDEFLIST> <QUALITEM>(/LOG\/NOLOG (D)) <QUALDEF>Specifies whether or not output logging is used. The default is /NOLOG. <QUALITEM>(/ECHO\/NOECHO (D)) <QUALDEF>Specifies whether or not input echoing is used. The default is /NOECHO. <ENDQUALDEFLIST> . . . <ENDCOMMAND_SECTION>This example produces the following output:
QUALIFIERS
/LOG
/NOLOG (D)
Specifies whether or not output logging is used. The default is /NOLOG./ECHO
/NOECHO (D)
Specifies whether or not input echoing is used. The default is /NOECHO.
<QUALITEM>
Labels one to seven items to be defined in a qualifier definition list.
Syntax
<QUALITEM> (item-1[\item-2...[\item-7]])
ARGUMENTS
item-n
Specifies the item in the qualifier list to be defined. This tag accepts a minimum of one item-n argument and a maximum of seven item-n arguments. When you specify more than one argument, each subsequent item-n argument after the initial argument formats flush left under the first optional argument.related tags
- <QUALDEF>
- <QUALDEFLIST>
restrictions
Valid only in the context of a <QUALDEFLIST> tag.required terminator
<QUALDEF>
DESCRIPTION
The <QUALITEM> tag labels one to seven items to be defined in a qualifier definition list. You can specify one to seven arguments as items requiring a single definition in the qualifier definition list. If you specify more than one item-n argument, the item-n arguments are stacked from top to bottom in the order in which they were specified.You may find it convenient to use the item-n arguments to the <QUALDEFLIST> tag in pairs. The first item in the pair could be the positive form of the qualifier, and the second item could be the negative form of the qualifier (for example, /LOG and /NOLOG). Use the global <ALIGN_AFTER> to format the item-n arguments differently than the default flush left formatting.
A sample use of this tag is illustrated in the following example. See Using Global TagsUsing Global Tags for more information on the <ALIGN_AFTER> tag.
Example
The following examples show several uses of the <QUALITEM> tag. The first two uses of the <QUALITEM> tag show how positive and negative forms of a qualifier may be grouped together. The third use of the <QUALITEM> tag shows how you use the global <ALIGN_AFTER> tag for special formatting.
<QUALDEFLIST> <QUALITEM>(/LOG\/NOLOG (D)) <QUALDEF>Specifies whether or not output logging should be used. The default is /NOLOG. <QUALITEM>(/ECHO\/NOECHO (D)) <QUALDEF>Specifies whether or not input echoing should be used. The default is /NOECHO. <QUALITEM>(/DEVICE=device type\ <ALIGN_AFTER>(DEVICE=)VT100\ <ALIGN_AFTER>(DEVICE=)VT220) <QUALDEF>Specifies the type of device to be used. <ENDQUALDEFLIST>This example produces the following output:
QUALIFIERS
/LOG
/NOLOG (D)
Specifies whether or not output logging should be used. The default is /NOLOG./ECHO
/NOECHO (D)
Specifies whether or not input echoing should be used. The default is /NOECHO./DEVICE=device type
VT100
VT220
Specifies the type of device to be used.
<QUAL_LIST>
Begins a qualifier summary list.
Syntax
<QUAL_LIST> [(
- alternate heading
- NONE
- SPECIAL
\WIDE)]
- \alternate heading
- \column width
- \WIDE
ARGUMENTS
alternate heading
This is an optional argument. It causes this text to be used instead of the default heading in the first column, Command Qualifiers. This default heading can be modified or suppressed by using the <QUAL_LIST_DEFAULT_HEADS> tag.NONE
This is an optional keyword argument. It indicates that there are no qualifiers or defaults and causes the text None to appear under the default headings for the first and second columns (Command Qualifiers and Defaults).SPECIAL
This is an optional keyword argument. It labels an unusual case and causes DECdocument to expect a value in the second argument that will set the width of the first qualifier column.alternate heading
This is an optional argument. It causes this text to be used in column two in place of the default heading Defaults. This default heading can be modified or suppressed by using the <QUAL_LIST_DEFAULT_HEADS> tag.column width
This is an optional argument. It provides DECdocument with the size in picas of the desired width of the first column (there are 6 picas to an inch). This value must be a nonzero positive integer and can be used only when the first argument is SPECIAL.WIDE
This is an optional keyword argument. It causes the margins to be adjusted to accommodate a wide list.
WIDE
This is an optional keyword argument. It causes the margins to be adjusted to accommodate a wide list. Use this third argument only in the two following cases:
- When you have used the first two arguments to specify headings for the first two columns.
- When you have used the first two arguments to specify a special list and the width of the first column.
related tags
- <QPAIR>
- <QUAL_LIST_DEFAULT_HEADS>
- <QUAL_LIST_HEADS>
restrictions
If you use the SPECIAL argument, you must use the <QUAL_LIST_HEADS> tag to specify headings for the qualifier list.required terminator
<ENDQUAL_LIST>
DESCRIPTION
The <QUAL_LIST> tag begins a qualifier summary list. A qualifier summary list provides a short table listing the qualifiers that are applicable for a system command. It is an optional part of the command template, but you can use it in any context in a SOFTWARE doctype document. In the context of the command template, it provides a brief listing of qualifiers for quick lookup.The arguments you specify to the <QUAL_LIST> tag provide you with formatting flexibility, and the choice of overriding the default headings that are output.
- When you specify the tag with no arguments, the column widths are set using the doctype design's default settings, and the default headings Command Qualifiers and Defaults are output.
- When you specify text in the arguments to the <QUAL_LIST> tag, the default headings are replaced:
<QUAL_LIST>(Subsystem Qualifier\Comment)
This changes the default heading for this qualifier summary list only.- You override the default headings for all qualifier summary lists in your document by using the <QUAL_LIST_DEFAULT_HEADS> tag, as follows:
<QUAL_LIST_DEFAULT_HEADS>(Subsystem Qualifier\Comment)
To suppress either heading, enter the alternate heading text as a null argument:
<QUAL_LIST_DEFAULT_HEADS>(\)- If items in the second column of your list result in output that does not fit horizontally in the SOFTWARE design you are using, specify the keyword argument WIDE in any of the following positions:
<QUAL_LIST>(WIDE)
This example uses the default headings, and shifts both columns of the list to the left, as far left as the doctype design allows.
<QUAL_LIST>(heading text\WIDE)
This example modifies the default heading for the first column, uses the default heading for the second column, and shifts both columns of the list to the left, as far left as the document design allows.
<QUAL_LIST>(heading text\second heading text\WIDE)
This example modifies the default headings for both the first and second columns, and shifts both columns of the list to the left, as far left as the doctype design allows.
<QUAL_LIST>(SPECIAL\18) <QUAL_LIST_HEADS>(Qualifiers)
If the default column width of the first column of the qualifier summary list is too narrow (for example, when qualifier names are long or include lengthy argument specifications), widen that column by specifying the SPECIAL keyword as the first argument to the <QUAL_LIST> tag.
The <QUAL_LIST> tag will then accept the column width argument as a second argument that specifies the width of the first column of the list in picas (there are 6 picas to an inch). If you use the <QUAL_LIST> tag in this manner, you must explicitly enter the headings for the qualifier summary list using the <QUAL_LIST_HEADS> tag.
Examples
The following example shows how to use the <QUAL_LIST> tag to create a qualifier summary list.
#1
<QUAL_LIST> <QPAIR>(/BOOK\None.) <QPAIR>(/[NO]CHECK\/CHECK) <QPAIR>(/[NO]FAMILY=keyword\/NOFAMILY) <QPAIR>(/OUTPUT=file spec\/OUTPUT=input file name) <QPAIR>(/PROFILE=file spec\None.) <QPAIR>(/TYPE=keyword\See text.) <ENDQUAL_LIST>This example produces the following output:
Command Qualifiers Defaults /BOOK None. /[NO]CHECK /CHECK /[NO]FAMILY=keyword /NOFAMILY /OUTPUT=file spec /OUTPUT=input file name /PROFILE=file spec None. /TYPE=keyword See text. The following example shows how to control the headings of the two columns of output by specifying the headings you want in arguments one and two. Compare the results here with the example in the discussion of the <QUAL_LIST_HEADS> tag.
#2
<QUAL_LIST>(Input Save Set Qualifiers\Default) <QPAIR>(/[NO]REWIND\/REWIND) <QPAIR>(/SAVE_SET\None.) <QPAIR>(/SELECT=(file spec[,...])\None.) <ENDQUAL_LIST>This example produces the following output:
Input Save Set Qualifiers Default /[NO]REWIND /REWIND /SAVE_SET None. /SELECT=(file spec[,...]) None.
<QUAL_LIST_DEFAULT_HEADS>
Specifies the default heading used by the <QUAL_LIST> tag.
Syntax
<QUAL_LIST_DEFAULT_HEADS> (heading-1
\heading-2)
ARGUMENTS
heading-1
Specifies the default heading text for the first column. If this argument is specified as null, no first column heading is output.heading-2
The default heading text for the second column. If this argument is specified as null, no second column heading is output.related tags
- <QPAIR>
- <QUAL_LIST>
- <QUAL_LIST_HEADS>
restrictions
Valid only in the context of a <QUAL_LIST> tag.
DESCRIPTION
The <QUAL_LIST_DEFAULT_HEADS> tag specifies the default heading used by the <QUAL_LIST> tag. If you specify the heading-1 or heading-2 arguments to this tag as null, the appropriate default heading (either the first or the second) is set to null and that heading is not output.
Example
The following example shows how to use the <QUAL_LIST_DEFAULT_HEADS> tag to supress a default heading in a qualifier summary list.
<QUAL_LIST> <QUAL_LIST_DEFAULT_HEADS>(Command Qualifiers\) <QPAIR>(/BOOK\None.) <QPAIR>(/[NO]CHECK\/CHECK) <QPAIR>(/[NO]FAMILY=keyword\/NOFAMILY) <QPAIR>(/OUTPUT=file spec\/OUTPUT=input file name) <QPAIR>(/PROFILE=file spec\None.) <QPAIR>(/TYPE=keyword\See text.) <ENDQUAL_LIST>This example produces the following output:
Command Qualifiers Defaults /BOOK None. /[NO]CHECK /CHECK /[NO]FAMILY=keyword /NOFAMILY /OUTPUT=file spec /OUTPUT=input file name /PROFILE=file spec None. /TYPE=keyword See text.
<QUAL_LIST_HEADS>
Labels the headings for one or both of the columns in a qualifier format list when you use the SPECIAL argument qualifier to the <QUAL_LIST> tag in unusual cases for formatting control.
Syntax
<QUAL_LIST_HEADS> (heading-1\heading-2)
ARGUMENTS
heading-1
Specifies the heading text for the left column.heading-2
Specifies the heading text for the right column. If you do not specify this heading, you will obtain the default heading, Defaults.related tags
- <QPAIR>
- <QUAL_LIST>
restrictions
Valid only in the context of a <QUAL_LIST> tag.
DESCRIPTION
The <QUAL_LIST_HEADS> tag labels the headings for one or both of the columns in a qualifier format list when you use the SPECIAL argument qualifier to the <QUAL_LIST> tag in unusual cases for formatting control.
Example
The following example shows how to use the <QUAL_LIST_HEADS> tag to create qualifier summary list headings.
<P>The following is a partial list of the qualifiers you may use with the BACKUP command: <QUAL_LIST>(SPECIAL\18) <QUAL_LIST_HEADS>(Output File Qualifiers\Qualifier Defaults) <QPAIR>(/OWNER_UIC[=option]\/OWNER_UIC=DEFAULT) <QPAIR>(/REPLACE\None.) <ENDQUAL_LIST>This example produces the following output:
The following is a partial list of the qualifiers you may use with the BACKUP command:
Output File Qualifiers Qualifier Defaults /OWNER_UIC[=option] /OWNER_UIC=DEFAULT /REPLACE None.
Previous Next Contents Index