DECdocument
Using Doctypes and Related Tags
Volume 1
Previous Contents Index

<OUTLINE>

Begins an outline and specifies a title for the outline.

Syntax

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

ARGUMENTS

title line-n

This is an optional argument. It specifies a title line. You can specify up to three title lines.

related tags

required terminator

<ENDOUTLINE>

DESCRIPTION

The <OUTLINE> tag begins an outline and specifies a title for the outline. An outline is a hierarchical list of numbered elements in which the hierarchy is conveyed to the reader through the letter or number on each outline entry and the indentation level. The <OUTLINE> tag begins an outline that permits up to six levels in the hierarchy. At the top level, level 1, the outline entries are marked with uppercase Roman numerals. At the lowest level, level 6, the outline entries are marked with lowercase letters enclosed in parentheses. The top level formats at the current left margin; each lower level indents from the level above it. If you supply one or more title lines as arguments to the <OUTLINE> tag, the lines center above the outline. You may want to add emphasis to some or all of the title lines. The outline usually aligns at the left margin of the text, but you can embed it in other tags---for example, after an <LE> tag, in which case the outline aligns with other list elements. Likewise, you can embed other tags in the outline, so that text or sublists can be interspersed with the outline entries. An outline does not affect heading levels established with any of the heading tags (<HEAD1>, <HEAD2>, and so on). Outline entries do not appear in the table of contents.

Example

The following example illustrates an outline created using the <OUTLINE> tag and the tags it enables. Note how you indent the <LEVEL> tags in the SDML file to make the file easier to read and more maintainable. This indentation in the SDML file has no effect on the output, which indents automatically according to the level specified in the <LEVEL> tags. 

<OUTLINE>(<EMPHASIS>(Maxillary Taxonomy)\An Enumeration of the 
Maxillae\from a Dentition Perspective) 
<LEVEL>(1\Historical introduction) 
<LEVEL>(1\Dentition in various groups of vertebrates) 
 <LEVEL>(2\Reptilia) 
  <LEVEL>(3\Histology and development of reptile teeth) 
  <LEVEL>(4\Survey of forms) 
 <LEVEL>(2\Mammalia) 
  <LEVEL>(3\Histology and development of mammalian teeth) 
  <LEVEL>(3\Survey of forms) 
   <LEVEL>(4\Primates) 
    <LEVEL>(5\Lemuroidea) 
    <LEVEL>(5\Anthropoidea) 
     <LEVEL>(6\Platyrrhini) 
     <LEVEL>(6\Catarrhini) 
   <LEVEL>(4\Carnivora) 
    <LEVEL>(5\Creodonta) 
    <LEVEL>(5\Fissipedia) 
     <LEVEL>(6\Aeluroidea) 
     <LEVEL>(6\Arctoidea) 
    <LEVEL>(5\Pinnipedia) 
   <LEVEL>(4\Etc<hellipsis>) 
<ENDOUTLINE>

<RUNNING_FEET>

Creates a single line heading at the bottom of each page.

Syntax

<RUNNING_FEET> (title text)

ARGUMENTS

title text

Specifies the text for the running feet.

related tags

DESCRIPTION

The <RUNNING_FEET> tag creates a single line heading at the bottom of each page. This heading is called a footer because it appears at the foot of the page. When the same footer runs for several pages, the footers are collectively called running feet. This tag accepts one argument, which is the text that should appear at the bottom of the page. This text is output exactly as entered, including spacing and capitalization. Use the <RUNNING_TITLE> tag to create a heading at the top of the page. Note that you can override headings established by the <RUNNING_FEET> and <RUNNING_TITLE> tags by a subsequent use of the <CHAPTER> tag or <SECTION> tag.

Example

The following example shows how to use the <RUNNING_FEET> tag to place the footer Getting the Piece of Paper at the bottom of each page. The running footer will be output exactly as entered. 

<RUNNING_FEET>(Getting the Piece of Paper) 
<CHEAD>(Getting the Piece of Paper) 
<p> 
You can buy clean paper in most major supermarkets, department stores, 
and hardware stores.  You should try to get ruled paper so that 
your letter will be neat and easy to read.

<RUNNING_TITLE>

Creates a 1- or 2-line running heading at the top of each page.

Syntax

<RUNNING_TITLE> (
  • OFF
  • title-1 [\title-2]
  • [\FIRST_PAGE]
)

ARGUMENTS

OFF

Specifies that any existing running titles created using the <RUNNING_TITLE> tag are disabled for the page on which this tag occurs and on any subsequent pages.

title-1

Specifies the text of a running title. If you specify a 2-line title, this title outputs on the upper title line.

title-2

This is an optional argument. It specifies the bottom line of a running title that has two lines.

FIRST_PAGE

This is an optional argument. It specifies that the running title is to be placed on the first output page. If you do not specify this keyword, the running title outputs on the page after the current page.

related tags

DESCRIPTION

The <RUNNING_TITLE> tag creates a 1- or 2-line running heading at the top of each page. Use the FIRST_PAGE argument to the <RUNNING_TITLE> tag to begin the title lines on the first page of output, rather than on the page after the current page, as is the default. Use the OFF argument to disable any existing running titles created using the <RUNNING_TITLE> tag. These titles are then disabled for the page on which this tag occurs and on any subsequent pages. Use the <RUNNING_FEET> tag to create a heading that appears at the bottom of the page. See the <RUNNING_FEET> tag in this chapter for more information. Override headings established by the <RUNNING_TITLE> and <RUNNING_FEET> tags by a subsequent use of the <CHAPTER> tag.

Examples

The following example shows how to use the <RUNNING_TITLE> tag to create the 2-line running title An E. B. Bartz Course: Writing Quality Correspondence. Note that because you use the FIRST_PAGE argument, the 2-line running title appears at the top of the first page.
#1 

<RUNNING_TITLE>(An E. B. Bartz Course:\Writing Quality 
Correspondence\FIRST_PAGE) 
<HEAD>(How to Write a Letter\32_HowtoWriteaLetter) 
<P> 
The first thing that you should do in writing a letter is to get 
a clean piece of paper and a well-sharpened pencil.

The following example shows how you can disable a running title by using the OFF argument to the <RUNNING_TITLE> tag.

#2 

<COMMENT>(turn off running titles for the following example page) 
<RUNNING_TITLE>(OFF) 
<HEAD>(An Example of a Letter\33_AnExampleofaLetter) 
. 
. 
.

<SECTION>

Begins a new page and creates a major heading at the left margin of that page.

Syntax

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

ARGUMENTS

heading text

Specifies the text of the section heading.

symbol name

This is an optional argument. It specifies the name of the symbol used in all references to this heading.

Symbol names must not exceed 31 characters and must only contain alphabetic letters, numbers, or underscores. Do not begin a symbol name with an underscore.

related tags

DESCRIPTION

The <SECTION> tag begins a new page and creates a major heading at the left margin of that page. It is one of the three REPORT doctype-specific tags that create unnumbered headings. The other tags that produce unnumbered headings, the global <HEAD> tag and the global <CHEAD> tag, do not begin a new page of output.

Example

The following example shows how to use the <SECTION> tag to begin a new page and place an unnumbered heading on that page. Note that this sample omits the symbol name argument to the <SECTION> tag, because the writer will not be referencing this section. 

<SECTION>(Writing Personal Correspondence) 
<P> 
Writing personal correspondence is more fun and less formal than 
writing business correspondence, but many of the same rules apply. 
<HEAD>(How to Write a Letter\34_HowtoWriteaLetter) 
<P> 
The first thing that you should do in writing a letter is to get a 
clean piece of paper and a well-sharpened pencil.

<SHOW_LEVELS>

Emphasizes text in an outline.

Syntax

<SHOW_LEVELS> (
  • BOLD
  • ITALIC
  • OFF
)

ARGUMENTS

BOLD

Specifies that the entry text arguments given to all subsequent <LEVEL> tags output in a bold typeface.

ITALIC

Specifies that the entry text arguments given to all subsequent <LEVEL> tags output in an italic typeface.

OFF

Specifies that the entry text arguments given to all subsequent <LEVEL> tags output in the standard typeface; this is the default.

related tags

restrictions

Valid only in the context of an <OUTLINE> tag.

DESCRIPTION

The <SHOW_LEVELS> tag emphasizes text in an outline. The text emphasized is the text associated with one or more <LEVEL> tags. Such text outputs in a bold typeface if you use the BOLD argument, or in an italic typeface if you use the ITALIC argument. The OFF argument disables the bolding or italicizing of the text used as an argument to the <LEVEL> tag. If you do not use the <SHOW_LEVELS> tag, or if you specify the OFF argument, the standard typeface is used in the outline. See the <LEVEL> tag description in this chapter for more information on the <LEVEL> tag.

Example

The following example shows an outline that uses the <SHOW_LEVELS> tag.

The entry text is italicized using the <SHOW_LEVELS>(ITALIC) tag beginning with the second-level entry Mammalia through the fourth-level entry Primates. The italicized text is then turned off using the OFF argument to the <SHOW_LEVELS> tag. 


<OUTLINE>(<EMPHASIS>(Maxillary Taxonomy)\An Enumeration of the 
Maxillae\from a Dentition Perspective) 
<LEVEL>(1\Historical introduction) 
<LEVEL>(1\Dentition in various groups of vertebrates) 
 <LEVEL>(2\Reptilia) 
  <LEVEL>(3\Histology and development of reptile teeth) 
  <LEVEL>(4\Survey of forms) 
 
         <COMMENT>(**Italicize the information covered on this weeks test**) 
         <SHOW_LEVELS>(ITALIC) 
 
 <LEVEL>(2\Mammalia) 
  <LEVEL>(3\Histology and development of mammalian teeth) 
  <LEVEL>(3\Survey of forms) 
   <LEVEL>(4\Primates) 
 
         <COMMENT>(**turn off italicization**) 
         <SHOW_LEVELS>(OFF) 
 
    <LEVEL>(5\Lemuroidea) 
    <LEVEL>(5\Anthropoidea) 
     <LEVEL>(6\Platyrrhini) 
     <LEVEL>(6\Catarrhini) 
   <LEVEL>(4\Carnivora) 
    <LEVEL>(5\Creodonta) 
    <LEVEL>(5\Fissipedia) 
     <LEVEL>(6\Aeluroidea) 
     <LEVEL>(6\Arctoidea) 
    <LEVEL>(5\Pinnipedia) 
   <LEVEL>(4\Etc<hellipsis>) 
<ENDOUTLINE>

<SIGNATURES>

Begins a list of signatures that appear in the front matter of a document.

Syntax

<SIGNATURES> [(NEWPAGE)]

ARGUMENTS

NEWPAGE

This is an optional argument. It specifies that the signature list begins on a new page.

related tags

restrictions

Valid only following the global <FRONT_MATTER> tag.

DESCRIPTION

The <SIGNATURES> tag begins a list of signatures that appear in the front matter of a document. You list each person's name by using the <BYLINE> tag following the <SIGNATURES> tag. The <BYLINE> tag places the name of the person, and additional information about that person (such as their title or affiliation), below a line on which the person is to sign. See the reference description of the <BYLINE> tag for more information on that tag.

Example

The following example shows the <SIGNATURES> tag beginning a list of signature lines. Note how the <BYLINE> tag is used to create each signature line. 

<FRONT_MATTER> 
<TITLE_PAGE> 
<TITLE>(The NYUC Simulator Reference Manual) 
<REVISION_INFO>(This revision is personally signed.) 
<AUTHOR>(Dr. Julian Jones\Research Head, STG Inc.) 
<SIGNATURES> 
<BYLINE>(Julian Jones\Author) 
<BYLINE>(Cecil Mills\Co-author) 
<ENDTITLE_PAGE> 
<ENDFRONT_MATTER>

Index Contents