summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/minitoc/minitoc.sum
blob: 847fcdf0447cf3b702c77e2f0b1cf7ab74b40d06 (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
%%%%%%%%%%%%%%%%%% minitoc.sum - summary of user commands
% \mtcindent   left/right indentation of minitoc (24pt)
% \mtcsetdepth{mini-table}{depth}
%              to change the depth of some mini-tables.
% \mtcsetoffset{mini-table}{offset}
%              to change the offset of some mini-tables.
% \mtcsetfont{mini-table}{sectionning-level}{commands}
%              to redefine a minitoc font command
% \mtcsetformat{mini-table}{parameter}{value}
%              to change the layout of some mini-tables
% \mtcsetpagenumbers{mini-table|*}{on|off}
%              to activate/inhibit page numbers in some mini-tables.
% \mtcsetrules{mini-table|*}{on|off}
%              to activate/inhibit horizontal rules in some mini-tables.
% \mtcsettitle{mini-table}{title string}
%              to change the title of some mini-tables
% \mtcsettitlefont{mini-table}{font commands}
%              to change the font of the title of some mini-tables
% \mtcsetfeature{mini-table}{before|after|open|under|pagestyle}{command}
%              redefines a feature for a mini-table.
% \mtcpolymtoc{P}{C}{S}{G}
%              Set up a polymorphic entry for the table of contents
%              (in Parttoc, Minitoc, Secttoc, Global toc).
% \mtcpolymlof{P}{C}{S}{G}
%              Set up a polymorphic entry for the list of figures
%              (in Partlof, Minilof, Sectlof, Global lof).
% \mtcpolymlot{P}{C}{S}{G}
%              Set up a polymorphic entry for the list of tables
%              (in Partlot, Minilot, Sectlot, Global lot).
% \ifin|part|toc| true if inside a parttoc,
%      |part|lof| ................ partlof,
%      |part|lot| ................ partlot,
%      |mini|toc| ................ minitoc,
%      |mini|lof| ................ minilof,
%      |mini|lof| ................ minilot,
%      |sect|toc| ................ secttoc,
%      |sect|lof| ................ sectlof,
%      |sect|lot| ................ sectlot.
% \mtcfont     font command for minitoc
%              (\small\rmfamily\upshape\mdseries)
% \mtcSfont    font command for minitoc (section entries)
%              (\small\rmfamily\upshape\bfseries)
% \mtcSSfont   for subsection entries *
% \mtcSSSfont  for subsubsection entries *
% \mtcPfont    for paragraph entries *
% \mtcSPfont   for subparagraph entries *
%              * by default, \mtcfont
% \mlffont     font for minilof
%              (\small\rmfamily\upshape\mdseries)
% \mlfSfont    font for minilof (subfigures entries)
%              (\small\rmfamily\upshape\mdseries)
% \mltfont     font for minilot
%              (\small\rmfamily\upshape\mdseries)
% \mltSfont    font for minilot (subtables entries)
%              (\small\rmfamily\upshape\mdseries)
% \mtifont     font for minixxx titles
%              (\large\rmfamily\upshape\bfseries)
% \mtctitle    title of minitocs (Contents)
% \mlftitle    title of minilofs (Figures)
% \mlftitle    title of minilots (Tables)
% \minitoc[x]  to put after each \chapter command
%              for which a minitoc is to be created
% \minilof[x]  to put after each \chapter command
%              for which a minilof is to be created
% \minilot[x]  to put after each \chapter command
%              for which a minilot is to be created
%              In the 3 commands above, [x] is an optional
%              argument to set the position of the
%              title for only that minitoc/lof/lot. See
%              below for the possible values of [x].
% \mtcprepare[x] invokes as many preparation commands
%              as possible.
% \dominitoc[x] to put just before the \tableofcontents
%              command (\dominitoc is mandatory)
% \dominilof[x] to put just before the \listoffigures
%              command (\dominilof is mandatory)
% \dominilot[x] to put just before the \listoftables
%              command (\dominilot is mandatory)
%              In the 3 commands above, [x] is an optional
%              argument to set the default position of
%              titles. Default: l. l=left, c=center,
%              r=right, e=empty, n=null (synonym of empty).
% \faketableofcontents
%              to replace \tableofcontents if you want
%              minitocs but no table of contents.
% \fakelistoffigures
%              to replace \listoffigures if you want
%              minilofs but no list of figures.
% \fakelistoftables
%              to replace \listoftables if you want
%              minilots but no list of tables.
% minitocdepth (\LaTeX counter) depth of the following
%              minitoc's. Analog to tocdepth. Default: 2.
%              Has no action on minilofs or minilots.
% \mtcselectlanguage{language}
%              loads language.mld to select a language
%              for minitoc (and siblings) titles.
% \mtcskip     To make a vertical skip between two
%              minitoc-like lists.
% \mtcskipamount
%              The length of \mtcskip. Default: \bigskipamount
% mtchideinmaintoc
%              Environment to hide entries in the main table of contents.
% mtchideinmainlof
%              Environment to hide entries in the main list of figures.
% \mtchideinmainlof \endmtchideinmainlof
%              Pair of commands to hide entries in the main list of figures.
% mtchideinmainlot
%              Environment to hide entries in the main list of tables.
% \mtchideinmainlot \endmtchideinmainlot
%              Pair of commands to hide entries in the main list of tables.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Commands for partial tocs/lofs/lots
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \ptcindent   left/right indentation of parttoc (0pt)
% \ptcfont     font command for parttoc (book, report: \normalsize\mdseries) (section entries)
%                                       (article: \small\mdseries)
% \ptcCfont    font command for parttoc (\normalsize\bfseries) (chapter entries)
% \ptcSfont    font command for parttoc (book,report: \normalsize\mdseries) (section entries)
%                                       (article: \normalsize\bfseries)
% \ptcSSfont   for subsection entries *
% \ptcSSSfont  for subsubsection entries *
% \ptcPfont    for paragraph entries *
% \ptcSPfont   for subparagraph entries *
%              * by default, \ptcfont
% \plffont     font for partlof (\normalsize\mdseries)
% \plfSfont    font for partlof (subfigures entries) (\normalsize\mdseries)
% \pltfont     font for partlot (\normalsize\mdseries)
% \pltSfont    font for partlot (subtables entries) (\normalsize\mdseries)
% \ptifont     font for partxxx titles (book, report: \LARGE\bfseries)
%                                      (article: \Large\bfseries)
% \ptctitle    title of parttocs (Table of Contents)
% \plftitle    title of partlofs (List of Figures)
% \plftitle    title of partlots (List of Tables)
% \parttoc[x]  to put after each \part command
%              for which a parttoc is to be created
% \partlof[x]  to put after each \part command
%              for which a partlof is to be created
% \partlot[x]  to put after each \part command
%              for which a partlot is to be created
%              In the 3 commands above, [x] is an optional
%              argument to set the position of the
%              title for only that parttoc/lof/lot. See
%              below for the possible values of [x].
% \doparttoc[x] to put just before the \tableofcontents
%              command (\doparttoc is mandatory)
% \dopartlof[x] to put just before the \listoffigures
%              command (\dopartlof is mandatory)
% \dopartlot[x] to put just before the \listoftables
%              command (\dopartlot is mandatory)
%              In the 3 commands above, [x] is an optional
%              argument to set the default position of
%              titles. Default: l. l=left, c=center,
%              r=right, e=empty, n=null (synonym of empty).
% parttocdepth (\LaTeX counter) depth of the following
%              parttoc's. Analog to tocdepth. Default: 2.
%              Has no action on partlofs or partlots.
% \beforeparttoc Action before a \parttoc (\cleardoublepage)
% \beforepartlof Action before a \partlof (\cleardoublepage)
% \beforepartlot Action before a \partlot (\cleardoublepage)
% \afterparttoc  Action after a \parttoc (\cleardoublepage)
% \afterpartlof  Action after a \partlof (\cleardoublepage)
% \afterpartlot  Action after a \partlot (\cleardoublepage)
% \openparttoc Action before inserting a parttoc file (\empty)
% \openpartlof Action before inserting a partlof file (\empty)
% \openpartlot Action before inserting a partlot file (\empty)
% \underparttoc  Action after inserting a parttoc file (\empty)
% \underpartlof  Action after inserting a partlof file (\empty)
% \underpartlot  Action after inserting a partlot file (\empty)
% \thispageparttocstyle page style command for a \parttoc
%                   (\thispagestyle{empty})
% \thispagepartlofstyle page style command for a \partlof
%                   (\thispagestyle{empty})
% \thispagepartlotstyle page style command for a \partlot
%                   (\thispagestyle{empty})
%
% ... and similar commands at chapter and section levels,
%     if available.
%
% \mtcgapbeforeheads Vertical gap before a part-level
%                    minitable
% \mtcgapafterheads Vertical gap after a part-level
%                    minitable
% \kernafterparttoc Vertical kern between a parttoc and
%                    its bottom rule
% \kernafterpartlof Vertical kern between a partlof and
%                    its bottom rule
% \kernafterpartlot Vertical kern between a partlot and
%                    its bottom rule
% \kernafterminitoc Vertical kern between a minitoc and
%                    its bottom rule
% \kernafterminilof Vertical kern between a minilof and
%                    its bottom rule
% \kernafterminilot Vertical kern between a minilot and
%                    its bottom rule
% \kernaftersecttoc Vertical kern between a secttoc and
%                    its bottom rule
% \kernaftersectlof Vertical kern between a sectlof and
%                    its bottom rule
% \kernaftersectlot Vertical kern between a sectlot and
%                    its bottom rule
% \ptcoffset Horizontal offset for parttocs
% \plfoffset Horizontal offset for partlofs
% \pltoffset Horizontal offset for partlots
% \mtcoffset Horizontal offset for minitocs
% \mtcoffset Horizontal offset for minitocs
% \mlfoffset Horizontal offset for minilofs
% \sltoffset Horizontal offset for sectlots
% \slfoffset Horizontal offset for sectlofs
% \sltoffset Horizontal offset for sectlots
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Miscellaneous commands
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \tightmtctrue
%              tight minitocs. Minimum space between lines.
% \tightmtcfalse
%              loose minitocs.
% \ktightmtctrue
%              tight minitocs. Minimum space between lines.
%              (Koma-script classes).
% \ktightmtcfalse
%              loose minitocs.
%              (Koma-script classes).
% \undottedmtctrue
%              no lines of dots in the minitocs.
% \undottedmtcfalse
%              lines of dots in the minitocs (from the title
%              to the page number).
% \adjustmtc   Adjusts (increments) the minitoc counter mtc.
% \adjustptc   Adjusts (increments) the parttoc counter ptc.
% \adjuststc   Adjusts (increments) the secttoc counter stc.
% \decrementmtc   Adjusts (decrements) the minitoc counter mtc.
% \decrementptc   Adjusts (decrements) the parttoc counter ptc.
% \decrementstc   Adjusts (decrements) the secttoc counter stc.
% \mtcaddchapter[title] Adds the title of a \chapter* in the toc.
% \mtcaddsection[title] Adds the title of a \section* in the toc.
% \mtcaddpart[title]    Adds the title of a \part* in the toc.
% \mtcfixindex[chapter|section|part] Fixes the index entry in the toc.
% \mtcfixglossary[chapter|section|part] Fixes the glossary entry
%              in the toc.
% \mtcfixnomenclature[chapter|section|part] Fixes the nomenclature
%              entry in the toc.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Commands for sectionnal tocs/lofs/lots
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \stcindent   left/right indentation of secttoc (0pt)
% \stcfont     font command for secttoc
%              (\small\rmfamily\upshape\mdseries)
%              (subsection entries)
% \stcSSfont   font command for secttoc
%              (\small\rmfamily\upshape\bfseries)
%              (subsection entries)
% \stcSSSfont  for subsubsection entries *
% \stcPfont    for paragraph entries *
% \stcSPfont   for subparagraph entries *
%              * by default, \stcfont
% \slffont     font for sectlof (\normalsize\mdseries)
% \slfSfont    font for sectlof (subfigures entries) (\normalsize\mdseries)
% \sltfont     font for sectlot (\normalsize\mdseries)
% \sltSfont    font for sectlot (subtables entries) (\normalsize\mdseries)
% \stifont     font for sectxxx titles (\normalsize\bfseries)
% \stctitle    title of secttocs (Contents)
% \slftitle    title of sectlofs (Figures)
% \slftitle    title of sectlots (Tables)
% \secttoc[x]  to put after each \section command
%              for which a secttoc is to be created
% \sectlof[x]  to put after each \section command
%              for which a sectlof is to be created
% \sectlot[x]  to put after each \section command
%              for which a sectlot is to be created
%              In the 3 commands above, [x] is an optional
%              argument to set the position of the
%              title for only that secttoc/lof/lot. See
%              below for the possible values of [x].
% \dosecttoc[x] to put just before the \tableofcontents
%              command (\dosecttoc is mandatory)
% \dosectlof[x] to put just before the \listoffigures
%              command (\dosectlof is mandatory)
% \dosectlot[x] to put just before the \listoftables
%              command (\dosectlot is mandatory)
%              In the 3 commands above, [x] is an optional
%              argument to set the default position of
%              titles. Default: l. l=left, c=center,
%              r=right, e=empty, n=null (synonym of empty).
% secttocdepth (\LaTeX counter) depth of the following
%              secttoc's. Analog to tocdepth. Default: 2.
%              Has no action on sectlofs or sectlots.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Commands to begin with a chapter (part or section)
% other than number 1
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \firstpartis{N}    N is the number of the first part
% \firstchapteris{N} N is the number of the first chapter
% \firstsectionis{N} N is the number of the first section
% these commands MUST be inserted BEFORE \dominitoc etc.
% They do not touch the numbering of parts, chapters or
% sections.
% THE \first...is COMMANDS ARE OBSOLETE SINCE VERSION 23
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Commands to enable/disable horizontal rules
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \ptcrule \noptcrule
% \mtcrule \nomtcrule
% \stcrule \nostcrule
% \plfrule \noplfrule
% \mlfrule \nomlfrule
% \slfrule \noslfrule
% \pltrule \nopltrule
% \mltrule \nomltrule
% \sltrule \nosltrule
% \mtcsetrules{mini-table|*}{on|off}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Keywords for \addcontentsline in a \part*, \chapter*, etc.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% starpart
% starchapter
% starsection
% starsubsection
% starsubsubsection
% starparagraph
% starsubparagraph
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Commands for main starred sectionning commands
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \starredpart
% \starredchapter
% \starredsection
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Commands to have (default) or not have page numbers
% in minitocs and siblings.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \mtcpagenumbers      \nomtcpagenumbers
% \stcpagenumbers      \nostcpagenumbers
% \ptcpagenumbers      \noptcpagenumbers
% \mlfpagenumbers      \nomlfpagenumbers
% \slfpagenumbers      \noslfpagenumbers
% \plfpagenumbers      \noplfpagenumbers
% \mltpagenumbers      \nomltpagenumbers
% \sltpagenumbers      \nosltpagenumbers
% \pltpagenumbers      \nopltpagenumbers
% \mtcsetpagenumbers{mini-table|*}{on|off}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% COFFEE stuff
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \coffeefont
% \addcoffeeline
% \coffeeline
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%