doc/groff.html.node/ms-Footnotes.html

   1 <!DOCTYPE html>
   2 <html>
   3 <!-- Created by GNU Texinfo 7.0.3, https://www.gnu.org/software/texinfo/ -->
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   6 <!-- This manual documents GNU troff version 1.23.0.
   7
   8 Copyright © 1994-2023 Free Software Foundation, Inc.
   9
  10 Permission is granted to copy, distribute and/or modify this document
  11 under the terms of the GNU Free Documentation License, Version 1.3 or
  12 any later version published by the Free Software Foundation; with no
  13 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  14 copy of the license is included in the section entitled "GNU Free
  15 Documentation License". -->
  16 <title>ms Footnotes (The GNU Troff Manual)</title>
  17
  18 <meta name="description" content="ms Footnotes (The GNU Troff Manual)">
  19 <meta name="keywords" content="ms Footnotes (The GNU Troff Manual)">
  20 <meta name="resource-type" content="document">
  21 <meta name="distribution" content="global">
  22 <meta name="Generator" content="makeinfo">
  23 <meta name="viewport" content="width=device-width,initial-scale=1">
  24
  25 <link href="index.html" rel="start" title="Top">
  26 <link href="Request-Index.html" rel="index" title="Request Index">
  27 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  28 <link href="ms-Body-Text.html" rel="up" title="ms Body Text">
  29 <link href="ms-Insertions.html" rel="prev" title="ms Insertions">
  30 <style type="text/css">
  31 <!--
  32 a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
  33 div.example {margin-left: 3.2em}
  34 span.r {font-family: initial; font-weight: normal; font-style: normal}
  35 span:hover a.copiable-link {visibility: visible}
  36 strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
  37 -->
  38 </style>
  39
  40
  41 </head>
  42
  43 <body lang="en">
  44 <div class="subsubsection-level-extent" id="ms-Footnotes">
  45 <div class="nav-panel">
  46 <p>
  47 Previous: <a href="ms-Insertions.html" accesskey="p" rel="prev">Tables, figures, equations, and references</a>, Up: <a href="ms-Body-Text.html" accesskey="u" rel="up">Body Text</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Request-Index.html" title="Index" rel="index">Index</a>]</p>
  48 </div>
  49 <hr>
  50 <h4 class="subsubsection" id="Footnotes">4.6.5.10 Footnotes</h4>
  51 <a class="index-entry-id" id="index-ms-macros_002c-footnotes"></a>
  52 <a class="index-entry-id" id="index-footnotes-_005bms_005d"></a>
  53
  54 <a class="index-entry-id" id="index-footnote-marker-_005bms_005d"></a>
  55 <a class="index-entry-id" id="index-marker_002c-footnote-_005bms_005d"></a>
  56 <p>A footnote is typically anchored to a place in the text with a
  57 <em class="dfn">marker</em>, which is a small integer, a symbol such as a dagger, or
  58 arbitrary user-specified text.
  59 </p>
  60 <dl class="first-deffn">
  61 <dt class="deffn" id="index-_005c_002a_005b_002a_005d"><span class="category-def">String: </span><span><strong class="def-name"><code class="t">\*[*]</code></strong><a class="copiable-link" href='#index-_005c_002a_005b_002a_005d'> &para;</a></span></dt>
  62 <dd><a class="index-entry-id" id="index-_002a-_005bms_005d"></a>
  63 <p>Place an <em class="dfn">automatic number</em>, an automatically generated numeric
  64 footnote marker, in the text.  Each time this string is interpolated,
  65 the number it produces increments by one.  Automatic numbers start at 1.
  66 This is a Berkeley extension.
  67 </p></dd></dl>
  68
  69 <p>Enclose the footnote text in <code class="code">FS</code> and <code class="code">FE</code> macro calls to set
  70 it at the nearest available &ldquo;foot&rdquo;, or bottom, of a text column or
  71 page.
  72 </p>
  73 <dl class="first-deffn first-defmac-alias-first-deffn">
  74 <dt class="deffn defmac-alias-deffn" id="index-_002eFS"><span class="category-def">Macro: </span><span><strong class="def-name"><code class="t">.FS</code></strong> <var class="def-var-arguments">[<span class="r"><i class="slanted">marker</i></span>]</var><a class="copiable-link" href='#index-_002eFS'> &para;</a></span></dt>
  75 <dd><a class="index-entry-id" id="index-FS-_005bms_005d"></a>
  76 </dd><dt class="deffnx defmacx-alias-deffnx def-cmd-deffn" id="index-_002eFE"><span class="category-def">Macro: </span><span><strong class="def-name"><code class="t">.FE</code></strong><a class="copiable-link" href='#index-_002eFE'> &para;</a></span></dt>
  77 <dd><a class="index-entry-id" id="index-FE-_005bms_005d"></a>
  78 <p>Begin (<code class="code">FS</code>) and end (<code class="code">FE</code>) a footnote.  <code class="code">FS</code> calls
  79 <code class="code">FS-MARK</code> with any supplied <var class="var">marker</var> argument, which is then
  80 also placed at the beginning of the footnote text.  If <var class="var">marker</var> is
  81 omitted, the next pending automatic footnote number enqueued by
  82 interpolation of the <code class="code">*</code> string is used, and if none exists,
  83 nothing is prefixed.
  84 </p></dd></dl>
  85
  86 <p>You may not desire automatically numbered footnotes in spite of their
  87 convenience.  You can indicate a footnote with a symbol or other text by
  88 specifying its marker at the appropriate place (for example, by using
  89 <code class="code">\[dg]</code> for the dagger glyph) <em class="emph">and</em> as an argument to the
  90 <code class="code">FS</code> macro.  Such manual marks should be repeated as arguments to
  91 <code class="code">FS</code> or as part of the footnote text to disambiguate their
  92 correspondence.  You may wish to use <code class="code">\*{</code> and <code class="code">\*}</code> to
  93 superscript the marker at the anchor point, in the footnote text, or
  94 both.
  95 </p>
  96 <p><code class="code">groff</code> <samp class="file">ms</samp> provides a hook macro, <code class="code">FS-MARK</code>, for
  97 user-determined operations to be performed when the <code class="code">FS</code> macro is
  98 called.  It is passed the same arguments as <code class="code">FS</code> itself.  An
  99 application of <code class="code">FS-MARK</code> is anchor placement for a hyperlink
 100 reference, so that a footnote can link back to its referential
 101 context.<a class="footnote" id="DOCF11" href="groff.html_fot.html#FOOT11"><sup>11</sup></a>  By default, this macro has an empty definition.
 102 <code class="code">FS-MARK</code> is a GNU extension.
 103 </p>
 104 <a class="index-entry-id" id="index-footnotes_002c-and-keeps-_005bms_005d"></a>
 105 <a class="index-entry-id" id="index-keeps_002c-and-footnotes-_005bms_005d"></a>
 106 <a class="index-entry-id" id="index-footnotes_002c-and-displays-_005bms_005d"></a>
 107 <a class="index-entry-id" id="index-displays_002c-and-footnotes-_005bms_005d"></a>
 108 <p>Footnotes can be safely used within keeps and displays, but you should
 109 avoid using automatically numbered footnotes within floating keeps.  You
 110 can place a second <code class="code">\**</code> interpolation between a <code class="code">\**</code> and its
 111 corresponding <code class="code">FS</code> call as long as each <code class="code">FS</code> call occurs
 112 <em class="emph">after</em> the corresponding <code class="code">\**</code> and occurrences of <code class="code">FS</code>
 113 are in the same order as corresponding occurrences of <code class="code">\**</code>.
 114 </p>
 115 <p>Footnote text is formatted as paragraphs are, using analogous
 116 parameters.  The registers <code class="code">FI</code>, <code class="code">FPD</code>, <code class="code">FPS</code>, and
 117 <code class="code">FVS</code> correspond to <code class="code">PI</code>, <code class="code">PD</code>, <code class="code">PS</code>, and <code class="code">CS</code>,
 118 respectively; <code class="code">FPD</code>, <code class="code">FPS</code>, and <code class="code">FVS</code> are GNU extensions.
 119 </p>
 120 <p>The <code class="code">FF</code> register controls the formatting of automatically numbered
 121 footnote paragraphs and those for which <code class="code">FS</code> is given a marker
 122 argument.  See <a class="xref" href="ms-Document-Control-Settings.html">Document Control Settings</a>.
 123 </p>
 124 <p>The default footnote line length is 11/12ths of the normal line length
 125 for compatibility with the expectations of historical <samp class="file">ms</samp>
 126 documents; you may wish to set the <code class="code">FR</code> string to &lsquo;<samp class="samp">1</samp>&rsquo; to align
 127 with contemporary typesetting practices.  In the
 128 past,<a class="footnote" id="DOCF12" href="groff.html_fot.html#FOOT12"><sup>12</sup></a> an <code class="code">FL</code> register
 129 was used for the line length in footnotes; however, setting this
 130 register at document initialization time had no effect on the footnote
 131 line length in multi-column arrangements.<a class="footnote" id="DOCF13" href="groff.html_fot.html#FOOT13"><sup>13</sup></a>
 132 </p>
 133 <p><code class="code">FR</code> should be used in preference to the old <code class="code">FL</code> register in
 134 contemporary documents.  The footnote line length is effectively
 135 computed as &lsquo;<samp class="samp"><i class="slanted">column-width</i> * \*[FR]</samp>&rsquo;.  If an absolute
 136 footnote line length is required, recall that arithmetic expressions in
 137 <code class="code">roff</code> input are evaluated strictly from left to right, with no
 138 operator precedence (parentheses are honored).
 139 </p>
 140 <div class="example">
 141 <div class="group"><pre class="example-preformatted">.ds FR 0+3i \&quot; Set footnote line length to 3 inches.
 142 </pre></div></div>
 143
 144
 145 </div>
 146 <hr>
 147 <div class="nav-panel">
 148 <p>
 149 Previous: <a href="ms-Insertions.html">Tables, figures, equations, and references</a>, Up: <a href="ms-Body-Text.html">Body Text</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Request-Index.html" title="Index" rel="index">Index</a>]</p>
 150 </div>
 151
 152
 153
 154 </body>
 155 </html>