Debian Codegraph @

texmf-dist/doc/latex/sneaker/sneaker-doc.tex

raw
1 \documentclass[a4paper, 11pt]{article}
2
3 \usepackage[T1]{fontenc}
4 \usepackage[utf8]{inputenc}
5 \usepackage{lmodern}
6 \usepackage{microtype}
7 \usepackage[english]{babel}
8
9 \usepackage{geometry}
10 \geometry{margin=2.5cm}
11
12 \usepackage{booktabs}
13 \usepackage{array}
14 \usepackage{xcolor}
15 \usepackage{listings}
16 \usepackage{parskip}
17 \usepackage{hyperref}
18 \hypersetup{
19 colorlinks=true,
20 linkcolor=blue!60!black,
21 urlcolor=blue!60!black,
22 }
23
24 \usepackage{tikz}
25 \usetikzlibrary{calc}
26 \usepackage{sneaker}
27
28 \newcommand{\meta}[1]{\textlangle\textit{#1}\textrangle}
29
30 %% ---- Code listing style ----
31 \lstset{
32 language=[LaTeX]TeX,
33 basicstyle=\ttfamily\small,
34 keywordstyle=\color{blue!70!black},
35 commentstyle=\color{gray},
36 backgroundcolor=\color{gray!8},
37 frame=single,
38 framerule=0.4pt,
39 rulecolor=\color{gray!40},
40 xleftmargin=8pt,
41 xrightmargin=8pt,
42 breaklines=true,
43 }
44
45 %% ---- Title ----
46 \title{%
47 \textbf{\textsf{Sneaker}}\\[4pt]
48 \large A configurable TikZ sneaker package\\[2pt]
49 \normalsize Version 1.0 \quad \today
50 }
51 \author{Aaron Molt\\\small\href{https://github.com/Aargon06/sneaker}{github.com/Aargon06/sneaker}}
52
53 \begin{document}
54
55 \maketitle
56 \tableofcontents
57 \vspace{1em}
58
59 %% ------------------------------------------------------------------
60 \section{Introduction}
61
62 What started as a small visual gimmick for the slides of my
63 Bachelor's thesis — a sneaker as a feature model to illustrate
64 variability and configuration — gradually grew into something more
65 elaborate. Every new talk added another option: laces, velcro,
66 patterns, wheels. At some point the \texttt{.sty} file had taken on
67 a life of its own, and it felt wrong to keep it to myself.
68 The \textsf{sneaker} package is the result of that growth,
69 cleaned up and made available so that anyone can drop a
70 configurable sneaker into their \LaTeX{} document with a single line.
71
72 The package provides a single highly configurable TikZ \texttt{pic}
73 that draws a stylised sneaker in isometric-like perspective.
74 The shoe is customised via a key--value interface: colours, laces,
75 velcro straps, eyelets, decorative patterns, stitching detail,
76 and rolling wheels are all available as simple options.
77
78 %% ------------------------------------------------------------------
79 \section{Requirements}
80
81 \textsf{sneaker} requires a standard \LaTeXe{} installation with
82 the following packages, all of which ship with every major
83 \TeX{} distribution (TeX~Live, MiKTeX):
84
85 \begin{itemize}
86 \item \textsf{tikz} (part of the \textsf{pgf} bundle)
87 \item TikZ library \texttt{calc}
88 \item \textsf{xcolor} (loaded automatically via TikZ)
89 \end{itemize}
90
91 %% ------------------------------------------------------------------
92 \section{Usage}
93
94 Load the package in the preamble and use the \texttt{pic} inside any
95 \texttt{tikzpicture} environment:
96
97 \begin{lstlisting}
98 \usepackage{sneaker}
99
100 \begin{tikzpicture}
101 \pic{sneaker={<options>}};
102 \end{tikzpicture}
103 \end{lstlisting}
104
105 All options are passed as a comma-separated key--value list inside
106 \verb|sneaker={...}|. Passing no options gives a plain blue sneaker.
107
108 %% ------------------------------------------------------------------
109 \section{Options Reference}
110
111 \subsection{Main colour}
112
113 \begin{tabular}{@{}lp{8.5cm}@{}}
114 \toprule
115 Key & Description \\
116 \midrule
117 \texttt{color=\meta{colour}} &
118 Sets the base colour of the whole shoe. Accepts any colour
119 expression valid for \verb|\colorlet|, e.g.\ \texttt{red},
120 \texttt{blue!40!black}, \texttt{teal}.
121 Default: \texttt{blue}. \\
122 \bottomrule
123 \end{tabular}
124
125 \subsection{Feature flags}
126
127 All flags default to \texttt{false}. Set them to \texttt{true} to
128 enable the feature.
129
130 \begin{tabular}{@{}lp{8.5cm}@{}}
131 \toprule
132 Key & Description \\
133 \midrule
134 \texttt{laces} & Draw shoelaces and a bow.
135 Requires \texttt{eyelets=true} to look correct. \\
136 \texttt{velcro} & Draw velcro strap(s). When combined with
137 \texttt{laces}, a single strap is drawn across
138 the lace zone; standalone gives two straps. \\
139 \texttt{eyelets} & Draw metal eyelets along the lace row. \\
140 \texttt{stitching}& Add dashed stitching lines on the upper and sole. \\
141 \texttt{rolls} & Add three inline-skate-style wheels under the sole. \\
142 \bottomrule
143 \end{tabular}
144
145 \subsection{Pattern}
146
147 \begin{tabular}{@{}lp{8.5cm}@{}}
148 \toprule
149 Key & Description \\
150 \midrule
151 \texttt{pattern} & Enable the side-panel decoration. \\
152 \texttt{pattern type=bolt} & Lightning-bolt shape (default). \\
153 \texttt{pattern type=star} & Five-pointed star. \\
154 \texttt{bolt} & Shorthand for \texttt{pattern=true, pattern type=bolt}. \\
155 \texttt{star} & Shorthand for \texttt{pattern=true, pattern type=star}. \\
156 \bottomrule
157 \end{tabular}
158
159 \subsection{Individual component colours}
160
161 Each key accepts any \textsf{xcolor}-compatible colour expression.
162
163 \begin{tabular}{@{}lp{8.5cm}@{}}
164 \toprule
165 Key & Affected part \\
166 \midrule
167 \texttt{pattern color=\meta{colour}} & Pattern decoration. Default: white. \\
168 \texttt{tongue color=\meta{colour}} & Tongue of the shoe. Default: tinted main colour. \\
169 \texttt{lace color=\meta{colour}} & Laces and bow. Default: off-white. \\
170 \texttt{sole color=\meta{colour}} & Sole area. Default: white. \\
171 \texttt{toe cap color=\meta{colour}} & Toe-cap panel. Default: light tinted main colour. \\
172 \bottomrule
173 \end{tabular}
174
175 %% ------------------------------------------------------------------
176 \section{Examples}
177
178 \subsection{Default sneaker}
179
180 No options — plain blue sneaker, the package baseline.
181
182 \begin{lstlisting}
183 \begin{tikzpicture}[scale=0.6]
184 \pic{sneaker={}};
185 \end{tikzpicture}
186 \end{lstlisting}
187
188 \begin{tikzpicture}[scale=0.6]
189 \pic{sneaker={}};
190 \end{tikzpicture}
191
192 \subsection{Colour}
193
194 The entire shoe is tinted from a single \texttt{color} key.
195
196 \begin{lstlisting}
197 \begin{tikzpicture}[scale=0.6]
198 \pic{sneaker={color=teal}};
199 \end{tikzpicture}
200 \end{lstlisting}
201
202 \begin{tikzpicture}[scale=0.6]
203 \pic{sneaker={color=teal}};
204 \end{tikzpicture}
205
206 \subsection{Eyelets}
207
208 Metal eyelets are placed along the lace row.
209
210 \begin{lstlisting}
211 \begin{tikzpicture}[scale=0.6]
212 \pic{sneaker={eyelets=true}};
213 \end{tikzpicture}
214 \end{lstlisting}
215
216 \begin{tikzpicture}[scale=0.6]
217 \pic{sneaker={eyelets=true}};
218 \end{tikzpicture}
219
220 \subsection{Laces}
221
222 Shoelaces with a bow. Combine with \texttt{eyelets=true} for the
223 intended look.
224
225 \begin{lstlisting}
226 \begin{tikzpicture}[scale=0.6]
227 \pic{sneaker={laces=true, eyelets=true,
228 lace color=red!60!orange}};
229 \end{tikzpicture}
230 \end{lstlisting}
231
232 \begin{tikzpicture}[scale=0.6]
233 \pic{sneaker={laces=true, eyelets=true,
234 lace color=red!60!orange}};
235 \end{tikzpicture}
236
237 \subsection{Velcro}
238
239 Two velcro straps, standalone (without laces).
240
241 \begin{lstlisting}
242 \begin{tikzpicture}[scale=0.6]
243 \pic{sneaker={velcro=true}};
244 \end{tikzpicture}
245 \end{lstlisting}
246
247 \begin{tikzpicture}[scale=0.6]
248 \pic{sneaker={velcro=true}};
249 \end{tikzpicture}
250
251 \subsection{Laces combined with Velcro}
252
253 When both are active, velcro appears as a single strap
254 across the lace zone.
255
256 \begin{lstlisting}
257 \begin{tikzpicture}[scale=0.6]
258 \pic{sneaker={laces=true, eyelets=true, velcro=true}};
259 \end{tikzpicture}
260 \end{lstlisting}
261
262 \begin{tikzpicture}[scale=0.6]
263 \pic{sneaker={laces=true, eyelets=true, velcro=true}};
264 \end{tikzpicture}
265
266 \subsection{Stitching}
267
268 Dashed seam lines on the upper panel and sole.
269
270 \begin{lstlisting}
271 \begin{tikzpicture}[scale=0.6]
272 \pic{sneaker={stitching=true}};
273 \end{tikzpicture}
274 \end{lstlisting}
275
276 \begin{tikzpicture}[scale=0.6]
277 \pic{sneaker={stitching=true}};
278 \end{tikzpicture}
279
280 \subsection{Pattern — bolt}
281
282 A lightning-bolt decoration on the side panel.
283
284 \begin{lstlisting}
285 \begin{tikzpicture}[scale=0.6]
286 \pic{sneaker={bolt, pattern color=yellow}};
287 \end{tikzpicture}
288 \end{lstlisting}
289
290 \begin{tikzpicture}[scale=0.6]
291 \pic{sneaker={bolt, pattern color=yellow}};
292 \end{tikzpicture}
293
294 \subsection{Pattern — star}
295
296 A star decoration on the side panel.
297
298 \begin{lstlisting}
299 \begin{tikzpicture}[scale=0.6]
300 \pic{sneaker={star, pattern color=pink}};
301 \end{tikzpicture}
302 \end{lstlisting}
303
304 \begin{tikzpicture}[scale=0.6]
305 \pic{sneaker={star, pattern color=pink}};
306 \end{tikzpicture}
307
308 \subsection{Rolls}
309
310 Three inline-skate-style wheels are added under the sole.
311
312 \begin{lstlisting}
313 \begin{tikzpicture}[scale=0.6]
314 \pic{sneaker={rolls=true, color=orange}};
315 \end{tikzpicture}
316 \end{lstlisting}
317
318 \begin{tikzpicture}[scale=0.6]
319 \pic{sneaker={rolls=true, color=orange}};
320 \end{tikzpicture}
321
322 \subsection{Fully loaded — all options at once}
323
324 \begin{lstlisting}
325 \begin{tikzpicture}[scale=0.6]
326 \pic{sneaker={color=red!50!black, star,
327 pattern color=yellow, tongue color=orange,
328 lace color=cyan!60, sole color=teal!15,
329 toe cap color=pink, laces=true,
330 eyelets=true, stitching=true,
331 velcro=true, rolls=true}};
332 \end{tikzpicture}
333 \end{lstlisting}
334
335 \begin{tikzpicture}[scale=0.6]
336 \pic{sneaker={color=red!50!black, star,
337 pattern color=yellow, tongue color=orange,
338 lace color=cyan!60, sole color=teal!15,
339 toe cap color=pink, laces=true,
340 eyelets=true, stitching=true,
341 velcro=true, rolls=true}};
342 \end{tikzpicture}
343
344 %% ------------------------------------------------------------------
345 \section{License}
346
347 This work is copyright \textcopyright{Aaron Molt} 2026 and may be
348 distributed and/or modified under the conditions of the
349 \href{https://www.latex-project.org/lppl.txt}{LaTeX Project Public
350 License}, version 1.3c or later.
351
352 \medskip
353 \noindent\textbf{Disclaimer.} The sneaker design in this package is
354 entirely fictional and created from scratch. It is not based on,
355 derived from, or intended to resemble any real product, brand, or
356 trademark. Any similarity to existing footwear designs is purely
357 coincidental.
358
359 \end{document}