HP 3000 Manuals

FORMAT [ HP SYSTEM DICTIONARY XL SDMAIN ] MPE/iX 5.0 Documentation


HP SYSTEM DICTIONARY XL SDMAIN

FORMAT 

Defines titles and/or page headers for dictionary reports.

Syntax 

     F[ORMAT]
           [;ALIGN[MENT] = alignment-option]
           [;F[ORMAT]-V[ARIABLE] = format-flag]
           [;P[AGE-]H[EADER] = ["page-header-text"]]
           [;TI[TLE] = ["title-text"]]
            .

Parameters 

alignment-option      A value that specifies which alignment option to
                      use with the output data from the dictionary.
                      Valid choices are:

                      aligned       Aligns all values with respect to the
                                    longest value header.

                      fixed-        Aligns all values assuming a fixed
                      aligned       length header of 15 characters.  If
                                    any value header (attribute name) is
                                    larger than 15 characters, it is
                                    truncated at 15 characters and a
                                    caret (^) is placed in the 16the
                                    position to indicate that the name is
                                    truncated.

                      unaligned     Aligns each value independently,
                                    immediately after its respective
                                    value header.

                      The default is to print the values unaligned.

format-flag           A value indicating how the text of variable length
                      attributes is formatted.  Valid choices are:

                      on            Formats the variable length attribute
                                    text before it is printed.

                      off           Does not format the variable length
                                    attribute text before it is printed.
                                    The text is printed in the format in
                                    which it is stored.

                      The default is for the text to be formatted.  If
                      the text is not formatted and a line will not fit
                      within the page or screen boundaries, the line will
                      wrap-around to the next line.

page-header-text      A quoted string that is printed at the top of each
                      page of a report for all output that is sent to a
                      destination other than the terminal.  It uses the
                      following format:

                      string1; string2; string3

                      where 

                      string1 is set flush to the left margin string2 is
                      centered on the page string3 is set flush to the
                      right margin

                      You can omit any of the strings by leaving them
                      blank.

                      Two special characters are recognized:

                      ^ substitutes the current date and time

                      !  substitutes an ascending page number

title-text            A quoted string that is printed on the first page
                      as the title of the report.  It is centered on the
                      page with three blank lines before and two lines
                      after.

Description 

To delete a value from the PAGE-HEADER or TITLE keyword, specify the
keyword with no value.

To reset all values to their default, issue the FORMAT command with no
keywords.

If you redefine the dictionary environment, (that is, switch scopes, open
a new dictionary, etc.), you do not need to reissue the FORMAT command if
this information remains the same for the new environment.

Open Mode:       Any

Scope:           Any

Example 

The following example sets up a page header including the current date
and time at the left margin, the string "January Month-End Report" in the
middle, and ascending page numbers at the right margin.  The title,
alignment, and format-variable options remain unchanged.

     >FORMAT PAGE-HEADER = "^;January Month-End Report;!". 
     >


MPE/iX 5.0 Documentation