Debian Codegraph @

texmf-dist/doc/luatex/lua-placeholders/lua-placeholders-example/example.tex

raw
1 %% example.tex
2 %% Copyright 2024 E. Nijenhuis
3 %
4 % This work may be distributed and/or modified under the
5 % conditions of the LaTeX Project Public License, either version 1.3c
6 % of this license or (at your option) any later version.
7 % The latest version of this license is in
8 % http://www.latex-project.org/lppl.txt
9 % and version 1.3c or later is part of all distributions of LaTeX
10 % version 2005/12/01 or later.
11 %
12 % This work has the LPPL maintenance status ‘maintained’.
13 %
14 % The Current Maintainer of this work is E. Nijenhuis.
15 %
16 % This work consists of the files lua-placeholders.sty lua-placeholders-manual.pdf
17 % lua-placeholders.lua lua-placeholders-common.lua lua-placeholders-namespace.lua lua-placeholders-parser.lua
18 % and lua-placeholders-types.lua
19
20 \documentclass{article}
21 \usepackage{gitinfo-lua}
22 \usepackage{lua-placeholders}
23 \usepackage{listings}
24 \usepackage{amsmath}
25 \usepackage{calc}
26 \usepackage[dutch,english]{babel}
27 \usepackage[autolanguage]{numprint}
28 \usepackage[english]{isodate}
29
30 \loadrecipe[\jobname]{example-specification.yaml}
31
32 \setlength{\parindent}{0pt}
33
34 \begin{document}
35 \title{Lua \paramplaceholder{placeholders} Example\thanks{This example corresponds to \texttt{lua-placeholders} version \gitversion{} written on \gitdate.}}
36 \author{\dogitauthors[\\]}
37 \maketitle
38
39 \section*{Basics}
40 Wrong parameter:\\
41
42 \lstinline[style=TeX,morekeywords={param}]|\param{non existing}|
43 $\implies$
44 \param{non existing}\\
45
46 Conditional Parameter:\\
47
48 \lstinline[style=TeX,morekeywords={hasparam}]|\hasparam{list example}{is set}{is not set}|
49 $\implies$
50 \hasparam{list example}{is set}{is not set}
51
52 \section*{Before values loaded}
53
54 Boolean example:\\
55
56 \lstinline[style=TeX,morekeywords={param}]|\param{bool example}|
57 $\implies$
58 \param{bool example}\\
59
60 \lstinline[style=TeX,morekeywords={ifparam}]|\ifparam{bool example}{TRUE}{FALSE}|
61 $\implies$
62 \ifparam{bool example}{TRUE}{FALSE}\\
63
64 String example:\\
65
66 \lstinline[style=TeX,morekeywords={param}]|\param{string example}|
67 $\implies$
68 ``\param{string example}''\\
69
70 Date example (a string whose payload value matches \texttt{YYYY-MM-DD}):\\
71
72 \lstinline[style=TeX,morekeywords={param}]|\param{date example}|
73 $\implies$
74 \param{date example}\\
75
76 Number example:\\
77
78 \lstinline[style=TeX,morekeywords={rawparam}]|\rawparam{\jobname}{number example}|
79 $\implies$
80 \rawparam{\jobname}{number example}\\
81
82 \lstinline[style=TeX,morekeywords={param}]|\param{number example}|
83 $\implies$
84 \lstinline[style=TeX,morekeywords={numprint}]|\numprint{|\rawparam{\jobname}{number example}\verb|}|
85 $\implies$
86 \param{number example}\\
87
88 \clearpage
89
90 Number in foreign language:\\
91
92 \lstinline[style=TeX,morekeywords={param,selectlanguage}]|\selectlanguage{dutch}\param{number example}|\\
93 $\implies$
94 \begingroup\selectlanguage{dutch}\param{number example}\endgroup\\
95
96 List example:\\
97
98 \lstinline[style=TeX,morekeywords={param}]|\param{list example}|
99 $\implies$
100 \param{list example}\\
101
102 \begin{lstlisting}[language={[LaTeX]TeX},morekeywords={formatitem,forlistitem}]
103 \begin{enumerate}
104 \newcommand\formatitem[1]{\item #1}
105 \forlistitem{list example}{formatitem}
106 \end{enumerate}
107 \end{lstlisting}
108 $\implies$
109 \begin{enumerate}
110 \newcommand\formatitem[1]{\item #1}
111 \forlistitem{list example}{formatitem}
112 \end{enumerate}
113
114 Object example:\\
115
116 \lstinline[style=TeX,morekeywords={paramfield}]|\paramfield{object example}{name}|\\
117 \lstinline[style=TeX,morekeywords={paramfield}]|\paramfield{object example}{email}|\\
118 \lstinline[style=TeX,morekeywords={paramfield}]|\paramfield{object example}{grade}|\\
119 $\implies$
120 \paramfield{object example}{name}
121 \paramfield{object example}{email}
122 \paramfield{object example}{grade}\\
123
124 \begin{lstlisting}[style=TeX,morekeywords={name,email,grade}]
125 \newcommand\name{...}
126 \begin{paramobject}{object example}
127 \name \email \grade
128 \end{paramobject}
129 % And here it works again
130 \name
131 \end{lstlisting}
132 $\implies$
133 \newcommand\name{...}%
134 \parbox{\linewidth}{
135 \begin{paramobject}{object example}
136 \name \email \grade
137 \end{paramobject}
138 \name
139 }\\
140
141 Table example:\\
142
143 \begin{lstlisting}[style=TeX,morekeywords={nprounddigits,npnoround,formatrow,fortablerow,description,price}]
144 \nprounddigits{2}
145 \newcommand\formatrow{\description & \price \\}%
146 \begin{tabular}{l | l}
147 \textbf{Description} & \textbf{Price} \\ \hline
148 \fortablerow{table example}{formatrow}
149 \end{tabular}
150 \npnoround
151 \end{lstlisting}
152 $\implies$
153 \nprounddigits{2}
154 \newcommand\formatrow{\description & \price \\}%
155 \begin{tabular}{l | l}
156 \textbf{Description} & \textbf{Price} \\ \hline
157 \fortablerow{table example}{formatrow}
158 \end{tabular}
159 \npnoround
160
161
162 \section*{After values loaded}
163 \loadpayload[\jobname]{example.yaml}
164
165 Boolean example:\\
166
167 \lstinline[style=TeX,morekeywords={param}]|\param{bool example}|
168 $\implies$
169 \param{bool example}\\
170
171 \lstinline[style=TeX,morekeywords={ifparam}]|\ifparam{bool example}{TRUE}{FALSE}|
172 $\implies$
173 \ifparam{bool example}{TRUE}{FALSE}\\
174
175 String example:\\
176
177 \lstinline[style=TeX,morekeywords={param}]|\param{string example}|
178 $\implies$
179 ``\param{string example}''\\
180
181 Date example:\\
182
183 \lstinline[style=TeX,morekeywords={rawparam}]|\rawparam{\jobname}{date example}|
184 $\implies$
185 \rawparam{\jobname}{date example}\\
186
187 \lstinline[style=TeX,morekeywords={param}]|\param{date example}|
188 $\implies$
189 \param{date example}\\
190
191 Number example:\\
192
193 \lstinline[style=TeX,morekeywords={rawparam}]|\rawparam{\jobname}{number example}|
194 $\implies$
195 \rawparam{\jobname}{number example}\\
196
197 \lstinline[style=TeX,morekeywords={param}]|\param{number example}|
198 $\implies$
199 \lstinline[style=TeX,morekeywords={numprint}]|\numprint{|\rawparam{\jobname}{number example}\verb|}|
200 $\implies$
201 \param{number example}\\
202
203 Number in foreign language:\\
204
205 \lstinline[style=TeX,morekeywords={param,selectlanguage}]|\selectlanguage{dutch}\param{number example}|\\
206 $\implies$
207 \lstinline[style=TeX,morekeywords={numprint}]|\numprint{|\rawparam{\jobname}{number example}\lstinline|}|
208 $\implies$
209 \begingroup\selectlanguage{dutch}\param{number example}\endgroup\\
210
211 List example:\\
212
213 \lstinline[style=TeX,morekeywords={param}]|\param{list example}|
214 $\implies$
215 \param{list example}\\
216
217 \begin{lstlisting}[language={[LaTeX]TeX},morekeywords={formatitem,forlistitem}]
218 \begin{enumerate}
219 \newcommand\formatitem[1]{\item #1}
220 \forlistitem{list example}{formatitem}
221 \end{enumerate}
222 \end{lstlisting}
223 $\implies$
224 \begin{enumerate}
225 \newcommand\formatitem[1]{\item #1}
226 \forlistitem{list example}{formatitem}
227 \end{enumerate}
228
229 Object example:\\
230
231 \lstinline[style=TeX,morekeywords={paramfield}]|\paramfield{object example}{name}|\\
232 \lstinline[style=TeX,morekeywords={paramfield}]|\paramfield{object example}{email}|\\
233 \lstinline[style=TeX,morekeywords={paramfield}]|\paramfield{object example}{grade}|\\
234 $\implies$
235 \paramfield{object example}{name}
236 \paramfield{object example}{email}
237 \paramfield{object example}{grade}\\
238
239 \begin{lstlisting}[style=TeX,morekeywords={name,email,grade}]
240 \newcommand\name{...}
241 \begin{paramobject}{object example}
242 \name \email \grade
243 \end{paramobject}
244 % And here it works again
245 \name
246 \end{lstlisting}
247 $\implies$
248 \parbox{\linewidth}{
249 \begin{paramobject}{object example}
250 \name \email \grade
251 \end{paramobject}
252 \name
253 }\\
254
255 Table example:\\
256
257 \begin{lstlisting}[style=TeX,morekeywords={nprounddigits,npnoround,formatrow,fortablerow,description,price}]
258 \nprounddigits{2}
259 \newcommand\formatrow{\description & \price \\}%
260 \begin{tabular}{l | l}
261 \textbf{Description} & \textbf{Price} \\ \hline
262 \fortablerow{table example}{formatrow}
263 \end{tabular}
264 \npnoround
265 \end{lstlisting}
266 $\implies$
267 \nprounddigits{2}%
268 \begin{tabular}{l | l}
269 \textbf{Description} & \textbf{Price} \\ \hline
270 \fortablerow{table example}{formatrow}
271 \end{tabular}
272
273 \section*{Payload File}
274 \lstinputlisting[language=YAML,numbers=left,xleftmargin={15pt},caption={example.yaml},columns=fullflexible]{example.yaml}
275
276 \section*{Specification File}
277 \lstinputlisting[language=YAML,numbers=left,xleftmargin=15pt,caption={example-specification.yaml},columns=fullflexible]{example-specification.yaml}
278 \end{document}