| Previous | Contents | Index |
Specifies text that overides the default section title in the topic
label above the text in the text window.
MANUAL.ONLINE,
MILSPEC.ONLINE, and SOFTWARE.ONLINE
Supplies an opening parenthesis anywhere in your file. You must use
this tag, however, to specify an opening parenthesis within an argument
to a tag, so that the opening parenthesis is not interpreted as the
opening parenthesis of the tag's argument.
GLOBAL
Labels the order number or part number that appears on the title page
of a book.
GLOBAL
<OUTLINE> [(title line-1 [
\title line-2] [ \title line-3])]
text
<ENDOUTLINE>
Begins an outline and specifies a title for the outline.
REPORT
Provides a summary description of a reference element.
SOFTWARE (Reference template)
Marks the beginning of a new paragraph.
GLOBAL
<PAGE> [(
Breaks a page of text, forcing the text that follows the tag to begin
on a new page.
GLOBAL
Begins the text that defines an item in a parameter definition list.
SOFTWARE
<PARAMDEFLIST> [(
Begins a definition list of parameters or arguments.
SOFTWARE
<PARAMITEM> (item-1 [ \item-2 .
. . [ \item-7]])
text
<PARAMDEF>
Labels one to seven items to be defined in a parameter definition list.
SOFTWARE
Supplies parentheses around a character you specify, resulting in
better spacing of the character between the parentheses.
GLOBAL
<PART> [(part title [ \symbol name])]
Labels the start of a major division within a document and starts it on
a new page.
GLOBAL
<PART_PAGE>
text
<ENDPART_PAGE>
Inserts a divider page for a new part of a document.
GLOBAL
<PREFACE> [(page number [
\symbol name])]
text
<ENDPREFACE>
Labels the beginning of a preface.
GLOBAL
<PREFACE_SECTION> (title [ \symbol name])
Creates a major section in the preface of a book to provide
information, such as a summary of changes to the book.
GLOBAL
Inserts a print date line on the copyright page.
GLOBAL
Indicates that the source file is a profile that generates a bookbuild.
GLOBAL
<PROMPT> (prompt text \related parameter [ \prompt width])
Identifies a prompt that appears on a separate line from other prompts,
and any parameters associated with that prompt.
SOFTWARE
(Command template)
<PROMPTS> [(alternate heading [
\NONE])]
text
<ENDPROMPTS>
Begins a summary of interactive prompts.
SOFTWARE (Command
template)
<QPAIR> (qualifier name \default qualifier name)
Labels a qualifier pair in a qualifier format list.
SOFTWARE
Begins the text that defines an item in a qualifier definition list.
SOFTWARE
<QUALDEFLIST> [(
Begins a definition list describing command qualifiers.
SOFTWARE
<QUALITEM> (item-1 [ \item-2 .
. . [ \item-7]])
text
<QUALDEF>
Labels one to seven items to be defined in a qualifier definition list.
SOFTWARE
<QUAL_LIST> [(
Begins a qualifier summary list.
SOFTWARE
<QUAL_LIST_DEFAULT_HEADS> (heading-1 \heading-2)
Modifies or suppresses default headings created by the
<QUAL_LIST> tag.
SOFTWARE
<QUAL_LIST_HEADS> (heading-1 \heading-2)
Labels the headings you want to use for one or both of the columns in a
qualifier format list, when you use <QUAL_LIST>(SPECIAL) in
unusual cases for formatting control.
SOFTWARE
<QUOTATION>
quoted text
<ENDQUOTATION>
Begins a quotation in which the spacing is retained and the text is not
filled or justified.
ARTICLE
<QUOTE> (quoted text)
or
<QUOTE>
quoted text
<ENDQUOTE>
Encloses text in quotation marks. The quotation marks appear as if they
are typeset.
GLOBAL
<REFERENCE> (symbol name [
Makes a reference to a symbol name in a book element or text element.
When processed, the <REFERENCE> tag is replaced with the current
value of the symbol name that is stored in the cross-reference file.
GLOBAL
<REF_NOTE> (text of note [ \symbol name])
Specifies the text of a reference note and creates a bracketed
reference number in the article text.
ARTICLE
Causes all accumulated reference notes to be output.
ARTICLE
Provides a text description of a tag or set of tags related to the tag
being described.
SOFTWARE (Tag template)
Specifies a single tag that is related to the current tag.
SOFTWARE (Tag template)
<RELATED_TAGS> [(NONE)]
text
<ENDRELATED_TAGS>
Provides a summary of tags whose use is related to the tag being
described.
SOFTWARE (Tag template)
<RESTRICTIONS> [(
Provides the restrictions on the use of a reference element.
SOFTWARE (Command and Tag templates)
Provides general information about the attributes of the value returned
by the routine.
SOFTWARE (Routine template)
<RETURNS> (usage info \data
type \access \mechanism [ \optional info])
or
<RETURNS> (HEADONLY)
Provides information about the value returned by a routine.
SOFTWARE (Routine template)
<RETURN_VALUE> [(alternate
heading)]
text
<ENDRETURN_VALUE>
Labels a character string return value.
SOFTWARE (Command
template)
<REVISION> [(UPDATE [ \update info])]
Indicates that the document contains either new or modified
information.
GLOBAL
<REVISION_INFO> ([title text] \info)
Labels a section on a title page that provides information on what
previous books have been superseded by the current one.
GLOBAL
<RIGHT_LINE> (text [
Specifies a line of text that is to be aligned against the right-hand
margin of the page.
GLOBAL
Labels an item in a list of restrictions.
SOFTWARE (Command
and Tag templates)
<ROUTINE> (routine name[ \info-1[ \info-2] [ \symbol name]])
Begins a new routine description.
SOFTWARE (Routine
template)
<ROUTINE_SECTION> [(([running
title] [ \number prefix] [ \NEWPAGE])]
text
<ENDROUTINE_SECTION>
Begins a routine reference section, enables tags reserved for use in
routine sections, and sets paging attributes.
SOFTWARE
(Routine template)
<RSDEFLIST> [(
Begins a return status definition list in the Routine template.
SOFTWARE (Routine template)
<RSITEM> (code \code description)
Specifies the return status value of a routine and lists its meaning.
SOFTWARE (Routine template)
Outputs a horizontal rule in a table.
GLOBAL
Creates a footer at the bottom of each page or slide.
ARTICLE,
MILSPEC, OVERHEADS, REPORT, and SOFTWARE.SPECIFICATION
<RUNNING_TITLE> (
Creates a 1- or 2-line running title at the top of each page or slide.
ARTICLE, OVERHEADS, REPORT, and SOFTWARE.SPECIFICATION
<RUNNING_TITLE> (title-1 [ \title-2 . . . [ \title-4]])
Creates a 1- to 4-line running title at the top of each page.
MILSPEC.DRAFT and MILSPEC.SECURITY
Labels the system portion of a dialog between user and system in an
interactive example.
GLOBAL
Specifies the salutation for the letter.
LETTER
<SAMPLE_TEXT>
text
<ENDSAMPLE_TEXT>
Typographically distinguishes an extract of text.
GLOBAL
<SDML_TAG> (tag name [ \symbol name])
Begins a new tag description.
SOFTWARE (Tag template)
<SECTION> (heading text [ \symbol name])
Begins a new page and creates a major heading at the left margin of
that page.
REPORT
<SECURITY> (classification
keyword)
text
<ENDSECURITY>
Assigns a security classification level to a text element.
MILSPEC
<SET_APPENDIX_LETTER> (appendix letter)
Overrides the default appendix letter assigned to an appendix by
DECdocument.
GLOBAL
<SET_APPENDIX_NUMBER> (Roman numeral integer)
Overrides the default appendix Roman numeral assigned to an appendix by
DECdocument.
MILSPEC
<SET_CHAPTER_NUMBER> (chapter number)
Overrides the default chapter number assigned to a chapter by
DECdocument.
GLOBAL
<SET_CONDITION> (condition name [ \REMOVE])
Creates or removes a condition in your SDML file.
GLOBAL
<SET_CONTENTS_SECURITY> (classification keyword)
Specifies a security classification to be applied to all pages in the
table of contents and index, overriding the default security
classification.
MILSPEC
<SET_FIGURE_FILE_SPACING_DEFAULT> ([space before] \ [space after])
Overrides the default for vertical blank space that appears before and
after an included graphics file.
GLOBAL
Allows you to alter the default Help levels in your Help files.
HELP
<SET_ONLINE_TOPIC> (
Specifies the level of topics in your Bookreader document and whether
table of contents entries are issued for ranges of messages or glossary
items.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE
<SET_PAGE_SECURITY> (classification keyword)
Specifies that a security classification be applied to a page to
override the default security classification.
MILSPEC.DRAFT
and MILSPEC.SECURITY
<SET_SECURITY_CLASS> (classification keyword \id text \classification text \priority)
Establishes a new security classification or overrides the default text
associated with an existing classification.
MILSPEC.DRAFT and
MILSPEC.SECURITY
<SET_TABLE_ROW_BREAK_DEFAULT> (number of rows)
Overrides the default value for a multipage table's first valid break.
GLOBAL
<SET_TEMPLATE_ARGITEM> (tag name \text one \text two \text three [ \text four] [ \text five] \longest text)
Sets up a user-defined argument list for documenting callable routines
for multiple operating system platforms. Also allows translation of the
argument list.
SOFTWARE
<SET_TEMPLATE_COMMAND> (tag name
Defines a new tag with the same function as the <COMMAND> tag,
and changes the format of command descriptions produced using the new
tag.
SOFTWARE (Command template)
<SET_TEMPLATE_HEADING> (element keyword \default heading)
Overrides the heading for all subsequent uses of a template tag.
SOFTWARE
<SET_TEMPLATE_LIST> (list tag name \default list heading \list item tag name \list type [ \heading level])
Creates a user-defined set of tags for listing information.
SOFTWARE
<SET_TEMPLATE_PARA> (tag name \default heading [ \heading level])
Defines a set of template tags for setting the format of a paragraph of
information.
SOFTWARE (Reference template)
<SET_TEMPLATE_ROUTINE> (tag name
Defines a new reference element tag name to use in the routine
template, and specifies the formatting attributes for the new tag.
SOFTWARE (Routine template)
<SET_TEMPLATE_STATEMENT> (tag name
Defines a new reference element tag name to use in the statement
template, and specifies the formatting attributes for the new tag.
SOFTWARE (Statement template)
<SET_TEMPLATE_SUBCOMMAND> (tag name [ \NONEWPAGE])
Changes the name of the <SUBCOMMAND> tag to the name you specify,
and specifies formatting attributes for the new tag.
SOFTWARE
(Command template)
<SET_TEMPLATE_TABLE> (table tag name \default table heading \table row tag name \column count \column widths [ \table column headings])
Defines a set of template tags for setting information in 2- or
3-column lists.
SOFTWARE
<SET_TEMPLATE_TAG> (tag name
Defines a new reference element tag name to use in the tag template,
and specifies formatting attributes for the newly-defined tag.
SOFTWARE (Tag template)
<SHELF_CREATE> (symbol name
\file spec)
text
<ENDSHELF_CREATE>
Outputs a SHELF entry for the current Bookreader bookshelf file and
creates a separate bookshelf file.
ONLINE_BOOKSHELF
<SHELF_REF> (symbol name \file spec)
Outputs a SHELF entry for a Bookreader bookshelf file that points to an
existing bookshelf file.
ONLINE_BOOKSHELF
<SHOW_LEVELS> (
Emphasizes text in an outline.
REPORT
Begins a list of signatures that appear in the front matter of a
document.
REPORT
<SIGNATURE_LINE> ([name-1] [ \name-2])
Creates up to two rules on a line and places a name below each rule;
each rule is used as a signatory line for the person listed below it.
MILSPEC
<SIGNATURE_LIST> (column
heading-1 \column heading-2)
text
<ENDSIGNATURE_LIST>
Begins a 2-column listing of signature lines on the title page of a
document and supplies a heading for each column.
MILSPEC
Supplies a single quotation mark as it appears on a keyboard.
GLOBAL
Begins a new overhead slide.
OVERHEADS
Provides information pertaining to the original source of information
for an article.
ARTICLE
<SPAN> (number of columns [ \LEFT])
Specifies that the accompanying argument in a table row or a table head
span more than one table column.
GLOBAL
Provides access to special characters that are not available on the
terminal keyboard.
GLOBAL
<SPECIFICATION_INFO> (specification number \code id number \specification date [ \additional info])
Creates a listing of information about the specification on the title
page and creates a 2-line running heading for the rest of the document.
MILSPEC
<SPEC_TITLE> (title text-1 [ \title text-2 . . . [ \title text-7]])
Creates a title with up to seven centered lines on the title page.
MILSPEC
<STATEMENT> (statement name [ \symbol name])
Begins a new statement description.
SOFTWARE (Statement
template)
<STATEMENT_FORMAT> [([alternate
heading] [ \MULTIPLE])]
text
<ENDSTATEMENT_FORMAT>
Begins a section that illustrates the syntax of a statement or
function, including keywords and parameters.
SOFTWARE
(Statement template)
<STATEMENT_LINE> [(text [ \INDENT])]
Indicates the position of a valid statement line in the context of a
statement format or a construct list.
SOFTWARE (Statement
template)
<STATEMENT_SECTION> [([running
title] [ \number prefix] [ \NEWPAGE])]
text
<ENDSTATEMENT_SECTION>
Begins a statement reference section, enables tags reserved for use in
statement sections, and sets paging attributes.
SOFTWARE
(Statement template)
<SUBCOMMAND> (subcommand name [ \symbol name])
Begins a new subcommand description.
SOFTWARE (Command
template)
<SUBCOMMAND_SECTION> [(running
title [ \NEWPAGE])]
text
<ENDSUBCOMMAND_SECTION>
Begins a subcommand reference section for subordinate commands in the
command section.
SOFTWARE (Command template)
<SUBCOMMAND_SECTION_HEAD> (heading)
Specifies the heading for text that precedes a subcommand section.
SOFTWARE (Command template)
<SUBHEADn> (heading text [ \symbol name])
Marks an unnumbered subsidiary heading.
GLOBAL
Places the subject of a memo or letter at the left margin with the
heading "Subject:"
LETTER
<SUBTITLE> (title line-1 [ \title line-2 . . . [ \ title line-7]])
ARTICLE: creates a subtitle of up to three lines centered on
the title page.
MILSPEC: creates a subtitle of up to
seven lines centered on the title page.
OVERHEADS:
creates a subtitle of up to four lines centered on a slide.
<SYNTAX> [(
Allows you to use special characters to describe programming language
syntaxes.
SOFTWARE
<SYNTAX_DEFAULT_HEAD> (
Creates a default heading for the <SYNTAX> tag.
SOFTWARE
<TABLE> [(table caption [
\symbol name])]
text
<ENDTABLE>
Begins a sequence of columnar data.
GLOBAL
<TABLE_ATTRIBUTES> [(
Specifies special formatting for a table.
GLOBAL
<TABLE_FILE> (
Causes a separate file containing a formal table to be included in the
SDML input file.
GLOBAL
<TABLE_HEADS> (column heading-1 [ \column heading-2 . . . [ \column heading-9]])
Specifies column headings for each column in the table.
GLOBAL
<TABLE_KEY>
text
<ENDTABLE_KEY>
Begins a key or legend for a table.
GLOBAL
Specifies that a table key should be printed below the table (or any
portion of a multipage table) in which this tag appears.
GLOBAL
<TABLE_ROW> (column text-1 [ \column text-2 . . . [ \column text-9]])
Specifies text for each column in a table.
GLOBAL
<TABLE_ROW_BREAK> (
Specifies the boundaries in which a long table can be broken onto a new
page.
GLOBAL
<TABLE_SETUP> [(number \width1 [...\widthnumber-1)]
Declares up to 9 columns in a table and the approximate width to be
assigned to each column.
GLOBAL