summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/enf.helpmark
blob: 4faefbc5585f9dcbae3bb465d5f0647616948d45 (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
+-----------------------------------------------------------------------------+
|                                endnoteformat                                |
+-----------------------------------------------------------------------------+
 
\endnoteformat{\skipbefore{4pt}
        \textreferenceposition{down}
        \textreferencefont{\rm}
        \textreferencestyle{[1]}
        \notereferenceposition{down}
        \notereferencefont{\tenpt}
        \notereferencestyle{1.}
        \notereferencegutter{1em}
        \everyendnote{\tenpt\pin{0pt}\lin{1.2em}}}
 
Abbreviation:  ã|\enfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã|\skipbefore, \textreferenceposition,
\textreferencefont, \textreferencestyle, \notereferenceposition, \noterefer-
encefont, \notereferencestyle, \notereferencegutter, \everyendnoteã%
 
    ã|Description:ã%
The \endnoteformat markup allows you to modify the shape and presentation of
endnotes generated with \autoendnote.
 
\skipbefore   indicates how much  space is to  be skipped  before printing a
block.  This amount is in addition to any paragraph skips.
 
\textreferenceposition    determines  if  the  endnote reference  number  is
superscripted or not.   By default, the reference is  not superscripted.  If
you want the  endnote reference number to be  superscripted, then change the
parameter to "up".
 
\textreferencefont   lets  you change  the face  or size.    By  default the
endnote reference number is always printed in the standard font.
 
\textreferencestyle  determines the numbering  style at the end of a chapter
or the end of the document (wherever the \printendnotes appears).  There are
five possible values:
  1. "1" for numbered endnotes
  2. "(1)" for numbered endnotes with parentheses
  3. "[1]" for numbered endnotes with square brackets
  4. "a" for lettered endnotes
  5. "(a)" for lettered endnotes with parentheses
The default is Arabic numerals in square brackets.
 
\notereferenceposition    determines  if  the  endnote reference  number  is
superscripted or not when  it is printed at the end  of a chapter or the end
of a document.  By default, the reference is not superscripted.  If you want
the endnote reference number  to be superscripted, then change the parameter
to "up".
 
\notereferencefont   lets  you change  the face  or size.    By  default the
endnote  reference number  printed at  the end  of a  chapter  (or end  of a
document, wherever \printendnotes occurs)  is always printed in the standard
font.
 
\notereferencestyle    determines the  numbering  style.     There are  five
possible values:
  1. "1."  for numbered endnotes
  2. "(1)" for numbered endnotes with parentheses
  3. "[1]" for numbered endnotes with square brackets
  4. "a" for lettered endnotes
  5. "(a)" for lettered endnotes with parentheses
The default is numbered endnotes.
 
\notereferencegutter   specifies  the amount  of  space between  the endnote
number and the endnote  text.  The gutter is  illustrated here as the shaded
portion between "1."  and "The first step":
+-----------------------------------------------------------------------------+
|                                                                             |
|       ...                                                                   |
|     1....The first step . . .                                               |
|                                                                             |
+-----------------------------------------------------------------------------+
 
\everyendnote  lets you  modify the shape of the notes.   You can change the
type face, the paragraph parameters, and the right and left indentation.
 
    ã|Example:ã%
This example shows an endnote style with a superscripted endnote number; the
body of the endnote in a 9 point Computer Modern set; the endnote at the end
of the document (or chapter) indented half an inch from the left and half an
inch from the  right of the rest of  the body of the  text; the endnote body
right ragged; and  the text of the document right  justified and in 10 point
 
Computer Modern.   The  endnote "text" reference  at the end  of the chapter
will retain the default style ("1."  not superscripted).
    Note that 9 point  was specified within both the "notereferencefont" and
"everyendnote" markups.   The  "notereferencefont" determines  the font that
the endnote reference number is to be printed in.  The "everyendnote" markup
determines the font that  the endnote text is to print  in at the end of the
document or end of chapter, wherever the next \printendnotes markup appears.
 
\endnoteformat{\skipbefore{12pt}
         \textreferenceposition{up}
         \textreferencefont{\ninepoint\rm}
         \textreferencestyle{1}
         \notereferenceposition{down}
         \notereferencefont{\ninepoint\rm}
         \notereferencestyle{1.}
         \everyendnote{\rightragged
           \pin{0pt}\psk{12pt}\ninepoint
           \leftindent{.5in}\rightindent{.5in}}
          }
 
 
| . .   automatically sets an interline skip 2 points greater                 |
than the font size.\autoendnote{This extra space is
referred to as leading.} The default font size is  . . .
 
The endnote in the document would look like:
+-----------------------------------------------------------------------------+
|                                                                             |
|  . . .     automatically sets an interline  skip 2 points greater than the  |
| font size.  The default font size is  . . .                                 |
|                                                                             |
+-----------------------------------------------------------------------------+
The endnote printed after the \printendnotes markup would look like:
+-----------------------------------------------------------------------------+
|                                                                             |
|     1.  This extra space is referred to as leading.                         |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Notes:ã%
The \endnoteformat markup must come after the \monospace markup, if both are
used.