summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/fnf.helpmark
blob: a1d3bd04912327ae62176ae571637e454c7df62e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
+-----------------------------------------------------------------------------+
|                               footnoteformat                                |
+-----------------------------------------------------------------------------+
 
\footnoteformat{\skipbeforedivider{12pt}
      \skipafterdivider{2.6pt}
      \footnotedivider{144pt}
      \textreferenceposition{up}
      \textreferenceplacement{after}
      \textreferencefont{\tenpt}
      \textreferencestyle{1}
      \notereferenceposition{down}
      \notereferencefont{\tenpt}
      \notereferencestyle{1.}
      \notereferencegutter{1em}
      \everyfootnote{\tenpt\pin{20pt}
                       \lin{0pt}}
      }
 
Abbreviation:  ã|\fnfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\skipbeforedivider, \skipafterdivider,
\footnotedivider, \textreferenceposition,
\textreferenceplacement, \textreferencefont,
\textreferencestyle, \textreferencegutter,
\everyfootnote, \notereferenceposition,
\notereferencefont, \notereferencestyle,
\notereferencegutterã%
 
    ã|Description:ã%
To  change the  footnote  style and  any  of the  other  footnote formatting
options of  the \autofootnote markup,  use the \footnoteformat markup.   The
default footnote format is:
 
ã|\skipbeforedividerã%  determines the distance  between the last  line of text
on a  page and the  footnote divider rule  which is printed  just before the
footnotes.  The default for this markup is 12 points.
 
ã|\skipafterdividerã% determines the distance between the footnote divider rule
and the first footnote.  The default for this markup is 2.5 points.
 
ã|\footnotedividerã% determines  the length of a short  rule that separates the
footnotes from text.  The default value is 144 points (2 inches).
 
ã|\textreferencepositionã%  determines if  the footnote  reference number  is a
superscript or not.   By default,  the reference is superscripted  (up).  If
you want  the footnote reference  number to be  on the baseline,  change the
parameter to "down".   The default for \monospace is  "down".  Do not change
it to "up" for \monospace.
 
\textreferenceplacement    determines   if  the  footnote  reference  number
precedes  or follows  the  word being  noted.    By  default,  the reference
will follow the noted word.  If you want the footnote reference number to be
placed before the word being noted, then change the parameter to "before".
 
ã|\textreferencefontã%  lets you  determine how  to print the  footnote number.
The default is the  roman face at 10 point.   For \monospace, the default is
the roman typewriter printer face.
 
ã|\textreferencestyleã%  determines the  numbering  style.     There are  four
possible values:
  1. "1" for numbered superscripted footnotes
  2. "(1)" for numbered footnotes surrounded with parentheses
  3. "a" for lettered footnotes
  4. "(a)" for lettered footnotes surrounded with parentheses
The default  is \textreferencestyle{1} for  composing printers.   Typewriter
printers using \monospace have a default of \textreferencestyle{(1)}.
 
ã|\notereferencepositionã% determines whether  the footnote reference number in
the note  is a  superscript or not.    By default,  the reference is  on the
baseline.   If you want  the footnote reference number  to be superscripted,
change the parameter to "up".   Do note specify "up" for typewriter printers
using \monospace.
 
ã|\notereferencefontã%  lets  you  determine what  font to  print  the footnote
number in.   The default is standard face at 10  point.  For \monospace, the
default is the roman typewriter printer face.
 
ã|\notereferencestyleã%  determines the numbering style  for the notes.   There
are four possible values:
  1. "1" for numbered superscripted footnotes
  2. "(1)" for numbered footnotes surrounded with parentheses
  3. "a" for lettered footnotes
  4. "(a)" for lettered footnotes surrounded with parentheses
The default is \textreferencestyle{1.}.
 
\notereferencegutter  sets the  distance between the footnote number and the
first word  of text  of the  note.   The gutter  is illustrated here  as the
shaded portion between "1."  and "The first step":
 
+-----------------------------------------------------------------------------+
|                                                                             |
|      ....                                                                   |
|     1....The first step . . .                                               |
|      ....                                                                   |
|                                                                             |
+-----------------------------------------------------------------------------+
 
The default is one em space, \notereferencegutter{1em}.
 
\everyfootnote{Nested Markup}   sets the style  for everyfootnote.   You can
change  the type  face, the  paragraph parameters,  and  the right  and left
indentation.  The  default text size is 10 point;  each note is in paragraph
format, with  an indent of  20 points.   Typewriter printers  which must use
\monospace may not change to another font set.
 
    ã|Example:ã%
The  following example  uses a  footnote style  that prints  a superscripted
footnote  number in  the text  and the  note,  the body  of the  footnote in
nine-point  Computer Modern  set, the  footnote at  the  bottom of  the page
indented 36 points from the left and 36 points from the right of the rest of
the body of  the text of the  document, the footnote body  right ragged, and
the text  of the document right  justified and in 10  point Computer Modern.
The \footnoteformat block is modified thus:
 
\footnoteformat{\skipbeforedivider{18pt}
        \footnotedivider{144pt}
        \textreferencefont{\ninepoint\rm}
        \notereferenceposition{up}
        \notereferencefont{\ninepoint\rm}
        \everyfootnote{\rightragged\pin{0pt}
             \psk{12pt}\ninepoint
             \leftindent{36pt}\rightindent{36pt}}}
 
Note that  \ninepoint was specified  within both  the \textreferencefont and
\everyfootnote markups.  The \textreferencefont determines the font that the
 
footnote reference  number is to be  printed in.   The \everyfootnote markup
determines the  font that  the footnote text  is to  print in at  the bottom
of  the page.    Most often  the fonts  specified in  \textreferencefont and
\everyfootnote are the same font.
 
    ã|Notes:ã%
This  markup  modifies  the  style  of the  \autofootnote  markup,  not  the
\footnote markup.
    The \footnoteformat  markup must  come after  the \monospace  markup, if
both are used.