HELPLIB.HLB  —  DSR
text entirely on a single page. If there is not enough room on the current page to accommodate that amount, DSR ends the current page and puts the entire text on the next page. Format .TEST PAGE n Abreviated format .TP n

2.91.1  –  Parameter

 n

    The number of lines required to be on one page. This number
    cannot be omitted and must be positive.

2.92  –  .TITLE

    The .TITLE command 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.)

    Format

      .TITLE  [text]

    Abreviated format

      .T  [text]

2.92.1  –  Parameter

 text

    The title of the main running head you want to appear.

2.92.2  –  Default

    If you do not enter the .TITLE command, you get the title you
    specified in any .CHAPTER command that is in effect (unless you
    have entered .NO HEADERS).

2.93  –  .VARIABLE

    The .VARIABLE command allows you to specify a character that
    corresponds to the name you have given the commands and text in
    an .IF (or .IFNOT) block. This identifying character is placed
    in the left margin when you process your file with the /DEBUG or
    /DEBUG=CONDITIONALS command line qualifier.

    Format

      .VARIABLE  name [t ,f]

    Abreviated format

      .VR name  [t ,f]

2.93.1  –  Parameters

 name

    The name you have given to the commands and text in an .IF (or
    .IFNOT) block.

 t

    (True) is a single character of your choice that appears in front
    of lines of text to indicate that they will be processed (.IF
    block) if you specify /VARIANT, instead of /DEBUG, in the command
    line.

 f

    (False) is a single character of your choice that appears
    in front of lines of text to indicate that they will not be
    processed (.IFNOT block) if you specify /VARIANT, instead of
    /DEBUG, in the command line.

2.94  –  .XLOWER

    The .XLOWER command allows you to control the case of index
    entries specified by the .INDEX and the .ENTRY commands, or by
    the Index flag (>). The case of the index entries will match
    exactly the case that you enter when you make the index entry.

    See also the .XUPPER command.

    Format

      .XLOWER

    Abreviated format

      .XL

2.94.1  –  Default

    If you do not specify the .XLOWER command, .XUPPER is the
    default.

2.95  –  .XUPPER

    The .XUPPER command lets DSR control the case of index entries.
    If .XUPPER is in effect (as it is by default), DSR capitalizes
    the first character of every index entry and drops everything
    else in the entry to lowercase.

    See also the .XLOWER command.

    Formats

      .XUPPER

    Abreviated formats

      .XU

2.95.1  –  Default

    .XUPPER

3  –  DSR Flags

    DSR flags are special characters that you enter to specify
    emphasis of text, case of characters, spacing of text, and other
    formatting details.

3.1  –  Accept

    The Accept flag (_) causes any character that directly follows it
    to be accepted as text.

    If the character is a punctuation mark after which DSR normally
    inserts an extra space (for example, a period), you can precede
    it with the Accept flag to cancel the extra space.

    If you want to insert a flag character into your text, the
    easiest way is to precede it with the Accept flag. For example,
    to insert an ampersand (&), which is also the Underline flag,
    type _&.

    For underlining purposes, you can use the Accept flag to cause
    the acceptance of an expandable space (one you produce by
    pressing the SPACE bar) because DSR normally does not underline
    spaces between words.

3.1.1  –  Default

    Recognition is turned on.

3.2  –  Bold

    The single character occurrence of the Bold flag (*) causes
    the next character to be printed in boldface; that is, to be
    overstruck once. You can cause characters to be overstruck more
    than once by using the /BOLD=number qualifier when processing
    the file with the RUNOFF command. Pairing the bold flag with the
    uppercase flag (^*) turns on the bolding until the lowercase/bold
    pair (\*) is encountered.

3.2.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS BOLD command.

3.3  –  Break

    The Break flag (|) tells DSR where it may break a word that
    occurs at the end of a line. You might want DSR to be able to
    break a word after a slash (/) or a hyphen (-) that is part
    of the word (for example, "a yes/no response"). The Break flag
    allows a line to end where the flag occurs; no hyphen is ever
    inserted because of it.

    If the flag is turned on and inserted at break points, DSR is
    able to break the word at any of the specified points. If more
    than one Break flag is present in a word that DSR is breaking at
    the end of a line, DSR leaves as much of the word as possible on
    the line; that is, it breaks the word at the last possible Break
    flag.

    The Break flag works the same whether .JUSTIFY or .NO JUSTIFY is
    in effect.

3.3.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS BREAK command.

3.4  –  Capitalize

    The Capitalize flag (<) causes all the letters in the word
    directly following it to be capitalized, except for letters that
    may be preceded by an Accept (_) or Lowercase (\) flag.

    Capitalization continues until one of the following is
    encountered:

       An expandable space
       A Break flag (|)
       A Hyphenate flag (=)
       Another Capitalize flag
       A pair of Uppercase flags (^^)
       A pair of Lowercase flags (\\)
       The end of the line

    You can pair the Capitalize flag with the Uppercase flag (^<) to
    capitalize all following text up to the next case flag.

3.4.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS CAPITALIZE command.

3.5  –  Comment

    The Comment flag (!) is used to insert comments in .RNO files.
    You type the comment text immediately after the Comment flag.
    Comments do not appear in the output file.

3.5.1  –  Default

    Recognition is turned on.

3.6  –  Control

    The Control flag (.) is placed at the left margin to begin a
    string of DSR commands. When you want a period to be accepted as
    a text character, you do not need to precede it with an Accept
    flag (_) as long as the period is not placed at the left margin.
    If you do need to have a period in the 0 character position
    (and it is not part of a DSR command), you must precede it with
    an Accept flag. Alternatively, you can use two periods at the
    beginning of a line; the effect is the same as if you had used an
    Accept flag.

3.6.1  –  Default

    Recognition is turned on.

3.7  –  Hyphenate

    When the Hyphenate flag (=) is turned on and inserted between
    syllables of a word, DSR knows where the word can be broken at
    the end of a line. DSR inserts a hyphen where the break occurs.
    If DSR does not find it necessary to break the word, however,
    the hyphen does not appear. By default, the Hyphenate flag is
    disabled.

    The action of this flag (as opposed to the recognition of the
    flag) can be disabled or reenabled by the .DISABLE HYPHENATION
    and .ENABLE HYPHENATION commands.

3.7.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS HYPHENATE command.

3.8  –  Index

    With the Index flag (>), you can mark words in the text of your
    document as index entries. Using the .INDEX command instead of
    the Index flag is a more common way of marking index entries.

3.8.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS INDEX command.

3.9  –  Lowercase

    The Lowercase flag (\) causes the letter that directly follows it
    to appear in lowercase. The flag has no effect if the character
    following it is not a letter.

    The Lowercase flag can be paired as follows:

    o  With the Underline flag (\&) to stop underlining text.

    o  With the Bold flag (\*) to stop bolding characters.

    o  With itself (\\) to cause the characters following it to be
       printed in lowercase by default. If you have a file that is
       in all uppercase, you can put a paired lowercase flag (\\)
       at the beginning of the file and then, as needed, override
       the temporary lowercase default by using a circumflex (^) to
       capitalize the letter following it.

3.9.1  –  Default

    Recognition is turned on.

3.10  –  Overstrike

    When the Overstrike flag (%) is turned on and inserted between
    two characters, it causes the first of the two characters to be
    overstruck by the following one. By default, the Overstrike flag
    is disabled.

    This capability allows the printing of characters not normally
    available, for example, a European 7, which is a 7 overstruck
    with a hyphen.

    Three or more characters can be overstruck, but only if you
    specify the /BACKSPACE qualifier in the DSR command line.
    Otherwise, only the first and last characters in an overstrike
    sequence will appear.

    The action performed by this flag (as opposed to the flag's
    recognition) can be disabled and reenabled by the .DISABLE
    OVERSTRIKING and .ENABLE OVERSTRIKING commands.

3.10.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS OVERSTRIKE command.

3.11  –  Period

    DSR routinely inserts an extra expandable space after a period
    (.), colon (:), question mark (?), or exclamation point (!) that
    is followed by the usual end-of-word space.

    The Period flag (+) lets you specify the extra space following
    other characters.

    If the flag is turned on and .FILL is in effect, an extra
    space occurs when the flag (+) is inserted directly after the
    character. You must, however, insert the end-of-word space after
    the flag if it is to be effective.

    For example, if you have a complete sentence enclosed in
    quotation marks or parentheses, you may want an extra space after
    the closing quotation mark or parenthesis.

3.11.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS PERIOD command.

3.12  –  Space

    The Space flag (#) produces one unexpandable space (not affected
    by justification) in the output file for every flag character
    inserted in the input file. If you insert the flag between two
    words, DSR treats them as one word (although they will appear
    as separate words in the output file). Therefore, you should not
    type any spaces before or after typing the Space flag.

    The flag can directly follow an Underline flag (&#) to cause the
    underlining of an unexpandable space.

3.12.1  –  Default

    Recognition is turned on.

3.13  –  Subindex

    The Subindex flag (>) works as a subindex entry flag only if you
    have issued an .INDEX or .ENTRY command. Subindex entries marked
    with this flag are collected and alphabetized below the primary
    entry to which they refer. The Subindex flag indicates that the
    next word or phrase will be placed on the following line of the
    index, indented two characters to the right of the preceding
    entry.

3.13.1  –  Default

    Recognition is turned on only within .INDEX and .ENTRY commands.

3.14  –  Substitute

    The Subsitute flag ($$) is the only flag that must be used in
    pairs. When the flag is turned on, it causes either a date or
    a time to be output. The output is determined by the word you
    associate with the flag pair; for example, $$Date. See the output
    in the following example.

    When the Substitute flag is turned on, any dollar sign character
    ($), even if it is not paired, must be preceded by an Accept flag
    if it is to be taken as normal text by DSR.

3.14.1  –  Default

    Recognition is turned off. To turn on recognition, you must use
    the .FLAGS SUBSTITUTE command.

3.14.2  –  Examples

    The following table shows the use of the substitute flag. The
    output file will contain the date and time that DSR processing of
    the file began.

    Input                  Output

    .FLAGS SUBSTITUTE
    $$Date                 10 November 1993
    $$Time                 10:55:00
    $$Year                 1993
    $$Month                November
    $$Day                  10
    $$Hours                10
    $$Minutes              55
    $$Seconds              00
    $$Month#$$Day,#$$Year  November 10, 1993

3.15  –  Underline

    The Underline flag (&) causes the next character to be
    underlined.

    The operation performed by this flag (as opposed to the flag's
    recognition) can be disabled and reenabled by the .DISABLE
    UNDERLINING and .ENABLE UNDERLINING commands.

    The Underline flag can be paired as follows:

    o  With the Uppercase flag (^&) to turn underlining on and with
       the Lowercase flag (\&) to turn underlining off.

    o  With the Space flag (&#) to cause the underlining of
       unexpandable spaces.

3.15.1  –  Default

    Recognition is turned on.

3.16  –  Uppercase

    The Uppercase flag (^) serves the same purpose as a typewriter
    Shift key when you use it just before typing a letter. The flag
    capitalizes any single letter that directly follows it. It has no
    effect if the character following it is not a letter.

    The Uppercase flag can be paired as follows:

    o  With a Capitalize flag (^<) to turn on the capitalization
       of the text that follows (the same as using Shift-Lock on a
       typewriter).

    o  With an Underline flag (^&) to turn on underlining of the text
       that follows.

    o  With a Bold flag (^*) to turn on bolding for the text that
       follows.

    o  With itself (^^) if you want to ensure that the case of
       letters in your input file is maintained in your output
       file. You can use this flag pair with those commands that
       control uppercasing and lowercasing (such as .HEADER LEVEL
       or .CHAPTER). When you specify a title, precede it with two
       circumflexes (^^).

3.16.1  –  Default

    Recognition is turned on.
Close Help