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
|
\NeedsTeXFormat{LaTeX2e}%
\newcommand{\ClassToLoad}{report}
\ProvidesClass{pms}
% Accept all options given through the loading tex file
\DeclareOption*{%
\PassOptionsToClass{\CurrentOption}{\ClassToLoad}
}
\PassOptionsToClass{a4paper}{\ClassToLoad}
% Let the base class process all give options, either from this class
% or user defined from an outside tex file.
\ProcessOptions\relax
\LoadClass{\ClassToLoad}
\PassOptionsToPackage{T1}{fontenc}
\PassOptionsToPackage{scaled=0.92}{helvet}
\PassOptionsToPackage{orig,english}{isodate}
% Dimensions of the text area. Define a narrow left margin to make
% room for margin notes in the right (outer) margin
\PassOptionsToPackage{textwidth=400pt,textheight=700pt,
left=20mm,marginparsep=10pt,marginparwidth=40mm,
vmarginratio=1:2,includehead}{geometry}
% Enable UTF-8 input encoding
\PassOptionsToPackage{utf8}{inputenc}
\PassOptionsToPackage{quiet}{marginnote}
\PassOptionsToPackage{nohyphen}{underscore}
\PassOptionsToPackage{hang,flushmargin}{footmisc}
\PassOptionsToPackage{nottoc,notlot,notlof}{tocbibind}
\PassOptionsToPackage{hyphens}{url} % url.sty implicitly loaded by hyperref
\PassOptionsToPackage{hyperfootnotes=false}{hyperref} % footmisc compatibility
\PassOptionsToPackage{local}{gitinfo2}
\PassOptionsToPackage{chapter}{algorithm}
% algorithmic and algorithm to be loaded last to avoid failures
\RequirePackage{parskip}[=v1] % Space between paragraphs instead of indentation
\RequirePackage{%
fontenc, % Load extended font sets
isodate, % Date formatting and conversions
geometry, % Set page layout
inputenc, % Allow input methods apart from ASCII
booktabs, % Nicer formatting of tables
ifthen, % Comfortable conditional routines
longtable, % Extend tables over more than one page
array, % Extended tabular environments
lscape, % Rotating pages
marginnote, % Typeset a paragraph in the page margin
paralist, % Additional list environments
underscore, % Allow simple _ instead of \_
footmisc, % Customise footnotes
chngcntr, % Redefinition of counters
tocbibind, % Add bibliography to table of contents
float, % More control over float environments
gitinfo2 % Metadata from git
}
% Make processing with TeX4HT possible
\newboolean{TEX4HT-HACKS}
\ifx\HCode\undefined
\RequirePackage{%
mathptmx, % Use Postscript fonts: Times ...
helvet, % ... and Helvetica
pdfpages % Insert whole PDF documents as separate pages
}
\setboolean{TEX4HT-HACKS}{false}
\else
\setboolean{TEX4HT-HACKS}{true}
\fi
% tex4ht workaround: hyperref needs to be loaded /after/ tex4ht injects itself
\g@addto@macro\@documentclasshook{
\RequirePackage{%
hyperref, % Support for hyperlinks
algorithm, %
algorithmic % Set algorithms
}
}
\ClassInfo{pms}{LaTeX class for the Package Manager Specification,
loaded baseclass: \ClassToLoad\MessageBreak}
% Define own label and reference commands, that display the label in
% the page margin.
\ifthenelse{\boolean{TEX4HT-HACKS}}{%
\newcommand{\featureref}[1]{\hyperref[feat:#1]{\textsc{#1}}}
\newcommand{\compactfeatureref}[1]{\featureref{#1}}
\newcommand{\featurelabel}[1]{\leavevmode\label{feat:#1}%
% tex4ht does not support marginnote
\framebox{\textsc{#1}}}
}{%
\newcommand{\featureref}[1]{\textsc{#1} on page~\pageref{feat:#1}}
\newcommand{\compactfeatureref}[1]{p.\,\pageref{feat:#1}}
\newcommand{\featurelabel}[1]{\leavevmode\label{feat:#1}%
\marginnote{\framebox{\textsc{#1}}}\ignorespaces}
}
% Change marginnote test to pretend that landscape pages are odd numbered
\g@addto@macro\@mn@margintest{%
\ifdim\columnwidth>\textheight\@tempswatrue\fi
}
% Support url fields in bibliography entries
\bibliographystyle{unsrturl}
% Redefine the titlepage environment not to reset the page number
\renewenvironment{titlepage}{\newpage\thispagestyle{empty}}{\newpage}
% Enumerate subsubsections and include them in the toc
\setcounter{secnumdepth}{3}
\setcounter{tocdepth}{3}
% Don't reset the footnote counter for each chapter
\counterwithout{footnote}{chapter}
% Some shorthands for the lazy ones.
% tex4ht workaround: this needs to happen after loading hyperref
\g@addto@macro\@documentclasshook{
\renewcommand{\i}[1]{\textit{#1}}
\renewcommand{\t}[1]{\texttt{#1}}
}
\newcommand{\note}[1]{\begin{trivlist}\item\textbf{Note:} #1\end{trivlist}}
% Because we are lazy, we define a table environment to fulfil our needs
\newenvironment{centertable}[1]%
{
\begin{table}
\centering
\caption{#1}
}{
\end{table}
}
% Define a new column type P for tables, like p but with ragged-right text
\newcolumntype{P}[1]{>{\setlength\rightskip{0pt plus 1fil}}p{#1}}
% Redefine headings for list of tables/figures/algorithms
\renewcommand{\listtablename}{Tables}
\renewcommand{\listfigurename}{Figures}
\g@addto@macro\@documentclasshook{
\renewcommand{\listalgorithmname}{Algorithms}
}
% Define a float environment for listings
\floatstyle{ruled}
\newfloat{listing}{tbp}{lol}[chapter]
\floatname{listing}{Listing}
\newcommand{\listoflistings}{\listof{listing}{Listings}}
% Prevent page break before a list
\newcommand{\nobreakpar}{\par\nobreak\@afterheading}
% Silence hyperref messages (see hint 11.3 in the hyperref manual)
\providecommand*{\toclevel@algorithm}{0}
\providecommand*{\toclevel@listing}{0}
% We always place captions above floats, so redefine vertical spacings
% Don't use the "caption" package because it interferes with TeX4ht
\setlength\belowcaptionskip{\abovecaptionskip}
\setlength\abovecaptionskip{0pt}
% Prevent numbers in list of tables from overrunning into the table captions
\renewcommand*{\l@figure}{\@dottedtocline{1}{1.5em}{2.8em}} % was 2.3em
\let\l@table\l@figure
% Be more tolerant when formatting paragraphs, to avoid overfull boxes
\tolerance=400 % was 200
\setlength\hfuzz{0.2pt} % was 0.1pt
\setlength\emergencystretch{1em} % was 0
% Don't add extra vertical space, to avoid underfull boxes. Only affects
% two-sided layout, for one-sided it is already the default
\raggedbottom
% Define some PDF meta-data.
% tex4ht workaround: this needs to happen after loading hyperref
\g@addto@macro\@documentclasshook{
\hypersetup{%
urlcolor=black,
colorlinks=true,
citecolor=black,
linkcolor=black,
pdflang={en},
pdfcreator={pdfLaTeX and hyperref},
pdfproducer={pdfLaTeX and hyperref},
}
}
% Reads the last commit date from the Git repository and even succeeds
% when none is available
\ifthenelse{\equal{\gitCommitterDate}{(None)}}{%
\date{Generated on: \today}
\newcommand{\commitinfo}{}
}{%
\date{\printdate{\gitCommitterDate}}
\newcommand{\commitinfo}{%
This version corresponds to commit \gitAbbrevHash
\ifthenelse{\equal{\gitBranch}{\detokenize{master}}}{}
{ on branch \gitBranch}%
\ifthenelse{\equal{\gitDirty}{}}{}{ with local changes}.%
}%
}
% Set page title
\pagestyle{headings}
% To find everywhere that needs updating when we add an EAPI
\newcommand{\CurrentEAPIIs}[1]{\def\TheCurrentEAPI{#1}}
\newcommand{\ChangeWhenAddingAnEAPI}[1]{%
\ifthenelse{\equal{\TheCurrentEAPI}{#1}}{}{%
\errmessage{This needs to be updated for EAPI \TheCurrentEAPI}%
}%
}
% vim: set filetype=tex fileencoding=utf8 et tw=80 spell spelllang=en :
%%% Local Variables:
%%% mode: latex
%%% TeX-master: "pms"
%%% LaTeX-indent-level: 4
%%% LaTeX-item-indent: 0
%%% TeX-brace-indent-level: 4
%%% fill-column: 80
%%% End:
|