summaryrefslogtreecommitdiff
path: root/macros/text1/cms_help_files/tocf.helpmark
blob: f178e50e3c3d9bc42b8cf5eb63fd3b63c13816e1 (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
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
+-----------------------------------------------------------------------------+
|                            tableofcontentsformat                            |
+-----------------------------------------------------------------------------+
 
Abbreviation:  ã|\tocfã%
 
Parameters:    ã|submarkupã%
 
Submarkup:     ã| \toctitle, \prefacetocformat, \parttocformat,
\continuechapter, \chaptertocformat,
\hangingchapterindent, \appendixtocformat,
\hangingappendixindent, \subheadatocformat,
\subheadbtocformat, \subheadctocformat,
\subheaddtocformat, \bibliographytocformat,
\figuretoctitle, \figuretocformat,
\hangingfigureindent, \tabletoctitle,
\tabletocformat, \hangingtableindentã%
 
    ã|Description:ã%
The table of  contents prints with the titles "Table  of Contents", "List of
Figures", and "List  of Tables" centered in bold  letters and each beginning
 
on a  new page.   If you want to  change these defaults you  use the \table-
ofcontentsformat markup.   This markup  also changes the  way part, chapter,
subhead, appendix,  bibliography, preface, figure and  table titles print in
table of contents.
 
ã|toctitleã% regulates how the table of contents title is to be printed.  By
default it is a  centered bold title "Table of Contents".   Use \toctitle to
change this default.
 
    ã|Example:ã%
If you  wanted the title  of the table  of contents to  print "Contents" you
would enter:
 
\tableofcontentsformat{
       \toctitle{\cl{\it Contents}}}
 
ã|prefacetocformatã% determines  how titles  entered on the  \preface markup
are to print in the table  of contents.  By default, they are simply printed
with a \noindent.
 
+-----------------------------------------------------------------------------+
|                                                                             |
|     Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  2  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
If you  wanted the preface title  to print in italics  as illustrated on the
next page, you would enter:
 
\tocf{\prefacetocformat{\nin\it
               \prefacetitle\leader\pn}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
|     Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  3  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
ã|parttocformatã% determines how  titles entered on the  \part markup are to
print in  the table of  contents.   By default,  part titles  skip one line,
center the part number, center the part title, skip another line, then print
"Part" followed  by the part number  again, followed by leader  and the page
number:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                                   Part 1                                    |
|                                  Mechanics                                  |
|                                                                             |
| Part 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
 
If you wanted parts to print in a hanging paragraph style, enter:
 
\tocf{\parttocformat{\hp\parttitle\leader\pn}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Videodiscs in today's modern office --- Timely                              |
|    TV Tutors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5  |
+-----------------------------------------------------------------------------+
 
ã|continuechapterã% if specified as "yes" will print "Chapter" at the top of
each page under the header.  The default is "no".
 
ã|chaptertocformat{Nested Markup}ã% determines how  a chapter title is to be
printed in the table of contents.   By default, the chapter number and title
are printed in a hanging number style.  For example, if you entered,
 
\chapter{The Nineteenth Century and after\lbr
best-sellers\toclbr and steady-sellers}
 
you would get in the table of contents:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|  1. The Nineteenth Century and after best-sellers                           |
|     and steady-sellers . . . . . . . . . . . . . . . . . . . . . . . . .  6 |
+-----------------------------------------------------------------------------+
 
Note that  the line  break from  \lbr only  occurs in the  text, not  in the
table of  contents.  Use  \toclbr to create  a line break which  is to occur
in  the table  of  contents.    To  change the  amount  of  indent,  use the
\hangingchapterindent.  You  may use markup such as \newpage, \chaptertitle,
\chapternumber, \verticalspace, and  \centerline within \chaptertocformat as
Nested Markup.    You may also  use \hangingchapternumber,  which prints the
chapter number in a similar fashion as \item.
 
    ã|Example:ã%
If you wanted chapter titles  to print in a hanging paragraph style, without
an associated chapter number, you would enter:
 
\tocf{\chaptertocformat{\hp\chaptertitle\leader\pn}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| The Nineteenth Century and after best-sellers                               |
|    and steady-sellers . . . . . . . . . . . . . . . . . . . . . . . . .  7  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
If you  want the title  "Chapter" to appear  left justified in  the table of
contents above  the first  chapter number,  prior to  the first  chapter you
would enter the following \putincontents markup:
 
\putincontents1{\nin Chapter}
\chapter{First Chapter}
Text of the first chapter . . .
 
which prints in the table of contents as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. First Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . .  8  |
+-----------------------------------------------------------------------------+
 
ã|hangingchapterindentã% controls  the amount of indent  before printing the
chapter title when you print using \hangingchapternumber.
 
ã|appendixtocformat{Nested Markup}ã% determines how  an appendix title is to
be printed in  the table of contents.   By default,  the appendix number and
title are printed in a hanging number style.  For example, if you entered,
 
\appendix{The Nineteenth Century and after\lbr
best-sellers\toclbr and steady-sellers}
 
you would get in the table of contents:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|  A. The Nineteenth Century and after best-sellers                           |
|     and steady-sellers . . . . . . . . . . . . . . . . . . . . . . . . .  9 |
+-----------------------------------------------------------------------------+
 
Note  that  the line  break  from  \lbr only  occurs  in  the  text,  not in
the  table  of  contents.     Use  \toclbr  to  create a  line  break  which
is  to  occur  in  the  table  of  contents.     To  change  the  amount  of
indent,  use  the  \hangingappendixindent.    You  may  use  markup such  as
\newpage,  \appendixtitle,  \appendixnumber,  \verticalspace,  and  \center-
line  within  \appendixtocformat  as  Nested  Markup.    You  may  also  use
\hangingappendixnumber, which prints the chapter number in a similar fashion
as \item.
 
    ã|Example:ã%
If you wanted appendix titles to print in a hanging paragraph style, without
an associated appendix number, you would enter:
 
\tocf{\appendixtocformat{\hp\appendixtitle\leader\pn}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| The Nineteenth Century and after best-sellers                               |
|    and steady-sellers . . . . . . . . . . . . . . . . . . . . . . . . . 10  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
If you  want the title "Appendix"  to appear left justified  in the table of
contents above  the first appendix number,  prior to the  first appendix you
would enter the following \putincontents markup:
 
\putincontents1{\nin Appendix}
\appendix{First Appendix}
Text of the first appendix . . .
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Appendix                                                                    |
|  A. First Appendix . . . . . . . . . . . . . . . . . . . . . . . . . .  11  |
+-----------------------------------------------------------------------------+
 
ã|hangingappendixindentã% controls the amount  of indent before printing the
appendix title when you print using \hangingappendixnumber.
 
ã|subheadatocformatã% by default prints all titles entered with \subheada to
be block indented 1/2 inch from the left  margin.  Use \subheadatocformat to
change this default.
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 12  |
|      Micro-to-Mainframe Links:  They don't quite                            |
|      make it yet  . . . . . . . . . . . . . . . . . . . . . . . . . . . 12  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
To have subheada  titles indented 1/4inch  and printed with a hangingindent,
enter:
 
\tocf{\subheadatocformat{\leftindent{.25in}
             \hp\subheadatitle \leader \pagenumber}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 12  |
|   Micro-to-Mainframe Links:  They don't quite make                          |
|       it yet  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
ã|subheadbtocformatã% by default prints all titles entered with \subheadb to
be block  indented 1 inch from  the left margin.   Use \subheadbtocformat to
change the default illustrated here:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 14  |
|           Micro-to-Mainframe Links:  They don't                             |
|           quite make it yet . . . . . . . . . . . . . . . . . . . . . . 14  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
To have  subheadb titles indented /4 inch and  printed with a  hangingindent
prefaced with "cc.aa.bb" where cc  is the chapter number, aa is the subheada
number and bb is the subheadb number, enter:
 
 \tocf{\subheadbtocformat{\leftindent{.25in}
              \hp\chapternumber.\subheadanumber.\subheadbnumber
                  \quad\subheadbtitle \leader \pagenumber}}
 
    The first \subheadb  in the second \subheada of  the first chapter would
print in the table of contents as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 15  |
|           1.2.1 Micro-to-Mainframe Links:  They                             |
|              don't quite make it yet  . . . . . . . . . . . . . . . . . 15  |
+-----------------------------------------------------------------------------+
 
ã|subheadctocformatã% by default prints all titles entered with \subheadc to
be block indented 11/2inch  from the left margin.  Use \subheadctocformat to
change this default.
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange .. . ...... . .. .. .. . ...... . .. .. .. . .....15  |
|                Micro-to-Mainframe Links:  They                              |
|                don't quite make it yet .... . . ..... . . ..... . . ....15  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
To have subheadc titles indented 3/4inch and printed in italics, enter:
 
\tocf{\subheadctocformat{\leftindent{.75in}
             \nin\italic
             \subheadctitle \leader \pagenumber}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 17  |
|        Micro-to-Mainframe Links:  They don't                                |
|        quite make it yet  . . . . . . . . . . . . . . . . . . . . . . . 17  |
+-----------------------------------------------------------------------------+
 
ã|subheaddtocformatã% by default prints all titles entered with \subheadd to
be block indented 2 inches from  the left margin.  Use \subheaddtocformat to
change this default.
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 17  |
|                     Micro-to-Mainframe Links:                               |
|                     They don't quite make                                   |
|                     it yet  . . . . . . . . . . . . . . . . . . . . . . 17  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
To have subheadd titles indented 2 inches, printed with a hangingindent in a
10 point Computer Modern italic font, and no page number, enter:
 
\tocf{\subheadatocformat{\leftindent{2in}
             \hp\tenpt\italic
                 \subheaddtitle}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
| Chapter                                                                     |
|  1. Document Exchange . . . . . . . . . . . . . . . . . . . . . . . . . 19  |
|                     Micro-to-Mainframe Links:                               |
|                        They don't quite make it yet                         |
+-----------------------------------------------------------------------------+
 
ã|bibliographytocformatã% determines how titles entered on the \bibliography
markup are to print  in the table of contents.   By default, they are simply
printed  with a  \noindent  like prefaces.    Use  \bibliographytocformat to
change this default.
 
+-----------------------------------------------------------------------------+
|                                                                             |
|     Bibliography  . . . . . . . . . . . . . . . . . . . . . . . . . . . 19  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
If you wanted the preface title to print in bold, you would enter:
 
\tocf{\bibliographytocformat{\nin\bold
               \bibtitle\leader\pn}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
|     ã|Bibliographyã%. . . . . . . . . . . . . . . . . . . . . . . . . . 20  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
ã|figuretoctitleã%  determines how  the list  of figures  is to  print.   By
default, it will  start a new page, center the  title "List of Figures", and
then print a  header above the first figure, which  in the example below had
the title "Hot times . . .  "  and printed on page 43:
+-----------------------------------------------------------------------------+
|                                                                             |
|                                                                         21  |
|                               List of Figures                               |
| Figure                                                                Page  |
|     1.  Hot times in the land of the midnight sun . . . . . . . . . . . 43  |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
If you wanted the list of figures to print the title "Illustrations" instead
of "List of Figures" after skipping to a new page, enter
 
\tocf{\figuretoctitle{\newpage
          \cl{\bd Illustrations}
          \line{Figure\rt{Page}}}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                                Illustrations                                |
| Figure                                                                Page  |
|     1.  Hot times in the land of the midnight sun ... . ...  ... . .....43  |
+-----------------------------------------------------------------------------+
 
ã|figuretocformat{Nested Markup}ã%  determines how a  figure title  is to be
printed in the table  of contents.  By default,  the figure number and title
are printed in a hanging number style.  For example, if you entered:
 
\figure{\halfpage}{The Nineteenth Century
and after best-sellers\toclbr and steady-sellers}
the figure title would print in the contents as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|  1. The Nineteenth Century and after best-sellers                           |
|     and steady-sellers  . . . . . . . . . . . . . . . . . . . . . . . . 22  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    To change the  amount of indent, use the  \hangingfigureindent.  You may
use markup  such as \figuretitle and  \figurenumber, within \figuretocformat
as  Nested Markup.    You may  also use  \hangingnumber{\figurenumber} which
prints the figure number in a similar fashion as \item.
 
    ã|Example:ã%
If you wanted  figure titles to print in  a hanging paragraph style prefaced
with the figure number, you would enter:
 
\tocf{\figuretocformat{\hp
           \figurenumber\quad\figuretitle\leader\pn}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
|     1 The Nineteenth Century and after best-sellers                         |
| and steady-sellers  . . . . . . . . . . . . . . . . . . . . . . . . . . 23  |
+-----------------------------------------------------------------------------+
 
ã|hangingfigureindentã% controls  the amount  of indent before  printing the
figure title when you print using:
 
\hangingnumber{\figurenumber}
 
ã|tabletoctitleã%  determines how  the  list of  tables  is  to print.    By
default, it will  start a new page, center the title  "List of Tables ", and
then print a  header above the first  table, which in  the example below had
the title "Hot times . . .  "  and printed on page 55:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                               List of Tables                                |
| Table                                                                 Page  |
|     1.  Hot times in the land of the midnight sun . . . . . . . . . . . 55  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    ã|Example:ã%
If you wanted the list of  tables to print the title "Tables" after skipping
to a new page, enter
 
\tocf{\tabletoctitle{\newpage
          \cl{\bd Tables}
          \line{Table\rt{Page}}}}
 
+-----------------------------------------------------------------------------+
|                                                                             |
|                                   Tables                                    |
| Table                                                                 Page  |
|     1.  Hot times in the land of the midnight sun . . . . . . . . . . . 55  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
ã|tabletocformat{Nested  Markup}ã% determines  how a  table  title is  to be
printed in the  table of contents.   By default, the  table number and title
are printed in a hanging number style.  For example, if you entered:
 
\tabletitle{The Nineteenth Century
and after best-sellers\toclbr and steady-sellers}
the table title would print as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
|  1. The Nineteenth Century and after best-sellers                           |
|     and steady-sellers  . . . . . . . . . . . . . . . . . . . . . . . . 26  |
|                                                                             |
+-----------------------------------------------------------------------------+
 
    To change  the amount of indent,  use the \hangingtableindent.   You may
use markup such  as \tabletitle and \tablenumber,  within \tabletocformat as
Nested Markup.   You may also use \hangingnumber{\tablenumber}, which prints
the table number in a similar fashion as \item.
 
    ã|Example:ã%
If you  wanted table titles to  print in a hanging  paragraph style prefaced
with "cc.tt" where cc is the  chapter number and tt is the table number, you
would enter,
 
\tocf{\tabletocformat{\hp\chapternumber.\tablenumber
           \quad\tabletitle\leader\pn}}
 
and the first table of the second chapter would print in the contents as:
 
+-----------------------------------------------------------------------------+
|                                                                             |
| 2.1 The Nineteenth Century and after best-sellers                           |
|    and steady-sellers . . . . . . . . . . . . . . . . . . . . . . . . . 27  |
+-----------------------------------------------------------------------------+
 
ã|hangingtableindentã%  controls the  amount of  indent before  printing the
table title when you print using:
 
\hangingnumber{\tablenumber}
 
    ã|Notes:ã%
The  \tableofcontentsformat markup  should  always appear  at the  top  of a
document, but after \monospace, if both are used.