SysIII/usr/src/man/docs/mm_man/s06sdf

.tr ~ 
.tr ``
.H 1 "MEMORANDUM AND RELEASED PAPER STYLES
One use of
\*(PM
is for the preparation of
memoranda and released papers,
which have special requirements for the
first page and for the cover sheet.
The information needed for the memorandum
or released paper 
(title, author, date, case numbers, etc.)
is entered in the same way for
.I both 
styles;
an argument to one macro
indicates which style is being used.
The following sections describe the macros used
to provide this data.
The required order is shown in {6.9}.
.P
If neither the memorandum nor released-paper
style is desired, the macros described below should
be omitted from the input text.
If these macros are omitted, the first page will simply have the page header {9}
followed by the body
of the document.
.H 2 Title
.Es 1
\&\f3.\fPTL [charging-case] [filing-case]
\&one or more lines of title text
.Ee
.P 
The arguments to the \f3.\fPTL macro are
the charging case number(s)
and filing case number(s).\*F\ 
.FS
The ``charging case'' is the case number to which time was charged for
the development of the project described in the memorandum.
The ``filing case'' is a number under which the memorandum is to be filed.
.FE
The title of the memorandum or paper follows the \f3.\fPTL macro
and is processed in fill mode {3.1}.
Multiple charging case numbers are entered as ``sub-arguments''
by separating each from the previous with a comma and a space,
and enclosing the
.I entire
argument within double quotes.
Multiple filing case numbers are entered similarly.
For example:
.Es 1
\&\f3.\fPTL "12345, 67890" 987654321
On the construction of a table
of all even prime numbers
.Ee
.P
The
\&\f3.\fPbr
request may be used to break the title
into several lines.
.P
On output, the title appears after the word ``subject''
in the memorandum style.
In the released-paper style,
the title is centered and bold.
.P
If only a charging case number or only a filing case number is given
then it will be separated from the title in the memorandum style by
a dash and will appear on the same line.  If both cases are given and
the numbers are the same then ``Charging and Filing Case'' followed by
the number will appear on a line following the title.  If the cases
are different then separate lines for ``Charging Case'' and ``File Case''
will appear following the title.
.H 2 Author(s)
.Es 1
\&\f3.\fPAU name [initials] [loc] [dept] [ext] [room] [arg] [arg] [arg]
\&\f3.\fPAT [title] \f3.\|.\|.\fP
.Ee
.P 
The \f3.\fPAU macro receives as arguments
information that describes an author.
If any argument contains blanks,
it must be enclosed within double quotes.
The first six arguments must appear in the 
order given
(a separate
\&\f3.\fPAU macro
is required for each author).
.P
The \f3.\fPAT macro is used to specify the author's title.  Up to nine
arguments may be given.  Each will appear in the Signature Block
for memorandum style {6.11.1} on a separate line following the signer's name.
The \f3.\fPAT must immediately follow the \f3.\fPAU for the given author.
For example:
.Es 1
\&\f3.\fPAU "J. J. Jones" JJJ PY 9876 5432 1Z-234
\&\f3.\fPAT Director "Materials Research Laboratory"
.Ee
.P
In the ``from'' portion in the memorandum style,
the author's name is followed by location
and department number on one line
and by room number and extension number on the next.
The ``x'' for the extension
is added automatically.
The printing of the
location, department number, extension number, and room number may be suppressed
on the first page of a memorandum
by setting the register
.I Au
to 0;
the default value for 
.I Au 
is 1.
Arguments 7 through 9 of the \f3.\fPAU macro, if present, will follow
this ``normal'' author information in the ``from'' portion,
each on a separate line.
Certain organizations have their own numbering schemes
for memoranda,
engineer's notes, etc.
These numbers are printed
after the author's name.
This can be done by
providing more than six arguments to the \f3.\fPAU
macro,
e.g.:
.Es 1
\&\f3.\fPAU "S. P. Lename" SPL IH 9988 7766 5H-444 3322.11AB
.Ee
.P
The name, initials, location, and department
are also used in the Signature Block {6.11.1}.
The author information in the ``from'' portion, as well as
the names and initials in the Signature Block will appear in the
same order as the \f3.\fPAU macros.
.P
The names of the authors in the released-paper style
are centered below the title.
After the name of the last author,
``Bell Laboratories''
and the location are centered.
For the case of authors from different locations,
see {6.8}.
.H 2 "TM Number(s)
.Es 1
\&\f3.\fPTM [number] \f3.\|.\|.\fP
.Ee
.P
If the memorandum is a Technical Memorandum,
the TM numbers are supplied via the \f3.\fPTM macro.
Up to nine numbers may be specified.
Example:
.Es 1
\&\f3.\fPTM 7654321 77777777
.Ee 1
This macro call is ignored in the released-paper and external-letter 
styles {6.6}.
.H 2 Abstract
.Es 1
\&\f3.\fPAS [arg] [indent]
text of the abstract
\&\f3.\fPAE
.Ee
.P
Three styles of cover sheet are available:  Technical Memorandum,
Memorandum for File, and released paper.
On the cover sheet,
the text of the abstract
follows the author information and is
preceded by the centered and underlined (italic) word ``ABSTRACT.''
.P 
The \f3.\fPAS (abstract start) and \f3.\fPAE (abstract end) macros bracket the 
abstract (which is optional except that for the Memorandum for File
style no cover sheet
will be produced
.I unless
an abstract is given).
.P
A combination of
the first argument to \f3.\fPAS and the use of the \f3.\fPCS macro
controls the production of the cover sheet.  If the first argument is 2,
a Memorandum for File cover sheet is generated automatically.  Any other
value for the first argument causes the text of the abstract to be
saved until the \f3.\fPCS macro is invoked and then the appropriate
cover sheet (either Technical Memorandum or released paper depending on
the \f3.\fPMT type) is generated.
Thus, \f3.\fPCS is
.I not
needed for Memorandum for File cover sheets.
.P
Notations {6.11.2}, such as a ``copy to'' list, are allowed on Memorandum
for File cover sheets.  The \f3.\fPNS and \f3.\fPNE macros are
given following the \f3.\fPAS 2 and \f3.\fPAE.
.P
The abstract is printed with the ordinary text margins.  An indentation
to be used for both margins can be specified as
the second argument for \f3.\fPAS.\*F\ 
.FS
Values that specify indentation must be
.I unscaled
and are treated as ``character positions,''
i.e., as the number of
.I ens.
.FE
.P
Note that headings {4.2, 4.3} and displays {7} are
.I not
permitted within an abstract.
.H 2 "Other Keywords
.Es 1
\&\f3.\fPOK [keyword] \f3.\|.\|.\fP
.Ee
.P 
Topical keywords should be specified
on a Technical Memorandum cover sheet.
Up to nine such keywords or keyword phrases may be specified as arguments
to the \f3.\fPOK macro;
if any keyword contains spaces, 
it must be enclosed within double quotes.
.H 2 "Memorandum Types
.Es 1
\&\f3.\fPMT [type] [addressee]
.Ee
.P 
The \f3.\fPMT macro controls the format of the
top part of the first page of a memorandum or of a released paper,
as well as the format of the cover sheets.
Legal codes for
.I type
and the corresponding values are:
.! tbl tbl-6.6
.P
If
.I type
indicates a memorandum style,
then
.I value
will be printed after
the last line of author information.
If
.I type
is longer than one character,
then
the string, itself,
will be printed.
For example:
.Es 1
\&\f3.\fPMT "Technical Note #5"
.Ee
.P 
A simple letter is produced
by calling \f3.\fPMT with a
null
(but
.I not
omitted!)
or zero argument.
.P 
The second argument to \f3.\fPMT is used
to give the name of the addressee of a letter.  The name and page number
will be used to replace the ordinary page header on the second and following
pages of the letter.  For example,
.Es 1
\&\f3.\fPMT 1 "John Jones"
.Ee
produces
.Es 1
John Jones - 2
.Ee
This second argument may
.I not
be used
if the first argument is 4
(i.e., for the released-paper style) as explained in {6.8}.
.P
In the external-letter style (\f3.\fPMT 5),
only the title (without the word ``subject:'') and the date
are printed in the upper left and right corners, respectively,
on the first page.
It is expected that preprinted stationery will be used,
providing the author's company logotype and address.
.H 2 "Date and Format Changes"
.H 3 "Changing the Date
By default, the current date appears 
in the ``date'' part
of a memorandum.
This can be overridden by using:
.Es 1
\&\f3.\fPND new-date
.Ee
.P
The \f3.\fPND macro alters the value of the string
.I DT ,
which is initially set to the current date.
.H 3 "Alternate First-Page Format"
One can specify that the words
``subject,'' ``date,'' and ``from''
(in the memorandum style)
be omitted
and that an alternate company name be used:
\&
.Es 1
\&\f3.\fPAF [company-name]
.Ee
.P 
If an argument is given, it replaces ``Bell Laboratories'',
without affecting the other headings.
If the argument is
.I null,
``Bell Laboratories'' is suppressed;
in this case, extra blank lines
are inserted to allow room for stamping the
document with a Bell System logo or a Bell Laboratories stamp.
\&\f3.\fPAF with
.I no 
argument suppresses ``Bell Laboratories''
and the ``Subject/Date/From''
.I headings,
thus allowing output on preprinted stationery.
The use of \f3.\fPAF with no arguments is equivalent to the use of
-rA1 {2.4} except that the latter
.I must
be used if it is necessary to change the line length and/or page offset
(which default to 5.8i and 1i, respectively, for preprinted forms).
The command line options -rOk and -rWk are not effective with \f3.\fPAF.
.P
The only \f3.\fPAF option appropriate for
.I troff
is to specify an argument to
replace ``Bell Laboratories'' with another name.
.H 2 "Released-Paper Style
The released-paper style
is obtained by specifying:
.Es 1
\&\f3.\fPMT 4 [1]
.Ee 1
This
results in
a centered, bold title
followed by centered names of authors.
The location of the last author is used as
the location following 
``Bell Laboratories''
(unless \f3.\fPAF {6.7.2} specifies a different company).
If the optional second argument to \f3.\fPMT\ 4 is given,
then the name of each author is followed by the respective
company name and location.
.P
Information necessary for the memorandum style
but not for the released-paper style is ignored.
.P
If the released-paper style is utilized,
most BTL location codes\*F
.FS
The complete list is: AK, CP, CH, CB, DR, HO, HOH, HP, IN, IH,
MV, MH, PY, RR, RD, WB, WV, and WH.
.FE
are defined as strings that are the addresses of the
corresponding BTL locations.
These codes are needed only
until
the \f3.\fPMT macro is invoked.
Thus,
.I following
the \f3.\fPMT macro, the user may re-use
these string names.
In addition, the macros described in {6.11}
and their associated lines of input
are ignored when the released-paper style is specified.
.P
Authors from non-BTL locations may include their affiliations
in the released-paper style
by specifying the appropriate
\&\f3.\fPAF
and defining a string (with a 2 character name such as XX) for the address
.I before 
each \f3.\fPAU.
For example:
.Es 1
\&\f3.\fPTL
\&A Learned Treatise
\&\f3.\fPAF "Getem Inc\f3.\fP"
\&\f3.\fPds XX "22 Maple Avenue, Sometown 09999"
\&\f3.\fPAU "F. Swatter" "\^" XX
\&\f3.\fPAF "Bell Laboratories"
\&\f3.\fPAU "Sam P. Lename" "\^" CB 
\&\f3.\fPMT 4 1
.Ee
.H 2 "Order of Invocation of ``Beginning'' Macros"
The macros described in {6.1-6.7},
.I "if present,"
must be given in the following order:
.Es 1
\&\f3.\fPND new-date  
\&\f3.\fPTL [charging-case] [filing-case]
\&one or more lines of text
\&\f3.\fPAF [company-name]  
\&\f3.\fPAU name [initials] [loc] [dept] [ext] [room] [arg] [arg] [arg] 
\&\f3.\fPAT [title] \f3.\|.\|.\fP
\&\f3.\fPTM [number] \f3.\|.\|.\fP
\&\f3.\fPAS [arg] [indent]
one or more lines of text
\&\f3.\fPAE  
\&\f3.\fPNS [arg]
one or more lines of text
\&\f3.\fPNE
\&\f3.\fPOK [keyword] \f3.\|.\|.\fP
\&\f3.\fPMT [type] [addressee]
.Ee
.P 
The only
.I required
macros for a memorandum or a released paper
are \f3.\fPTL, \f3.\fPAU, and \f3.\fPMT;
all the others (and their associated input lines)
may be omitted if the features they provide are not needed.
Once \f3.\fPMT has been invoked,
.I none
of the above macros (except \f3.\fPNS and \f3.\fPNE)
can be re-invoked because they are
removed from the table of defined macros to save space.
.H 2 Example
The input text for this manual begins as follows:
.Es 1
\&\f3.\fPTL 
MM\e*(EMMemorandum Macros 
\&\f3.\fPAU "D. W. Smith" DWS PY \f3.\|.\|.\fP
\&\f3.\fPAU "J. R. Mashey" JRM  WH \f3.\|.\|.\fP
\&\f3.\fPAU "E. C. Pariser (January 1980 Revision)" ECP PY \f3.\|.\|.\fP
\&\f3.\fPAU "N. W. Smith (April 1980 Revision)" NWS PY \f3.\|.\|.\fP
\&\f3.\fPMT 4
.Ee
.H 2 "Macros for the End of a Memorandum"
At the end of a memorandum
(but not of a released paper),
the signatures of the authors
and a list of notations\*F
.FS 
See
the
.I "BTL Office Guide"\c
\^\*(Rf, pp. 1.12\*-16
.FE
.RS BB
Bell Laboratories,
Methods and Systems Department.
.I
Office Guide.
.R
Unpublished Memorandum,
Bell Laboratories,
April 1972 (as revised).
.RF
can be requested.
The following macros and their input are ignored if the
released-paper style is selected.
.H 3 "Signature Block"
\&
.Es 1
\&\f3.\fPFC [closing]
\&\f3.\fPSG [arg] [1]
.Ee
.P
\&\f3.\fPFC prints ``Yours very truly,'' as a formal closing.
It must be given before the \f3.\fPSG which prints the signer's name.
A different closing may be specified as an argument to \f3.\fPFC.
.P 
\&\f3.\fPSG prints the
author name(s) after the formal closing (or the last line of text).
Each name begins at the center of the page.
Three blank lines are left above each name for the actual signature.
If no argument is given, the line of reference data\*F
.FS
The following information is known as reference data:
location code, department number,
author's initials, and typist's initials, all
separated by hyphens.
See
the
.I "BTL Office Guide"\c
\^\*(BB,
page 1.11
.FE
will
.I not
appear following the last line.
.P
A non-null first argument
is treated as the typist's initials,
and is appended to the reference data.
Supply a null argument
to print reference data with neither the
typist's initials nor the preceding hyphen.
.P
If there are several authors and
if the second argument is given, then the reference data is
placed on the same line as the name of the first author,
rather than on the line that has the name of the last author.
.P
The reference data 
contains only the location and department
number of the first author.
Thus,
if there are authors from different departments and/or from different
locations,
the reference data should be supplied 
manually after the invocation (without arguments) of the \f3.\fPSG macro.
For example:
.Es 1
\&\f3.\fPSG
\&\f3.\fPrs
\&\f3.\fPsp -1v
PY/MH-9876/5432-JJJ/SPL-cen
.Ee
.H 3 "``Copy to'' and Other Notations"
\&
.Es 1
\&\f3.\fPNS [arg]
\&zero or more lines of the notation
\&\f3.\fPNE
.Ee
.P 
After the signature and reference data,
many types of notations may follow, such as
a list of attachments or ``copy to'' lists.
The various notations are obtained through the \f3.\fPNS macro,
which provides for the proper spacing
and for breaking the notations across pages,
if necessary.
.P
The codes for
.I arg
and the corresponding notations are:
.! tbl tbl-6.11.2
.P 
If
.I arg
consists of more than one character, 
it is 
placed within parentheses between the words ``Copy''
and ``to.''\ 
For example:
.Es 1
\&\f3.\fPNS "with att. 1 only"
.Ee1
will generate ``Copy (with att. 1 only) to''
as the notation.
More than one notation may be specified
before the \f3.\fPNE occurs,
because a \f3.\fPNS macro terminates
the preceding notation, if any.
For example:
.Es  1
\&\f3.\fPNS 4
\&Attachment 1-List of register names
\&Attachment 2-List of string and macro names
\&\f3.\fPNS 1
\&J. J. Jones
\&\f3.\fPNS 2
\&S. P. Lename
\&G. H. Hurtz
\&\f3.\fPNE
.Ee 1
would be formatted as:
.DS L N
.nf
.in +\n(Sin
Atts.
Attachment 1-List of register names
Attachment 2-List of string and macro names
.ie t .sp .5
.el .sp
Copy (with att.) to
J. J. Jones
.ie t .sp .5
.el .sp
Copy (without att.) to
S. P. Lename
G. H. Hurtz
.in -\n(Sin
.fi
.DE
.P
The \f3.\fPNS and \f3.\fPNE macros may also be used at the beginning
following \f3.\fPAS\ 2 and \f3.\fPAE to place the notation list on the
Memorandum for File cover sheet {6.4}.  If notations are given at the beginning
without \f3.\fPAS\ 2, they will be saved and output at the end of the
document.
.H 3 "Approval Signature Line"
.Es 1
\&\f3.\fPAV approver's-name
.Ee
The \f3.\fPAV macro may be used after the last notation block to automatically
generate a line with spaces for the approval signature and date.  For example,
.Es 1
\&\f3.\fPAV "Jane Doe"
.Ee
produces:
.Es 1
.AV "Jane Doe"
.Ee
.H 2 "Forcing a One-Page Letter"
At times, one would like just a bit more space on the page,
forcing the signature or items
within notations onto the bottom
of the page, so that the letter or memo is just one page in length.
This can be accomplished by increasing the page length through
the -rL\f2n\fP option, e.g. -rL90.
This has the effect of making the formatter believe
that the page is 90 lines long and therefore
giving it more room than usual to
place the signature or the notations.
This will
.I only
work for a
.I single-page
letter or memo.