| Previous | Contents | Index |
Outputs all the reference notes created with the <REF_NOTE> tag at the place in the file where you use the <REF_NOTES> tag.
<REF_NOTES> [(heading text)]
heading text
This is an optional argument. It specifies a heading for the reference notes.If you do not specify the heading text argument, no heading is output. You can specify your own heading with the heading tag (<HEAD1>, <HEAD2>, and so on) that is appropriate to your document.
- <ACKNOWLEDGMENTS>
- <BACK_NOTES>
- <REF_NOTES>
DESCRIPTION
The <REF_NOTES> tag outputs all the reference notes created with the <REF_NOTE> tag at the place in the file where you use the <REF_NOTES> tag. These references are numbered and correspond to the number placed in your document by the <REF_NOTE> tag (for example, [4]). Typically, place the <REF_NOTES> tag at the end of the SDML file so that the accumulated references appear at the end of the article.
EXAMPLES
The following example shows how to create a list of headings with the heading "References".
#1
<REF_NOTES>(References)The following example shows how to use a heading tag as an alternative heading for the list of references. In this example, the <HEAD2> tag was used.
#2
<HEAD2>(References\25_References) <REF_NOTES>
<RUNNING_FEET>
Creates a single-line heading at the bottom of each page.
Syntax
<RUNNING_FEET> (footer text)
ARGUMENTS
footer text
Specifies the text to be used as a running heading at the foot of the page.
- <RUNNING_TITLE>
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 is used for several pages, the footers are collectively called running feet.This tag accepts one argument that is the text heading that appears at the bottom of the page. This text is output exactly as entered, including spacing and capitalization.
Example
The following example shows how to use the <RUNNING_FEET> tag to place the heading Getting the Piece of Paper at the bottom of each page. The running footer outputs exactly as entered.
<RUNNING_FEET>(Getting the Piece of Paper) <HEAD2>(Getting the Piece of Paper\26_GettingthePieceofPaper) <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 title at the top of each page.
Syntax
<RUNNING_TITLE> (
)
- OFF
- title-1 [\title-2]
- [\FIRST_PAGE]
ARGUMENTS
OFF
This is an optional keyword argument. It 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
This 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 keyword argument. It specifies that the running title is to begin output on the first output page. If you do not specify this keyword, the running title outputs on the page after the current page.
- <RUNNING_FEET>
DESCRIPTION
The <RUNNING_TITLE> tag creates a 1- or 2-line title 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.
Examples
The following example shows how to use the <RUNNING_TITLE> tag to create the 2-line running title An E. B. Bartz Course: and 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\27_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 to disable a running title by using the OFF argument to the <RUNNING_TITLE> tag.
#2
<RUNNING_TITLE>(OFF) <HEAD>(An Example of a Letter\28_AnExampleofaLetter)...
<SOURCE_NOTE>
Provides information pertaining to the original source of information for an article.
Syntax
<SOURCE_NOTE> (source text)
ARGUMENTS
source text
Specifies the text that describes the source of the article. The text can be any length and can include any tags not listed in the restrictions section. The source text is positioned at the bottom of the column of output in which the tag is specified.
- <AUTHOR>
- <VITA>
Do not use the following tags as part of the source note text: <CODE_EXAMPLE>, <EXAMPLE>, <FIGURE>, <FORMAT>, <HEAD1> through <HEAD6>, <INTERACTIVE>, <MATH>, or <NOTE>.
The <SOURCE_NOTE> tag provides information pertaining to the original source of information for an article. Typically, place information provided in the <SOURCE_NOTE> tag either at the beginning of the first column on the first page of an article, or at the end of the last column on the last page. Place the <SOURCE_NOTE> tag in your SDML file to correspond to where you want the output to appear.If you want the text to appear on the first page, specify the tag following the <AUTHOR> tag. If you want the text to appear on the last page, specify the tag at the end of the SDML file.
The following example shows how to create a note describing the original source of an article.
<SOURCE_NOTE>(Reprinted from <EMPHASIS>(Visible Discs,) Volume V, Number 3, Summer 1971. c/o The Top-Ten Museum of Art, Cleveland, Ohio, U.S.A., 44106 |
Specifies a subtitle for an article.
<SUBTITLE> (title line-1[\title line-2[\title line-3]])
title line-n
Specifies up to three lines of text for a subtitle of an article. The text of each argument centers on a new line of output.
- <TITLE>
- <TITLE_SECTION>
DESCRIPTION
The <SUBTITLE> tag specifies a subtitle for an article. This subordinate article title can have up to three separate lines. Each of the subtitle lines centers in the column in which the tag occurs (typically the first column). Use the <TITLE> tag to create a main title for an article.If you want the subtitle (or title) to span both columns of the article, use the <TITLE_SECTION> tag in your SDML file before the <SUBTITLE> (or <TITLE>) tag.
Example
The following example shows how to code a main title followed by a subtitle that spans both columns. Note that the <AUTHOR> tag occurs outside of the context of the <TITLE_SECTION> tag, so the name of the author does not span both columns in the output.
<TITLE_SECTION> <TITLE>(FILE PROCESSING) <SUBTITLE>(CONCEPTS AND INSTRUCTIONS) <ENDTITLE_SECTION> <AUTHOR>(A.B. Roma\Contributing Editor)
<TITLE>
Specifies the main title line for an article.
Syntax
<TITLE> (title line-1[\title line-2[\title line-3]])
ARGUMENTS
title line-n
Specifies up to three lines of text for the title of the article. The text of each argument centers on a new line of output.
- <SUBTITLE>
- <TITLE_SECTION>
DESCRIPTION
The <TITLE> tag specifies the main title line for an article. This title can have up to three separate lines. Each of the title lines is centered in the column in which the tag occurs (typically the first column). Use the <SUBTITLE> tag to create a subordinate title for an article.If you want the title (or subtitle) to span both columns of the article, use the <TITLE_SECTION> tag in your SDML file before the <TITLE> (or <SUBTITLE>) tag.
Example
The following example shows how to code a main title followed by a subtitle that spans both columns. Note that the <AUTHOR> tag occurs outside of the context of the <TITLE_SECTION> tag, so the name of the author does not span both columns in the output.
<TITLE_SECTION> <TITLE>(FILE PROCESSING\USING THE CALL INTERFACE) <SUBTITLE>(CONCEPTS AND INSTRUCTIONS) <ENDTITLE_SECTION> <AUTHOR>(A.B. Roma\Contributing Editor)
<TITLE_SECTION>
Begins the title section of an article. The title spans both columns of the article.
Syntax
<TITLE_SECTION>
ARGUMENTS
None.
- <SUBTITLE>
- <TITLE>
<ENDTITLE_SECTION>
The <TITLE_SECTION> tag begins the title section of an article. The title spans both columns of the article. Use this tag to create a section at the beginning of an article whenever you want a title, subtitle, or other information to span the full page. If you use the <TITLE> or <SUBTITLE> tag in the context of the <TITLE_SECTION> tag, the typeface output by those tags will be larger than the typeface output outside of the context of the <TITLE_SECTION> tag.If you do not use the <TITLE_SECTION> tag, any titles, subtitles, or additional information outputs in the appropriate column and does not span the full page.
In the following example, the <TITLE> and <SUBTITLE> tags are specified in the context of the <TITLE_SECTION> tag. The <AUTHOR> tag appears after the <ENDTITLE_SECTION>, so it will be formatted in the first column of the article.
| #1 |
|---|
<TITLE_SECTION> <TITLE>(Optical Discs) <SUBTITLE>(The New Documentation Frontier) <ENDTITLE_SECTION> <AUTHOR>(A.B. Roma) |
In the following example, the <TITLE> and <SUBTITLE> tags are used without the <TITLE_SECTION> tag so the title and subtitle text will be set in the first column with the author information.
| #2 |
|---|
<TITLE>(Optical Discs) <SUBTITLE>(The New Documentation Frontier) <AUTHOR>(A. B. Roma) |
Provides information about the author's professional history.
<VITA> (vita text)
vita text
Specifies information describing the professional history of the author. The text can be any length and can include any tags that are not listed in the restrictions section.
- <AUTHOR>
- <AUTHOR_ADDR>
- <AUTHOR_AFF>
- <AUTHOR_LIST>
- <SOURCE_NOTE>
Do not use the following tags as part of the vita text: <CODE_EXAMPLE>, <EXAMPLE>, <FIGURE>, <FORMAT>, <HEAD1> through <HEAD6>, <INTERACTIVE>, <MATH>, or <NOTE>.
The <VITA> tag provides information about the author's professional history. Typically, place information provided in the <VITA> tag either at the beginning of the first column of the first page of an article, or at the end of the last column on the last page. Place the <VITA> tag in your SDML file to correspond to where you want the output to appear.To make the text appear on the first page, specify the <VITA> tag following the <AUTHOR> tag. To make the text appear on the last page, specify the <VITA> tag at the end of the SDML file.
The following example shows how to use the <VITA> tag. The descriptive text is positioned at the bottom of the first column of the first page of the article.
<AUTHOR>(A.B. Roma) <VITA>(A.B. Roma is program director for information processing and distribution for the Top-Ten Corporation. She has published numerous magazine articles.) |
The GENERAL doctype is another doctype that can be used to produce manuals and reference material. It is similar to the SOFTWARE.REFERENCE design but with much less white space. The GENERAL doctype has only one design.
The GENERAL doctype creates pages in an 8 1
2 x 11 inch
format.
| Page Layout Characteristics | |
|---|---|
| Running heads | Chapter title text |
| Running feet | Page number |
| Page numbering | Chapter oriented |
| Trim size | 8 1/2 x 11 inches |
| Gutter width | 2.0 picas |
| Right margin | Unjustified (Ragged right) |
| Text Element Characteristics | |
| Headings | Numbered |
| Paragraphs | Flush left at gutter width |
| Figures, tables, and examples | Numbered, table of contents entry |
The GENERAL doctype design requires no doctype-specific tags, but accepts the full range of DECdocument global tags as well as the tags used for the SOFTWARE doctype. See Using Global TagsUsing Global Tags and Using Doctypes and Related TagsUsing Doctypes and Related Tags - Volume 2 for more information on global and SOFTWARE tags.
Process a file with the GENERAL doctype by using GENERAL as the doctype keyword on the DOCUMENT command line. The following example shows how to process a file named MYMANUAL.SDML with the GENERAL doctype to create a manual.
$ DOCUMENT MYMANUAL GENERAL PS |
3.1 Example of Using the GENERAL Doctype
The Tutorial and Application Guide manual was created using the GENERAL doctype.
| Previous | Next | Contents | Index |