DECdocument
Using Global Tags

This example produces the following output:

Table 1-4 shows ten default system logical names.

For Bookreader output, "Table 1-4" is a hotspot: [Table 1-4].

The following example shows how to use the <REFERENCE> and <TABLE> tags to refer to the table in full, that is, to refer to the number and name of the table. The symbol name "lognames_tab" is defined in the <TABLE> tag and then referred to with the <REFERENCE> tag.

#2

<REFERENCE>(lognames_tab\full) shows ten default system logical names. <TABLE>(System Logical Names\lognames_tab) . . .

This example produces the following output:
Table 1-4, System Logical Names, shows ten default system logical names.
For Bookreader output, "Table 1-4, System Logical Names" is a hotspot: [Table 1-4, System Logical Names].
The following example shows how to use the <REFERENCE> and <HEAD1> tags to refer to the text of the heading. The symbol name "assigning_attributes" is defined in the <HEAD1> tag and then \ referred to with the <REFERENCE> tag.

#3

The <REFERENCE>(assigning_attributes\text) section describes the 
method to assign color to the objects on your screen.            
<HEAD1>(Assigning Color Attributes\assigning_attributes)

This example produces the following output:
The Assigning Color Attributes section describes the method to assign color to the objects on your screen.
For Bookreader output, "Assigning Color Attributes" is a hotspot: [Assigning Color Attributes].
The following example shows how to use the <REFERENCE> tag to refer to a chapter number without outputting any related information, such as the chapter title.

#4

<P>See Chapters <REFERENCE>(lognames_chap\value) and 
<REFERENCE>(filespec_chap\value) to see ...

This example produces the following output:
See Chapters 3 and 4 to see ...
For Bookreader output, "3" and "4" are hotspots: [ 3 ] and [ 4 ].

<REVISION>

Indicates that the document contains either new or modified information.

Format

<REVISION> [(UPDATE [\update info])]

ARGUMENTS

UPDATE
This is an optional keyword argument, but you must specify it if you are producing the document for an update. If you specify UPDATE, the file must contain the <UPDATE_RANGE> and <ENDUPDATE_RANGE> tags to indicate the pages to be processed. If no <UPDATE_RANGE> tags are present, no output is produced. The UPDATE argument has no effect for Bookreader output.
update info
This is an optional argument. It specifies information that is related to the system version and the date of the update. The text appears on the bottom of each page of output in the update. The update info argument has no effect for Bookreader output.

related tags

<UPDATE_RANGE>

restrictions

Invalid in the two multicolumn doctypes, ARTICLE and REPORT.TWOCOL.

DESCRIPTION

The <REVISION> tag indicates that the document contains either new or modified information. It enables the , <ENDMARK>, <UPDATE_RANGE>, and <ENDUPDATE_RANGE> tags. By default, these tags are defined for all doctypes to be non-operational; that is, if a file is processed without the <REVISION> tag, the related tags produce no output.
You can produce update pages only for a printed document; you cannot produce them for Bookreader.
When a file that contains the <REVISION>(UPDATE) tag is processed, the table of contents and index are handled as follows: if you specify /CONTENTS and /INDEX on the command line, you receive a table of contents and an index even if you do not specify the <CONTENTS_FILE> and <INDEX_FILE> tags within the <UPDATE_RANGE> and <ENDUPDATE_RANGE> tags.

Note
If the device converter encounters errors on point pages created using the <REVISION>(update) tag, it signals them as occurring on the original page, not the point page. For example, an error on point page 11-2.1 is signalled as occurring on page 11-2.

Examples

The following example shows how to use the <REVISION> tag in a document that is extensively revised.

#1

<REVISION>
   .
   .
   .
<P>
The following characters are legal in MACRO-11 source programs: 
<LIST>(UNNUMBERED) 
<LE>The letters A through Z. Both upper- and lowercase letters are 
acceptable, although, upon input, lowercase  letters are converted to 
uppercase. 
<MARK>
<LE>Characters in the Digital Multinational Character Set (MCS). A chart 
showing the MCS is located in <REFERENCE>(mcs_app), 
with a list of directives that support the MCS. 
<LE>The digits 0 through 9. 
<ENDMARK>
<LE>The characters period <PARENDCHAR>(.) and dollar sign 
<PARENDCHAR>($). These characters  are reserved for use as Digital 
Equipment Corporation system program symbols. 
<ENDLIST>

This example produces the following output:
The following characters are legal in MACRO-11 source programs:

The letters A through Z. Both upper- and lowercase letters are acceptable, although, upon input, lowercase letters are converted to uppercase.
Characters in the Digital Multinational Character Set (MCS). A chart showing the MCS is located in Appendix A, with a list of directives that support the MCS.
The digits 0 through 9.
The characters period (.) and dollar sign ($). These characters are reserved for use as Digital Equipment Corporation system program symbols.

The following example shows how to use the <REVISION> tag to update a manual. See the <UPDATE_RANGE> tag description for more information on identifying a section of updated material.

#2

<REVISION>(UPDATE\November 1990) 
   .
   .
   .
<UPDATE_RANGE>(3\10)

<REVISION_INFO>

Labels a section on a title page that provides information on what previous books have been superseded by the current one.

Format

<REVISION_INFO> ([title text] \info)

ARGUMENTS

title text
This is an optional argument. It specifies heading information. If you do not specify this argument, the default text "Revision/Update Information:" is supplied.
info
Specifies revision and update information.

related tags

<FRONT_MATTER>

restrictions

Valid only in the context of a <TITLE_PAGE> tag.

DESCRIPTION

The <REVISION_INFO> tag labels a section on a title page that provides information on what previous books have been superseded by the current one.

Example

See the example in the discussion of the <FRONT_MATTER> tag.

<RIGHT_LINE>

Specifies a line of text that is to be aligned against the right-hand margin of the page.

Format

<RIGHT_LINE> (text [

\BIGSKIP
\SMALLSKIP
])

ARGUMENTS

text
Specifies the line of text to be aligned against in the right-hand margin of the page.
BIGSKIP

SMALLSKIP
These are optional keyword arguments. They specify that a set amount of vertical space precede the element identified as a line or block of text. The actual amount of space inserted is determined by the doctype.

related tags

<CENTER_LINE>
<LINE>

restrictions

Invalid in the context of an <EXAMPLE> and a <MATH> tag.
The aligned text must fit within the right-hand margin. If you specify text that is too wide, the text formatter issues a warning message, and you should examine your output.

DESCRIPTION

The <RIGHT_LINE> tag specifies a line of text that is to be aligned against the right-hand margin of the page. This text is said to be right-justified.

Note
When you use the <RIGHT_LINE> tag as the first tag in a table column, it leaves extra space in that column.

Examples

The following example shows how to use the <RIGHT_LINE>(SMALLSKIP) tag.

#1

<P>Please include the following information: 
<RIGHT_LINE>(Name) 
<RIGHT_LINE>(Address\smallskip) 
<RIGHT_LINE>(Phone Number)

This example produces the following output:

Please include the following information: Name Address Phone Number

The following example shows how to use the <RIGHT_LINE>(BIGSKIP) tag.

#2

<P>Please include the following information: 
<RIGHT_LINE>(Name) 
<RIGHT_LINE>(Address\bigskip) 
<RIGHT_LINE>(Phone Number)

This example produces the following output:

Please include the following information: Name Address Phone Number

<RULE>

Outputs a horizontal rule in a table.

Format

<RULE>

ARGUMENTS

None.

related tags

<TABLE_HEADS>
<TABLE_ROW>
<TABLE_UNIT_HEADS>

restrictions

Valid only in an argument to a <TABLE_ROW>, <TABLE_HEADS>, or <TABLE_UNIT_HEADS> tag; it must immediately follow the argument text under which the rule is to be placed.

DESCRIPTION

The <RULE> tag outputs a horizontal rule in a table. You place a <RULE> tag inside an argument to a <TABLE_HEADS>, <TABLE_ROW>, or <TABLE_UNIT_HEADS> tag.
The horizontal length of the rule does not correspond to the dimensions of the table. It equals the width of the table column or the spanned columns, if the argument also is preceded by a tag. See the tag description for more information.

Example

See the example in the discussion of the <TABLE_UNIT> tag.

<S>

Labels the system portion of a dialog between user and system in an interactive example.

Format

<S> (text)

ARGUMENTS

text
Specifies the text of the system message.

related tags

<INTERACTIVE>

restrictions

Invalid in the context of a <MATH> tag.

DESCRIPTION

The <S> tag labels the system portion of a dialog between user and system in an interactive example. An example containing this type of dialog must have both parts identified in order to differentiate the two types of text in the source code, the output, or both.
In the Software doctype, you can also use the <S> and tags to differentiate the system and user text inside of examples created with the <EXAMPLE_SEQUENCE> and <EXI> tags. For more information on this doctype, refer to Using Doctypes and Related Tags.

Examples

The following example shows how to use the <S> tag.

#1

<P>The system prompt <S>($) indicates you can enter a command.

This example produces the following output:
The system prompt $ indicates you can enter a command.
The following example shows how to code dialog between both the system and the user. In a dialog, the <S> and tags must be used between <INTERACTIVE> and <ENDINTERACTIVE> tags. Note that you should specify, within the argument to the <S> tag, whatever space follows the system prompt.

#2

<P>The following example of VAXMAIL contains messages from both 
the system and a user of the system: 
<INTERACTIVE>
<U>(mail) 
<S>(MAIL> )<U>(send) 
<S>(To: )<U>(nodename::Courtney) 
<S>(%MAIL-E-NOSUCHUSR, no such user COURTNEY at node NODENAME) 
<ENDINTERACTIVE>

This example produces the following output:
The following example of VAXMAIL contains messages from both the system and a user of the system:
mail MAIL> send To: nodename::Courtney %MAIL-E-NOSUCHUSR, no such user COURTNEY at node NODENAME

<SAMPLE_TEXT>

Typographically distinguishes an extract of text.

Format

<SAMPLE_TEXT>

ARGUMENTS

None.

related tags

<CENTER_LINE>

restrictions

The <SAMPLE_TEXT> tag does not provide paragraph formatting. If you want to show a paragraph within the sample text, you must label it with a tag.

required terminator

<ENDSAMPLE_TEXT>

DESCRIPTION

The <SAMPLE_TEXT> tag typographically distinguishes an extract of text. The sample text is indented from the normal text margins.

Example

The following example shows how to use the <SAMPLE_TEXT> tag.

<P>The language is perpetually in flux: it is a living stream, 
shifting, changing, receiving new strength from a thousand tributaries. . . 
<SAMPLE_TEXT>
<P>Taken from Strunk, William Jr. and White, E.B.: The Elements of Style. 
Macmillan Publishing Co., Inc., 1979. 
<ENDSAMPLE_TEXT>

This example produces the following output:
The language is perpetually in flux: it is a living stream, shifting, changing, receiving new strength from a thousand tributaries. . .

Taken from Strunk, William Jr. and White, E.B.: The Elements of Style. Macmillan Publishing Co., Inc., 1979.

<SET_APPENDIX_LETTER>

Overrides the default appendix letter assigned to an appendix by DECdocument.

Format

<SET_APPENDIX_LETTER> (appendix letter)

ARGUMENTS

appendix letter
Specifies the letter of the appendix. This argument must be a letter from A to Z.

related tags

<APPENDIX>
<SET_CHAPTER_NUMBER>
The MILSPEC doctype <SET_APPENDIX_NUMBER> tag

DESCRIPTION

The <SET_APPENDIX_LETTER> tag overrides the default appendix letter assigned to an appendix by DECdocument. The tag is useful only in an element build to override the default appendix letter created by DECdocument; it is ignored in a bookbuild. The <SET_APPENDIX_LETTER> tag resets the current appendix letter and resets the lettering for all following appendixes. For example, if you specified C as the argument, the <APPENDIX> tag generates Appendix C. The next <APPENDIX> tag generates Appendix D, and so on.
Place the <SET_APPENDIX_LETTER> tag in your SDML file before the <APPENDIX> tags you want it to affect, because the <SET_APPENDIX_LETTER> tag affects only the <APPENDIX> tags that follow it.
You can use the <SET_APPENDIX_LETTER> tag multiple times in an SDML file.

Example

The following example shows how to use the <SET_APPENDIX_LETTER> tag. The appendix "Error Messages" is explicitly set to C using the <SET_APPENDIX_LETTER> tag. This causes any subsequent appendixes to be numbered beginning with the letter D, unless you use another <SET_APPENDIX_LETTER> tag to reset the current appendix letter.
<SET_APPENDIX_LETTER>(C) <APPENDIX>(Error Messages\error_msg_app) The following error messages...
<SET_CHAPTER_NUMBER>

Overrides the default chapter number assigned to a chapter by DECdocument.

Format

<SET_CHAPTER_NUMBER> (chapter number)

ARGUMENTS

chapter number
Specifies the number of the chapter. This argument must be a positive integer.

related tags

<CHAPTER>
<SET_APPENDIX_LETTER>

DESCRIPTION

The <SET_CHAPTER_NUMBER> tag overrides the default chapter number assigned to a chapter by DECdocument. The tag is useful only in an element build to override the default chapter number created by DECdocument; it is ignored in a bookbuild. The <SET_CHAPTER_NUMBER> tag resets the current chapter number and the numbering for all following chapters. For example, if you specify 13 as the chapter number, the next <CHAPTER> tag generates Chapter 13. The following <CHAPTER> tag generates Chapter 14, and so on.
Place the <SET_CHAPTER_NUMBER> tag in your SDML file before the <CHAPTER> tags you want it to affect, because the <SET_CHAPTER_NUMBER> tag affects only the <CHAPTER> tags that follow it.
You can use the <SET_CHAPTER_NUMBER> tag multiple times in an SDML file.

Example

The following example shows how to use the <SET_CHAPTER_NUMBER> tag. The chapter is set to 13 using the <SET_CHAPTER_NUMBER> tag. This causes any subsequent chapters to be numbered beginning with number 14, unless you use another <SET_CHAPTER_NUMBER> tag to reset the current chapter number.
<SET_CHAPTER_NUMBER>(13) <CHAPTER>(Supported Devices\sup_dev_chap) The primary supported devices...
<SET_CONDITION>

Creates or removes a condition in your SDML file.

Format

<SET_CONDITION> (condition name[\REMOVE])

ARGUMENTS

condition name
Specifies a name you use to conditionalize a portion of your SDML file. This name is limited to 28 characters.
REMOVE
This is an optional keyword argument. It removes the condition name.

related tags

<CONDITION>

DESCRIPTION

The <SET_CONDITION> tag creates or removes a condition in your SDML file. You specify conditions with the <CONDITION> tag.
For a complete explanation of creating conditional text, refer to Producing Online and Printed Documentation.
Normally, you create a condition at the front of your input file and it remains in effect for the rest of the file. If you want to process a portion of the input file without the condition, you can remove it by repeating the <SET_CONDITION> tag with the REMOVE argument.
You can use the /CONDITION qualifier on the DOCUMENT command line instead of placing the <SET_CONDITION> tag into your file. For example, you might use the command line qualifier /CONDITION=local instead of putting the <SET_CONDITION>(local) tag in your input file.

Example

The following example shows how to use the <SET_CONDITION> tag at the beginning of your file in order to establish the condition. In this case, the condition, set by the <SET_CONDITION>(Christmas) tag, is "Christmas". This means that only the information on Christmas, designated with the <CONDITION> tag, is processed.
This example also shows how to use the <SET_CONDITION> tag with the REMOVE argument in order to remove the condition you set with the <SET_CONDITION> tag. Removing the condition applies for the rest of your file. In this case, the first instance of Christmas information is processed, but all instances of Christmas information after the <SET_CONDITION>(Christmas\REMOVE) tag are not processed.
<SET_CONDITION>(Christmas) <CONDITION>(Christmas) Christmas, by convention, is celebrated on December 25th... <ENDCONDITION> <CONDITION>(Chanukah) Chanukah is called the Festival of Lights... <ENDCONDITION> <CONDITION>(Passover) Passover is usually celebrated... <ENDCONDITION> <SET_CONDITION>(Christmas\REMOVE) <CONDITION>(Christmas\Chanukah) <HEAD1>(Religious Holidays) This paragragh contains general information about several religious holidays... <ENDCONDITION>
Previous Next Contents Index

DECdocumentUsing Global Tags

<REVISION>

Format

<REVISION> [(UPDATE [\update info])]

ARGUMENTS

UPDATE

update info

related tags

restrictions

DESCRIPTION

Examples

<REVISION_INFO>

Format

<REVISION_INFO> ([title text] \info)

ARGUMENTS

title text

info

related tags

restrictions

DESCRIPTION

Example

<RIGHT_LINE>

Format

<RIGHT_LINE> (text [ \BIGSKIP \SMALLSKIP ])

ARGUMENTS

text

BIGSKIP

SMALLSKIP

related tags

restrictions

DESCRIPTION

Examples

<RULE>

Format

<RULE>

ARGUMENTS

related tags

restrictions

DESCRIPTION

Example

<S>

Format

<S> (text)

ARGUMENTS

text

related tags

restrictions

DESCRIPTION

Examples

<SAMPLE_TEXT>

Format

<SAMPLE_TEXT>

ARGUMENTS

related tags

restrictions

required terminator

DESCRIPTION

Example

<SET_APPENDIX_LETTER>

Format

<SET_APPENDIX_LETTER> (appendix letter)

ARGUMENTS

appendix letter

related tags

DESCRIPTION

Example

<SET_CHAPTER_NUMBER>

Format

<SET_CHAPTER_NUMBER> (chapter number)

ARGUMENTS

chapter number

related tags

DESCRIPTION

Example

<SET_CONDITION>

Format

<SET_CONDITION> (condition name[\REMOVE])

ARGUMENTS

condition name

REMOVE

DECdocument
Using Global Tags

<RIGHT_LINE> (text [

\BIGSKIP
\SMALLSKIP
])