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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<title>Class novel - 6 - Headers and Footers</title>
<link rel="stylesheet" type="text/css" href="html-resources/novel-doc.css"/>
</head>
<body>
<div id="master">
<div id="toc">
<p>Document class "novel"</p>
<p><a href="#a6">6. Headers and Footers</a></p>
<ul>
<li><a href="#a6.1">6.1 Global Header/Footer Settings</a>
<ul>
<li><a href="#a6.1.1">6.1.1 \SetHeadJump{}<br/><span style="visibility:hidden">6.1.1 </span>\SetFootJump{}</a></li>
<li><a href="#a6.1.2">6.1.2 \SetHeadFootStyle{}</a>
<li><a href="#a6.1.3">6.1.3 \SetEmblems{}{}</a></li>
<li><a href="#a6.1.4">6.1.4 \SetPageNumberStyle{}</a></li>
<li><a href="#a6.1.5">6.1.5 \SetHeadFont[]{}</a></li>
<li><a href="#a6.1.6">6.1.6 \SetLooseHead{}</a></li>
<li><a href="#a6.1.7">6.1.7 \SetChapterDisplay{}</a></li>
</ul>
</li><!-- end 6.1 -->
<li><a href="#a6.2">6.2 Local Header/Footer Settings</a>
<ul>
<li><a href="#a6.2.1">6.2.1 \SetVersoHeadText{}<br/><span style="visibility:hidden">6.2.1 </span>\SetRectoHeadText{}</a></li>
<li><a href="#a6.2.2">6.2.2 \thispagestyle{}</a>
</ul>
</li><!-- end 6.2 -->
</ul>
<p> </p>
</div><!-- end toc -->
<div id="main">
<a id="a6"></a>
<h1>Documentation for <code>novel</code> document class</h1>
<p>Documentation version: 1.0.7.</p>
<div class="pagetopage">
<p><b>User Guide</b></p>
<p><a href="noveldocs-01-overview.html">1. Overview</a></p>
<p><a href="noveldocs-02-class-options.html">2. Class Options</a></p>
<p><a href="noveldocs-03-metadata-pdfx.html">3. Metadata, PDF/X</a></p>
<p><a href="noveldocs-04-layout.html">4. Page Layout</a></p>
<p><a href="noveldocs-05-fonts.html">5. Choosing Fonts</a></p>
<p>6. Headers, Footers<br/>
<p><a href="noveldocs-07-text-size-style.html">7. Text Sizes, Styles</a></p>
<p><a href="noveldocs-08-images.html">8. Using Images</a></p>
<p><a href="noveldocs-09-chapters-displays.html">9. Chapters, Display Pages</a></p>
</div>
<h2 style="clear:none;">6. Headers and Footers</h2>
<p><b>Overview:</b> The <code>novel</code> class has a default header style. If you like it, then you do not have to use any of the configuration commands. So, before studying these commands, do a test document that uses the defaults.</p>
<p>You may choose among several pre-configured header/footer styles. Then, you may change the appearance, content, and position. If none of it works for you, then you may define your own headers/footers using <code>fancyhdr</code> syntax. However, just about every style used in fictional works can be obtained using the pre-configured styles and adjustments.</p>
<p>Individual pages, such as title, copyright, and new chapters, can have the header/footer style changed locally, on a per-page basis.</p>
<a id="a6.1"></a>
<h3 style="clear:none;">6.1 Global Header/Footer Settings, only in Preamble.</h3>
<p>These commands determine whether your book will have headers and/or footers, and set the default style that is used for nearly all pages of the text. Per-page exceptions, such as for blank pages, title, copyright, and new chapters, are performed using the local settings commands.</p>
<a id="a6.1.1"></a>
<h4>6.1.1 <code>\SetHeadJump{<em>number of baselines</em>}</code>, <code>\SetFootJump{<em>number of baselines</em>}</code></h4>
<p>These two commands pertain to page layout, rather than style. Their usage is described on <a href="noveldocs-04-layout.html#a4.2.6">Page 4</a>.</p>
<a id="a6.1.2"></a>
<h4>6.1.2 <code>\SetHeadFootStyle{<em>number</em>}</code></h4>
<p>Command <code>\SetHeadFootStyle{<em>number</em>}</code> chooses among several pre-configured header/footer styles, numbered 1 through 6. The default is style 1. The internals of the configuration can then be changed using a variety of commands.</p>
<p>Some styles support an optional "emblem", which applies a decoration near the page number.</p>
<p>Style 0 means neither header nor footer. Not practical for fiction, but it exists.</p>
<p> </p>
<pre style="clear:both"><img class="floatright" src="html-resources/headfoot1.png" width="276" height="219" alt="style 1" title="style 1"/>
<b>\SetHeadFootStyle{1}</b></pre>
<p>Only header.<br/>
Page number at outside (left verso, right recto).<br/>
Optional emblem adjacent to page number.<br/>
Text centered. Default author verso, title recto.<br/>
<em>This is the default for the novel document class.</em></p>
<pre style="clear:both"><img class="floatright" src="html-resources/headfoot2.png" width="276" height="219" alt="style 2" title="style 2"/>
<b>\SetHeadFootStyle{2}</b></pre>
<p>Only footer.<br/>
Page number at outside (left verso, right recto).<br/>
Optional emblem adjacent to page number.</p>
<pre style="clear:both"><img class="floatright" src="html-resources/headfoot3.png" width="276" height="219" alt="style 3" title="style 3"/>
<b>\SetHeadFootStyle{3}</b></pre>
<p>Only footer.<br/>
Page number centered.<br/>
Disregards emblem, if coded.</p>
<pre style="clear:both"><img class="floatright" src="html-resources/headfoot4.png" width="276" height="219" alt="style 4" title="style 4"/>
<b>\SetHeadFootStyle{4}</b></pre>
<p>Only header.<br/>
Page number at outside (left verso, right recto).<br/>
Optional emblem adjacent to page number.<br/>
Text towards outside, instead of centered.<br/>
Text begins or ends 1em from the emblem.<br/>
Default author verso, title recto.</p>
<pre style="clear:both"><img class="floatright" src="html-resources/headfoot5.png" width="276" height="219" alt="style 5" title="style 5"/>
<b>\SetHeadFootStyle{5}</b></pre>
<p>Header and Footer.<br/>
Page number centered in footer.<br/>
Disregards emblem, if coded.<br/>
Text centered in header.<br/>
Default author verso, title recto.</p>
<pre style="clear:both"><img class="floatright" src="html-resources/headfoot6.png" width="276" height="219" alt="style 6" title="style 6"/>
<b>\SetHeadFootStyle{6}</b></pre>
<p>Only header.<br/>
Page number at outside (left verso, right recto).<br/>
Optional emblem adjacent to page number.<br/>
Text towards inside, instead of centered.<br/>
Default author verso, title recto.</p>
<h5>Custom Style</h5>
<p>Before you think about writing custom header/footer styles, be sure to try the pre-configured choices. I have looked through a lot of fiction of all kinds. The pre-configured choices include every style I have seen, with the exception of the most highly decorative.</p>
<p>If none of the above are satisfactory, then you can write your own headers and footers using the syntax of the <code>fancyhdr</code> package.</p>
<p>• In the Preamble, use one of the above <code>\SetHeadFootStyle{<em>integer</em>}</code> to pick a starting point, in terms of whether or not there is a header and/or footer. <em>This is required, so that the layout engine knows how to calculate space.</em> After that, write the <code>fancyhdr</code> code for your custom header/footer in the Preamble. It will over-ride the numerical style in terms of appearance, but occupy the same space.</p>
<p>• You cannot use a header or footer with more than one line. No exceptions.</p>
<p>• See the file <code>novel-HeadFootStyles.sty</code> for how it is done in the pre-configured styles. In the file, the relevant portion follows <em>Look here for the pre-defined styles, for use as models.</em></p>
<p>• Particularly note that your own style will not automatically use the headfont, or loose tracking, unless you include the necessary code in your own definition.</p>
<p>• No cheating! If you choose a numerical style that does not have a header, then do not attempt to write a custom style that includes a header. Same with footer. Also, if you you choose a numerical style with both header and footer, then you cannot only customize one of them; you must customize both.</p>
<a id="a6.1.3"></a>
<h4>6.1.3 <code>\SetEmblems{<em>verso</em>}{<em>recto</em>}</code></h4>
<p>If the style supports it, you may place an "emblem" that appears at a fixed distance (2.5em} from the outer margin. Thus, it will appear to the right of the page number on verso pages, and to the left of the page number on recto pages. In the case of style <code>4</code>, there will be a clearance of 1em between the emblem and the header text.</p>
<p>The font used for emblems will be the same as the headfont, unless you code the emblem to use a different font (perhaps one you specified with the <code>\NewFontFace</code> command), or unless you use one of the built-in <code>\decoglyph</code> codes.</p>
<p>An emblem is a minor decoration that should not distract the eye from the main text.</p>
<p><img class="floatright" src="html-resources/emblembar.png" width="380" height="104" alt="simple emblems using vertical bar"/>• Most books do not use emblems. When they do, it is typically a vertical bar, or a bullet, like this:</p>
<p class="code"><code>\SetHeadFootStyle{4}</code></p>
<p class="code"><code>\SetEmblems{|}{|}</code></p>
<p>The verso and recto emblems may be different. Whether they are the same or not, you must set them both, if you use emblems. Blanks are allowed.</p>
<p><img class="floatright" src="html-resources/emblemdingbats.png" width="380" height="104" alt="dingbat emblems"/>• Emblems may be styled. For example:</p>
<p>The header emblems shown at right were produced using the code below. Dingbats from the NovelDeco font were specified, adjusted for size and position.</p>
<p style="clear:both" class="code"><code>\SetEmblems{\charscale{1.1}{\raisebox{-0.05em}{\decoglyph{l9825}}}}%</code></p>
<p class="code"><code>{\charscale{1.1}{\raisebox{-0.05em}{\decoglyph{l9826}}}}</code></p>
<p>• You may also use images, or combined images and text. If you use images, they must be at the exact resolution required by your print service (usually 300dpi for gray, 600dpi for b/w), and at exact size without scaling. The <code>\InlineImage</code> command must be used. See novel's image documentation details. You may find that a vertical offset of <code>\nfs</code> (normal font size) is useful, as this will place the top of the emblem image at the top margin.</p>
<p class="code" style="text-indent:0px"><img class="floatright" src="html-resources/emblemimg.png" width="295" height="77" alt="emblem image"/>
<code>\SetHeadFootStyle{4}<br/>
\SetEmblems{\InlineImage[0pt,b]{spy.png}}%<br/>
{\InlineImage[0pt,b]{spy.png}}
</code></p>
<p>• At the small size of an emblem, it is difficult to use detailed artwork. A black/white image at 600dpi will print similarly to a font dingbat. Grayscale at 300dpi will probably not be satisfactory unless the emblem is a single shade of gray. For the above example, a character from the "Fontawesome" font was converted to a png image at mid-gray. It is less distracting than a black character from the font, but hard to discern. Note that there is no "gray ink" for directly writing text in gray.</p>
<p>• Ask your print service whether the presence of a small image in each page header will affect production costs. Probably not, but if there is a different per-page charge when pages have an image... Oops!</p>
<p>• The layout calculation does not care whether emblems intrude into the margins. You will have to inspect your PDF to determine whether a header emblem is too tall, or a footer emblem too deep, for the allowed top and bottm margin clearance. Class option <code>shademargins</code> (in draft mode only) is helpful.</p>
<a id="a6.1.4"></a>
<h4>6.1.4 <code>\SetPageNumberStyle{<em>code using \thepage</em>}</code></h4>
<p>By default, the page number is simply <code>\thepage</code>. In most cases, leave it that way. But if you wish to change how the page number is displayed, you can use this command to style how <code>\thepage</code> is displayed. Examples:</p>
<p class="code" style="text-indent:0px"><code>\SetPageNumberStyle{\emph{thepage}} % Page number in italics.<br/>
\SetPageNumberStyle{-- \thepage --} % En-dash on each side of number, for headstyle 3 or 5.</code></p>
<p>The headfont is applied automatically, unless you over-ride it in your code.</p>
<p>You could also get more involved, using a different font or size. Avoid over-doing it. If you are tempted to use a macro that counts page numbers backwards, be aware that your print service will likely reject it. Anyway, it has already been done in fiction.</p>
<a id="a6.1.5"></a>
<h4>6.1.5 <code>\SetHeadFont[<em>features</em>]{<em>font</em>}</code></h4>
<p>This setting is described on <a href="noveldocs-05-fonts.html#a5.3.2">Page 5</a>, among other fonts.</p>
<a id="a6.1.6"></a>
<h4>6.1.6 <code>\SetLooseHead{<em>number</em>}</code></h4>
<p>This command applies to both headers and footers.</p>
<p>If you are using a style that has header text, then for best appearance the characters should appear with a little extra space between them, so that they are more easily distinguished from the main text. This is especially true if you are using small caps. The name for such adjustment is "tracking."</p>
<p class="centerimg"><img src="html-resources/looseheads.png" width="400" height="76" alt="loosehead 50 and 100"/></p>
<p>The argument of <code>\SetLooseHead</code> is a number from 0 to 1000. At <code>0</code> there is no extra space between the letters. Values from <code>50</code> (default) to <code>200</code> are most useful. Higher values are unusual.</p>
<p>Page number tracking will be clamped at a maximum of 50, even when a larger (looser) tracking is applied to text.</p>
<a id="a6.1.7"></a>
<h4>6.1.7 <code>\SetChapterDisplay{<em>choice</em>}</code></h4>
<p>This command is only applied if you begin new chapters with the <code>ChapterDisplay</code> environment. You may pick one of the <code>thispagestyle</code> choices, described in the next section. For example:</p>
<p class="code"><code>\SetChapterDisplay{dropfolioinside}</code></p>
<p>Then, that choice will be applied to each page using <code>ChapterDisplay</code>, without you having to write <code>\thispagestyle</code> each time.</p>
<p>The default is <code>footer</code>. This allows a ChapterDisplay page to show its footer (only if it has one), but not header.</p>
<p>If you use this command, you may still over-ride it on a particular page, by using <code>\thispagestyle{<em>choice</em>}</code> <em>before</em> <code>\begin{ChapterDisplay}</code>.</p>
<a id="a6.2"></a>
<h3>6.2 Local Header/Footer Settings, in Document Body</h3>
<p>These commands are used when a page header/footer style is an exception to the general rule. Examples are blank pages, titles, copyright, and new chapters. You can also dynamically change the header text.</p>
<a id="a6.2.1"></a>
<h4>6.2.1 <code>\SetVersoHeadText{<em>text</em>}</code>, <code>\SetRectoHeadText{<em>text</em>}</code></h4>
<p>If you are using style <code>1</code>, <code>4</code>, <code>5</code>, or <code>6</code>, the header text can be dynamically changed from page to page. This feature is useful if your wish to include chapter titles in the header. It is also useful if your work is a collection of stories with different titles, perhaps by different authors. But before you use this feature, speak with your print service! Many print-on-demand services will insist that the content of headers must not vary from place to place, because different headers may be confused with portions of different books, during the assembly process.</p>
<p class="code"><code>\SetVersoHeadText{New~Verso~Head}</code> <code>\SetRectoHeadText{New~Recto~Head}</code></p>
<p>Notice that instead of space, a tilde <code>~</code> is used to separate words. <em>This is required.</em> Use only tilde, not both tilde and space.</p>
<p>These two commands may be used at any time, in the Preamble or document body. When a command is used, it stores its argument in <code>\versoheadtext</code> or <code>\rectoheadtext</code>. In turn, the current value of <code>\versoheadtext</code> or <code>\rectoheadtext</code> is immediately used for the header, and will remain in effect until changed again by <code>\SetVersoHeadText</code> or <code>\SetRectoHeadText</code>.<p>
<p>If you do not use these commands in the Preamble, then at the beginning of the document body they will be automatically set to the author (verso) and the title (recto). with tildes automatically substituted for spaces.<p>
<p>You may use ordinary LaTeX styling commands for the text:</p>
<p class="code"><code>\SetRectoHeadText{The~\emph{Bad~Boy}~Chronicles}</code></p>
<p>The most popular styling uses lowercase to small caps:</p>
<p class="code"><code>\SetRectoHeadText{\smcp{The~Danton~Code}}</code></p>
<p>• Avoid bold. Avoid underline. Really. Don't do it. No, no, no!</p>
<p>• At some future time, there may be a change in the LaTeX code that affects inter-word spacing in headers. This is not within my control. If you find that, for no obvious reason, inserting tildes no longer provides acceptable spacing, then don't use the tildes.</p>
<a id="a6.2.2"></a>
<h4>6.2.2 <code>\thispagestyle{<em>choice</em>}</code></h4>
<p>When you choose a style with header, then space is allocated above the text block, where the header will be placed. That space will be allocated whether or not the header is full or empty. The same applies to the footer. This allocation is global, and cannot be changed in your document body. All standard books work this way, not just with TeX.</p>
<p>However, on a per-page basis you can change whether or not a header or footer has visible content. This is routinely done for blank pages, title page, copyright page, and some others. It is also the norm for pages that begin a new chapter.</p>
<p>• The word "folio" has several meanings: It may refer to a particular paper size, or to a folded piece of paper at any size, or simply to a page number. Below, "folio" means page number.</p>
<p>• When you use the <code>\thispagestyle</code> command, your choice is applied only to the one page on which the command is written. It is best to use this command at or towards the top of the affected page. If the page uses the <code>ChapterDisplay</code> environment, and you use <code>\thispagestyle</code>, then you <em>must</em> place <code>\thispagestyle</code> before <code>\begin{ChapterDisplay}</code>.</p>
<p>• The following choices are allowed: <code>fancy</code>, <code>empty</code>, <code>footer</code>, <code>forcenumber</code>, <code>dropfoliobeneath</code>, and <code>dropfolioinside</code>.</p>
<p>For compatibility reasons, <code>plain</code> and <code>fancyplain</code> are also allowed, and have the same effect as <code>footer</code>.</p>
<pre>
<b>\thispagestyle{fancy}</b></pre>
<p>This applies the default (fancy) page style, so it is not normally needed. Only use this command to over-ride some other <code>\thispagestyle</code> command, or to over-ride the <code>\SetChapterDisplay</code> setting.</p>
<pre>
<b>\thispagestyle{empty}</b></pre>
<p>Header and footer are both blank.</p>
<pre>
<b>\thispagestyle{footer}</b></pre>
<p>Ignored if the style has no footer. If it does, then the usual footer appears. Header, if any, is blank.</p>
<p>This command is an alias for <code>fancyplain</code>. It is like the <code>plain</code> style, except that the footer (which is presumed to contain the page number) is fully styled. But unlike <code>plain</code>, the <code>footer</code> style does <em>not</em> cause a page number to appear when no footer exists. If that is what you need, then use either style <code>dropfoliobeneath</code> or <code>dropfolioinside</code>, depending on whether you have extra room in the bottom margin.</p>
<pre>
<b>\thispagestyle{forcenumber}</b></pre>
<p>If the style has a footer, then it appears as usual, and the header (if any) is blank. If the style has a header but no footer, then the outside portion of the header (which is presumed to contain the page number and emblem) appears, but the text portion of the header is blank.</p>
<p>The <code>forcenumber</code> choice is non-standard. Use it only if you must have a page number, and no other choice is suitable.</p>
<pre>
<b>\thispagestyle{dropfoliobeneath}</b></pre>
<p>The header (if any) is blank. If there is a footer, then it appears as usual. But if there is no footer, this command creates a one-page fake footer, which contains the centered page number. The fake footer is located where the next line of text would be, if the textblock were one line longer than its actual value.</p>
<p>• For the fake footer to be acceptable in print, the bottom margin must be wider than the minimum amount required by your print service. For example, suppose that the minimum bottom margin is 0.5in, but you set the bottom margin to 0.75in. That gives you 0.25in wiggle room, into which the fake footer will probably fit, because typical baselineskip is 0.2in to 0.25in.</p>
<p>• The document class does not know whether or not you have extra space available in the bottom margin. It is your responsibility to know.</p>
<pre>
<b>\thispagestyle{dropfolioinside}</b></pre>
<p>The header (if any) is blank. If there is a footer, then it appears as usual. But if there is no footer, this commands temporarily reduces the number of lines per page by one line. At the bottom, where the last line of text would normally be, the page number is centered. Thus, there is no intrusion into the bottom margin.</p>
<p>This command may only be used following the <code>\clearpage</code> command. Thus, it may be used at the start of new chapters, or on pages (such as copyright page) that do not flow from a previous page. If you use it elsewhere, the print will have incorrect layout, but there will be no error or warning, since the compiler is not sure what you are trying to do.</p>
<p>If used on a page with <code>ChapterDisplay</code> environment, you must place <code>\thispagestyle{dropfolioinside}</code> <em>before</em> you begin <code>ChapterDisplay</code>. The display block has a disposable blank line at its top, which is removed when <code>dropfolioinside</code> is used (instead of removing a line from the following text block).</p>
</div><!-- end main -->
<div id="finish"></div>
</div><!-- end master -->
</body>
</html>
|
