Labels a tag and its arguments.

Format

<TAG> (tag name [\tag arg-1 . . . [\tag arg-8]])

ARGUMENTS

tag name

Specifies the name of the tag.

tag arg

This is an optional argument. It specifies an argument to the tag. The number of arguments you specify depends on the number of arguments available to the tag you are labeling.

related tags

• <LITERAL>

restrictions

Invalid in the context of a <MATH> tag.

DESCRIPTION

The <TAG> tag labels a tag and its arguments.

Examples

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

<P>You use the <TAG>(p) tag to begin a new paragraph. 

This example produces the following output:

You use the <P> tag to begin a new paragraph.

The following example shows how to use the <TAG> tag with an argument.

Use the <TAG>(code_example\WIDE) tag if your example 
has long lines. 

This example produces the following output:

Use the <CODE_EXAMPLE>(WIDE) tag if your example has long lines.

The following example shows the difference in output caused by the <TAG> tag and the <LITERAL> tag.

A writer can use the <tag>(line_art) tag to label a rough sketch. A writer 
should not use the <literal><icon><endliteral> tag for that purpose. 
      

This example produces the following output:

A writer can use the <LINE_ART> tag to label a rough sketch. A writer should not use the <icon> tag for that purpose.

Labels the title used on either a title page or part page. (A part page is a divider page for a new part of a document.)

Format

<TITLE> (title line-1[\title line-2[\title line-3]])

ARGUMENTS

title line-n

Specifies one to three separate lines of text for the title.

related tags

• <PART_PAGE>
• <TITLE_PAGE>

restrictions

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

Must appear immediately after the <PART_PAGE> or <TITLE_PAGE> tag.

The <RIGHT_LINE> and <CENTER_LINE> tags are invalid within an argument to the <TITLE> tag.

Accepts only two title line arguments when used within a part page or in the SOFTWARE.BROCHURE doctype.

DESCRIPTION

The <TITLE> tag labels the title used on either a title page or part page. (A part page is a divider page for a new part of a document.)

On a part page, the <TITLE> tag accepts one or two title text arguments, and the title text is kept on the same line.

In the SOFTWARE.BROCHURE doctype, the <TITLE> tag accepts one or two title text arguments. If you specify only the first argument, the title text is placed at the top of the first page and at the bottom of each successive page; if you also specify the optional second argument, that title text is placed at the bottom of each page. The title text placed at the bottom of the page by the SOFTWARE.BROCHURE <TITLE> tag will be overridden by the text argument of any subsequent <CHAPTER> tags. Refer to Using Doctypes and Related Tags for more information on using the tag in the SOFTWARE.BROCHURE doctype.

Example

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

Labels the beginning of a title page and enables the title page tags.

Format

<TITLE_PAGE>

ARGUMENTS

None.

restrictions

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

If you are using a preface, you must terminate the <TITLE_PAGE> tag before you use the <PREFACE> tag. If you are using a copyright page, you must terminate the <TITLE_PAGE> tag before you use the <COPYRIGHT_PAGE> tag.

required terminator

<ENDTITLE_PAGE>

DESCRIPTION

The <TITLE_PAGE> tag labels the beginning of a title page and enables the following title page tags:

• <ABSTRACT>
• <ORDER_NUMBER>
• <REVISION_INFO>
• <TITLE>

DOCUMENT considers the title page to be an online topic. See Producing Online and Printed Documentation for more information about online topics.

Your Bookreader document must contain a title page with the <TITLE_PAGE> and <ENDTITLE_PAGE> tags. The <FRONT_MATTER> tag and the LMF (License Management Facility) tags must appear before the <TITLE_PAGE> tag. Do not place any tags that generate text before the <TITLE_PAGE> tag.

Example

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

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

Format

<U> (text)

ARGUMENTS

text

Specifies the text of the user input.

related tags

• <INTERACTIVE>
• <S>

---

DESCRIPTION

The <U> tag labels the user portion of a dialog between user and system in an interactive example. You must identify both parts of an example containing this type of dialog in order to differentiate the two types of text in the source code, the output, or both. In Bookreader output, the text that you label with the <U> tag appears in boldface.

In the SOFTWARE doctype, you can use the <U> and <S> 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 <U> tag.

#1

<P>The user prompt <U>(send) indicates you can send a command.

This example produces the following output:

The user prompt send indicates you can send a command.

The following example shows how to code dialog between both the system and the user. In a dialog, the <S> and <U> 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

---

<UNDERLINE>

Marks a portion of text you want underlined.

---

Format

<UNDERLINE> (text)

or

<UNDERLINE>

text

.
.
.

<ENDUNDERLINE>

---

ARGUMENTS

text

Specifies the text string you want to underline.

restrictions

Because the text string that is marked for underlining is kept on the same line in the output, do not make the underline longer than the page width, or errors may be generated.

required terminator

<ENDUNDERLINE> --- Required if you do not specify the text argument to the <UNDERLINE> tag.

DESCRIPTION

The <UNDERLINE> tag marks a portion of text you want underlined.

Examples

The following example shows how to use the <UNDERLINE> tag with an argument.

<P>If you use the appropriate flags, your output 
may look like this: 
<P>
<SAMPLE_TEXT>
<UNDERLINE>(The Decline and Fall of the Roman Empire) 
<ENDSAMPLE_TEXT>
 

This example produces the following output:

If you use the appropriate flags, your output may look like this:

The Decline and Fall of the Roman Empire

The following example shows how to use the <UNDERLINE> tag with the <ENDUNDERLINE> tag. This example produces the same output as the first example.

<P>If you use the appropriate flags, your output 
may look like this: 
<P>
<SAMPLE_TEXT>
<UNDERLINE>The Decline and Fall of the Roman Empire<ENDUNDERLINE>
<ENDSAMPLE_TEXT>
 

Marks the location at which a new section of updated pages begins.

Format

<UPDATE_RANGE> (start page\

• end page
• EOF

)

ARGUMENTS

start page

Specifies the page number from the printed documentation of the first updated page you want to print.

end page

Specifies the last page to be included in a set of update pages. DECdocument automatically generates point-numbered pages if text within the bounds of the <UPDATE_RANGE>(START PAGE) and <UPDATE_RANGE>(END PAGE) tags will not fit within those pages.

EOF

This keyword specifies that the update range continues to the end of a chapter or section.

related tags

• <MARK>
• <REVISION>

restrictions

The <UPDATE_RANGE> tag has no effect on Bookreader output.

Valid only in the context of a <REVISION> tag, and the <REVISION> tag must specify the keyword UPDATE. If you do not specify the <REVISION> tag, no output is generated from the <UPDATE_RANGE> and <ENDUPDATE_RANGE> tags.

required terminator

<ENDUPDATE_RANGE>

DESCRIPTION

The <UPDATE_RANGE> tag marks the location at which a new section of updated pages begins. Files coded with the <REVISION>(UPDATE\update info) tag and containing <UPDATE_RANGE> tags process as follows:

• When the text formatter processes a file that has been marked as an update, it processes all text and commands in the file, but does not produce actual output for the DVI file, except for those pages marked within an update range.
• When the text formatter reaches the beginning of an update range, it sets the page number to the page number specified as the start of the update. Therefore, it is not important that previous versions of the text formatter file were modified for pagination during final production. All pages processed outside of an update range are not output.

The following rules apply to the placement of the <UPDATE_RANGE> tag:

• If the text on the first update page is in the middle of a text element (for example, a paragraph, a list element, a code example), then the <UPDATE_RANGE> tag must precede the word of text that is the first word on the page.
• If the text on the first update page represents the beginning of a new text element (for example, the <P>, <LIST>, <LE>, <CODE_EXAMPLE> tags, and so on), you must place the <UPDATE_RANGE> tag immediately preceding the tag for the text element.
• If an update range begins on a page that starts with a continued table, the file must specify the start of the update range on the odd-numbered page preceding the beginning of that table, or (if the table begins on an odd-numbered page) the page on which the table begins. If these pages are not to be a part of the update, you can discard them.
• If one or more pages before an update range begins contain a floating figure or example, you must modify the <FIGURE_ATTRIBUTES> or <EXAMPLE_ATTRIBUTES> tags to specify the KEEP argument. This prevents the text formatter from floating the figure or example to the top of the first update page.
  Put a <COMMENT> tag in the file to indicate that the modification was made for the purposes of the update only. For example:

  <COMMENT>(KEEP added to example for update only...)

  When the file is subsequently revised, you can remove the KEEP arguments.

• When you process a file that contains the <REVISION>(UPDATE) tag, 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.

Example

In the following example, the updated material begins on page 5 and continues through page 24. When page 24 is reached, the page numbering becomes 24.1, 24.2, and so on, until the end of the update range is reached. You must place the <ENDUPDATE_RANGE> tag in the source file at the position corresponding to the place at which an update sequence ends.

<REVISION>(UPDATE\November 1990) 
   .
   .
   .
<UPDATE_RANGE>(5\24) 
<P>
The first sentence on page 5 goes here. 
   .
   .
   .
20 or more pages of modified text go here. 
   .
   .
   .
The last sentence on page 24.n goes here. 
<ENDUPDATE_RANGE>

Labels text that you want to appear in uppercase in the final output.

Format

<UPPERCASE> (text)

ARGUMENTS

text

Specifies the text you want to appear in uppercase.

related tags

• <LOWERCASE>

---

DESCRIPTION

The <UPPERCASE> tag labels text that you want to appear in uppercase in the final output. In your book, there may be a text element, such as a heading, that normally appears in lowercase. Use the <UPPERCASE> tag if you need to overcome the default case in one of your tags and ensure that the result in the final output appears in uppercase.

---

Example

In the following example, assume that the doctype being used causes the <HEAD2> tag to output a heading that is in lowercase, no matter what the case of the text passed to it. The <UPPERCASE> tag overrides the default in this <HEAD2> tag.

<HEAD2>(Here is an example of <UPPERCASE>(uppercase) text.)

This example produces the following output:

Here is an example of UPPERCASE text.

---

<USER_I_MESSAGE>

Sends an informational message to the terminal, .LIS, or .LOG file during processing of a file.

---

Format

<USER_I_MESSAGE> (info text)

---

ARGUMENTS

info text

Specifies the text you want to appear on the terminal or in the .LIS or .LOG file.

related tags

• <USER_W_MESSAGE>

restrictions

For batch processing, you must process the file with the /LOG qualifier on the command line in order to see any <USER_I_MESSAGE> tag messages.

The message text is limited to 150 characters.

DESCRIPTION

The <USER_I_MESSAGE> tag sends an informational message to the terminal, .LIS, or .LOG file during processing of a file.

If you process the file interactively, the message will appear on your screen. If you process the file interactively and use the /LIST qualifier on the command line, the message is also listed in the .LIS file.

If you process the file in batch and specify the /LOG qualifier on the command line, the message is listed in the .LOG file.

You can use the tag to broadcast any important information that should be noted during processing; for example, you might use it as a reminder that you still must add information to a file.

The tag translator displays the line number and the file name in which the tag appears. The message is output in the following format:

%TAG-I-USER_IMSG, mmmmmmmmmmmmmmmmmm Line is nnn of file fffffffffffff

Note If you want to generate only a few messages, you might choose to use the <USER_W_MESSAGE> tag and not process the file with the additional qualifier.

Example

The following example shows how to use the <USER_I_MESSAGE> tag to flag a section of a file that requires further work.

<USER_I_MESSAGE>(Section 2 is incomplete and requires 
information from Tom Smith.) 

Suppose the file containing this message is called "Chapter_1.SDML." Depending on how you process this file, the message appears on your screen, in the .LIST file, or in the .LOG file as follows:

%TAG-I-USER_IMSG, Section 2 is incomplete and requires information from Tom Smith. Line is 68 of file part2.sdml

Sends a warning message to the terminal, .LIS, or .LOG file during processing of a file.

Format

<USER_W_MESSAGE> (warning text)

ARGUMENTS

warning text

Specifies the text you want to appear on the terminal or in the .LIS or .LOG file.

related tags

• <USER_I_MESSAGE>

restrictions

For batch processing, you must process the file with the /LOG qualifier on the command line in order to see any <USER_W_MESSAGE> tag messages.

The message text is limited to 150 characters.

DESCRIPTION

The <USER_W_MESSAGE> tag sends a warning message to the terminal, .LIS, or .LOG file during processing of a file.

If you process the file interactively, the message will appear on your screen. If you process the file interactively and use the /LIST qualifier on the command line, the message is also listed in the .LIS file.

If you process the file in batch and specify the /LOG qualifier on the command line, the message is listed in the .LOG file.

Note This type of message is counted by the tag translator as a warning message. After thirty warning messages, tag translation halts. Therefore, use the <USER_W_MESSAGE> tag for generating messages only if you are issuing a few messages. For a file that contains many messages, tag messages with <USER_I_MESSAGE> tags and process the file with the /LOG qualifier.

You can use the tag to broadcast any important information that should be noted during processing; for example, you might use it as a reminder that a part of the file is incomplete.

The tag translator displays the line number and the file name in which the tag appears. The message is output in the following format:

%TAG-W-USER_WMSG, at tag <USER_W_MESSAGE> on line nnn of file ffffffff mmmmmmmmmmmmmmmmmmmmmmmmmmm

Example

The following example shows how to use the <USER_W_MESSAGE> tag to identify a notice in a file.

<USER_W_MESSAGE>(Reviewers: Please note missing parameters here.) 

Suppose the file containing this message is called "Reviewers_copy.SDML." Depending on how you process this file, the message appears on your screen, in the .LIST file, or in the .LOG file as follows:

%TAG-W-USER_WMSG, at tag USER_W_MESSAGE on line nn of file Reviewers_copy.SDML. Reviewers: Please note missing parameters here.