SysIII/usr/src/man/docs/mm_man/s08fs

.H 1 FOOTNOTES
There are two macros that delimit the 
text of footnotes,\*F
.FS
Footnotes are processed in an environment that is different from that
of the body of the text
(see the \f3.\fPev request\*(II).
.FE
a string used to automatically number the footnotes,
and a macro 
that specifies the style of the footnote text.
.H 2 "Automatic Numbering of Footnotes
Footnotes may be automatically numbered by 
typing the three characters ``\\\(**F''
immediately after the text to be footnoted,
without any intervening spaces.
This will place the
next sequential footnote 
number (in a smaller point size)
a half-line above the text to be footnoted.
.H 2 "Delimiting Footnote Text
There are two macros that delimit the text of each footnote:
.Es1
\&\f3.\fPFS [label]
\&one or more lines of footnote text
.br
\&\f3.\fPFE
.Ee
.P
The \f3.\fPFS (footnote start) marks the beginning
of the text of the footnote,
and the \f3.\fPFE marks its end.
The
.I label 
on the \f3.\fPFS, if present, will be used
to mark the footnote text.
Otherwise, the number retrieved from the string F will be used.
Note that automatically-numbered and user-labeled
footnotes may be intermixed.
If a footnote is labeled (\f3.\fPFS 
.I label \^),
the text to be
footnoted
.I must 
be followed by 
.I label,
rather than by ``\\\(**F''.
The text between \f3.\fPFS and \f3.\fPFE
is processed in fill mode.
Another \f3.\fPFS, a \f3.\fPDS, or a \f3.\fPDF are
.I not 
permitted
between the \f3.\fPFS and \f3.\fPFE macros\f3.\fP
Automatically numbered footnotes may not be used for information, such as
the title and abstract, to
be placed on the cover sheet,
but labeled footnotes are allowed.
Similarly, only labeled footnotes may be used with tables {7.3}.
Examples:
.Es1
1.  Automatically-numbered footnote:
.ie t .sp .5
.el .sp
.in +5n
This is the line containing the word\\\\\(**F
\&\f3.\fPFS
This is the text of the footnote.
\&\f3.\fPFE
to be footnoted.
.in -5n
.Ee1
.Es1
2.  Labelled footnote:
.ie t .sp .5
.el .sp
.in +5n
This is a labeled\(**
\&\f3.\fPFS \(**
The footnote is labeled with an asterisk.
\&\f3.\fPFE
footnote.
.in -5n
.Ee
.P
The text of the footnote (enclosed within the \f3.\fPFS-\f3.\fPFE pair) should 
.I immediately
follow the word to be footnoted in the input text,
so that
``\\\(**F'' or
.I label 
occurs at the end of a line of input
and the next line is the \f3.\fPFS macro call\f3.\fP
It is also good practice to append a unpaddable space {3.3}
to ``\\\(**F'' or
.I  label
when they follow an
end-of-sentence punctuation mark
(i.e., period, question mark, exclamation point).
.P
Appendix B illustrates the various available footnote styles as well as
numbered and labeled footnotes.
.H 2 "Format of Footnote Text \*(BU
.Es 1
\&\f3.\fPFD [arg] [1]
.Ee
Within the footnote text, the user can control
the formatting style by specifying text
hyphenation, right margin justification,
and text indentation, as well as left- or right-justification of the label
when text indenting is used.
The \f3.\fPFD macro is invoked to select the appropriate style\f3.\fP
The first argument is a number from 
the left column of the following table.
The formatting style for each number is given by the remaining four columns.
For further explanation of the first two of these columns, see the
definitions of the
\&\f3.\fPad, \f3.\fPhy, \f3.\fPna,
and
\&\f3.\fPnh
requests\*(II.
.! tbl tbl-8.3
.P
.tr ~
If the first argument to \f3.\fPFD is out of range,
the effect is as if \f3.\fPFD~0 were specified.
If the first argument is omitted or null,
the effect is equivalent to \f3.\fPFD~10 in 
.I nroff
and to \f3.\fPFD~0 in
.I troff;
these are also the respective initial defaults.
.P
.tr ~~
If a second argument is specified, 
then whenever a first-level heading 
is encountered,
automatically-numbered
footnotes begin again with 1.
This is most useful with the ``section-page'' page
numbering scheme.
As an example, the input line:
.Es 1
\&\f3.\fPFD "\|" 1
.Ee 1
maintains the default formatting style
and causes footnotes to be numbered afresh after each first-level heading.
.P
For long footnotes that continue onto the following page,
it is possible that,
if hyphenation is permitted,
the last line of the footnote on the current page
will be hyphenated.
Except for this case
(over which the user has control
by specifying an
.I even 
argument to \f3.\fPFD),
hyphenation across pages is inhibited by
\*(PM.
.P
Footnotes are separated from the body of the text by a short
rule.
Footnotes that continue to the next page
are separated from the body of the text by a full-width rule.
In
.I troff,
footnotes are set in type that is two points smaller than the
point size used in the body of the text.
.H 2 "Spacing between Footnote Entries
Normally, one blank line (a three-point vertical space) separates
the footnotes
when more than one occurs on a page.
To change this spacing,
set the register
.I Fs
to the desired value.
For example:
.Es1
\&\f3.\fPnr Fs 2
.Ee 1
will cause two blank lines (a six-point vertical space) to occur between footnotes.