DECdocument
Using Global Tags

Contents

Index

<LE>

Labels a list element.

Format

<LE> [(callout number)]

ARGUMENTS

callout number
This is an optional argument. It sets the callout number identifying the list element.

related tags

<LIST>

restrictions

Valid only in the context of a <LIST> tag.
You can use the callout number argument of the <LE> tag only in the context of a <LIST>(CALLOUT) tag.

DESCRIPTION

The <LE> tag labels a list element.

Examples

See the examples in the discussion of the <LIST> tag.

<LINE>

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

Format

<LINE> [(

INDENT [ \unit number]
BIGSKIP
SMALLSKIP
)]

ARGUMENTS

INDENT
This is an optional keyword argument. It specifies that the next line or block of text be indented from the preceding text.
unit number
If you use INDENT, you have the option of specifying a unit number from 2 to 9 indicating the number of units that the text is to be indented. The default indent is 1 unit. The size of these units is determined separately for each doctype.
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 created is determined by the doctype.

related tags

<CENTER_LINE>
<FINAL_CLEANUP>
<RIGHT_LINE>

restrictions

Invalid in the context of an <EXAMPLE> and a <MATH> tag.

DESCRIPTION

The <LINE> tag specifies that the text that follows this tag be placed on a new line of output. The result of using the <LINE> tag differs according to whether you use it in the context of a <P> tag, a <TABLE_ROW> tag, or a <FORMAT> tag:

When you specify the <LINE> tag in the context of a paragraph of text or a list element, the <LINE> tag ends the current paragraph or list element and then starts a new block of text. By default, the block of text is not preceded by any extra vertical space, nor is it indented.
When you specify the <LINE> tag in the context of a <TABLE_ROW> or a <FORMAT> tag, the <LINE> tag causes the following text to begin on a new line of output, but does not modify the current paragraph.

Be sure that you want a line break in all formatting cases, including Bookreader output. Do not use the <LINE> tag in a paragraph simply to cause the text formatter to break a line within the paragraph. Breaking a line to override a specific line break is a final formatting instruction; use the <FINAL_CLEANUP>(LINE_BREAK) tag for this.

Examples

The following example shows how to use the <LINE> tag in a list.

#1

<LIST>(NUMBERED) 
<le>ITEM 
<LINE>This item specifies...

This example produces the following output:

ITEM
This item specifies ...

The following example shows how to use the <LINE> tag to create an indented line with a small skip.

#2

<P>This is a normal paragraph. 
<line>(INDENT\1\SMALLSKIP) 
This is a block paragraph, indented with a small skip.

This example produces the following output:
This is a normal paragraph.
This is a block paragraph, indented with a small skip.
The following example shows the misuse of the <LINE> tag for formatting within a paragraph.

#3

<P>Elaborate designs are inappropriate for software manuals or for 
any serious or formal books because they do not reflect the 
intention of the writer. The purpose of any book design is<LINE> 
to clarify what the author is conveying, to translate the text 
attractively as print on a page, to communicate the message 
visually in harmony with the ideas.

Although the correct output may result on a given output device for a particular run of a file, the output may also be formatted incorrectly, as follows:
Elaborate designs are inappropriate for software manuals or for any serious or formal books because they do not reflect the intention of the writer. The purpose of any book design is
to clarify what the author is conveying, to translate the text attractively as print on a page, to communicate the message visually in harmony with the ideas.
The following example shows how to use the <LINE> tag in a three-column table.

#4

<TABLE>(Card Reader Errors: Causes and Corrective Actions\cardread_tab) 
<TABLE_ATTRIBUTES>(wide\multipage) 
<TABLE_SETUP>(3\12\21) 
<TABLE_HEADS>(Error\Causes\Corrective Action) 
<TABLE_ROW>(READ CHECK\Card edges torn <LINE> Punch in column 0 
or 81\Remove the faulty card from the output stacker, duplicate the card, place 
it in the input hopper, and press the <EMPHASIS>(RESET\bold) button.) 
<TABLE_ROW_BREAK>(FIRST) 
<TABLE_ROW>(PICK CHECK\Damage to leading edge <LINE> Torn webs 
<LINE> Cards 
stapled together\Remove the card from the input hopper, duplicate 
the faulty card, place the card back in the input 
hopper, and press the <EMPHASIS>(RESET\bold) button.) 
<TABLE_ROW_BREAK>(LAST) 
<TABLE_ROW>(STACK CHECK\Jam in the card track <LINE> Badly mutilated card 
\Correct the jam and/or remove the mutilated card from the output stacker, 
duplicate the card, place it in the input hopper, and press the 
<EMPHASIS>(RESET\bold) button.) 
<TABLE_ROW>(HOPPER CHECK\Input hopper empty <LINE> Output stacker full\Load 
the input hopper. <LINE> Unload the output stacker.) 
<ENDTABLE>

This example produces the following output:
Table n--n: Card Reader Errors: Causes and Corrective Actions

Error Causes Corrective Action

READ CHECK Card edges torn
Punch in column 0 or 81 Remove the faulty card from the output stacker, duplicate the card, place it in the input hopper, and press the RESET button.

PICK CHECK Damage to leading edge
Torn webs
Cards stapled together Remove the card from the input hopper, duplicate the faulty card, place the card back in the input hopper, and press the RESET button.

STACK CHECK Jam in the card track
Badly mutilated card Correct the jam and/or remove the mutilated card from the output stacker, duplicate the card, place it in the input hopper, and press the RESET button.

HOPPER CHECK Input hopper empty
Output stacker full Load the input hopper.
Unload the output stacker.

The following example shows how to use the <LINE> tag in the context of a <FORMAT> tag.

Error	Causes	Corrective Action
READ CHECK	Card edges torn Punch in column 0 or 81	Remove the faulty card from the output stacker, duplicate the card, place it in the input hopper, and press the RESET button.
PICK CHECK	Damage to leading edge Torn webs Cards stapled together	Remove the card from the input hopper, duplicate the faulty card, place the card back in the input hopper, and press the RESET button.
STACK CHECK	Jam in the card track Badly mutilated card	Correct the jam and/or remove the mutilated card from the output stacker, duplicate the card, place it in the input hopper, and press the RESET button.
HOPPER CHECK	Input hopper empty Output stacker full	Load the input hopper. Unload the output stacker.

#5

<FORMAT>(MY COMMAND) 
<FCMD>( ) 
<FPARMS>(one parameter<line>two<line>three) 
<ENDFORMAT>

This example produces the following output:

MY COMMAND

one parameter
two
three

<LINE_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.

Format

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

ARGUMENTS

KEEP
This is an optional keyword argument. It specifies that the line art not be broken across pages; that is, if the line art does not fit on the current page, it will be placed on the next page. If the line art itself does not fit on a single page of output, it will be broken anyway. This keyword has no effect for Bookreader output.
WIDE
This is an optional keyword argument. It specifies that the width of the line art exceeds the document's default width for text. Depending on the doctype, this argument is interpreted as follows:

If the doctype contains a left margin area that is normally used for headings, the line art's width spans that area as well as the normal text area.
If the document uses a multicolumn format, the line art suspends the multicolumn output while it is being processed. The line art is then output, and then multicolumn output is restored.
Depending on the doctype, this argument provides a range of font sizes and font styles for line art.

MAXIMUM
This is an optional keyword argument. It specifies that the text of the code example is adjusted to a smaller point size in order to fit within the boundaries of the left and right margins of the page. You can use this keyword in conjunction with WIDE to indicate that the example may require additional adjustment to fit within the boundaries of the page. You should use this keyword with discretion, and it may not be suitable in all doctypes.

Note
You can use the KEEP, WIDE, and MAXIMUM keywords together or separately and in any order in the argument list.

related tags

<FIGURE>
<VALID_BREAK>

required terminator

<ENDLINE_ART>

DESCRIPTION

The <LINE_ART> tag labels a rough sketch produced at the terminal keyboard for draft output, to give some idea of what the final figure will look like.
Note that the results of keyboard drawing may be adequate for draft purposes, but may not be acceptable for laser printer output.
When you print an informal or formal figure (within which is the line art) or process an informal figure for Bookreader display, the figure is indented in the same way the regular text is for the particular doctype you are using.

Example

See the first example in the discussion of the <FIGURE> tag.

<LIST>

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

Format

<LIST> (keyword[\attribute-1 [\attribute-2]])

ARGUMENTS

KEYWORD
Specifies the type of list. The following keywords indicate the type of list.

ALPHABETIC The list element identifiers are alphabetic letters.

CALLOUT The list element identifiers are reverse-print callout numbers (on supported output devices), for example (5) .

NUMBERED The list element identifiers are Arabic numerals.

ROMAN The list element identifiers are Roman numerals.

SIMPLE There are no list element identifiers.

STACKED Individual list elements do not have identifiers, but the entire list is stacked within the specified set of delimiters (braces, brackets, double brackets, single or double vertical rules).

UNNUMBERED List element identifiers are special characters.

ATTRIBUTES
This is an optional argument. It specifies the attributes of the list element keywords. You can specify more than one attribute.

BRACES
BRACKETS
DOUBLE_BRACKETS
DOUBLE_VERTICAL_RULE
VERTICAL_RULE For a STACKED list. Each attribute for a STACKED list specifies the delimiter to be used to surround the stacked elements. If you do not specify a keyword, list elements are stacked without a surrounding delimiter.

char For an UNNUMBERED list. Specifies a single character or a tag that results in a single printed character of output that is used to indicate list elements. If you do not specify char, the bullet character is used.

start-letter For an ALPHABETIC list. Specifies the alphabetic letter to use for the first item in the sequence. Subsequent items are automatically incremented.

start-number For a NUMBERED or ROMAN list. Specifies the number to be assigned to the first list element. Subsequent list elements are automatically incremented.

UPPERCASE For an ALPHABETIC or ROMAN list. Specifies that the list element identifiers (alphabetic letters or Roman numerals) be printed in uppercase. By default, Alphabetic and Roman list element identifiers are printed in lowercase.

related tags

<ALIGN_AFTER>
<ALIGN_CHAR>
<LE>

restrictions

Valid only in the context of a <P> or a <TABLE> tag.
You can nest <LIST> tags that use the following keywords: ALPHABETIC, NUMBERED, ROMAN, SIMPLE, or UNNUMBERED. (Nesting a list means that an element of a list may itself contain the beginning of another list.) None of these list types are compatible with the <LIST>(STACKED) tag.

required terminator

<ENDLIST>

DESCRIPTION

The <LIST> tag begins a list. You specify the type of list by using a keyword argument to the tag.
The <LIST>(ALPHABETIC), <LIST>(NUMBERED), and <LIST>(ROMAN) tags begin a list whose elements have a particular sequence or priority. The <LIST>(SIMPLE) or <LIST>(UNNUMBERED) tags begin a list that has no inherent order or priority. Alphabetic lists are useful when nested within numbered lists. Use a numbered list to indicate a particular sequence or priority within the list elements.
The <LIST>(SIMPLE) tag labels a simple list with no enumerator or special character preceding each list element. It terminates the current paragraph and indents the list, so that the list is seen as a separate entity from the text above and below it.
The <LIST>(UNNUMBERED) tag labels a list that has no particular order or priority within the list element. Normally a bullet is the character used before each list element. You can specify another character by using it as the second argument to the <LIST>(UNNUMBERED) tag; for example, <LIST>(UNNUMBERED\+).
Use the <LIST>(STACKED) tag to begin a list whose elements are left-justified on successive lines. The block of text can have large braces or brackets placed on each side. The block of text is then centered vertically so that it aligns with text to the left or right on the same line. The <LIST>(STACKED) tag is especially useful for showing syntactic elements with a <FORMAT> tag.

Examples

The following is an example of nested lists. The first nested list has no particular sequence. The order of the second nested list is reflected in the use of the <LIST>(ALPHABETIC) tag.

#1

<LIST>(NUMBERED) 
<LE>Review the document 
<LE>Find out these numbers: 
     <LIST>(UNNUMBERED) 
     <LE>number of copies 
     <LE>department number 
     <LE>order number 
     <ENDLIST>
<LE>For revisions of documents not already in the library, have 
the writer rename the file according to its new order number. 
<LE>Open a library for the book if none exists. 
     <LIST>(ALPHABETIC) 
     <LE>Decide with the writer about timing: 
          <LIST>(UNNUMBERED) 
          <LE>Must be done before final production. 
          <LE>Should not be done until text is stable. 
          <ENDLIST>
     <LE>Cooperate with the business department on paperwork. 
     <LE>Help writers name new element files correctly. 
     <LE>Verify that all files are of the same file type. 
     <LE>For a revision, be sure files are renamed with the new file name. 
     <ENDLIST>
<ENDLIST>

This example produces the following output:

Review the document
Find out these numbers:

number of copies
department number
order number

For revisions of documents not already in the library, have the writer rename the file according to its new order number.
Open a library for the book if none exists.

Decide with the writer about timing:

Must be done before final production.
Should not be done until text is stable.

Cooperate with the business department on paperwork.
Help writers name new element files correctly.
Verify that all files are of the same file type.
For a revision, be sure files are renamed using the new file name.
The following is an example of an alphabetic list that begins with the letter "e".

#2

<P>Items e and f describe the $GETJPI AST activity: 
<LIST>(ALPHABETIC\e) 
<LE>An ACB is constructed for a special kernel AST. 
<LE>When the special kernel mode AST routine executes in the context of 
the target process, the requested information is moved into the system buffer. 
The ACB is then reset to deliver a special kernel mode AST back to the 
requesting process. 
<ENDLIST>

This example produces the following output:
Items e and f describe the $GETJPI AST activity:

An ACB is constructed for a special kernel AST.
When the special kernel mode AST routine executes in the context of the target process, the requested information is moved into the system buffer. The ACB is then reset to deliver a special kernel mode AST back to the requesting process.

The following is an example of a list with callouts.

#3

<P>At this point, you can log in to the system as the system manager 
by performing the following steps at the console terminal: 
<LIST>(CALLOUT) 
<LE>Press RETURN. 
<LE>In response to the system's request for your user name, type SYSTEM. 
<LE>In response to the system's request for your password, type MANAGER. 
<ENDLIST>

This example produces the following output:
At this point, you can log in to the system as the system manager by performing the following steps at the console terminal:

Press RETURN.
In response to the system's request for your user name, type SYSTEM.
(3) In response to the system's request for your password, type MANAGER.

The following is an example of a numbered list.

#4

<P>At this point, you can log in to the system as the system manager 
by performing the following steps at the console terminal: 
<LIST>(NUMBERED) 
<LE>Press RETURN. 
<LE>In response to the system's request for your user name, type SYSTEM. 
<LE>In response to the system's request for your password, type MANAGER. 
<ENDLIST>

This example produces the following output:
At this point, you can log in to the system as the system manager by performing the following steps at the console terminal:

Press RETURN.
In response to the system's request for your user name, type SYSTEM.
In response to the system's request for your password, type MANAGER.

The following is an example of a numbered list that begins with the number "6".

#5

<P>Items six and seven describe two main principles of a generic 
markup language: 
<LIST>(NUMBERED\6) 
<LE>Descriptive markup predominates and is distinguished from processing 
instructions. 
<LE>Markup is formally defined for each type of document. 
<ENDLIST>

This example produces the following output:
Items six and seven describe two main principles of a generic markup language:

Descriptive markup predominates and is distinguished from processing instructions.
Markup is formally defined for each type of document.

The following is an example of a list that begins with the Roman numeral "iv".

#6

<P>Items six and seven describe two main principles of a generic 
markup language: 
<LIST>(ROMAN\4) 
<LE>Descriptive markup predominates and is distinguished from processing 
instructions. 
<LE>Markup is formally defined for each type of document. 
<ENDLIST>

This example produces the following output:
Items six and seven describe two main principles of a generic markup language:

Descriptive markup predominates and is distinguished from processing instructions.
Markup is formally defined for each type of document.

The following is an example of a simple list.

#7

<P>The following items are needed: 
<LIST>(SIMPLE) 
<LE>bread 
<LE>milk 
<LE>cheese 
<LE>cereal 
<LE>fruit 
<ENDLIST>

This example produces the following output:
The following items are needed:

bread
milk
cheese
cereal
fruit

The following is an example of two stacked lists with braces around the list elements. The tags are indented to help in visually checking the matching of the <LIST>(STACKED) and <ENDLIST> tags. This indentation has no effect on the output, however.

#8

<P>
ON <LIST>(stacked\braces) 
      <LE>ANYCONDITION 
      <LE>ENDFILE(reference) 
      <LE>ENDPAGE(reference) 
      <LE>FINISH 
      <LE>KEY(reference) 
      <LE>UNDEFINEDFILE(reference) 
      <LE>ERROR 
      <LE>FIXEDOVERFLOW 
      <LE>OVERFLOW 
      <LE>UNDERFLOW 
      <LE>VAXCONDITION(expression) 
      <LE>ZERODIVIDE 
   <ENDLIST>
 
   <LIST>(stacked\braces) 
      <LE>statement 
      <LE>begin-block 
   <ENDLIST>

This example produces the following output:
ON

ANYCONDITION
ENDFILE(reference)
ENDPAGE(reference)
FINISH
KEY(reference)
UNDEFINEDFILE(reference)
ERROR
FIXEDOVERFLOW
OVERFLOW
UNDERFLOW
VAXCONDITION(expression)
ZERODIVIDE

statement
begin-block

The following is an example of nested and stacked lists with brackets.

#9

<P>
OPEN FILE (reference) [TITLE(expression)] 
<P>
<LIST>(stacked\brackets) 
       <LE>[STREAM] <LIST>(stacked\brackets) 
                             <LE>[INPUT] 
                             <LE>OUTPUT [LINESIZE] [PRINT [PAGESIZE(integer)] ] 
                    <ENDLIST>
       <LE>RECORD <LIST>(stacked\brackets) 
                             <LE>[INPUT] 
                             <LE>OUTPUT 
                             <LE>UPDATE 
                  <ENDLIST>
                          <LIST>(stacked\brackets) 
                             <LE>DIRECT 
                             <LE>[SEQ[UENTIAL]] 
                          <ENDLIST>
                           [KEYED] 
        <ENDLIST>

This example produces the following output:
OPEN FILE (reference) [TITLE(expression)]

[STREAM]
[INPUT]
OUTPUT [LINESIZE] [PRINT [PAGESIZE(integer)] ]

RECORD
[INPUT]
OUTPUT
UPDATE

DIRECT
[SEQ[UENTIAL]]
[KEYED]

Previous Next Contents Index

ALPHABETIC	The list element identifiers are alphabetic letters.
CALLOUT	The list element identifiers are reverse-print callout numbers (on supported output devices), for example (5) .
NUMBERED	The list element identifiers are Arabic numerals.
ROMAN	The list element identifiers are Roman numerals.
SIMPLE	There are no list element identifiers.
STACKED	Individual list elements do not have identifiers, but the entire list is stacked within the specified set of delimiters (braces, brackets, double brackets, single or double vertical rules).
UNNUMBERED	List element identifiers are special characters.

BRACES BRACKETS DOUBLE_BRACKETS DOUBLE_VERTICAL_RULE VERTICAL_RULE	For a STACKED list. Each attribute for a STACKED list specifies the delimiter to be used to surround the stacked elements. If you do not specify a keyword, list elements are stacked without a surrounding delimiter.
char	For an UNNUMBERED list. Specifies a single character or a tag that results in a single printed character of output that is used to indicate list elements. If you do not specify char, the bullet character is used.
start-letter	For an ALPHABETIC list. Specifies the alphabetic letter to use for the first item in the sequence. Subsequent items are automatically incremented.
start-number	For a NUMBERED or ROMAN list. Specifies the number to be assigned to the first list element. Subsequent list elements are automatically incremented.
UPPERCASE	For an ALPHABETIC or ROMAN list. Specifies that the list element identifiers (alphabetic letters or Roman numerals) be printed in uppercase. By default, Alphabetic and Roman list element identifiers are printed in lowercase.

DECdocumentUsing Global Tags

<LE>

Format

<LE> [(callout number)]

ARGUMENTS

callout number

related tags

restrictions

DESCRIPTION

Examples

<LINE>

Format

<LINE> [( INDENT [ \unit number] BIGSKIP SMALLSKIP)]

ARGUMENTS

INDENT

unit number

BIGSKIP

SMALLSKIP

related tags

restrictions

DESCRIPTION

Examples

MY COMMAND

one parameter two three

<LINE_ART>

Format

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

ARGUMENTS

KEEP

WIDE

MAXIMUM

related tags

required terminator

DESCRIPTION

Example

<LIST>

Format

<LIST> (keyword[\attribute-1 [\attribute-2]])

ARGUMENTS

KEYWORD

ATTRIBUTES

related tags

restrictions

required terminator

DESCRIPTION

Examples

DECdocument
Using Global Tags

<LINE> [(

INDENT [ \unit number]
BIGSKIP
SMALLSKIP
)]

one parameter
two
three