mosd(5) mosd(5)
NAME
mosd - the OSDD adapter macro package for formatting
documents
SYNOPSIS
osdd [options] [files]
mm -mosd [options] [files]
nroff -mm -mosd [options] [files]
nroff -cm -mosd [options] [files]
mmt -mosd [options] [files]
troff -mm -mosd [options] [files]
troff -cm -mosd [options] [files]
DESCRIPTION
The OSDD adapter macro package is a tool used in conjunction
with the mm macro package to prepare Operations Systems
Deliverable Documentation. Many of the OSDD Standards are
different than the default format provided by mm. The OSDD
adapter package sets the appropriate mm options for
automatic production of the OSDD Standards. The OSDD
adapter package also generates the correct OSDD page headers
and footers, heading styles, Table of Contents format, etc.
OSDD document (input) files are prepared with the mm macros.
Additional information which must be given at the beginning
of the document file is specified by the following string
definitions:
.ds H1 document-number
.ds H2 section-number
.ds H3 issue-number
.ds H4 date
.ds H5 rating
The document-number should be of the standard 10 character
format. The words ``Section'' and ``Issue'' should not be
included in the string definitions; they will be supplied
automatically when the document is printed. For example:
.ds H1 OPA-1P135-01
.ds H2 4
.ds H3 2
automatically produces:
OPA-1P135-01
Section 4
Issue 2
as the document page header. Quotation marks are not used
in string definitions.
If certain information is not to be included in a page
Page 1 (last mod. 1/14/87)
mosd(5) mosd(5)
header, then the string is defined as null; e.g.,
.ds H2
means that there is no section-number.
The OSDD Standards require that the ``Table of Contents'' be
numbered beginning with ``Page 1''. By default, the first
page of text will be numbered ``Page 2''. If the ``Table of
Contents'' has more than one page, for example n, then
either -rPn+1 must be included as a command line option or
.nr P n must be included in the document file. For example,
if the ``Table of Contents'' is four pages, then use -rP5 on
the command line or .nr P 4 in the document file.
The OSDD Standards require that certain information such as
the document rating appear on the ``Document Index'' or on
the ``Table of Contents'' page if there is no index. By
default, it is assumed that an index has been prepared
separately. If there is no index, the following must be
included in the document file:
.nr Di 0
This will ensure that the necessary information is included
on the ``Table of Contents'' page.
The OSDD Standards require that all numbered figures be
placed at the end of the document. The .Fg macro is used to
produce full page figures. This macro produces a blank page
with the appropriate header, footer, and figure caption.
Insertion of the actual figure on the page is a manual
operation. The macro usage is:
.Fg page-count "figure caption"
where page-count is the number of pages required for a
multi-page figure (default 1 page).
Figure captions are produced by the .Fg macro using the
.BS/.BE macros Thus the .BS/.BE macros are also not
available for users. The .Fg macro cannot be used within
the document unless the final .Fg in a series of figures is
followed by a .SK macro to force out the last figure page.
The ``Table of Contents'' for OSDD documents (see Figure 4
in Section 4.1 of the OSDD Standards) is produced with:
.Tc
System Type
System Name
Document Type
.Td
Page 2 (last mod. 1/14/87)
mosd(5) mosd(5)
The .Tc/.Td macros are used instead of the .TC macro from
mm.
By default, the adapter package causes the ``NOTICE''
disclosure statement to be printed. The .PM macro may be
used to suppress the ``NOTICE'' or to replace it with the
``PRIVATE'' disclosure statement as follows:
.PM none printed
.PM P ``PRIVATE'' printed
.PM N ``NOTICE'' printed (default)
The .P macro is used for paragraphs. The Np register is set
automatically to indicate the paragraph numbering style. It
is very important that the .P macro be used correctly. All
paragraphs (including those immediately following a .H
macro) must use a .P macro. Unless there is a .P macro,
there will not be a number generated for the paragraph.
Similarly, the .P macro should not be used for text which is
not a paragraph. The .SP macro may be appropriate for these
cases, e.g., for ``paragraphs'' within a list item.
The page header format is produced automatically in
accordance with the OSDD Standards. The OSDD Adapter macro
package uses the .TP macro for this purpose. Therefore the
.TP macro normally available in mm is not available for
users.
FILES
/usr/lib/tmac/tmac.osd
SEE ALSO
mm(1), mmt(1), nroff(1), troff(1), mm(5).
``mm Reference'' and ``Other text processing tools'' in Oreo
Text Processing Tools.
Page 3 (last mod. 1/14/87)