DECdocument
Using Doctypes and Related Tags
Volume 1


Previous Contents Index


Chapter 10
Using the REPORT Doctype

The REPORT doctype has two designs, shown in Figure 10-1, and is used for general-purpose documents such as reports and formal outlines.

Figure 10-1 REPORT Doctype Designs


10.1 Characteristics of the REPORT Design

Table 10-1 lists the page layout of the REPORT doctype design. Table 10-2 lists the page layout of the REPORT.TWOCOL doctype designs.

Table 10-1 Page Layout of the REPORT Doctype Design
Page Layout Characteristics
Running heads None¹
Running feet Page number, title text optional¹
Page numbering Sequential¹
Trim size 8 1/2 x 11 inches
Right margin Justified
Text Element Characteristics
Headings Numbered
Paragraphs Flush left
Figures, tables, and examples Numbered


¹You can modify this characteristic

Table 10-2 Page Layout of the REPORT.TWOCOL Doctype Design
Page Layout Characteristics
Running heads None¹
Running feet Page number, title text optional¹
Page numbering Sequential
Trim size 8 1/2 x 11 inches
Right margin Justified
Text Element Characteristics
Headings Unnumbered
Paragraphs First line indent
Figures, tables, and examples Numbered


¹You can modify this characteristic

This doctype accepts the full range of DECdocument global tags (see the Using Global TagsUsing Global Tags for more information on the global tags). The REPORT doctype also provides additional tags that let you perform the following functions: You process a file with the REPORT doctype by using the REPORT or REPORT.TWOCOL doctype keyword on the DECdocument command line.


$  DOC/LIST/CONTENTS/SYMBOLS=MY_SYMBOLS.SDML-
_$ MyFile.sdml REPORT LN03
See Chapter 2 for information on special formatting considerations of a 2-column doctype design, and for suggestions on improving final output.

Table 10-3 summarizes the tags available in the REPORT doctype and provides a brief description of each tag. Section 10.4 contains the reference information on the tags listed in this table.

Table 10-3 Tags Available in the REPORT Doctype
Tag Name Description
Tags Available in the Front Matter
<AUTHOR> Places the name of an author and up to two additional lines of information about the author on the output page.
<BYLINE> Creates a rule to be used as a signature line, and places the name of the signatory beneath the line.
<SIGNATURES> Begins a listing of signature lines created by the <BYLINE> tag. Optionally, you can use this tag to begin the listing of signature lines on a new page.
Tags Available Throughout the Document
<COLUMN> Specifies that a new column of output should begin in a 2-column doctype.
<DOCUMENT_ATTRIBUTES> Modifies the numbering of pages and formal elements in the document.
<RUNNING_FEET> Places a heading at the bottom of each page.
<RUNNING_TITLE> Places a heading at the top of each page.
<SECTION> Begins a new page and places an unnumbered heading at the top of the new page on the left margin.
Tags Available to Create Outlines
<LEVEL> Specifies an entry in an outline.
<OUTLINE> Enables the <LEVEL> and <SHOW_LEVELS> tags and specifies a title for the outline.
<SHOW_LEVELS> Emphasizes text in the outline using either bolding or italics.

10.2 Sample Use of the REPORT Doctype Tags

This section contains an example of the first pages of a report created using the REPORT doctype tags. This report includes a front matter section and an outline in the body of the report. Note how the outline and front matter tags are used in this example. You may find this sample useful in understanding how the tags all fit together to create reports and other general-purpose documents.

The SDML code for the report is shown first, followed by the output from that SDML code.


<FRONT_MATTER> 
<TITLE_PAGE> 
<TITLE>(Equipment Usage in this Company) 
<RUNNING_TITLE>(Equipment Used) 
<RUNNING_FEET>(A Valuable Resource) 
<ABSTRACT> 
This is an internal report on equipment usage during 
the period (May 1989 - November 1989). 
<ENDABSTRACT> 
<AUTHOR>(Thomas A. Smith\Comptroller\Eastern Division) 
<SIGNATURES> 
<BYLINE>(T. A. Smith) 
<BYLINE>(John Whorfin\Accounting Consultant) 
<DATE>(26-November-1989) 
<ENDTITLE_PAGE> 
<ENDFRONT_MATTER> 
<CHAPTER>(Equipment Usage Summary) 
<P>Equipment usage is a very important quantity to monitor. 
If equipment is not used, it is a wasted resource.  If equipment is over-used, 
it tends to break sooner, and means that people must wait to use it. If people 
are waiting, they are not being as productive as they might otherwise be. 
<P>The following sections summarize equipment usage in various departments. 
 
<HEAD1>(Usage of Official Vehicles\28_UsageofOfficialVehicles) 
<P> 
Official vehicle usage is listed in a separate report CORP-AUTO-1439u2. 
This report is organized as in the following outline.  Note that there 
are two new categories in the report.  These categories are italicized 
in the following outline. 
<OUTLINE>(Outline of Report\CORP-AUTO-1439u2\Motor Vehicle Usage) 
<LEVEL>(1\Four wheeled Vehicles) 
<LEVEL>(2\Cars) 
<LEVEL>(2\Trucks) 
<SHOW_LEVELS>(ITALIC) 
<LEVEL>(3\Heavy trucks) 
<LEVEL>(3\Light trucks (less than 2 ton)) 
<SHOW_LEVELS>(OFF) 
<LEVEL>(2\Vans) 
<ENDOUTLINE> 
 

Should you wish to create the output file yourself, you can obtain the file REPORT_SAMPLE.SDML from directory DOC$ROOT:[EXAMPLES] and process it with the REPORT doctype. Comparing the output to this SDML file may be helpful in understanding how to use these tags.

10.3 A Sample Use of the REPORT.TWOCOL Doctype Tags

This section shows the preceding example modified to show how to use the <COLUMN> tag and the global <CHEAD> tag.


<FRONT_MATTER> 
<TITLE_PAGE> 
<TITLE>(Equipment Usage in this Company) 
<RUNNING_TITLE>(Equipment Used) 
<RUNNING_FEET>(A Valuable Resource) 
<ABSTRACT> 
This is an internal report on equipment usage during 
the period (May 1989 - November 1989). 
<ENDABSTRACT> 
<AUTHOR>(Thomas A. Smith\Comptroller\Eastern Division) 
<SIGNATURES> 
<BYLINE>(T. A. Smith) 
<BYLINE>(John Whorfin\Accounting Consultant) 
<DATE>(26-November-1989) 
<ENDTITLE_PAGE> 
<ENDFRONT_MATTER> 
<CHAPTER>(Equipment Usage Summary) 
<P>Equipment usage is a very important quantity to monitor. 
If equipment is not used, it is a wasted resource.  If equipment is over-used, 
it tends to break sooner, and means that people must wait to use it. If people 
are waiting, they are not being as productive as they might otherwise be. 
<P>The following sections summarize equipment usage in various departments. 
 
<HEAD1>(Usage of Official Vehicles\28_UsageofOfficialVehicles) 
<P> 
Official vehicle usage is listed in a separate report CORP-AUTO-1439u2. 
This report is organized as in the following outline.  Note that there 
are two new categories in the report.  These categories are italicized 
in the following outline. 
<OUTLINE>(Outline of Report\CORP-AUTO-1439u2\Motor Vehicle Usage) 
<LEVEL>(1\Four wheeled Vehicles) 
<LEVEL>(2\Cars) 
<LEVEL>(2\Trucks) 
<SHOW_LEVELS>(ITALIC) 
<LEVEL>(3\Heavy trucks) 
<LEVEL>(3\Light trucks (less than 2 ton)) 
<SHOW_LEVELS>(OFF) 
<LEVEL>(2\Vans) 
<ENDOUTLINE> 
<COLUMN> 
<CHEAD>(A Valuable Resource) 
<P> 
We must all be concerned about the safe handling and preventive 
maintenance of all of our vehicles... 
 
 

Should you wish to create the output file yourself, you can obtain the file REPORT_TWOCOL_SAMPLE.SDML from directory DOC$ROOT:[EXAMPLES] and process it using the REPORT_TWOCOL doctype. Comparing the output to this SDML file may be helpful in understanding how to use these tags.

10.4 REPORT Doctype Tag Reference

This part of this chapter provides reference information on all the tags specific to the REPORT doctype.


<AUTHOR>

Places the name of an author and one or two additional lines of information about the author in the front matter portion of a document.

Syntax

<AUTHOR> (author name [\author info-1] [\author info-2])


ARGUMENTS

author name

Specifies the name of the author.

author info-n

This is an optional argument. It specifies any additional information about the author below the author's name. Information you specify as author info-1 outputs above information you specify as author info-2.

related tags

restrictions

Valid only in the context of the global <FRONT_MATTER> tag in the REPORT doctype.

DESCRIPTION

The <AUTHOR> tag places the name of an author and one or two additional lines of information about the author in the front matter portion of a document. This tag accepts two optional arguments to provide the additional information about the author. If you want a signatory line for the author in the front matter, use the <SIGNATURES> and <BYLINE> tags. See the descriptions of those tags in this chapter for more information.


Example

The following example shows how you can use the <AUTHOR> tag in the front matter of a document. Note how the optional second argument to the <AUTHOR> tag specifies the author's title.

<FRONT_MATTER> 
<TITLE_PAGE> 
<TITLE>(The NYUC Simulator Reference Manual) 
<ORDER_NUMBER>(AA-Z0000-TE) 
<ABSTRACT> 
This manual describes the NYUC Simulator. 
This program simulates a conversation between three people 
by analyzing the syntactic and semantic components of three 
related statements, and then synthesizing statements and responses 
based upon these original statements. 
<ENDABSTRACT> 
<REVISION_INFO>(This revision is personally signed.) 
<AUTHOR>(Mr. Jones\Research Head, STG Inc.) 
<SIGNATURES> 
<BYLINE>(Nat Jones\Author) 
<DATE>(July 11, 1985) 
<PRINT_DATE>(June 1987) 
<ENDTITLE_PAGE> 
<ENDFRONT_MATTER> 
 


<BYLINE>

Places a name and other optional information below a ruled line in a signature list.

Syntax

<BYLINE> (name [\additional info])


ARGUMENTS

name

Specifies the name of the signatory. This name outputs under the beginning of the signature line on the left side of the page.

additional info

This is an optional argument. It specifies any additional information about the signatory. This information outputs on the same line as the name argument with an em dash (---) between the two arguments.

related tags

restrictions

Valid only in the context of the global <FRONT_MATTER> tag and after the <SIGNATURES> tag.

DESCRIPTION

The <BYLINE> tag places a name and other optional information below a ruled line in a signature list. You can place additional information about the signer by using the additional info argument. Additional information formats to the right of the name of the signer, on the same line, separated by an em dash (---). Use as many <BYLINE> tags as you want to create approval lines in the front matter of a document, as long as all these tags follow the <SIGNATURES> tag. Use the <SIGNATURES> tag to begin all the approval lines on a separate page of the front matter. See the <SIGNATURES> tag in this chapter for more information.


Example

The following example shows three occurrences of the <BYLINE> tag. The first two occurrences list the positions of the signers using the optional additional info argument. The third occurrence of the <BYLINE> tag omits the optional argument. Note that all three tags follow the <SIGNATURES> tag.

<FRONT_MATTER> 
<TITLE_PAGE> 
<TITLE>(The NYUC Simulator Reference Manual) 
<REVISION_INFO>(This revision is personally signed.) 
<AUTHOR>(Mr. Jones\Research Head, STG Inc.) 
<SIGNATURES> 
<BYLINE>(Nat Jones\Author) 
<BYLINE>(Cecil Mills\Co-author) 
<BYLINE>(Matt Smith) 
<DATE>(July 11, 1985) 
<PRINT_DATE>(June 1987) 
<ENDTITLE_PAGE> 
<ENDFRONT_MATTER> 
 


<COLUMN>

In a 2-column doctype, specifies that a new column of output begins.

Syntax

<COLUMN>


ARGUMENTS

None.

related tags

restrictions

Valid only in a 2-column doctype.

DESCRIPTION

The <COLUMN> tag, in a 2-column doctype, specifies that a new column of output begins. This causes the text immediately following the tag to be started in a new column. If this tag occurs in the left text column, the text immediately following it begins in the right text column. If this tag occurs in the right text column, the text immediately following it begins in the left column of the next page. Use the <COLUMN> tag when you always want to begin a new column at that point in your text. You can use the COLUMN_BREAK argument to the global <FINAL_CLEANUP> tag to also specify a column break. However, only use it during the final processing of the 2-column document. See Chapter 2 for more information on improving the formatting of a 2-column doctype such as REPORT.TWOCOL and ARTICLE.


Example

The following example shows how to use the <COLUMN> tag to begin a new text column. In this example, the writer wants the two descriptions to appear side by side, one in each column.

<CHEAD>(Woodwind Instruments) 
<P>Woodwind instruments have the following 
attributes: 
<LIST>(UNNUMBERED) 
<LE>They are often made of wood, hence their name. 
<LE>Musicians create sound using these instruments by causing a reed 
to vibrate. 
. 
. 
. 
<ENDLIST> 
<COLUMN> 
<CHEAD>(Brass Instruments) 
<P>Brass instruments have the following 
attributes: 
<LIST>(UNNUMBERED) 
<LE>They are often made of brass, hence their name. 
<LE>Musicians create sound using these instruments by 
vibrating (buzzing) their lips into a steel mouthpiece. 
. 
. 
. 
<ENDLIST> 
 


<DOCUMENT_ATTRIBUTES>

Enables doctype-specific tags that override the default design format of the REPORT doctype.

Syntax

<DOCUMENT_ATTRIBUTES>


ARGUMENTS

None.

required terminator

<ENDDOCUMENT_ATTRIBUTES>

DESCRIPTION

The <DOCUMENT_ATTRIBUTES> tag enables doctype-specific tags that override the default design format of the REPORT doctype. This tag is used in three doctypes: The <DOCUMENT_ATTRIBUTES> tag enables a group of tags in each of these doctypes that allow you to modify the default format of that doctype. DECdocument recognizes these tags only in the context of the <DOCUMENT_ATTRIBUTES> tag. If other DECdocument tags occur in this context, DECdocument ignores them, as if they had occurred in the context of a <COMMENT> tag. Typically, use the <DOCUMENT_ATTRIBUTES> tag at the beginning of an input file (or in a file processed using the /INCLUDE qualifier on the DECdocument command line) to alter the default format of a doctype for the processing of that entire file. Book builds and element builds in this doctype do not save information about attributes, such as page numbers, specified with the <DOCUMENT_ATTRIBUTES> tag. To ensure that the same attributes are specified in both contexts, place <DOCUMENT_ATTRIBUTES> tags in a file that is included in both book and element builds. To do this, either place the <DOCUMENT_ATTRIBUTES> tag at the beginning of every element file, or use the /INCLUDE or /SYMBOLS qualifier to specify a file containing the <DOCUMENT_ATTRIBUTES> tag. Table 10-4 summarizes the formatting tags enabled by the <DOCUMENT_ATTRIBUTES> tag in the REPORT doctype.

Table 10-4 Doctype-specific Tags Enabled by the<DOCUMENT_ATTRIBUTES> tag
Formatting Tags Description
<SET_HEADINGS>(UNNUMBERED)
<SET_HEADINGS>(NUMBERED)
The <SET_HEADINGS> tag specifies whether the heading-level tags produce numbered or unnumbered headings. (<HEAD1>, <HEAD2>, and so on). By default, headings are not numbered in a document processed using the ARTICLE doctype.

Use the <SET_HEADINGS>(NUMBERED) tag to specify numbered headings.


Example

The following example is of a file that is to be processed under the REPORT doctype. This example shows how you use the <SET_PAGE_NUMBERING> and <SET_FORMAL_ELEMENT_NUMBERING> tags to create page and formal element numbering that is chapter-oriented rather than sequential. Note how the BY_CHAPTER argument is used by both tags to specify that numbering should be by chapter rather than sequential.

<DOCUMENT_ATTRIBUTES> 
<SET_PAGE_NUMBERING>(BY_CHAPTER) 
<SET_FORMAL_ELEMENT_NUMBERING>(BY_CHAPTER) 
<ENDDOCUMENT_ATTRIBUTES> 
 


<LEVEL>

Specifies an outline entry and the organizational level of that outline entry.

Syntax

<LEVEL> (level number\entry text)


ARGUMENTS

level number

Specifies the organizational level of the entry. This argument can be any whole number from 1 to 6.

entry text

Specifies the text for a particular level.

related tags

restrictions

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

DESCRIPTION

The <LEVEL> tag specifies an outline entry and the organizational level of that outline entry. Top-level entries (those specified as <LEVEL>(1)) are marked using uppercase Roman numerals. At the lowest level, level 6, the 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.

Example

The following example illustrates an outline created using the <LEVEL> tag in the context of the <OUTLINE> tag. Note how you indent the <LEVEL> tags in the SDML file to make the file easier to read and more maintainable.

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


Previous Next Contents Index