This guide summarizes all the DECdocument tags. It lists each tag and its terminating tag (if any), its argument(s), a description of the tag, and the doctype(s) under which the tag operates.

Revision/Update Information: Updated for Version 3.2

Operating System and Version: VAX OpenVMS Version 5.4 or higher
Alpha OpenVMS Version 6.1
or higher

Software Version: DECdocument Version 3.2

NOTICE

Copyright ©1995, 1997 Touch Technologies, Inc.

All Rights Reserved

The information in this document is subject to change without notice and should not be construed as a commitment by Touch Technologies, Inc. Touch Technologies, Inc. assumes no responsibility for any errors that may appear in this document.

The software described in this document is furnished under a license and may be used or copied only in accordance with the terms of such license.

No responsibility is assumed for the use or reliability of software on equipment that is not supplied by Digital Equipment Corporation or its affiliated companies.

Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013.

The following are trademarks of Touch Technologies, Inc., and may be used only to describe products of Touch Technologies, Inc.:

DYNAMIC TAPE ACCELERATOR	INTOUCH 4GL
DYNAMIC LOAD BALANCER PLUS	INTOUCH INSA
REMOTE DEVICE FACILITY

The following are trademarks of Digital Equipment Corporation:

DEC	DIBOL	UNIBUS
DEC/CMS	EduSystem	VAX
DEC/MMS	IAS	VAXcluster
DECnet	MASSBUS	VMS/OpenVMS
DECsystem--10	PDP	VT
DECSYSTEM--20	PDT
DECUS	RSTS
DECwriter	RSX	Digital logo

PostScript is a registered trademark of Adobe Systems, Inc.

May 1997

Contents

Index

Document Structure

This guide consists of a summary of each DECdocument tag. Each tag is listed in alphabetical order, followed by its argument(s), its terminating tag (if any), a description of the tag, and the doctype(s) in which it is valid.

Intended Audience

This guide is intended for writers, editors, and general users, both new and experienced, who need a quick summary of any DECdocument tag.

Associated Documents

This manual is part of the DECdocument documentation set that includes the following manuals:

• Installation Guide
• Tutorial and Application Guide
• Producing Online and Printed Documentation
• Using Global Tags
• Using Doctypes and Related Tags - 2 Volumes
• Tags Quick Reference
• Command Summary and Processing Messages
• Graphics Editor User's Guide for Motif

Conventions

The following table lists the typographical conventions used in this guide.

Convention	Meaning
<TAG>(argument)	Parentheses enclose an argument to a tag. A lowercase word as an argument to a tag indicates that a user-specified argument must be entered.
<TAG>[(argument)]	Brackets indicate that the enclosed argument to the tag is optional.
<TAG>[(argument-1 [ \argument-2])]	This tag syntax indicates that both arguments are optional. Only if you use argument-1, however, do you have the choice of using argument-2.
<TAG>[([argument-1] \ [argument-2])]	This tag syntax indicates that both arguments are optional. You can use either argument as the first argument.
<TAG> [( argument-1 KEYWORD-1 [ \KEYWORD-2] )]	This tag syntax indicates that all arguments are optional. The braces indicate a choice between argument-1 and KEYWORD-1. You must choose your first argument. If you choose KEYWORD-1, you also have the option of indicating /KEYWORD-2 as the second argument.
<TAG>(KEYWORD)	An uppercase word within an argument to a tag indicates that that word is a keyword, and that that specific keyword must be entered.
<TAG>(\KEYWORD)	A keyword following a backslash in an argument to a tag indicates that that keyword must follow a backslash.
...	A horizontal ellipsis indicates that arguments to a tag have been omitted.
\	A backslash separates multiple arguments to a tag.

The following is an alphabetical list of the tags that DECdocument recognizes. For each tag, the arguments are listed (unless there are no arguments to that tag), the tag descriptions are given, and the doctype is listed as one of the standard doctypes or as GLOBAL.

If the doctype is specified as GLOBAL, the tag is recognized in all doctypes. Global tags are described in Using Global Tags.

If the doctype listed is one of the standard doctypes, the tag is recognized only for that doctype and is described in Using Doctypes and Related Tags.

The SOFTWARE doctype has four templates (Command, Routine, Statement, and Tag) you can use to format your reference material in a particular way. The specific template is indicated for each relevant SOFTWARE doctype tag.

<ABSTRACT> [(heading)]
text
<ENDABSTRACT>

Begins a summary description of a document.
ARTICLE

<ABSTRACT> [(heading)]
text
<ENDABSTRACT>

Begins a summary description of a document on the title page or part page of the document.
GLOBAL

<ACCENT> (

• ACUTE
• GRAVE
• UMLAUT

Supplies a freestanding acute, grave, or umlaut accent mark.
GLOBAL

<ACKNOWLEDGEMENTS> (acknowledgement text)

Creates an acknowledgments section in an article.
ARTICLE

<ALIGN_AFTER> (text)

Allows you to position text in a list after the text specified in the argument.
GLOBAL

<ALIGN_CHAR> (character [ \DELTA])
text
<ENDALIGN_CHAR>

Identifies a nonprinting character you want to use to align numeric information in text or within a column of a list or table.
GLOBAL

<ALIGN_NUMBER> (number)

Specifies a number that you want to be aligned with other numbers in the same column of a table.
GLOBAL

<AMPERSAND>

Specifies an ampersand (&) anywhere in your file. To specify an ampersand in an argument to a tag or in the context of the <MATH> tag, you must use this tag.
GLOBAL

<APPENDIX> (appendix title [ \symbol name])
text
<ENDAPPENDIX>

Begins an appendix.
GLOBAL

<ARGDEF>

Begins the text that defines an item in an argument definition list.
SOFTWARE

<ARGDEFLIST> [(

• alternate heading
• NOHEAD
• NONE

Begins a definition list of arguments.
SOFTWARE

<ARGITEM> (item-1 [ \item-2 . . . [ \item-7]])
text
<ARGDEF>

Labels one to seven routine argument items to be defined in an argument definition list outside of the Routine template.
SOFTWARE

<ARGITEM> (arg name [ \usage info \data type \access \mechanism [ \mechanism info]])
text
<ARGDEF>

Labels a single routine argument and its attributes.
SOFTWARE (Routine template)

<ARG_SEP> (argument-1<ARG_SEP>argument-2)

Creates a separator character (\) between arguments in the FORMAT section of a tag description.
SOFTWARE (Tag template)

<ARGTEXT>
text
<ENDARGTEXT>

Labels definition text in an argument definition list that replaces the information contained in a pair of <ARGITEM> and <ARGDEF> tags.
SOFTWARE (Routine template)

<ARGUMENT> (argument name)

Emphasizes an argument name within text.
SOFTWARE

<AUTHOR> (author name [ \optional info])

Specifies an author of an article.
ARTICLE

<AUTHOR> (author name [ \author info-1 \author info-2])

Places the name of an author and one or two additional lines of information about the author in the front matter portion of a document.
REPORT and SOFTWARE.SPECIFICATION

<AUTHOR_ADDR> (address line-1 [ \address line-2 . . . [ \address line-6]])

Specifies in one to six lines the address of the author.
ARTICLE

<AUTHOR_AFF> (affiliation info)

Specifies information about the organizational affiliation of the author.
ARTICLE

<AUTHOR_INFO> (info line-1 [ \info line-2 . . . [ \info line-4]])

Specifies up to four lines of informational text about the author in an overhead slide presentation.
OVERHEADS

<AUTHOR_LIST> [(heading text)]
text
<ENDAUTHOR_LIST>

Creates a list of authors for an article with multiple authors.
ARTICLE

<AUTO_NUMBER> [(text)]

Specifies that slides be numbered automatically, and that the slide number is placed at the bottom of every slide. Optionally, specifies a text string to be placed in front of the slide number on each page.
OVERHEADS

<BACKSLASH>

Specifies a backslash anywhere in your file. To specify a backslash in an argument to a tag, you must use this tag.
GLOBAL

<BACK_NOTE> (back note text)

Creates a back note entry and a superscript reference number to that entry in the article text.
ARTICLE

<BACK_NOTES> [(heading text)]

Outputs all the back notes created with the <BACK_NOTE> tag at the place in the file where you use the <BACK_NOTES> tag.
ARTICLE

<BIBLIOGRAPHY> [(heading text)]
text
<ENDBIBLIOGRAPHY>

Begins a bibliography.
ARTICLE

<BIB_ENTRY> (bibliography text)

Specifies a single entry in a bibliography.
ARTICLE

<BOOK_ONLY>
text
<ENDBOOK_ONLY>

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

<BOOK_REF> (symbol name \file spec)

Outputs a BOOK entry for a Bookreader bookshelf file.
ONLINE_BOOKSHELF

<BOX> (label)

Produces a box that surrounds a user-specified character string.
GLOBAL

<BYLINE> (name [ \additional info])

Places a name and other optional information below a ruled line in a signature list.
REPORT and SOFTWARE

<CALLOUT> [(number)]

Identifies a number that is printed as a white letter in a black box or circle (depending on the output device) in an example. (The <CALLOUT> tag is identical to the <CO> tag.)
GLOBAL

<CALLOUT_REF> (callout number)

Labels a reference in text to a callout number.
GLOBAL

<CALLOUTS> [([callout number] [ \PREFIX])]
text
<ENDCALLOUTS>

Labels the beginning of a series of callouts contained in an example and enables the use of the <CALLOUT> and <CO> tags.
GLOBAL

<CC> (receiver name)

Lists the name of someone who is to receive a copy of a memo or letter.
LETTER

<CCLIST>

Begins a list of persons to whom you want to send a copy of a memo or letter.
LETTER

<CENTER_LINE> (text [

• \ BIGSKIP
• \ SMALLSKIP

Specifies a line of text that is to be centered in the current text margin.
GLOBAL

<CHAPTER> (chapter title [ \symbol name])

Begins a chapter.
GLOBAL

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

Specifies an unnumbered centered heading.
GLOBAL

<CHECK_FOR_INCLUSION> (file label)
text
<ENDCHECK_FOR_INCLUSION>

Marks a definitions file to ensure that the file is read only once.
GLOBAL

<CLOSING> (closing line-1 [ \closing line-2 . . . [ \closing line-5]])

Specifies in one to five lines the closing of a letter.
LETTER

<CO> [(number)]

Identifies a number that is printed as a white letter in a black box or circle (depending on the output device) in an example. (The <CO> tag is identical to the <CALLOUT> tag.)
GLOBAL

<CODE_EXAMPLE> (inline code example)
or
<CODE_EXAMPLE> [(

• KEEP
• WIDE [ \MAXIMUM]
• MAXIMUM

Begins an example of code. Code consists of words or lines of instructions written in a programming language or a command language.
GLOBAL (code example text uses monospaced font; inline code example uses italic font)
MILSPEC.DRAFT, MILSPEC.SECURITY (uses a proportionally spaced font)

<COLUMN>

Specifies that a new column of output begins in a 2-column format.
ARTICLE and REPORT.TWOCOL

<COMMAND> (command name [ \informational name] [\symbol name])

Begins a new command description.
SOFTWARE (Command template)

<COMMAND_SECTION> [([running title] [ \number prefix] [ \NEWPAGE])]
text
<ENDCOMMAND_SECTION>

Begins a command reference section, enables tags reserved for use in command sections, and sets paging attributes.
SOFTWARE (Command template)

<COMMENT> (comment text)
or
<COMMENT>
comment text
<ENDCOMMENT>

Marks a section of an SDML file that you do not want to appear in your output. Text marked by a <COMMENT> tag is ignored by the tag translator during processing.
GLOBAL

<CONDITION> (condition name-1 [ \condition name-2] [ \condition name-3])
conditional text
<ENDCONDITION>

Marks a section of an SDML file that is not processed unless one of the arguments to the tag matches the argument in the related <SET_CONDITION> tag or matches the condition you set with the /CONDITION qualifier on the DOCUMENT command line.
GLOBAL

<CONSTRUCT> [(construct name)]

Specifies a variable construct and gives its expansion.
SOFTWARE (Statement template)

<CONSTRUCT_LIST> (construct name)
text
<ENDCONSTRUCT_LIST>

Begins a list of construct items and definitions that expand on variables specified in the context of the <STATEMENT_FORMAT> tag.
SOFTWARE (Statement template)

<CONTENTS_FILE> [(file spec)]

Specifies the position in a source file where a table of contents output file will be included; it does not produce a table of contents.
GLOBAL

<COPYRIGHT_DATE> (date [ \owner])

Inserts a copyright date line on the copyright page along with other system-specific copyright information.
GLOBAL

<COPYRIGHT_PAGE>
text
<ENDCOPYRIGHT_PAGE>

Begins a copyright page and enables copyright page tags.
GLOBAL

<CP>

Marks the continuation of a paragraph that has been interrupted by another text element, such as a figure, list, or a table.
GLOBAL

<CPAREN>

Supplies a closing parenthesis anywhere in your file. You must use this tag, however, to specify a closing parenthesis within an argument to a tag, so that the closing parenthesis is not interpreted as the closing parenthesis of the tag's argument.
GLOBAL

<CPOS> (placement character)

Marks the cursor position in a screen display.
SOFTWARE

<DATE> [(

• FULL
• date text

Produces either the current system or user-specified date and time.
GLOBAL

<DEFINE_BOOK_NAME> (symbol name \title)

Defines the title of a book and associates a user-defined symbol name to the cross-reference file.
GLOBAL

<DEFINE_SYMBOL> (symbol name \text string)

Associates a string of text with a user-defined symbol, so that you can reference the text by this symbol throughout the document.
GLOBAL

<DEFINITION_LIST>
definition list items
<ENDDEFINITION_LIST>

Begins a definition list, which includes an item followed by its definition.
GLOBAL

<DEFINITION_LIST_HEAD> (heading text)

Supplies the heading for a list of defined items you specify with the <DEFINITION_LIST> tag.
GLOBAL

<DEFLIST_DEF>

Introduces an item's definition in a definition list.
GLOBAL

<DEFLIST_ITEM> (item-1 [ \item-2 . . . [ \item-7]])

Marks an item you want to define in a definition list.
GLOBAL

<DELAYED> (delayed text)
or
<DELAYED>
delayed text
<ENDDELAYED>

Allows you to specify text that contains tags in an argument to another tag. Execution of the <DELAYED> tag is delayed until the outer tag's text is processed.
GLOBAL

<DELETE_KEY>

Creates a special character resembling a DELETE key on a keyboard.
SOFTWARE

<DESCRIPTION> [(alternate heading)]
text
<ENDDESCRIPTION>

Begins a section of descriptive text about the current reference element.
SOFTWARE

<DISPLAY> (display text)
or
<DISPLAY> [(

• KEEP
• WIDE [ \MAXIMUM]

Simulates the appearance and position of characters on a terminal screen.
SOFTWARE

<DISTLIST>

Begins a list of persons to whom you want to distribute a memo or letter.
LETTER

<DOCTYPE> (document type)

Identifies the doctype for your file. This tag is for informational purposes only.
GLOBAL

<DOCUMENT_ATTRIBUTES>
text
<ENDDOCUMENT_ATTRIBUTES>

Enables doctype-specific tags that override the default doctype design format.
ARTICLE, MILSPEC, REPORT, and SOFTWARE

<DOUBLE_QUOTE>

Supplies a double quotation mark as it appears when it is typeset.
GLOBAL

<ELEMENT> (file spec)

Identifies a file that contains an element of a book.
GLOBAL

<ELLIPSIS>

Supplies vertical ellipsis points to show omitted material in text and tables.
GLOBAL

<EMPHASIS> (text

• \ [BOLD]
• \ [ITALIC]
• \ [SMALLCAPS ]
• \ [SMALL_BOLDCAPS]

Marks a word or phrase for distinctive typographical treatment.
GLOBAL

<ENDCOPYRIGHT_PAGE> [(identification)]

Terminates the copyright page and optionally provides text that is output at the bottom of the copyright page.
GLOBAL

<ENDPART_PAGE> [(RENUMBER)]

Terminates a part page (which is a dividing page between major sections of a document) and optionally specifies paging attributes for text that follows.
GLOBAL

<ENDTITLE_PAGE> [(text)]

Terminates a title page and optionally specifies text to appear at the bottom of the title page.
GLOBAL

<EXAMPLE> [(example caption [ \symbol name])]
example text
<ENDEXAMPLE>

Labels the beginning of an example.
GLOBAL

<EXAMPLE_ATTRIBUTES> (

• FLOAT
• KEEP
• MULTIPAGE

Specifies attributes for the current example.
GLOBAL

<EXAMPLE_FILE> (file spec)

Causes a separate file containing an example to be included in the source file.
GLOBAL

<EXAMPLE_SEQUENCE> [(

• EXAMPLE
• heading text
• NOHEAD

---

Next

Contents

Index