OpenVMS User's Manual

For additional information on DSR, refer to the OpenVMS DIGITAL Standard Runoff Reference Manual or DCL Help for a complete description of the RUNOFF commands and qualifiers.

10.2 About DSR

By inserting DSR commands, control characters, and other special identifiers within a text file, you can use DSR to:

Determine the size of pages
Create uneven or justified right margins
Place space between lines
Form lists
Create title pages, footnotes, tables of contents, indexes, and appendixes

10.2.1 Formatting a File Using DSR

The steps for formatting a file with DSR are as follows:

Step Task

1 Create the source file with EDT, EVE, or another text editor.
By default, the DSR source file has the file type .RNO.

2 Enter DSR commands, flags, and control characters within the source file to indicate how the file is to be formatted.
DSR flags are special characters that you insert in text to specify emphasis of text, case of characters, spacing of characters, and so forth.

3 Process the file with the DCL command RUNOFF.
When DSR processes the source file, the DSR commands cause the text to be formatted into sections, paragraphs, lists, and so on. Neither the DSR commands nor the DSR flags appear in the final document.

Step	Task
1	Create the source file with EDT, EVE, or another text editor. By default, the DSR source file has the file type .RNO.
2	Enter DSR commands, flags, and control characters within the source file to indicate how the file is to be formatted. DSR flags are special characters that you insert in text to specify emphasis of text, case of characters, spacing of characters, and so forth.
3	Process the file with the DCL command RUNOFF. When DSR processes the source file, the DSR commands cause the text to be formatted into sections, paragraphs, lists, and so on. Neither the DSR commands nor the DSR flags appear in the final document.

10.3 Entering DSR Commands in Source Files

To enter a DSR command, create the source file with EDT, EVE, or another text editor. Begin the command in column 1 of a line and precede the command with a period. Most DSR commands have standard abbreviations. For example, you can abbreviate the .NO CONTROL CHARACTERS command as .NCC.

10.3.1 Example

The following example shows how to insert a blank line between two lines of text:

We sail the ocean blue, 
.BLANK 
And our saucy ship's a beauty.

10.4 Invoking DSR

The following sections describe how to invoke DSR.

10.4.1 Using the RUNOFF Command

After you add DSR commands to your file and exit from the editor, you are ready to process the file with DSR. To invoke DSR, enter the RUNOFF command followed by the name of the file you want to process.

If you process a file with the file type .RNO, you need only to enter the file name, not the file type. By default, the RUNOFF command produces an output file with the same file name as the input file and the file type .MEM.

10.4.2 Examples

Both of the following examples produce output files named FUN.MEM.

In the following example, a file named FUN.RNO is processed:
```
$ RUNOFF FUN
```
In the following example, a file named FUN.FUN is processed (both the file name and the file type are specified):
```
$ RUNOFF FUN.FUN
```

10.4.3 Overriding DSR Commands or Flags

By using qualifiers with the RUNOFF command, you can override DSR commands or flags included in your text file. RUNOFF command qualifiers allow you to alter the position of the text on all pages of the document, to specify emphasis such as underlining and bolding, and to otherwise control the appearance of printed output.

10.4.4 Example

In the following example, the /NOBOLD qualifier suppresses any bolding specified in the file by using the DSR command .FLAGS BOLD:

$ RUNOFF/NOBOLD FUN

10.4.5 RUNOFF Command Qualifiers

The following table summarizes the RUNOFF command qualifiers:

Qualifier Description

/BACKSPACE Uses the Backspace character to bold, overstrike, or underline text as it is printed. This generally gives more exact underlining and bolding for files printed on letter-quality printers. The /BACKSPACE qualifier is not recommended for line printers.

/[NO]BOLD Enables and disables bolding. Any bolding specified in chapter and header titles appears in the table of contents.

/[NO]CHANGE_BARS Enables and disables the appearance of change bars in the output file.

/CONTENTS Generates a table of contents. (See Section 10.5.)

/[NO]DEBUG Traces the operation of certain DSR commands by causing the commands to appear in the output file.

/DEVICE Specifies printing options.

/DOWN Specifies the number of blank lines to be inserted at the top of each page, preceding any header information.

/INDEX Generates an index. (See Section 10.6.)

/FORM_SIZE Controls the number of lines that can be accommodated per page of output.

/[NO]INTERMEDIATE Generates an intermediate binary file with the default file type .BRN for use with the DSR Table of Contents utility and the DSR Indexing utility.

/[NO]LOG Controls whether or not DSR displays processing information at your terminal.

/MESSAGES Lets you specify whether you want error messages displayed on your terminal or in an output file only. By default, DSR displays messages in both places.

/[NO]OUTPUT Specifies the name of the output file produced by DSR.

/PAGES Limits the output file to a specified range of pages.

/[NO]PAUSE Controls whether DSR pauses after printing each page of output.

/REVERSE_EMPHASIS Specifies that underlining of flagged text is to be done after the text is printed. By default, the printer prints the underscores, issues a carriage return without a line feed, then prints the flagged text above the underscores.

/[NO]RIGHT Causes the text on each page to be shifted to the right.

/SEPARATE_UNDERLINE Underlines text by using separate characters on the next line instead of overprinting with underscores on the same line.

/[NO]SEQUENCE Controls whether DSR outputs line numbers from the input file.

/[NO]SIMULATE Controls whether blank lines or form feeds are used to advance to the top of each page.

/[NO]UNDERLINE_CHAR Allows you to specify the character to be used for underlining of flagged text.

/VARIANT Controls the execution of the condition commands (.IF, .IFNOT, .ELSE, .ENDIF) by specifying the names of the segments to be processed.

Qualifier	Description
/BACKSPACE	Uses the Backspace character to bold, overstrike, or underline text as it is printed. This generally gives more exact underlining and bolding for files printed on letter-quality printers. The /BACKSPACE qualifier is not recommended for `line printers`.
/[NO]BOLD	Enables and disables bolding. Any bolding specified in chapter and header titles appears in the table of contents.
/[NO]CHANGE_BARS	Enables and disables the appearance of change bars in the output file.
/CONTENTS	Generates a table of contents. (See Section 10.5.)
/[NO]DEBUG	Traces the operation of certain DSR commands by causing the commands to appear in the output file.
/DEVICE	Specifies printing options.
/DOWN	Specifies the number of blank lines to be inserted at the top of each page, preceding any header information.
/INDEX	Generates an index. (See Section 10.6.)
/FORM_SIZE	Controls the number of lines that can be accommodated per page of output.
/[NO]INTERMEDIATE	Generates an intermediate binary file with the default file type .BRN for use with the DSR Table of Contents utility and the DSR Indexing utility.
/[NO]LOG	Controls whether or not DSR displays processing information at your terminal.
/MESSAGES	Lets you specify whether you want error messages displayed on your terminal or in an output file only. By default, DSR displays messages in both places.
/[NO]OUTPUT	Specifies the name of the output file produced by DSR.
/PAGES	Limits the output file to a specified range of pages.
/[NO]PAUSE	Controls whether DSR pauses after printing each page of output.
/REVERSE_EMPHASIS	Specifies that underlining of flagged text is to be done after the text is printed. By default, the printer prints the underscores, issues a carriage return without a line feed, then prints the flagged text above the underscores.
/[NO]RIGHT	Causes the text on each page to be shifted to the right.
/SEPARATE_UNDERLINE	Underlines text by using separate characters on the next line instead of overprinting with underscores on the same line.
/[NO]SEQUENCE	Controls whether DSR outputs line numbers from the input file.
/[NO]SIMULATE	Controls whether blank lines or form feeds are used to advance to the top of each page.
/[NO]UNDERLINE_CHAR	Allows you to specify the character to be used for underlining of flagged text.
/VARIANT	Controls the execution of the condition commands (.IF, .IFNOT, .ELSE, .ENDIF) by specifying the names of the segments to be processed.

10.4.6 Using DSR Defaults

When you use DSR to process a file, your output file looks different from your input file because DSR provides the following standard format default settings:

A standard typewriter page size of 8 1/2 x 11 inches; that is, a width of 70 character positions and a length of 58 lines of text per page (.PAGE SIZE 58,70)
Sequential page numbering for every page but the first (.PAGING)
A left margin setting of 0 (just before the first character position of a line) and a right margin setting of 70 (just after the 70th character position of a line) (.LEFT MARGIN 0 and .RIGHT MARGIN 70)
Line spacing equivalent to the single-space setting on a typewriter (.SPACING 1)
A tab setting every eighth character position on a line (.TAB STOPS 8, 16, 24, ...)
Filling: DSR fills each line with as many words as possible until the addition of another complete word would exceed the right margin (.FILL)
Justification: DSR adds spaces between words to expand each line exactly to the right margin, making the right margin even or justified (.JUSTIFY)

10.4.7 Disabling Default Settings

If you do not want your file to be formatted according to the DSR default commands (shown in parentheses in the preceding list), you must disable them. See the OpenVMS DIGITAL Standard Runoff Reference Manual for a complete list of the default commands provided by DSR and the commands you need to disable them.

10.5 Creating Tables of Contents

To create a table of contents, perform the following steps:

Step Task

1 Generate an intermediate (binary) file.
Be sure to specify an .RNO file type. (DSR then produces a file with a .BRN file type, which contains both table of contents and indexing information.)

2 Run the Table of Contents utility.
Be sure to specify a .BRN file type. You can add qualifiers to this command line to customize the table of contents. (DSR then produces a file with an .RNT file type.)

3 Process the .RNT file.
Be sure to specify an .RNT file type. (DSR then produces a file with an .MEC file type, which contains the table of contents.)

Step	Task
1	Generate an intermediate (binary) file. Be sure to specify an .RNO file type. (DSR then produces a file with a .BRN file type, which contains both table of contents and indexing information.)
2	Run the Table of Contents utility. Be sure to specify a .BRN file type. You can add qualifiers to this command line to customize the table of contents. (DSR then produces a file with an .RNT file type.)
3	Process the .RNT file. Be sure to specify an .RNT file type. (DSR then produces a file with an .MEC file type, which contains the table of contents.)

10.5.1 Table of Contents Default Settings

The RUNOFF/CONTENTS command produces a table of contents with the following features:

Chapter titles and numbers (generated by the .CHAPTER command).
Section titles and numbers (generated by the .HEADER LEVEL command). By default, DSR allows up to six levels of headers to appear in the table of contents.
Appendix titles and letters (generated by the .APPENDIX command).
Chapter-oriented page numbers (1--1, 1--2, 1--3,...) for all table of contents entries.
An output file with the same name as the input file.

10.5.2 Example: Creating a Table of Contents

The following example shows the commands and default output associated with producing a table of contents:

$  RUNOFF/INTERMEDIATE FUN.RNO
$  RUNOFF/CONTENTS FUN.BRN
$  RUNOFF FUN.RNT
$  TYPE FUN.MEC

                               CONTENTS 
 
 
 
CHAPTER 1       How to Tile a Floor 
 
        1.1     Reading About Tiling . . . . . . . . . . 1-1 
        1.1.1     Tiling for Fun . . . . . . . . . . . . 1-2 
        1.1.2     Your Home in Tile  . . . . . . . . . . 1-3 
        1.1.3     Changing a Room with Tile  . . . . . . 1-3 
        1.2     Buying the Tile  . . . . . . . . . . . . 1-5 
        1.2.1     Researching Tiles Produced Abroad. . . 1-5 
        1.2.2     Coordinating Colors  . . . . . . . . . 1-6 
        1.2.3     Tile Textures  . . . . . . . . . . . . 1-6 
        1.2.4     Types of Tiles . . . . . . . . . . . . 1-7 
        1.2.4.1   Ceramic  . . . . . . . . . . . . . . . 1-7 
        1.2.4.2   Clay . . . . . . . . . . . . . . . . . 1-7 
        1.3     Tools for Tiles  . . . . . . . . . . . . 1-8 
        1.3.1     Renting a Cutter . . . . . . . . . . . 1-8 
        1.3.2     Buying or Renting Crimpers . . . . . . 1-9 
        1.4     Accompanying Materials . . . . . . . . . 1-9 
        1.4.1     How to Adhere the Tiles  . . . . . . . 1-9 
        1.4.2     Grout  . . . . . . . . . . . . . . .  1-10 
CHAPTER 2       How to Cedar a Ceiling 
 
        2.1     Getting Started  . . . . . . . . . . .   2-1 
        2.1.1     Various Surfaces . . . . . . . . . .   2-2

10.5.3 DSR Qualifiers for Tailoring a Table of Contents

To tailor the DSR Table of Contents utility to meet your own needs, use these qualifiers:

Qualifier Result

/BOLD Enables bolding of chapter and header titles in the table of contents.

/DEEPEST_HEADER=n Displays header levels up to and including level n.

/IDENTIFICATION Displays the current version number of the DSR Table of Contents utility.

/INDENT Indents each header level after header level 1, two spaces beyond the preceding header level.

/LOG Reports the name of each input file as it is processed and after it is processed, plus the name of the generated output file.

/OUTPUT=newfile
/NOOUTPUT Specifies the name of the output file produced by DSR. The /NOOUTPUT qualifier causes DSR to process the input file without creating an output file.

/PAGE_NUMBERS=RUNNING Uses running page numbers instead of chapter-oriented page numbers for all table of contents entries, whether or not you specified running page numbers in the document.

/REQUIRE=filespec Allows you to change the heading on the first page of a table of contents.

/NOSECTION_NUMBERS Suppresses the display of section numbers for all header levels.

/UNDERLINE Includes underlining specified in chapter and header titles in the table of contents.

Qualifier	Result
/BOLD	Enables bolding of chapter and header titles in the table of contents.
/DEEPEST_HEADER=n	Displays header levels up to and including level n.
/IDENTIFICATION	Displays the current version number of the DSR Table of Contents utility.
/INDENT	Indents each header level after header level 1, two spaces beyond the preceding header level.
/LOG	Reports the name of each input file as it is processed and after it is processed, plus the name of the generated output file.
/OUTPUT=newfile /NOOUTPUT	Specifies the name of the output file produced by DSR. The /NOOUTPUT qualifier causes DSR to process the input file without creating an output file.
/PAGE_NUMBERS=RUNNING	Uses running page numbers instead of chapter-oriented page numbers for all table of contents entries, whether or not you specified running page numbers in the document.
/REQUIRE=filespec	Allows you to change the heading on the first page of a table of contents.
/NOSECTION_NUMBERS	Suppresses the display of section numbers for all header levels.
/UNDERLINE	Includes underlining specified in chapter and header titles in the table of contents.

10.5.4 Example

The following example shows how to change the display of page numbers from chapter-oriented numbers (1--1, 1--2, 1--3,...) to running numbers (1, 2, 3,...):

 
$ RUNOFF/CONTENTS/PAGE_NUMBERS=RUNNING FUN.MEC
$ TYPE FUN.MEC

                               CONTENTS 
 
 
 
CHAPTER 1       How to Tile a Floor 
 
        1.1     Reading About Tiling . . . . . . . . . . . 1 
        1.1.1     Tiling for Fun . . . . . . . . . . . . . 2 
        1.1.2     Your Home in Tile  . . . . . . . . . . . 3 
        1.1.3     Changing a Room with Tile  . . . . . . . 3 
        1.2     Buying the Tile  . . . . . . . . . . . . . 5 
        1.2.1     Researching Tiles Produced Abroad. . . . 5 
        1.2.2     Coordinating Colors  . . . . . . . . . . 6 
        1.2.3     Tile Textures  . . . . . . . . . . . . . 6 
        1.2.4     Types of Tiles . . . . . . . . . . . . . 7 
        1.2.4.1   Ceramic  . . . . . . . . . . . . . . . . 7 
        1.2.4.2   Clay . . . . . . . . . . . . . . . . . . 7 
        1.3     Tools for Tiles  . . . . . . . . . . . . . 8 
        1.3.1     Renting a Cutter . . . . . . . . . . . . 8 
        1.3.2     Buying or Renting Crimpers . . . . . . . 9 
        1.4     Accompanying Materials . . . . . . . . . . 9 
        1.4.1     How to Adhere the Tiles  . . . . . . . . 9 
        1.4.2     Grout  . . . . . . . . . . . . . . . .  10 
 
CHAPTER 2       How to Cedar a Ceiling 
 
        2.1     Getting Started  . . . . . . . . . . . . . 1 
        2.1.1     Various Surfaces . . . . . . . . . . . . 2

10.6 Creating Indexes

The following sections describe how to use DSR to create an index.

10.6.1 Index Entry Formats

To create an index, enter .INDEX and .ENTRY commands throughout your file. The .INDEX flag will create an index entry with an associated page number. The .ENTRY command will create an index entry without a page number and is usually used for See and See also entries. The format for an index entry is as follows:

.INDEX topic> subtopic> subtopic

.ENTRY topic [>subtopic >subtopic]

10.6.2 Example

If you want the word Chopin with the subtopic "Frederic" to appear in your index, enter the .INDEX command followed by the words Chopin>Frederic:

The music was soft and romantic, and Marvin knew at once that it
.ENABLE INDEXING
.XLOWER
.INDEX Chopin>Frederic
was a waltz by Frederic Chopin that held his attention.

In this example, the .ENABLE INDEXING flag enables the operation of the other index commands (.XLOWER and .INDEX). The .XLOWER flag determines that the case of all index entries will be exactly as entered (as opposed to the .XUPPER flag, which automatically capitalizes the first character of every entry and drops everything else in the entry lowercase).

10.6.3 Producing an Index

After you enter the index commands in your file, perform the following procedure:

Step Task

1 Generate an intermediate (binary) file.
Be sure to specify an .RNO file type. (DSR then produces a file with the file type .BRN.)

2 Run the Indexing utility.
Be sure to specify a .BRN file type. You can add qualifiers to this command line to customize the Indexing utility. (DSR then produces a file with the file type .RNX.)

3 Process the .RNX file.
Be sure to specify an .RNX file type. (DSR then produces a file with the file type .MEX, which contains an index.)

Step	Task
1	Generate an intermediate (binary) file. Be sure to specify an .RNO file type. (DSR then produces a file with the file type .BRN.)
2	Run the Indexing utility. Be sure to specify a .BRN file type. You can add qualifiers to this command line to customize the Indexing utility. (DSR then produces a file with the file type .RNX.)
3	Process the .RNX file. Be sure to specify an .RNX file type. (DSR then produces a file with the file type .MEX, which contains an index.)

10.6.4 Default Index Settings

The RUNOFF/INDEX command produces an index with the following features:

Fifty-five lines per page, including the top and bottom header areas
Chapter-oriented page numbers for index entries
Consecutive page numbers merged into ranges
An output file with the same file name as the input file

10.6.5 Example: Producing an Index

The following example shows an index produced by DSR default values:

$ RUNOFF/INTERMEDIATE FUN.RNO
$ RUNOFF/INDEX FUN.BRN
$ RUNOFF FUN.RNX
$ TYPE FUN.MEX

 
                                                      Page Index-1 
 
 
                                INDEX 
 
 
 
Amadeus                             Liszt, Franz, 3-2, 4-11 
  See Mozart, Wolfgang Amadeus 
                                    Mozart, Wolfgang Amadeus, 3-5, 
Bach, Carl Phillip Emanuel, 1-2         4-14  
    to 1-4, 4-9 
Bach, Johann Sebastian, 1-1, 3-2,   Prokofiev, Sergei, 4-5, 4-15 
    4-9, 4-12 
Baroque composer                    Rachmaninoff, Sergei, 3-3 to 3-6, 
  See Bach, Johann Sebastian            4-13 
Bartok, Bela, 2-1, 3-4, 4-10,       Rite of Spring 
    4-13                              See Stravinsky, Igor 
Britten, Benjamin, 4-3, 4-14 
                                    Satie, Erik, 2-2, 4-10 
Ceremony of Carols                  Stravinsky, Igor, 4-7, 4-15 
  See Britten, Benjamin             Syrinx, 4-8, 4-17 
Chopin, Frederic, 4-1 to 4-4       
    4-14                            Velvet Gentleman 
                                      See Satie, Erik 
Debussy, Claude, 3-3, 4-13          
                                    Waltz  
French composer                       See Chopin, Frederick 
  See Debussy, Claude 
                                    
Hindemith, Paul, 4-5 to 4-7, 4-15

10.6.6 DSR Qualifiers for Tailoring an Index

To tailor the DSR Indexing utility to meet your own needs, use the following qualifiers:

Qualifier Result

/IDENTIFICATION Displays the current version number of the DSR Indexing utility.

/LINES_PER_PAGE=n Determines the number of lines of index entries on each page. The number n does not include the number of lines required for running heads and feet.

/LOG Reports the name of each input file as it is processed and after it is processed, plus the name of the generated output file.

/OUTPUT=newfile
/NOOUTPUT Specifies the name of the output file produced by DSR. The /NOOUTPUT qualifier causes DSR to process your input file without creating an output file.

/PAGE_NUMBERS=RUNNING Uses running page numbers instead of chapter-oriented page numbers for all index entries, whether or not you specified running page numbers in the document.

/REQUIRE=filespec Allows you to change the heading on the first page of an index.

/RESERVE=n Allows you to reserve n number of lines on the top of the first page of the index.

Qualifier	Result
/IDENTIFICATION	Displays the current version number of the DSR Indexing utility.
/LINES_PER_PAGE=n	Determines the number of lines of index entries on each page. The number n does not include the number of lines required for running heads and feet.
/LOG	Reports the name of each input file as it is processed and after it is processed, plus the name of the generated output file.
/OUTPUT=newfile /NOOUTPUT	Specifies the name of the output file produced by DSR. The /NOOUTPUT qualifier causes DSR to process your input file without creating an output file.
/PAGE_NUMBERS=RUNNING	Uses running page numbers instead of chapter-oriented page numbers for all index entries, whether or not you specified running page numbers in the document.
/REQUIRE=filespec	Allows you to change the heading on the first page of an index.
/RESERVE=n	Allows you to reserve n number of lines on the top of the first page of the index.

10.6.7 Example: Tailoring an Index

In the following example, DSR displays index pages that are 15 lines long:

$ RUNOFF/INDEX/LINES_PER_PAGE=15 FUN.MEX
$ TYPE FUN.MEX

                                                      Page Index-1 
 
 
                                INDEX 
 
 
 
Amadeus                             Britten, Benjamin, 4-3, 4-14 
  See Mozart, Wolfgang Amadeus 
                                    Ceremony of Carols 
Bach, Carl Phillip Emanuel, 1-2       See Britten, Benjamin 
    to 1-4, 4-9                     Chopin, Frederic, 4-1 to 4-4, 
Bach, Johann Sebastian, 1-1, 3-2,       4-14 
    4-9, 4-12 
Baroque composer                    Debussy, Claude, 3-3, 4-13 
  See Bach, Johann Sebastian 
Bartok, Bela, 2-1, 3-4, 4-10,       French composer 
    4-13                              See Debussy, Claude 
 
 
 
                                                      Page Index-2 
 
Hindemith, Paul, 4-5 to 4-7, 4-15   Rite of Spring  
                                      See Stravinsky, Igor 
Liszt, Franz, 3-2, 4-11             Satie, Erik, 2-2, 4-10 
                                    Stravinsky, Igor, 4-7, 4-15 
Mozart, Wolfgang Amadeus, 3-5,      Syrinx, 4-8, 4-17 
    4-14 
                                    Velvet Gentleman 
Prokofiev, Sergei, 4-5, 4-15          See Satie, Erik 
 
Rachmaninoff, Sergei, 3-3 to 3-5,   Waltz 
    4-13                              See Chopin, Frederic

10.7 Summary of DSR Commands

The following sections list the DSR commands you can use to perform specific operations.

10.7.1 Page Size and Running Heads

The following table lists all DSR commands used for modifying page size and running heads:

Command

.AUTOSUBTITLE
.NO AUTOSUBTITLE .AST
.NAST Enable and disable use of section (.HEADER LEVEL) titles for running-head subtitles.

.DATE
.NO DATE .D
.ND Control whether or not the current date appears in running heads. Requires use of the .SUBTITLE command.

.FIRST TITLE .FT Allows running-head information to appear on the first page of a document with no chapters. (See also .HEADERS ON, .LAYOUT, .TITLE, .SUBTITLE, and .AUTOSUBTITLE.)

.HEADERS ON
.NO HEADERS .HD
.NHD Restore and cancel the capability of having one or two lines of information, called running heads, at the top of a page. Running heads indicate the content of the page and the page number.

.HEADERS UPPER
.HEADERS LOWER
.HEADERS MIXED .HD UPPER
.HD LOWER
.HD MIXED Specify the case of the word "page" that precedes the page number. The commands produce, respectively, PAGE, page, and Page. In an index, these commands also affect the word "index" that is part of the page number (for example, Page Index-3). The command normally takes effect on the next page.

.LAYOUT .LO Rearranges running-head and running-foot information on pages.

.PAGE SIZE .PS Sets the page "frame" by specifying the page length (the maximum number of lines of text on a page) and the page width for the running heads.

.SUBTITLE
.NO SUBTITLE .ST
.NST Allow you to specify a subtitle for a running head (see .HEADERS ON).

.TITLE .T Allows you to specify a title for a running head (see .HEADERS ON). This title normally appears at the top of every page but the first, at the leftmost position on the line (character position 0), regardless of the .LEFT MARGIN setting. (See also .FIRST TITLE, .SUBTITLE, and .LAYOUT.)

Command
.AUTOSUBTITLE .NO AUTOSUBTITLE	.AST .NAST	Enable and disable use of section (.HEADER LEVEL) titles for running-head subtitles.
.DATE .NO DATE	.D .ND	Control whether or not the current date appears in running heads. Requires use of the .SUBTITLE command.
.FIRST TITLE	.FT	Allows running-head information to appear on the first page of a document with no chapters. (See also .HEADERS ON, .LAYOUT, .TITLE, .SUBTITLE, and .AUTOSUBTITLE.)
.HEADERS ON .NO HEADERS	.HD .NHD	Restore and cancel the capability of having one or two lines of information, called running heads, at the top of a page. Running heads indicate the content of the page and the page number.
.HEADERS UPPER .HEADERS LOWER .HEADERS MIXED	.HD UPPER .HD LOWER .HD MIXED	Specify the case of the word "page" that precedes the page number. The commands produce, respectively, PAGE, page, and Page. In an index, these commands also affect the word "index" that is part of the page number (for example, Page Index-3). The command normally takes effect on the next page.
.LAYOUT	.LO	Rearranges running-head and running-foot information on pages.
.PAGE SIZE	.PS	Sets the page "frame" by specifying the page length (the maximum number of lines of text on a page) and the page width for the running heads.
.SUBTITLE .NO SUBTITLE	.ST .NST	Allow you to specify a subtitle for a running head (see .HEADERS ON).
.TITLE	.T	Allows you to specify a title for a running head (see .HEADERS ON). This title normally appears at the top of every page but the first, at the leftmost position on the line (character position 0), regardless of the .LEFT MARGIN setting. (See also .FIRST TITLE, .SUBTITLE, and .LAYOUT.)

10.7.2 Paging and Page-Number Control

The following table lists all DSR commands used for controlling paging and page numbers:

Command

.DISPLAY NUMBER .DNM Allows you to specify the form that sequential numbering (or lettering) of pages will take.

.NO NUMBER
.NUMBER PAGE .NNM
.NMPG Suspend and resume normal page numbering. The .NUMBER PAGE command keeps track of the numbering while the .NO NUMBER command is in effect; or, it allows you to specify the beginning of a new number sequence by specifying a number for the next page. (See also .NUMBER RUNNING, .DISPLAY NUMBER, .NO PAGING, and .HEADERS ON.)

.NUMBER RUNNING .NMR Allows you to specify the beginning of a new sequence of running page numbers. This command affects page numbers only if you have entered a .LAYOUT command with an n1 value of 3. (See .LAYOUT, .HEADERS ON, and .NO NUMBER.)

.PAGING
.NO PAGING .PS
.NPA Enable and disable paging, which splits a document into numbered pages and reserves space for running heads. This command has no effect on help files (files with the file type .RNH).

Command
.DISPLAY NUMBER	.DNM	Allows you to specify the form that sequential numbering (or lettering) of pages will take.
.NO NUMBER .NUMBER PAGE	.NNM .NMPG	Suspend and resume normal page numbering. The .NUMBER PAGE command keeps track of the numbering while the .NO NUMBER command is in effect; or, it allows you to specify the beginning of a new number sequence by specifying a number for the next page. (See also .NUMBER RUNNING, .DISPLAY NUMBER, .NO PAGING, and .HEADERS ON.)
.NUMBER RUNNING	.NMR	Allows you to specify the beginning of a new sequence of running page numbers. This command affects page numbers only if you have entered a .LAYOUT command with an n1 value of 3. (See .LAYOUT, .HEADERS ON, and .NO NUMBER.)
.PAGING .NO PAGING	.PS .NPA	Enable and disable paging, which splits a document into numbered pages and reserves space for running heads. This command has no effect on help files (files with the file type .RNH).

10.7.3 Subpaging

The following table lists all DSR commands used for subpaging:

Command

.DISPLAY SUBPAGE .DSP Allows you to specify the form that sequential lettering (or numbering) of subpage characters will take.

.NUMBER SUBPAGE .NMSPSG Allows you to specify the beginning of a new sequence of subpage numbers, for example, 1-16A, 1-16B, 1-16C, and so on. This command affects only the letters that the .SUBPAGE command appends to the normally numeric page number. .NUMBER SUBPAGE takes effect on the next page. (See also .SUBPAGE and .DISPLAY SUBPAGE.)

.SUBPAGE
.END SUBPAGE .SPG
.ES Begin and end a new page and a new format for page numbering. (See also .NUMBER SUBPAGE, .DISPLAY SUBPAGE, .HEADERS ON, .LAYOUT, and .PAGE.)

Command
.DISPLAY SUBPAGE	.DSP	Allows you to specify the form that sequential lettering (or numbering) of subpage characters will take.
.NUMBER SUBPAGE	.NMSPSG	Allows you to specify the beginning of a new sequence of subpage numbers, for example, 1-16A, 1-16B, 1-16C, and so on. This command affects only the letters that the .SUBPAGE command appends to the normally numeric page number. .NUMBER SUBPAGE takes effect on the next page. (See also .SUBPAGE and .DISPLAY SUBPAGE.)
.SUBPAGE .END SUBPAGE	.SPG .ES	Begin and end a new page and a new format for page numbering. (See also .NUMBER SUBPAGE, .DISPLAY SUBPAGE, .HEADERS ON, .LAYOUT, and .PAGE.)

10.7.4 Margin Settings

The following table lists all DSR commands used for setting margins:

Command

.LEFT MARGIN .LM Sets the left margin to the specified position.

.RIGHT MARGIN .RM Sets the right margin to the specified position. This is the position to which a line of text normally extends. If .JUSTIFY is in effect, the .RIGHT MARGIN value is the position against which text is justified. If .NO JUSTIFY is in effect, the .RIGHT MARGIN value specifies the maximum number of characters on any text line.

Command
.LEFT MARGIN	.LM	Sets the left margin to the specified position.
.RIGHT MARGIN	.RM	Sets the right margin to the specified position. This is the position to which a line of text normally extends. If .JUSTIFY is in effect, the .RIGHT MARGIN value is the position against which text is justified. If .NO JUSTIFY is in effect, the .RIGHT MARGIN value specifies the maximum number of characters on any text line.

10.7.5 Filling and Justifying Text

The following table lists all DSR commands used for filling and justifying text:

Command

.AUTOJUSTIFY
.NO AUTOJUSTIFY .AJ
.NAJ Justifies and fills text automatically within the context of an appendix, chapter, section, or note. The .NO AUTOJUSTIFY command disables automatic justification. If you disable justification and filling with the .NO JUSTIFY command, the settings for .[NO]FILL and .[NO]JUSTIFY will remain in effect.

.FILL
.NO FILL .F
.NF Fills each line with words until the addition of one more word would exceed the right margin. The .NO FILL command suspends both line filling and justification.

.JUSTIFY
.NO JUSTIFY .J
.NJ Inserts exactly enough space between words so that the last character reaches the right margin. The .NO JUSTIFY command disables justification.

Command
.AUTOJUSTIFY .NO AUTOJUSTIFY	.AJ .NAJ	Justifies and fills text automatically within the context of an appendix, chapter, section, or note. The .NO AUTOJUSTIFY command disables automatic justification. If you disable justification and filling with the .NO JUSTIFY command, the settings for .[NO]FILL and .[NO]JUSTIFY will remain in effect.
.FILL .NO FILL	.F .NF	Fills each line with words until the addition of one more word would exceed the right margin. The .NO FILL command suspends both line filling and justification.
.JUSTIFY .NO JUSTIFY	.J .NJ	Inserts exactly enough space between words so that the last character reaches the right margin. The .NO JUSTIFY command disables justification.

  6489P015.HTM
  OSSG Documentation
  22-NOV-1996 13:16:57.40

Legal