DECdocument
Tags Quick Reference
Previous Contents Index

Begins a numbered sequence of informal examples.
SOFTWARE

<EXAMPLE_SPACE> (

[ \text])

Leaves space for an example to be pasted in during final production.
GLOBAL

<EXAMPLES_INTRO>

Provides introductory text before an example.
SOFTWARE

<EXC>
text
<EXTEXT>

Begins a code example in a series of numbered informal examples.
SOFTWARE

<EXI>
text
<EXTEXT>

Begins an interactive example in a series of numbered informal examples.
SOFTWARE

<EXTENSION> [(text)]
or
<EXTENSION>
text
<ENDEXTENSION>

For Bookreader documentation, the <EXTENSION> tag highlights language extensions to standards or other information; it displays the extension text as slightly shaded.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<EXTEXT>

Terminates an example and begins an explanation in a sequence of numbered examples.
SOFTWARE

<FARG> (argument name)

Adds a single argument line to a list of arguments in a routine syntax format section.
SOFTWARE (Routine template)

<FARGS> (argument list [ \STACK])

Provides the argument portion of a routine syntax statement in the context of the <FORMAT> tag.
SOFTWARE (Routine template)

<FCMD> (keyword [ \parameters])

Specifies the keyword portion of a command/parameter pair in a format section.
GLOBAL

<FCMD> (keyword [ \parameters])

Identifies a statement or function keyword and an optional parameter list in a format section.
SOFTWARE (Command and Statement templates)

<FFUNC> (

)

Labels a function in the context of a <FORMAT> or <STATEMENT_FORMAT> tag section.
SOFTWARE (Routine and Statement templates)

<FIGURE> [(figure caption [ \symbol name])]
text
<ENDFIGURE>

Labels the beginning of a figure.
GLOBAL

<FIGURE_ATTRIBUTES> (

[ \WIDE])

Specifies the placement of a figure on the page.
GLOBAL

<FIGURE_FILE> (target device

[ \WIDE])

Includes a graphics file in your output file if the output device has graphics capability.
GLOBAL

<FIGURE_SPACE> (

[ \text])

Marks the space required for a figure that will be pasted in during final production.
GLOBAL

<FILE_SPEC> (file specification)

Allows you to use a file specification that contains angle brackets as an argument to a tag without DECdocument interpreting that file specification as a tag.
GLOBAL

<FINAL_CLEANUP> (

)

Provides explicit formatting instructions for the text formatter to be used for final formatting and clean up.
GLOBAL

<FOOTNOTE> (char \footnote text)

Creates a footnote in text and tables. In text, this tag specifies the footnote character and footnote text, and places the footnote text at the bottom of the page or in a pop-up window for Bookreader output. In a table, this tag specifies the footnote character and footnote text; the <FOOTREF> tag outputs the footnote character. Footnotes in tables appear at the bottom of the table.
GLOBAL

<FOOTNOTE_TEXT> (char \text)

Specifies the text of a footnote that is in a heading, copyright page, or title page.
GLOBAL

<FOOTREF> (char-1 [ \char-2 . . . [ \char-9]])

Creates a footnote character in a heading, copyright page, or title page. Also used to specify a previously defined footnote in text more than once, and along with the <FOOTNOTE> tag, to produce a footnote in a table.
GLOBAL

<FORMAT> [(

)]
text
<ENDFORMAT>

Enables the <FCMD>, <FPARMS>, and <FPARM> tags to distinguish formatted command keywords and parameters.
GLOBAL

<FORMAT> [(alternate heading)]
text
<ENDFORMAT>

Begins a section that illustrates the syntax of a command, routine, or tag, including keywords and arguments.
SOFTWARE (Command, Routine, and Tag templates)

<FORMAT_SUBHEAD> (heading text)

Introduces one of a set of multiple formats in the statement format section.
SOFTWARE (Statement template)

<FPARM> (parameter)

Specifies a parameter to be formatted following the <FPARMS> tag, aligned under the parameters portion of a keyword/parameters pair.
GLOBAL

<FPARM> (parameter)

Adds a single parameter to a list of parameters in a command or statement format section.
SOFTWARE (Command and Statement templates)

<FPARMS> (parameters)

Specifies the parameter portion of a command/parameter pair in a format section.
GLOBAL

<FPARMS> (parameters)

Specifies the parameters to a command or statement keyword in a format section.
SOFTWARE (Command and Statement templates)

<FROM_ADDRESS> (address line-1 [ \address line-2 . . . [ \address line-5]])

Places the name and address of the sender of a letter flush left at the right margin.
LETTER

<FRONT_MATTER> [(symbol name)]
text
<ENDFRONT_MATTER>

Begins the front matter of a book.
GLOBAL

<FRTN> (

)

Specifies the routine keyword portion of a routine syntax statement within the context of the <FORMAT> tag.
SOFTWARE (Routine template)

<FTAG> (tag name [ \argument list [ \OPTIONAL]])

Specifies the name of a tag and its arguments within the context of a <FORMAT> tag.
SOFTWARE (Tag template)

<FUNCTION> (function name)

Begins a new function description.
SOFTWARE (Statement template)

<GDEF>

Labels the text that defines a term in a glossary or anywhere in a document.
GLOBAL

<GLOSSARY> [(text [ \symbol name])]
text
<ENDGLOSSARY>

Formats a glossary of terms in a document or book.
GLOBAL

<GRAPHIC> (char-1 \char-2)

Displays terminal graphics characters.
SOFTWARE

<GREF> (glossary term)

Marks a cross-reference from anywhere in your document, including the glossary, to a term within a glossary.
GLOBAL

<GTERM> (term)
text
<GDEF>

Labels a term you want to define in a glossary or anywhere in a document.
GLOBAL

<HEAD> (heading text [ \symbol name])

Creates an unnumbered heading on the left side of the page.
GLOBAL

<HEADn> (heading text [ \symbol name])

Marks a heading of the level you specify (<HEAD1> through <HEAD6> in all doctypes except MILSPEC; in MILSPEC, <HEAD1> through <HEAD20>).
GLOBAL

<HELLIPSIS>

Places horizontal ellipsis points on a line.
GLOBAL

<HELP_ONLY>

Identifies text that you want to include only in Help output and not in printed or Bookreader output.
HELP

<HIGHEST_SECURITY_CLASS>

Prints the classification text associated with the highest security classification encountered in a document.
MILSPEC

<HOTSPOT> (symbol name [ \text])

Changes any text into a hotspot for Bookreader documentation.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<HTML> (. . . .)

The data within the parentheses can be any HTML tag/text combinations.
GENERAL, SOFTWARE.REFERENCE

<HTML_BACKGROUND> (. . . .)

The data within the parentheses specifies the background color or graphic image for HTML file pages.
GENERAL, SOFTWARE.REFERENCE

<HTML_FOOTER> (. . . .)

Causes the given HTML code (within the parentheses) to be inserted at the bottom/foot of each generated HTML page. "literal" tags should be used inside the parentheses around the HTML code so that DECdocument will not attempt to process the HTML tags as DECdocument tags.
GENERAL, SOFTWARE.REFERENCE

<HTML_HEADER> (. . . .)

Causes the given HTML code (within the parentheses) to be inserted at the top/header of each generated HTML page. "literal" tags should be used inside the parentheses around the HTML code so that DECdocument will not attempt to process the HTML tags as DECdocument tags.
GENERAL, SOFTWARE.REFERENCE

<HTML_OPTIONS> (

)

When MANUAL_SEGMENTATION is specified, the DECdocument HTML converter will not automatically break apart the document body. When UNNUMBERED is specified, the section name (i.e. Chapter) and number will be dropped. Effected sections are: chapter, heading, part, table, example, figure, appendix. ETC... --- There are various other options that can be used; all of the options are explained in detail in the "HTML Publishing" chapter in the DECdocument Tutorial and Application Guide.
GENERAL, SOFTWARE.REFERENCE

<HTML_SEGMENT> (segment name)

Forces the start of a new HTML file. The segment name is in quotes, is appended to the output file name for the converter and used as the new HTML file name. Used in conjunction with the <HTML_OPTIONS>(MANUAL_SEGMENTATION) tag to control HTML file contents.
GENERAL, SOFTWARE.REFERENCE

<HYPHENATE> (part1 \part2 [ \part 3 . . . [ \part9]])

Provides information about legal hyphenation of a word.
GLOBAL

<ICON>
text
<ENDICON>

Allows you to print a small graphic with explantory text printed to the right or left of the graphic.
GLOBAL

<ICON_FILE> (target device

\ vertical size \horizontal size [ \RIGHT])

Specifies a graphics file that accompanies text within the <ICON> and <ENDICON> tags.
GLOBAL

<ICON_TEXT> (text [ \WRAP])

Labels the text that accompanies a graphic image that you include with the <ICON_FILE> tag.
GLOBAL

<INCLUDE> (file spec)

Specifies the position in a document where you want to include a file for processing.
GLOBAL

<INCLUDES_FILE> (logical name \file spec)

Equates a logical name with a file specification during processing of a profile.
GLOBAL

<INDEX_FILE> [(file spec)]

Specifies the position in a book or document where you want to include an index file in the output.
GLOBAL

<INTERACTIVE> (code)
or
<INTERACTIVE> [([KEEP] \[WIDE] \[MAXIMUM])]
interactive code or text
<ENDINTERACTIVE>

Begins an example dialog between the user and system and enables the <S> and <U> tags to distinguish system text from user text.
GLOBAL

<INTRO_SUBTITLE> (title line-1 [ \title line-2 . . . [ \title line-4]])

Creates a secondary title of up to four lines on an introductory slide.
OVERHEADS

<INTRO_TITLE> (title line-1 [ \title line-2 . . . [ \title line-4]])

Creates a main title of up to four lines on an introductory slide.
OVERHEADS

<KEEP> (text)

Specifies that a string of text should not be broken across a line of output.
GLOBAL

<KEEP_HELP_LEVEL>

Allows you to override the default multi-level Help output and keep the Help output at a single level. This tag affects only the <COMMAND> and <SUBCOMMAND> tags of the SOFTWARE doctype.
HELP

<KEY> (key label-1 [ \key label-2]

)

Depicts a key from a keyboard or keypad graphically.
SOFTWARE

<KEYPAD> [(

)]
text
<ENDKEYPAD>

Specifies an individual keypad diagram and optionally supplies a title for that diagram.
SOFTWARE

<KEYPAD_ENDROW> (col-1 arg \col-2 arg \col-3 arg)

Displays up to three keys of the bottom row of an editing keypad.
SOFTWARE

<KEYPAD_ROW> (col-1-arg \col-2-arg \col-3-arg \col-4-arg)

Displays a row of an editing keypad that has up to four keys.
SOFTWARE

<KEYPAD_SECTION>
text
<ENDKEYPAD_SECTION>

Begins a series of one or more keypad diagrams.
SOFTWARE

<KEY_NAME> (key name)

Emphasizes the name of a key in text.
SOFTWARE

<KEY_PLUS>

Creates a plus sign between keys in a key sequence example.
SOFTWARE

<KEY_SEQUENCE>
text
<ENDKEY_SEQUENCE>

Begins a section containing one or more key representations.
SOFTWARE

<KEY_TYPE> (labeling text string \key text string)

Provides a descriptive label for keys in a key sequence.
SOFTWARE

<KEYWORD> (word)

Labels a word that you want to distinguish typographically.
GLOBAL

<LANGUAGE> (

)

Causes text that is automatically generated by DECdocument (such as "Example", "Figure", "Table", and so on) to be output in the language you specify. It also causes text to be hyphenated and index entries to be sorted according to the rules of the language you specify.
GLOBAL

<LE> [(callout number)]

Labels a list element.
GLOBAL

<LEVEL> (level number \entry text)

Specifies an outline entry and the organizational level of the entry.
REPORT

<LINE> [(

)]

Specifies that the text that follows this tag be placed on a new line of output.
GLOBAL

<LINE_ART> [([KEEP] \[WIDE] \[MAXIMUM])]
text
<ENDLINE_ART>

Labels a rough sketch produced at the terminal keyboard for draft output, to give some idea of what the final figure will look like.
GLOBAL

<LIST> (

[ \attribute-1] [ \attribute-2])
text
<ENDLIST>

Begins a list. You specify the type of list by using a keyword argument to the tag.
GLOBAL

<LITERAL> (literal text)
or
<LITERAL>
literal text
<ENDLITERAL>

Allows you to specify text that contains words in angle brackets that might otherwise be interpreted as tags.
GLOBAL

<LMF> (

)
text
<ENDLMF>

For Bookreader documentation, the <LMF> tag marks the beginning of the tag sequence that specifies the License Management Facility (LMF) information for the document.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LMF_ALTNAME> (alternate name)

For Bookreader documentation, the <LMF_ALTNAME> tag specifies an alternate product name for the software product.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LMF_INFO> (

)

For Bookreader documentation, the <LMF_INFO> tag writes licensing information into the .DECW$BOOK file.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LMF_PRODUCER> (producer)

For Bookreader documentation, the <LMF_PRODUCER> tag specifies the producer of the software product.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LMF_PRODUCT> (product name)

For Bookreader documentation, the <LMF_PRODUCT> tag specifies the software product.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LMF_RELEASE_DATE> (dd-mmm-yyyy)

For Bookreader documentation, the <LMF_RELEASE_DATE> tag specifies the release date of the software product.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LMF_VERSION_NUMBER> (version number)

For Bookreader documentation, the <LMF_VERSION_NUMBER> tag specifies the version number of the software product.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<LOWERCASE> (text)

Labels text that you want to appear as lowercase in the final output.
GLOBAL

<MARK>
text
<ENDMARK>

Indicates the beginning of new or modified information.
GLOBAL

<MATH> (

)
DISPLAY text
<ENDMATH>

Labels a short mathematical expression or the beginning of an extended mathematical example.
GLOBAL

<MATH_CHAR> (keyword)

Creates a special mathematical symbol.
GLOBAL

<MCS> (character)

Labels a character in the Digital Multinational Character Set.
GLOBAL

<MEMO_DATE> (date argument)

Creates a line in a memo or letter that displays the date after the heading "Date:".
LETTER

<MEMO_FROM> (address line-1 [ \address line-2 . . . [ \address line-5]])

Places the name and address of the sender of a memo flush left on the left margin and adds the heading "From:".
LETTER

<MEMO_HEADER>

Centers the heading "Interoffice Memorandum" in bold letters on the page.
LETTER

<MEMO_LINE> (heading text \memo line-1 [ \memo line-2 . . . [ \memo line-5]])

Allows you to create your own titled informational lines.
LETTER

<MEMO_TO> (address line-1 [ \address line-2 . . . [ \address line-5]])

Places the name and address of the receiver of a memo flush left on the left margin with a heading "To:".
LETTER

<MESSAGE_SECTION>
text
<ENDMESSAGE_SECTION>

Begins a section of error message descriptions.
SOFTWARE

<MESSAGE_TYPE> (

)

Establishes the format for error messages in the context of the <MESSAGE_SECTION> tag.
SOFTWARE

<MSG> (message id [ \message text-1 [ \message text-2]])

Formats the text of a message in a series of error message descriptions.
SOFTWARE

<MSG_ACTION>

Labels the text explanation of what action you should take in response to an error message from a system or application.
SOFTWARE

<MSG_FACILITY> (facility-1 [ \facility-2] [ \facility-3] [ \facility-4])

Labels up to four message sources in a series of system or application error messages.
SOFTWARE

<MSGS> (message text-1 [ \message text-2 . . . [ \message text-9]])

Formats the text of one or more messages in a series of error message descriptions.
SOFTWARE

<MSG_SEVERITY>

Labels the severity of a message in a series of system or application error messages.
SOFTWARE

<MSG_TEXT> [(alternate heading)]
text
<ENDMESSAGE_SECTION> required unless the <MSG_TEXT> tag is followed by an <MSG> tag

Labels text that describes a message in a <MESSAGE_SECTION> tag section.
SOFTWARE

<NESTED_TABLE_BREAK>

Marks a place where a nested table may be broken across pages.
GLOBAL

<NEWTERM> (term)

Labels a term introduced into the text for the first time. The term is italicized in output.
GLOBAL

<NOTE> (note text)
or
<NOTE> [(heading text)]
note text
<ENDNOTE>

Labels a note, caution, warning, or some other portion of text to which you want to draw attention.
GLOBAL

<ONLINE_CHUNK>

For Bookreader documentation, the <ONLINE_CHUNK> tag breaks lengthy pieces of text (for example, lists, informal code examples) into online chunks to prevent the text formatter from running out of memory.
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

<ONLINE_POPUP> (text type)
text
<ENDONLINE_POPUP>

Specifies that an informal text element appear (that is, pop up) in a separate window (as do formal examples, formal figures, and formal tables).
MANUAL.ONLINE, MILSPEC.ONLINE, and SOFTWARE.ONLINE

Previous Next Contents Index