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
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% Copyright (c) 2014 - Michiel Helvensteijn (www.mhelvens.net) %
% %
% https://github.com/mhelvens/latex-lt3graph %
% %
% This work may be distributed and/or modified under the conditions %
% of the LaTeX Project Public License, either version 1.3 of this %
% license or (at your option) any later version. The latest version %
% of this license is in http://www.latex-project.org/lppl.txt %
% and version 1.3 or later is part of all distributions of LaTeX %
% version 2005/12/01 or later. %
% %
% This work has the LPPL maintenance status 'maintained'. %
% %
% The Current Maintainer of this work is Michiel Helvensteijn. %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\let\packagename\jobname
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document Class %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\LoadClassWithOptions{l3doc}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Importing The Main Package %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage{\packagename}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Importing Other Packages %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage{etoolbox}
\RequirePackage[table]{xcolor}
\RequirePackage[xcolor]{mdframed}
\RequirePackage{marginnote}
\RequirePackage{listings}
\RequirePackage{textcomp}
\RequirePackage{hyperref}
\RequirePackage{needspace}
\RequirePackage{noindentafter}
\RequirePackage{\packagename-dry}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Documentation Options %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\EnableCrossrefs
\CodelineIndex
\RecordChanges
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% File Info %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\def\extratitlenote{}
\GetFileInfo{\packagename.sty}
\title{
The \textsf{\packagename} package\thanks{%
This document corresponds to
\textsf{\packagename}~\fileversion,
dated \filedate.
}
\ifdefempty{\extratitlenote}{}{\thanks{\extratitlenote}}
}
\author{
Michiel Helvensteijn\\
\href{mailto:mhelvens+latex@gmail.com}{mhelvens+latex@gmail.com}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Development Info %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newmdenv[
leftline = false,
rightline = false
]{bannerframe}
\apptocmd{\maketitle}{
\begin{bannerframe}
\small
\begin{center}
Development of this package is organized at
\href{https://github.com/mhelvens/latex-\packagename}
{github.com/mhelvens/latex-\packagename}.\\
I am happy to receive feedback there!
\end{center}
\end{bannerframe}
}{}{}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Example Environment Setup %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Extra keywords for LaTeX
%
\newcommand{\moretexcs}[1]{
\lstdefinelanguage{latex}{
language=[LaTeX]tex,
alsoletter={_,:},
moretexcs={ExplSyntaxOn,ExplSyntaxOff,lstinputlisting,detokenize,#1}
}
\lstMakeShortInline[style=examplecode]|
}
%%% Code formatting
%
\lstdefinestyle{examplecode}{%
language=latex,%
basicstyle=\ttfamily\small,%
texcsstyle=*\bfseries,%
keywordstyle=\bfseries%
}
%%% Setting up example code block
%
\definecolor{examplecodelinecolor}{rgb}{0,0,0}
\definecolor{examplecodebackgroundcolor}{rgb}{.9,.9,.9}
\newmdenv[
linecolor = examplecodelinecolor,
backgroundcolor = examplecodebackgroundcolor,
skipabove = 0bp,
skipbelow = 0bp,
innertopmargin = -3bp,
innerrightmargin = 4bp,
innerbottommargin = -3bp,
innerleftmargin = 4bp
]{examplecodeframe}
%%% Defining example output block
%
\definecolor{exampleoutputbackgroundcolor}{rgb}{1,1,1}
\newmdenv[
linecolor = examplecodelinecolor,
backgroundcolor = exampleoutputbackgroundcolor,
skipabove = 0bp,
skipbelow = 0bp,
innertopmargin = 4bp,
innerrightmargin = 4bp,
innerbottommargin = 4bp,
innerleftmargin = 4bp
]{exampleoutputframe}
%%% Macros for counting lines in file, adapted from
%%% http://andreas.scherbaum.la/blog/archives/
%%% 670-Read-number-lines-in-a-file-in-LaTeX.html
%
\RequirePackage{ifthen}
\newboolean{packagedoc@restfile}
\newcommand*{\packagedoc@fileline}{}
\newread\packagedoc@file
\newcommand*{\packagedoc@readnextline}[1]{%
\ifthenelse{\boolean{packagedoc@restfile}}{%
\read#1 to \packagedoc@fileline%
\ifeof#1\setboolean{packagedoc@restfile}{false}%
\else\fi%
}{}%
}
\newcommand*{\countlinesinfile}[2]{%
\setboolean{packagedoc@restfile}{true}%
\setcounter{packagedoc@linecount}{0}%
\openin\packagedoc@file=#1%
\whiledo{\boolean{packagedoc@restfile}}{%
\packagedoc@readnextline{\packagedoc@file}%
\ifthenelse{\boolean{packagedoc@restfile}}{%
\stepcounter{packagedoc@linecount}%
}{}%
}%
\closein\packagedoc@file%
\edef#2{\thepackagedoc@linecount}%
}
\newcounter{packagedoc@linecount}
\newlength{\packagedoc@spacetoreserve}
%%% DRYer without output
%
\NewDRYer{latex-example}{%
\addvspace{4bp}%
{%
\ttfamily\small%
\countlinesinfile{#1}{\countedlines}%
\setlength{\packagedoc@spacetoreserve}{\countedlines\baselineskip}%
\setlength{\packagedoc@spacetoreserve}{1.7\packagedoc@spacetoreserve}%
\addtolength{\packagedoc@spacetoreserve}{-4bp}%
\needspace{\packagedoc@spacetoreserve}%
}%
\begin{examplecodeframe}%
\renewcommand{\ttdefault}{pcr}%
\lstinputlisting[style=examplecode]{#1}%
\end{examplecodeframe}%
#2%
\addvspace{4bp}%
}
\NoIndentAfterEnv{latex-example}
%%% DRYer WITH output but WITHOUT side-effects
%
\NewDRYer{latex-example-show}{%
\addvspace{4bp}%
{%
\ttfamily\small%
\countlinesinfile{#1}{\countedlines}%
\setlength{\packagedoc@spacetoreserve}{\countedlines\baselineskip}%
\setlength{\packagedoc@spacetoreserve}{1.7\packagedoc@spacetoreserve}%
\addtolength{\packagedoc@spacetoreserve}{\baselineskip}%
\needspace{\packagedoc@spacetoreserve}%
}%
\begin{examplecodeframe}%
\renewcommand{\ttdefault}{pcr}%
\lstinputlisting[style=examplecode]{#1}%
\end{examplecodeframe}\vspace{-4bp}%
\begin{exampleoutputframe}%
#2%
\end{exampleoutputframe}%
\addvspace{4bp}%
}
\NoIndentAfterEnv{latex-example-show}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Implementation Code Box Setup %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Saving old implementation code block font
%
\AtBeginDocument{\let\old@macro@font\macro@font}
%%% Setup for 'interesting' implementation code blocks
%
\definecolor{interestingcodebackgroundcolor}{rgb}{.9,.9,.9}
\definecolor{interestingcodelinecolor}{rgb}{0,0,0}
\mdfdefinestyle{interestingcode}{
linecolor = interestingcodelinecolor,
backgroundcolor = interestingcodebackgroundcolor
}
\newcommand*{\interesting}{%
\def\codestyle{interestingcode}%
\let\macro@font\old@macro@font%
}
%%% Setup for 'UNinteresting' implementation code blocks
%
\definecolor{uninterestingcodebackgroundcolor}{rgb}{.97,.97,.97}
\definecolor{uninterestingcodelinecolor}{rgb}{.5,.5,.5}
\definecolor{uninterestingcodecolor}{rgb}{.4,.4,.4}
\mdfdefinestyle{uninterestingcode}{
linecolor = uninterestingcodelinecolor,
backgroundcolor = uninterestingcodebackgroundcolor,
}
\newcommand*{\uninteresting}{%
\def\codestyle{uninterestingcode}%
\def\macro@font{\color{uninterestingcodecolor}\old@macro@font}%
\vskip-\belowdisplayskip%
\vskip-1.05\abovedisplayskip%
}
\BeforeBeginEnvironment{macrocode}{\lstDeleteShortInline|\vskip.2\abovedisplayskip}
%%% Actually surround 'macrocode' with the frame
%
\surroundwithmdframed[
style = \codestyle,
skipabove = 0bp,
skipbelow = 0bp,
splitbottomskip = 4bp,
innertopmargin =-3bp,
innerrightmargin = 1bp,
innerbottommargin = 4bp,
innerleftmargin = 1bp
]{macrocode}
%%% Start out with 'interesting' code status and
%%% always go back to it after one code block
%
\interesting
\AfterEndEnvironment{macrocode}{\lstMakeShortInline[style=examplecode]|\vskip\belowdisplayskip\interesting\NoIndentAfterThis}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Argument Specifiers and such %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand*{\movarg}[1]{[ \texttt{#1} ]}
\newcommand*{\momarg}[1]{[ \meta{#1} ]}
\newcommand{\describemacro}[2]{%
\needspace{3\baselineskip}%
\noindent\\\DescribeMacro{#1} #2\\\NoIndentAfterThis%
}
\newcommand{\describeanymacro}[2]{%
\needspace{3\baselineskip}%
\noindent\\\marginnote{#1} #2\\\NoIndentAfterThis%
}
\newcommand{\describemetamacro}[2]{%
\describeanymacro{\meta{#1}}{#2}%
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Other Stuff %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\NoIndentAfterEnv{description}
\NoIndentAfterEnv{itemize}
\NoIndentAfterEnv{enumerate}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Automatic Implementation Docs %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\AtEndDocument{
\pagebreak
\section{Implementation} \label{sec:implementation}
\StopEventually {\PrintChanges}
We now show and explain the entire implementation from \texttt{\packagename.sty}.
\DocInput{\packagename.sty}
\Finale
\PrintIndex
}
|
