DECdocument
Using Global Tags

<FINAL_CLEANUP>

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

Format

<FINAL_CLEANUP> (

COLUMN_BREAK
LINE_BREAK
PAGE_BREAK
SPECIAL_BREAK
)

ARGUMENTS

COLUMN_BREAK
Specifies that a new column of text be started at the place where the <FINAL_CLEANUP> tag occurs. This argument is only valid in a two-column doctype: the ARTICLE or REPORT.TWOCOL doctypes, described in Using Doctypes and Related Tags.
LINE_BREAK
Specifies that the following text begin a new line of output.
PAGE_BREAK
Specifies that the following text begin a new page of output.
SPECIAL_BREAK
Specifies a special break when vertical spacing appears to be lost. In some circumstances, the output of a two-column page may have had some of its vertical spacing lost due to the text formatter processing; for example, a heading tag may not have any space before it. You can correct this by placing the <FINAL_CLEANUP>(SPECIAL_BREAK) tag in your file between the words that are ouput on the final line of the first column.
Use the SPECIAL_BREAK argument only if there is a spacing problem and only after you are ready to give your document a final format check, because changes to the source file may help the text formatter resolve the spacing problem.

related tags

<COLUMN> --- In the ARTICLE and REPORT.TWOCOL doctypes, described in Using Doctypes and Related Tags.
<LINE>
<PAGE>

restrictions

Should be used only for final production formatting.
If you use the <FINAL_CLEANUP>(PAGE_BREAK) tag in a table to force a page break, the table headings are not repeated on the page after the break. You must repeat the <TABLE_HEADS> tag immediately after the <FINAL_CLEANUP>(PAGE_BREAK) tag to restore the default table headings. Headings are repeated on each page of a table only when DOCUMENT is allowed to break the table across pages.
In doctypes with right-justified text (that is, text aligned against the right margin), the <FINAL_CLEANUP>(LINE_BREAK) tag must be on the same line of the text you want broken.

DESCRIPTION

The <FINAL_CLEANUP> tag provides explicit formatting instructions to the text formatter to be used for final formatting and clean up. The <FINAL_CLEANUP> tag is not a generic markup tag; it explicitly instructs the text formatter to change aspects of the page makeup.
In a single-column doctype, the <FINAL_CLEANUP> tag enables you to specify line breaks and page breaks using the LINE_BREAK and PAGE_BREAK arguments. In a two-column doctype, you can use the COLUMN_BREAK argument to start a new column of text. Use the SPECIAL_BREAK argument only rarely at the final stage of production to affect the final format of your document.
When you are working with the ARTICLE or REPORT.TWOCOL doctypes, you may need to make some final adjustments when your text is complete. The text formatter makes formatting decisions based on your source file. It is more difficult for the text formatter to create a well-formatted two-column page than a well-formatted one-column page. Therefore, the output of these doctypes may need additional attention, using the <FINAL_CLEANUP> tag, during the last stage of production.
Using the <FINAL_CLEANUP> tag has no effect for Bookreader output.

EXAMPLES

The following example shows how final production might use the <FINAL_CLEANUP>(LINE_BREAK) tag in the front matter of a book to make it look better.

#1

<FRONT_MATTER>(front) 
   .
   .
   .
<REVISION_INFO>(Revision/Update Information:\This revised manual 
supersedes the 
<final_cleanup>(line_break) 
<emphasis>(User Manual, Volume 1 Version 1.1) 
<oparen>Order Number AA--JT84B--TE<cparen>.) 
   .
   .
   .

The following example shows how final production might use the <FINAL_CLEANUP>(PAGE_BREAK) tag, because the information in these specific headings might look better or fit better on separate pages.

#2

<HEAD1>(Survey Results)
   .
   .
   .
<FINAL_CLEANUP>(page_break)
<HEAD2>(Brand X)
   .
   .
   .

<FOOTNOTE>

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.

Format

<FOOTNOTE> (char\footnote text)

ARGUMENTS

char
Specifies the footnote character. The character can be a single character, a number, or one of the following keywords denoting special characters associated with footnote references:

DAG (+)
DDAG (++)
R (®)
S (§)
TM (^tm)

When placing a footnote in a table, you must use a number or one of the keywords as the footnote character.
If you use more than one of the keywords allowed for table footnotes, you should declare them in the following order to ensure that the footnotes print in the correct order at the bottom of the page or in the pop-up window for Bookreader output:

TM
R
S
DAG
DDAG

footnote text
Specifies the text of the footnote.

related tags

<FOOTNOTE_TEXT>
<FOOTREF>

restrictions

Invalid in the context of a <MATH> tag.
The following restrictions apply to footnotes in text:

Do not place the following tags within an argument to the <FOOTNOTE> tag: <CODE_EXAMPLE>, <EXAMPLE>, <FIGURE>, <HEADN>, <MATH>, <NOTE>, or <TABLE>.
Do not place more than four footnotes within a stacked list or a monospaced example.

The following restrictions apply to footnotes in a table:

Use the <FOOTNOTE> and <FOOTREF> tag combination in a table. It is the <FOOTREF> tag that causes the footnote character to appear. Place the <FOOTREF> tag in the argument to the <TABLE_ROW> tag at the end of the argument you want to footnote.
Declare all table footnotes at the top of the table using a <FOOTNOTE> tag just after the <TABLE_SETUP> tag. Do not specify <FOOTNOTE> tags in a nested table.
Do not specify more than twelve footnotes in a table. If you use a nonnumeric footnote character, there can be no more than seven numeric footnotes.
Footnotes in the body of a multipage table appear at the bottom of a page only if they are called out on that page.
Footnotes called out in the heading of a multipage table appear at the bottom of each page of the table.

DESCRIPTION

The <FOOTNOTE> tag creates a footnote in text and tables. In text, this tag specifies the footnote character, which appears in the text at the place where the tag is located, and footnote text. The footnote text appears at the bottom of the page or in a pop-up window for Bookreader output (once you click on the superscript footnote reference, which is a hotspot). 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 for both printed and Bookreader output.
For footnotes in a heading, on a copyright page, or on a title page, use the <FOOTNOTE_TEXT> and <FOOTREF> tag combination. See the <FOOTNOTE_TEXT> and <FOOTREF> tag descriptions for more information.

Examples

The following example shows how to place a footnote in text.

#1

<P>The <TAG>(footnote) tag produces output that looks like 
this.<FOOTNOTE>(1\Note how 
footnote text appears at the bottom of the page or in a pop-up window for 
Bookreader output.)

This example produces the following output:
The <FOOTNOTE> tag produces output that looks like this.¹
The following example shows how to use a footnote in a table.

#2

<TABLE>(Rules for Determining Expression Modes\express_modes_tab) 
  <TABLE_ATTRIBUTES>(MULTIPAGE) 
  <TABLE_SETUP>(2\15) 
  <FOOTNOTE>(1\A footnote in a table.) 
  <TABLE_HEADS>(Expression\Value Type) 
  <TABLE_ROW>(Integer value\Integer) 
  <TABLE_ROW>(String value\String<FOOTREF>(1)) 
  <TABLE_ROW>(Integer lexical function\Integer) 
  <TABLE_ROW>(String lexical function\String) 
  <TABLE_ROW>(Integer symbol<FOOTREF>(1)\Integer) 
  <TABLE_ROW>(String symbol\String) 
  <TABLE_ROW>(Any value .AND. or .OR. any value\Integer) 
  <TABLE_ROW>(Any value\Integer) 
  <TABLE_ROW>(Any value\Integer) 
  <ENDTABLE>

This example produces the following output:
Table n--n: Rules for Determining Expression Modes

Expression Value Type

Integer value Integer

String value String¹

Integer lexical function Integer

String lexical function String

Integer symbol¹ Integer

String symbol String

Any value .AND. or .OR. any value Integer

Any value Integer

Any value Integer

¹A footnote in a table.

The following example shows how to use the <FOOTNOTE> and <FOOTREF> tags in text to produce multiple references to the same footnote.

Expression	Value Type
Integer value	Integer
String value	String¹
Integer lexical function	Integer
String lexical function	String
Integer symbol¹	Integer
String symbol	String
Any value .AND. or .OR. any value	Integer
Any value	Integer
Any value	Integer

#3

<P>The macro format for a $GETDVI request is:<FOOTNOTE>(1\The 
eighth (last) 
argument is not used; it is reserved for future use.) 
<CODE_EXAMPLE>
 $GETDVI [efn],[chan],[devnam],itmlst,[iosb],[astadr],[astprm] 
<ENDCODE_EXAMPLE>
<P>The high-level language format for a $GETDVI request is:<FOOTREF>(1) 
<CODE_EXAMPLE>
 SYS$GETDVI([efn],[chan],[devnam],itmlst<FOOTREF>(1),[iosb],[astadr],[astprm]) 
<ENDCODE_EXAMPLE>

This example produces the following output:
The macro format for a $GETDVI request is:¹
$GETDVI [efn],[chan],[devnam],itmlst,[iosb],[astadr],[astprm]
The high-level language format for a $GETDVI request is:¹
SYS$GETDVI([efn],[chan],[devnam],itmlst¹,[iosb],[astadr],[astprm])

Note

¹ Note how footnote text appears at the bottom of the page or in a pop-up window for Bookreader output.

¹ The eighth (last) argument is not used; it is reserved for future use.

<FOOTNOTE_TEXT>

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

Format

<FOOTNOTE_TEXT> (char\text)

ARGUMENTS

char
Specifies the footnote character. The character can be a single character or number, or it can be one of the following keywords denoting special characters associated with footnote references:

DAG (+)
DDAG (++)
R (®)
S (§)
TM (^tm)

text
Specifies the text associated with the footnote.

related tags

<FOOTNOTE>
<FOOTREF>
<SPECIAL_CHAR>

restrictions

Do not use the <FOOTNOTE_TEXT> tag for table footnotes; use the <FOOTNOTE> tag.
Must follow the related <FOOTREF> tag in the source file.
You must use the <SPECIAL_CHAR> tag to output a special character that you want to appear in the text argument to the <FOOTNOTE_TEXT> tag.

DESCRIPTION

The <FOOTNOTE_TEXT> tag specifies the text of a footnote in a heading, copyright page, or title page. The footnote text appears at the bottom of the page or in a pop-up window for Bookreader output. The <FOOTNOTE_TEXT> tag must follow the <FOOTREF> tag.
Use the <FOOTREF> tag to output a footnote in the argument to a <HEADN> tag and the <COMMAND_SECTION_HEAD> and <SUBCOMMAND_SECTION_HEAD> tags of the SOFTWARE doctype, and to output footnotes on a copyright page or a title page. In all other cases, you must use the <FOOTNOTE> tag.

Examples

The following example shows how you might use a footnote on the title page of a document.

#1

<FRONT_MATTER> 
<TITLE_PAGE> 
<TITLE>(Guide to Growing Premium Fruit Bearing Plants) 
 
<ABSTRACT>(July 1990) 
This document describes how to cultivate LEMON<FOOTREF>(TM) trees. 
<ENDABSTRACT> 
 
<FOOTNOTE_TEXT>(TM\LEMON is a trademark of Lemon Growers, Inc.) 
<ENDTITLE_PAGE>

The following example shows how to use the <FOOTNOTE_TEXT> and <FOOTREF> tags in a heading.

#2

<HEAD1>(Introduction to The News Today<footref>(TM)) 
<footnote_text>(TM\The News Today 
is a trademark of the American Television 
Society.)

This example produces the following output:
n.n Introduction to The News Today^tm

The following example shows how to use multiple arguments to the <FOOTREF> tag and how to use the <SPECIAL_CHAR> tag in footnote text.

#3

<HEAD1>(Using PostScript<FOOTREF>(1\2) Printers\ps_printers) 
<FOOTNOTE_TEXT>(1\PostScript <SPECIAL_CHAR>(TRADEMARK_SYMBOL) is a trademark 
of Adobe Systems, Inc.) 
<FOOTNOTE_TEXT>(2\For more information about Digital's printers . . . )

This example produces the following output:
n.n Using PostScript^1,2 Printers

Note

^tm The News Today is a trademark of the American Television Society.

¹ PostScript ^tm is a trademark of Adobe Systems, Inc.

² For more information about Digital's printers ...

<FOOTREF>

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.

Format

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

ARGUMENTS

char-1...9
Specifies up to nine characters for a footnote. A character can be a single character or number, or it can be one of the following keywords denoting special characters associated with footnote references:

DAG (+)
DDAG (++)
R (®)
S (§)
TM (^tm)

In a table, the reference must be to a number or to one of the special characters.

related tags

<FOOTNOTE>
<FOOTNOTE_TEXT>

restrictions

Invalid in the context of a <MATH> tag.
You can use only one <FOOTREF> tag per heading or your Bookreader bookbuild will fail.
If you want to generate a special character in the context of footnotes, use the <FOOTREF> tag. In other contexts, use the <SPECIAL_CHAR> tag, or you may encounter Bookreader bookbuilding problems.
When using this tag in an argument list, you must place the tag at the end of the argument you want to footnote; you cannot embed it in text. The end of an argument is indicated by a backslash (\) and the end of an argument list is indicated by a closing parenthesis ()).

DESCRIPTION

The <FOOTREF> tag creates a footnote character in a heading, copyright page, or title page. It is 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.
The <FOOTREF> tag causes as many as nine superscripted characters to appear where you place the tag in your file.
You must use the <FOOTREF> tag:

To specify footnotes in the argument to a <HEADN> tag and <COMMAND_SECTION_HEAD> and <SUBCOMMAND_SECTION_HEAD> tags of the SOFTWARE doctype
To specify footnotes on a copyright page and title page
To specify the same footnote in text more than once
To specify a footnote in a table

To footnote information in a heading, use a combination of two tags: <FOOTREF> and <FOOTNOTE_TEXT>. Place the <FOOTREF> tag in the argument to the heading to refer to the <FOOTNOTE_TEXT> tag. Place the <FOOTNOTE_TEXT> tag on the line directly following the <HEADN> tag.
For Bookreader output, you can use only one <FOOTREF> tag per heading. Also, the character or number that the <FOOTREF> tag produces is a hotspot.
To use a footnote in a table, use a combination of tags: <FOOTNOTE> and <FOOTREF>. Define the <FOOTNOTE> tag just after the <TABLE_SETUP> tag. Then use the <FOOTREF> tag to label the footnote references within the argument to a <TABLE_ROW> tag; do not define the footnote within a table row. The <FOOTREF> tag causes the text of the footnote to appear at the bottom of the table for both printed and Bookreader output. For a printed document, if the table is longer than a single page, and if the <FOOTREF> tag appears multiple times, the footnote text appears at the bottom of the table on each page containing the reference.
If you have a footnote in text that you want to refer to more than once, use a <FOOTNOTE> tag directly after the text to label the first occurrence of the footnote and the <FOOTREF> tag to label the subsequent references to that note. The <FOOTREF> tag always refers to the most recent occurrence of the <FOOTNOTE> tag that uses the same argument number or character.

Note
The text formatter does not automatically repeat text footnotes, except for multipage tables, if references are output on more than one page. You must reenter the footnote for it to appear on another page.

Examples

See the examples in the discussion of the <FOOTNOTE> and <FOOTNOTE_TEXT> tags.

<FORMAT>

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

Format

<FORMAT> [(

heading text [ \WIDE]
WIDE
)]

ARGUMENTS

heading text
This is an optional argument. It specifies a heading.
WIDE
This is an optional keyword argument. It specifies, for doctypes in which the left margin is indented, that the body of the formatted text be extended into the margin.

related tags

<FCMD>
<FPARM>
<FPARMS>

restrictions

Invalid in the context of <EXAMPLE>, <FIGURE>, <MATH>, and <TABLE> tags.

required terminator

<ENDFORMAT>

DESCRIPTION

The <FORMAT> tag enables the <FCMD>, <FPARM>, and <FPARMS> tags to distinguish formatted command keywords and parameters.

Example

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

Contents

Index

DECdocumentUsing Global Tags

<FINAL_CLEANUP>

Format

<FINAL_CLEANUP> ( COLUMN_BREAK LINE_BREAK PAGE_BREAK SPECIAL_BREAK)

ARGUMENTS

COLUMN_BREAK

LINE_BREAK

PAGE_BREAK

SPECIAL_BREAK

related tags

restrictions

DESCRIPTION

EXAMPLES

<FOOTNOTE>

Format

<FOOTNOTE> (char\footnote text)

ARGUMENTS

char

footnote text

related tags

restrictions

DESCRIPTION

Examples

¹ Note how footnote text appears at the bottom of the page or in a pop-up window for Bookreader output.

¹ The eighth (last) argument is not used; it is reserved for future use.

<FOOTNOTE_TEXT>

Format

<FOOTNOTE_TEXT> (char\text)

ARGUMENTS

char

text

related tags

restrictions

DESCRIPTION

Examples

tm The News Today is a trademark of the American Television Society.

¹ PostScript tm is a trademark of Adobe Systems, Inc.

² For more information about Digital's printers ...

<FOOTREF>

Format

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

ARGUMENTS

char-1...9

related tags

restrictions

DESCRIPTION

Examples

<FORMAT>

Format

<FORMAT> [( heading text [ \WIDE] WIDE)]

ARGUMENTS

heading text

WIDE

related tags

restrictions

required terminator

DESCRIPTION

Example

DECdocument
Using Global Tags

<FINAL_CLEANUP> (

COLUMN_BREAK
LINE_BREAK
PAGE_BREAK
SPECIAL_BREAK
)

^tm The News Today is a trademark of the American Television Society.

¹ PostScript ^tm is a trademark of Adobe Systems, Inc.

<FORMAT> [(

heading text [ \WIDE]
WIDE
)]