-
Notifications
You must be signed in to change notification settings - Fork 0
/
polytech.cls
600 lines (498 loc) · 17.7 KB
/
polytech.cls
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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
\def\polytechfileversion{2.5.2}
\def\polytechfiledate{2019/08/07}
\ProvidesClass{polytech/polytech}[\polytechfiledate\space Polytech document class by Thomas Couchoud <thomas.couchoud@gmail.com> (forked from Sebastien Aupetit <aupetit@univ-tours.fr>), V\polytechfileversion]
% -----------------------------------------------------------------------------
% Include generic packages to extend LaTeX memory and add common utility commands
% -----------------------------------------------------------------------------
\RequirePackage{etex}
\RequirePackage{filecontents}
\RequirePackage{atveryend} % required before etoolbox by pageslts
\RequirePackage{etoolbox}
\RequirePackage{calc}
\RequirePackage{xstring}
\RequirePackage{xparse}
\RequirePackage{forloop}
% Add an early hook at the beginning of the document allowing to do some tests of parameters
\AtBeginDocument{\csuse{polytech@check@preamble}}
\newcommand{\polytechwarning}[1]{%
\@warning{Polytech : #1}%
}
% Display an error message and stop compilation as soone as possible
\newcommand{\polytechfatalerror}[1]{%
\begingroup%
\set@display@protect%
\errmessage{Polytech: #1}%
\endgroup%
\stop%
}
\AtBeginDocument{\booltrue{polytech@allownewpagestartenddoc}}
\AtEndDocument{\booltrue{polytech@allownewpagestartenddoc}}
% suppress warning : PDF inclusion: multiple pdfs with page group included in a single page
\ifcsdef{pdfsuppresswarningpagegroup}{%
\pdfsuppresswarningpagegroup=1%
}{}
% -----------------------------------------------------------------------------
% Declare documentclass options
% -----------------------------------------------------------------------------
% Prepare document in english
\newbool{polytech@english}
\csdef{polytech@lang}{fr}
\DeclareOption{english}{
\setbool{polytech@english}{true}
\csgdef{polytech@lang}{en}
}
% Make document final disabling useless things
\newbool{polytech@bare}
\DeclareOption{bare}{\booltrue{polytech@bare}}
\newbool{polytech@final}
\DeclareOption{final}{\booltrue{polytech@final}}
\newbool{polytech@debug}
\DeclareOption{final}{\booltrue{polytech@debug}}
% Force black and white colors
\newbool{polytech@blackandwhite}
\DeclareOption{blackandwhite}{\booltrue{polytech@blackandwhite}}
\newbool{polytech@hideweeklyreports}
\DeclareOption{hideweeklyreports}{\booltrue{polytech@hideweeklyreports}}
\newbool{polytech@nodate}
\DeclareOption{nodate}{\booltrue{polytech@nodate}}
\newbool{polytech@nobibannotations}
\DeclareOption{nobibannotations}{\booltrue{polytech@nobibannotations}}
\newbool{polytech@roundtofour}
\DeclareOption{roundtofour}{\booltrue{polytech@roundtofour}\booltrue{polytech@twoside}}
\newbool{polytech@twoside}
\DeclareOption{twoside}{\booltrue{polytech@twoside}}
\newbool{polytech@firstlastonly}
\DeclareOption{firstlastonly}{\booltrue{polytech@firstlastonly}}
\newbool{polytech@noposter}
\DeclareOption{noposter}{\booltrue{polytech@noposter}}
\newbool{polytech@poster}
\DeclareOption{poster}{\booltrue{polytech@poster}}
\newbool{polytech@onlyposter}
\DeclareOption{onlyposter}{\booltrue{polytech@onlyposter}\booltrue{polytech@poster}}
\newbool{polytech@noimg}
\DeclareOption{noimg}{\booltrue{polytech@noimg}}
\newbool{polytech@glossaries}
\DeclareOption{glossaries}{\booltrue{polytech@glossaries}}
\DeclareOption*{\PackageWarning{polytech}{Unknown option `\CurrentOption'}}
\ProcessOptions\relax
%------------- global lrbox (use \begin{lrbox*} instead of \begin{lrbox} to save the box globally instead of locally ----------------
\cslet{lrbox*}\lrbox
\expandafter\patchcmd\csname lrbox*\endcsname{\setbox}{\global\setbox}{}{}
%\expandafter\show\csname lrbox*\endcsname % uncomment to see if it has worked
\cslet{endlrbox*}\endlrbox
%-------------- Configuration ----------------
% upgrade PDF version of the document to reduce some warnings
\ifcsdef{pdfoptionpdfminorversion}{%
\pdfoptionpdfminorversion=6
}{}
% allow url to break on multiple lines
\PassOptionsToPackage{hyphens}{url}
% Enable colors
\PassOptionsToPackage{svgnames,table,override}{xcolor}
% babel
\ifbool{polytech@english}{
\PassOptionsToPackage{french,british}{babel} % english document
\RequirePackage{babel}
\PassOptionsToPackage{english}{algorithm2e}
}{
\PassOptionsToPackage{english,french}{babel} % french document
\RequirePackage{babel}
\frenchbsetup{StandardEnumerateEnv=true}
\frenchspacing
\PassOptionsToPackage{frenchstyle}{kpfonts}
\PassOptionsToPackage{french}{algorithm2e}
}
\ifbool{polytech@twoside}{
\PassOptionsToClass{twoside}{book}
}{}
\ifbool{polytech@final}{
\PassOptionsToClass{final}{book}
}{}
\PassOptionsToClass{11pt}{book}
\LoadClass{book}
\setlength\paperheight{29.7cm}%
\setlength\paperwidth{21cm}%
\RequirePackage[
papersize={\paperwidth,\paperheight},
twoside,
bindingoffset=0cm,
heightrounded,
includeall,
nomarginpar,
headheight=14pt,
headsep=12pt,
footskip=30pt,
vmargin=1.5cm,
hmargin=2.5cm]{geometry}
\csdef{polytech@output@setupfirstlastpagegeometry}{%
\newgeometry{%
twoside,
bindingoffset=0cm,
heightrounded,
includeall,
nomarginpar,
headheight=0pt,
headsep=0pt,
footskip=0pt,
vmargin=1.5cm,
hmargin=2.5cm
}%
}
% enable overbox display as black box. must be after class loading
\notbool{polytech@final}{
\setlength{\overfullrule}{5pt}
}{}
\RequirePackage[T1]{fontenc} % OT1 font encoding (must be before inputenc)
\RequirePackage[utf8]{inputenc} % encoding is set to utf8
\RequirePackage[full]{textcomp}
\DeclareUnicodeCharacter{B0}{\textdegree}
% add last pages at end of document. Must be before biblatex to allow biblatex to handle the result from printbibliography
\AtEndDocument{
\csuse{polytech@makelastpages}
}
% csquote and biblatex need to be after
\RequirePackage{csquotes}
\RequirePackage[%
backend=biber,
style=numeric-comp,
sorting=nyt,
sortcase=false,
sortcites=true,
maxnames=10,
minnames=10,
autocite=plain,
defernumbers=true,
bibencoding=utf8,
autolang=other
]{biblatex}
% options are processed then we do some update
\ifbool{polytech@blackandwhite}{
\PassOptionsToPackage{light}{kpfonts} % better printing in light
}{}
% switch to richer and more scallable fonts
\RequirePackage[nofligatures,nointlimits,sumlimits]{kpfonts}
% improve typography
\RequirePackage[final,babel]{microtype}
% allow to customize sectionning
\RequirePackage[rigidchapters,explicit,toctitles,clearempty]{titlesec}
%%% newpage disabled flags
\newbool{polytech@allownewpagesection}
\newbool{polytech@allownewpagestartenddoc}
% change the behavior of \newpage
\let\polytech@oldnewpage\newpage
\renewcommand{\newpage}{%
\ifbool{polytech@allownewpagestartenddoc}{
\polytech@oldnewpage%
}{%
\ifbool{polytech@allownewpagesection}{%
\polytech@oldnewpage%
}{%
\ifbool{polytech@debug}{\polytech@oldnewpage}{}% while debugging, we must output \newpage to allow patching new command
\polytechwarning{You are not allowed to use \string\newpage, \string\clearpage\space or \string\cleardoublepage. Command suppressed.}%
}%
}%
}
% patch standard sectionning command before loading package changing them
% force long title in TOC but keep short title for headings
\patchcmd{\@chapter}%
{\addcontentsline {toc}{chapter}{\protect\numberline {\thechapter }#1}}
{\addcontentsline {toc}{chapter}{\protect\numberline {\thechapter }#2}%
}
{}{
\polytechfatalerror{Cannot patch \string\@chapter.}
}
\patchcmd{\@chapter}%
{\addcontentsline {toc}{chapter}{#1}}
{\addcontentsline {toc}{chapter}{#2}%
}
{}{
\polytechfatalerror{Cannot patch \string\@chapter.}
}
\patchcmd{\@chapter}%
{\addcontentsline {toc}{chapter}{#1}}
{\addcontentsline {toc}{chapter}{#2}%
}
{}{
\polytechfatalerror{Cannot patch \string\@chapter.}
}
% remove calls to \@chapter and \@schapter from the original \chapter command
\patchcmd{\chapter}
{\secdef\@chapter\@schapter}
{}
{}
{
\polytechfatalerror{Cannot patch \string\chapter.}
}
\csdef{polytechlinebreak}{}
% save current definition
\let\polytech@chapter\chapter
% allow to differentiate chapter/part of sections
\newbool{polytech@ref@section}
% allow to detect if we are in a chapter
\newbool{polytech@ref@inchapter}
% allow proper handling of unnumbered chapters in \ref
\newbool{polytech@ref@unnumberedchapter}
\newcounter{polytech@chapter@counter}[part]
% \appendix called ?
\newbool{polytech@ref@appendix}
% replace \chapter definition to automatically register unnumbered chapter in toc and set heading marks
% need to be before hyperref
\RenewDocumentCommand{\chapter}{som}{%
\booltrue{polytech@allownewpagesection}%
\csuse{FloatBarrier}% flush floats before a new chapter
\boolfalse{polytech@ref@section}%
\booltrue{polytech@ref@inchapter}%
\polytech@chapter%
\IfBooleanTF{#1}{% starred
% if unnumbered appendix => error
\ifbool{polytech@ref@appendix}{%
%\polytechfatalerror{Appendix chapter must be numbered. \string\chapter* is forbidden here.}%
}{}%
\global\booltrue{polytech@ref@unnumberedchapter}%
\@schapter{#3}%
\addcontentsline {toc}{chapter}{#3}{}%
\IfValueTF{#2}{%
\markboth{#2}{}%
}{%
\markboth{#3}{}%
}%
}{%
\global\boolfalse{polytech@ref@unnumberedchapter}%
\IfValueTF{#2}{%
\@chapter[#2]{#3}%
}{%
\@chapter[#3]{#3}%
}%
}%
\stepcounter{polytech@chapter@counter}%
\boolfalse{polytech@allownewpagesection}%
}
% for \part we need the complete definition which is modified by titlesec in sectionning.sty
\AtEndOfClass{
\let\polytech@newpage@oldpart\part
\RenewDocumentCommand{\part}{som}{%
\booltrue{polytech@allownewpagesection}%
\csuse{FloatBarrier}% flush floats before a new part
\boolfalse{polytech@ref@section}%
\IfBooleanTF{#1}{% starred
\polytech@newpage@oldpart*{#3}%
}{%
\IfValueTF{#2}{%
\polytech@newpage@oldpart[#2]{#3}%
}{%
\polytech@newpage@oldpart{#3}%
}%
}%
\boolfalse{polytech@allownewpagesection}%
}
}
% patch some commands for newpage. The commands are defined later.
\AtEndOfClass{
\preto{\landscape}{\booltrue{polytech@allownewpagesection}}
\appto{\endlandscape}{\boolfalse{polytech@allownewpagesection}}
% allow newpage for pdfpages
\let\polytech@oldincludepdf\includepdf
\gdef\includepdf[#1]#2{%
\booltrue{polytech@allownewpagesection}%
\polytech@oldincludepdf[#1]{#2}%
\boolfalse{polytech@allownewpagesection}%
}
\let\polytech@oldincludepdfmerge\includepdfmerge
\gdef\includepdfmerge[#1]#2{%
\booltrue{polytech@allownewpagesection}%
\polytech@oldincludepdfmerge[#1]{#2}%
\boolfalse{polytech@allownewpagesection}%
}
}
\preto{\appendix}{%
\booltrue{polytech@allownewpagesection}%
\booltrue{polytech@ref@appendix}%
\boolfalse{polytech@ref@inchapter}%
}
\appto{\appendix}{%
\part*{\csuse{polytech@ref@name@appendices@\csuse{polytech@lang}}}%
\boolfalse{polytech@allownewpagesection}%
}
\preto{\section}{%
\booltrue{polytech@ref@section}%
}
\preto{\subsection}{%
\booltrue{polytech@ref@section}%
}
\preto{\subsubsection}{%
\booltrue{polytech@ref@section}%
}
\preto{\paragraph}{%
\booltrue{polytech@ref@section}%
}
\preto{\subparagraph}{%
\booltrue{polytech@ref@section}%
}
%-------------- lot of packages -------------
\RequirePackage{fancyhdr}
\RequirePackage{makeidx}
\RequirePackage{amsmath}
\RequirePackage{amsfonts}
\RequirePackage{marvosym}
\RequirePackage{stmaryrd}
\RequirePackage[final]{listings}
\RequirePackage{fancybox}
\RequirePackage{longtable}
\RequirePackage{colortbl}
\RequirePackage{lscape}
\RequirePackage{comment}
\RequirePackage{tikz}
\RequirePackage{url}
\RequirePackage{framed}
\RequirePackage{fancyvrb}
\RequirePackage{makerobust}
\RequirePackage[figure,table,lstlisting]{totalcount}
%\RequirePackage[lined,boxed]{algorithm2e}
% to count algorithm using totalcount
%\DeclareTotalCounter{algocf}
\RequirePackage{pax} % for proper handling of pdfpages with hyperref
\RequirePackage{pdfpages}
\RequirePackage[user]{zref} % allow for better \ref and \label
\RequirePackage[calc]{adjustbox} % box sizing utilities
\RequirePackage{placeins} % to flush pending floats
\RequirePackage{enumitem} % to typeset enums
\RequirePackage{array}
\RequirePackage{multirow}
\usetikzlibrary{decorations.pathmorphing,calc,patterns,positioning,fit}
\ifbool{polytech@blackandwhite}{
% disable hyperlinks
\PassOptionsToPackage{draft,linkcolor=black,citecolor=black,filecolor=black,urlcolor=black}{hyperref}
}{
\PassOptionsToPackage{final,linkcolor=red,citecolor=green,filecolor=cyan,urlcolor=magenta}{hyperref}
}
\RequirePackage[plainpages=false,
pdfpagelabels=true,
verbose=false,
breaklinks=true,
colorlinks=true,
bookmarksopen=true,
pdfborder={0 0 0},
unicode=true,
bookmarksnumbered,
pdfnewwindow=true,
pdfstartview={FitH},
pdftoolbar=true,
pdfmenubar=true,
linktocpage=true,
bookmarks=true]{hyperref}
\RequirePackage{bookmark}
\RequirePackage{pageslts} % to have total page count of the document. Must be at the end for proper functionning
\ifbool{polytech@glossaries}{
\RequirePackage[record,nomain,acronyms,toc,numberedsection,shortcuts]{glossaries-extra}
}{
\RequirePackage[acronyms,toc,numberedsection]{glossaries}
}
% colors
\definecolor{polytechdarkblue}{RGB}{0,74,117}
\definecolor{polytechlightblue}{RGB}{0,156,221}
\definecolor{polytechorange}{RGB}{221,56,0}
\newlength{\polytechfitimageheight}
\newlength{\polytechfitimagewidth}
% height, filepath
\newcommand{\fitimagetoheight}[2]{%
% compute length to allow expression
\setlength{\polytechfitimageheight}{#1}%
\maxsizebox{!}{\polytechfitimageheight}{%
\adjincludegraphics[min height=\polytechfitimageheight]{#2}%
}%
}
% width, filepath
\newcommand{\fitimagetowidth}[2]{%
% compute length to allow expression
\setlength{\polytechfitimagewidth}{#1}%
\maxsizebox{\polytechfitimagewidth}{!}{%
\adjincludegraphics[min width=\polytechfitimagewidth]{#2}%
}%
}
% width, height, filepath
\newcommand{\fitimagetobox}[3]{%
% compute length to allow expression
\setlength{\polytechfitimagewidth}{#1}%
\setlength{\polytechfitimageheight}{#2}%
\maxsizebox{\polytechfitimagewidth}{\polytechfitimageheight}{%
\adjincludegraphics[min height=\polytechfitimagewidth, min width=\polytechfitimageheight]{#3}%
}%
}
\RequirePackage{polytech/constants}
\RequirePackage{polytech/references}
\RequirePackage[planb=false]{newfloat} % needed for biblatex: why ? I don't know or remember
\RequirePackage{float} % to force caption position
\RequirePackage[tableposition=top]{caption} % for typesetting captions
\RequirePackage[labelformat=simple]{subfig} % for subfloat
\RequirePackage{polytech/citingdoc}
\RequirePackage{polytech/firstlastpage}
\RequirePackage{polytech/warning}
\RequirePackage{polytech/headings}
\RequirePackage{polytech/sectionning}
\RequirePackage{polytech/floats}
\RequirePackage{polytech/weeklyreports}
\RequirePackage{polytech/pollistings}
\RequirePackage{polytech/poster}
\RequirePackage{polytech/index}
\RequirePackage{polytech/polglossaries}
\setlength{\parskip}{1ex plus 0.2ex minus 0.2ex}
\setlength{\topsep}{1pt plus 1pt minus 1pt}
\setlength{\parsep}{\parskip}
\setlength{\itemsep}{1pt plus 1pt minus 1pt}
\setlength{\partopsep}{1pt plus 1pt minus 1pt}
\setlength{\parindent}{0in}
\ifcsdef{setlist}{
\setlist{noitemsep,nosep,topsep=0pt,parsep=0pt,partopsep=0pt}
}{}
\widowpenalty=300
\clubpenalty=300
\setcounter{tocdepth}{5}
\renewcommand{\@dotsep}{0.1}
\setcounter{secnumdepth}{3}
\renewcommand{\baselinestretch}{1}
\ifbool{polytech@blackandwhite}{
\arrayrulecolor{black}
}{
\arrayrulecolor{polytechdarkblue}
}
\renewcommand{\arraystretch}{1.2}
% patch \addcontentsline to remove empty chapter from the list of figures and tables
\newbool{polytech@contentsline@lof@written}
\newbool{polytech@contentsline@lot@written}
\let\polytech@contentsline@oldaddcontentsline\addcontentsline
\renewcommand{\addcontentsline}[3]{
\ifcsdef{polytech@contentsline@add@#1@#2}{
\csuse{polytech@contentsline@add@#1@#2}{#1}{#2}{#3}
}{}
\polytech@contentsline@oldaddcontentsline{#1}{#2}{#3}
}
\newcommand{\polytech@contentsline@add@toc@chapter}[3]{%
\boolfalse{polytech@contentsline@lot@written}%
\boolfalse{polytech@contentsline@lof@written}%
\global\csdef{polytech@contentsline@current@content}{#3}
%\csxdef{polytech@contentsline@current@page}{\thepage}
\csxdef{polytech@contentsline@current@href}{\@currentHref}%
}
\newcommand{\polytech@contentsline@add@lof@figure}[3]{
\ifbool{polytech@contentsline@lof@written}{%
}{%
\addtocontents{lof}{\protect \contentsline {chapter}{\csuse{polytech@contentsline@current@content}}{\csuse{polytech@contentsline@current@page}}{\csuse{polytech@contentsline@current@href}}}%
\global\booltrue{polytech@contentsline@lof@written}%
}%
}
\newcommand{\polytech@contentsline@add@lot@table}[3]{%
\ifbool{polytech@contentsline@lot@written}{%
}{%
\addtocontents{lot}{\protect \contentsline {chapter}{\csuse{polytech@contentsline@current@content}}{\csuse{polytech@contentsline@current@page}}{\csuse{polytech@contentsline@current@href}}}%
\global\booltrue{polytech@contentsline@lot@written}%
}%
}
% replace \cleardoublepage by \clearpage on oneside printing
\ifbool{polytech@twoside}{}{\renewcommand{\cleardoublepage}{\clearpage}}
% \nocite is fordibben
%\csundef{nocite}
% allow line break on any character
\renewcommand{\UrlBreaks}{\do\-\do\&\do\=\do\_\do\+\do\a\do\b\do\c\do\d\do\e\do\f\do\g\do\h\do\i\do\j\do\k\do\l\do\m\do\n\do\o\do\p\do\q\do\r\do\s\do\t\do\u\do\v\do\w\do\x\do\y\do\z\do\A\do\B\do\C\do\D\do\E\do\F\do\G\do\H\do\I\do\J\do\K\do\L\do\M\do\N\do\O\do\P\do\Q\do\R\do\S\do\T\do\U\do\V\do\W\do\X\do\Y\do\Z}
%###
\RequirePackage{polytech/couchoud}