-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy patherrata.sty
697 lines (696 loc) · 28 KB
/
errata.sty
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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
%%
%% This is file `errata.sty',
%% generated with the docstrip utility.
%%
%% The original source files were:
%%
%% errata.dtx (with options: `package')
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{errata}[2015/04/16 v1.0 Errata Management]
\RequirePackage{xifthen}
\RequirePackage{pgfkeys}
\RequirePackage{etoolbox}
\RequirePackage{xpatch}
\RequirePackage{xparse}
\RequirePackage{pgffor}
\RequirePackage{xinttools} % defines \xintFor macro
\RequirePackage[family=@errata@]{strkeyformatter}
\RequirePackage{kvoptions}[2009/07/21]
\SetupKeyvalOptions {
family = Errata,
prefix = @errataOpt@,
}
\DeclareBoolOption{show}
\DeclareComplementaryOption{hide}{show}
\DeclareBoolOption{margins}
\DeclareBoolOption{foots}
\DeclareBoolOption[true]{record}
\DeclareBoolOption[true]{requirecmddescription}
\DeclareBoolOption[true]{hyperref}
\DeclareBoolOption[true]{cleveref}
\DeclareBoolOption[true]{marginnote}
\DeclareBoolOption[false]{linenos}
\DeclareStringOption[0]{environmenttestmode}
%% Disabled by default (0), if option set, default level is 3.
\DeclareStringOption[0]{uniquelistlabels}[3]
\DeclareBoolOption[true]{inlinemarks}
\DeclareBoolOption[true]{inlinechanges}
\DeclareStringOption[default]{styles}
\DeclareStringOption[]{defaultargs}
\DeclareStringOption[]{defaultargsadd}
\DeclareStringOption[]{defaultargsdelete}
\DeclareStringOption[]{defaultargsreplace}
\DeclareStringOption[]{defaultargsnote}
\ProcessKeyvalOptions{Errata}
%% Utility macros
\input{erratapgfkeysextra}
\NewDocumentCommand{\@errata@requirepackage}{ m }{%
\@ifpackageloaded{#1}{}{
\PackageWarning{errata}{The current errata settings require the #1 package to be loaded.
Loading package #1...}
\RequirePackage{#1}
}
}
\def\errataset{\pgfqkeys{/@errata@}}
\DeclareExpandableDocumentCommand{\@errata@setvalue}{ m } {\pgfkeys{/@errata@/#1}}
\DeclareExpandableDocumentCommand{\@errata@setvalues}{ O{} m } {\pgfkeys{/@errata@/#1.cd, #2}}
\DeclareExpandableDocumentCommand{\@errata@getvalue}{ m } {\pgfkeysvalueof{/@errata@/#1}}
\NewDocumentCommand{\@errata@ifnotempty}{ m m }{\ifthenelse{\equal{#1}{}}{}{#2}}
%%\NewDocumentCommand{\@errata@ifelsenotempty}{ m m }{\ifthenelse{\equal{#1}{}}{}{#2}}
\NewDocumentCommand{\@errata@ifempty}{ m m }{\ifthenelse{\equal{#1}{}}{#2}{}}
\NewDocumentCommand{\@errata@ifelseempty}{ m m m }{\ifthenelse{\equal{#1}{}}{#2}{#3}}
\NewDocumentCommand{\@errata@ifstrequal}{ m m m }{\ifthenelse{\equal{#1}{#2}}{#3}{}}
%%
\pgfkeys{
/@errata@/cmdkeys/.is family, /@errata@/cmdkeys,
defaultargs/.style={record=true, foot=true, margin=true, marginargs={},
lineno=true, inlinemark=true, inlinechange=true},
defaultargsadd/.style={},
defaultargsreplace/.style={},
defaultargsdelete/.style={},
defaultargsnote/.style={},
/handlers/.errataapplystyles/.code={\xintFor ##9 in {#1} \do {\errataset{styles/##9}}},
}
\errataset{customformatkeys/.initial={}}
%% Add any default arguments specified by the user
\@errata@setvalues[cmdkeys/]{defaultargs/.append style/.expand once={{\@errataOpt@defaultargs}}}
\@errata@setvalues[cmdkeys/]{defaultargsadd/.append style/.expand once={\@errataOpt@defaultargsadd}}
\@errata@setvalues[cmdkeys/]{defaultargsreplace/.append style/.expand once={\@errataOpt@defaultargsreplace}}
\@errata@setvalues[cmdkeys/]{defaultargsdelete/.append style/.expand once={\@errataOpt@defaultargsdelete}}
\@errata@setvalues[cmdkeys/]{defaultargsnote/.append style/.expand once={\@errataOpt@defaultargsnote}}
%%
\AtBeginDocument{%
\ifboolexpr{ bool{@errataOpt@linenos} and not test{\@ifpackageloaded{lineno}} } {%
\@errata@requirepackage{lineno}
}{}
}
%%
\if@errataOpt@show
\@errataOpt@marginstrue%
\@errataOpt@footstrue%
\@errataOpt@inlinemarkstrue%
\@errataOpt@inlinechangestrue%
\fi
%%
\@ifpackageloaded{hyperref}{}{\@errataOpt@hyperreffalse }
\@ifpackageloaded{cleveref}{}{\@errataOpt@clevereffalse }
\if@errataOpt@marginnote
\@ifpackageloaded{marginnote}{}{\RequirePackage{marginnote}}
\fi
%%
\newcounter{@errata@erratum}
\newcounter{erratum@note}[@errata@erratum]
\if@errataOpt@record\newwrite\@errata@file
\immediate\openout\@errata@file=\jobname-errata.tex
\AtEndDocument{\closeout\@errata@file}\fi
%%
\newlength{\@errata@groupindent}
\setlength\@errata@groupindent{14.7pt}
\newcounter{@errata@uniquelistlabels}
\setcounter{@errata@uniquelistlabels}{\@errataOpt@uniquelistlabels}
\newcounter{@errata@environmenttestmode}
\setcounter{@errata@environmenttestmode}{\@errataOpt@environmenttestmode}
%%
\NewDocumentCommand{\@errata@declareKey}{ O{UNDEF} m }
{\@errata@setvalue{#2/.initial={#1}}}
%%
\NewDocumentCommand{\@errata@declareStoreKey}{ O{UNDEF} m }
{%% Basically 'estore in', but must build macro name from argument
\pgfkeys{/@errata@/#2/.code={\expandafter\edef\csname @errata@#2\endcsname{##1}}}%
\pgfkeys{/@errata@/#2={#1}}%
}
%%
\NewDocumentCommand{\@errata@setcmdkeys}{ O{0} m }{%
\xintFor ##9 in {#2} \do {%
\edef\@errata@key{##9}%
\@errata@ifnotempty{##9} {%
\@errata@setvalue{cmdkeys/\@errata@key/.initial=#1}%
}}}
%%
\NewDocumentCommand{\errataSetFootFormat}{ m }{%
\@errata@declareStoreKey[#1]{footformat}%
}
\NewDocumentCommand{\errataSetListFormat}{ m }{%
\@errata@declareStoreKey[#1]{listformat}%
}
\@errata@declareStoreKey[type, description, location, date, id, pageref, lineref,
inlinemark, inlinechange, uselabel, label, margin, foot, record, lineno,
marginargs, usemarginnote, reported-by, actionid, action, actionargs, actiondescription,
erratumlistitem, erratumlistitemtitle, erratumlisttarget,
listbeforenewgroup, listafternewgroup, listbeforesamegroup, listaftersamegroup,
erratumlabel, erratumname, erratumnamedlink]{formatkeys}% Defines \@errata@formatkeys
%%
\@errata@setcmdkeys{\@errata@formatkeys}
\@errata@setvalue{cmdkeys/usemarginnote/.default={0pt}}
%%
\NewDocumentCommand{\errataSetKeyFormat}{ O{} m m }{% PGF argument pattern, key, formated output
\StrKeyFmtSetKeyFormat[#1]{#2}{#3}%
}
\NewDocumentCommand{\errataRegisterFormatKey}{ m }{%
\errataset{customformatkeys/.append=#1}%
\errataset{formatkeys/.append code=#1}%
\@errata@setcmdkeys{#1}
}
%% Set default formater for all keys
\SetDefaultKeylistFormat[#1]{listformats}{\@errata@formatkeys}
\SetDefaultKeylistFormat[#1]{footformats}{\@errata@formatkeys}
\SetDefaultKeylistFormat[#1]{errformats}{errfmt, eerrbeginfmt, eerrendfmt}
\SetDefaultKeylistFormat[#1]{actionformat}{add, delete, replace, note}
\errataSetKeyFormat[#1+#2]{marginfmt/marginnote}{#2}%
%%
\@errata@declareKey[{@errata@erratum}]{footnoteprefix}
\@errata@declareKey[\scshape{Erratum!}]{footnotebegin}
%%
%% Used internally to track label and label references
\@errata@declareKey{labelref}
\@errata@declareStoreKey{erratumname}
\@errata@setvalue{labelname/.gstore in=\@errata@labelname}
\@errata@setvalue{labelname={}}
\@errata@setvalue{prevlabel/.gestore in=\@errata@prevlabel}
\@errata@setvalue{prevlabel={}}
\@errata@setvalue{lastuniquelabel/.gestore in=\@errata@lastuniquelabel}
\@errata@setvalue{lastuniquelabel={UNDEF}}
\@errata@setvalue{newlabelgroup/.gstore in=\@errata@newlabelgroup}
\@errata@setvalue{newlabelgroup={true}}
%%
\@errata@setvalue{lastcommandinlinevalue/.gstore in=\lastcommandinlinevalue}
\@errata@setvalue{lastcommandinlinevalue={}}
\@errata@setvalue{inlinevalue/.initial={}}
\input{erratastyles}
\errataset{.errataapplystyles/.list={basekeyformats, \@errataOpt@styles}}
%%
\DeclareExpandableDocumentCommand{\@errata@htargetname}{ m } {errata#1}%
\DeclareExpandableDocumentCommand{\@errata@linenoname}{ m } {\if@errataOpt@linenos%
erratalineno#1\else{}\fi}%
\DeclareExpandableDocumentCommand{\@errata@htargetlisttname}{ m } {erratalist#1}%
\NewDocumentCommand{\@errata@hlink}{ m m } {#2}%
\NewDocumentCommand{\@errata@label}{ m } {%
\protected@edef\@errata@expanded@arg{#1}\label{\@errata@expanded@arg}}%
\NewDocumentCommand{\@errata@htargeterratum}{ O{} m m } {\@errata@label{#1}#2}
\NewDocumentCommand{\@errata@hlinkerratum}{ m m } {\@errata@hlink{\@errata@htargetname{#1}}{#2}}
\NewDocumentCommand{\@errata@hlinkerratumlist}{ m m } {\@errata@hlink{\@errata@htargetlisttname{#1}}{#2}}
%%
%% Enable internal linking if hyperref
\if@errataOpt@hyperref
\RenewDocumentCommand{\@errata@hlink}{ m m } {%
\protected@edef\@errata@expanded@arg{#1}%
\hyperlink{\@errata@expanded@arg}{#2}}%
%%
%% \@errata@htargeterratum
%% ARG1: Optional argument to indicate whether to add labels,
%% ARG2: The (optional) target name of a custom label
%% ARG3: The target name of the primary label/hyperlink
%% ARG4: The text to insert after the label/hypertarget
%% Hypertarget creates a hyper-link anchor, used to link to this location with \hyperlink
%% The label is needed for such as ref/pageref/cref
\RenewDocumentCommand{\@errata@htargeterratum}{ O{} O{} m m }{%
\Hy@raisedlink{\hypertarget{#3}{}}%
\@errata@ifempty{#1}{% Add labels
\@errata@label{#3}% Primary label
\if@errataOpt@linenos%
\ifboolexpr{ test {\ifdolineno} }{%
\edef\@errata@expanded@arg{\@errata@linenoname{\the@errata@erratum}}%
\ifinner%
\expandafter\@LN@postlabel\expandafter{\@errata@expanded@arg}%
\else%
\expandafter\linelabel\expandafter{\@errata@expanded@arg}%
\fi%
}{}%
\fi%
\@errata@ifnotempty{#2}{\@errata@label{#2}}% Seconday custom label
}{#4}%
}%
\fi
%%
%% Code for cleveref support
\if@errataOpt@cleveref
\AtBeginDocument{%
\Crefname{errata}{Err}{Errata}
\crefname{errata}{err}{errata}
\crefformat{errata}{Err(#2#1#3)}
\Crefformat{errata}{Err(#2#1#3)}
}
\RenewDocumentCommand{\@errata@label}{ m } {%
\protected@edef\@errata@expanded@arg{#1}\label[errata]{\@errata@expanded@arg}}%
\fi
%%
\NewDocumentCommand{\@errata@FormatKeywords}{ O{} m m m }{% key, keys/values, format-string
\@StrKeyFmt@FormatKeywords[#1]{#2}{cmdkeys}{#3}{#4}%
}
%%
\newcounter{@errata@lowerlabellim}
\setcounter{@errata@lowerlabellim}{0}
%% Return true of the label name can be set
\newcommand\ifuniquelabeltest[1]{%
%% Current document class doesn't have chapters.
\setcounter{@errata@lowerlabellim}{#1}%
\@ifundefined{thechapter}{%
\stepcounter{@errata@lowerlabellim}%
}{}%
\ifboolexpr{test {\ifnumcomp{\value{@errata@uniquelistlabels}}{=}{0}} or test {\ifnumcomp{\value{@errata@uniquelistlabels}}{>}{\value{@errata@lowerlabellim}}}}}
%%
\DeclareExpandableDocumentCommand{\@errata@setlabelref}{ } {%
\@ifundefined{thechapter}{}{%
\ifnumcomp{\value{chapter}}{>}{0}{%
\@errata@setvalue{labelname=\thechapter}%
\@errata@setvalue{labelref={chapter.\thechapter}}%
}{}}%
%% Check section
\@ifundefined{thesection}{}{%
\ifnumcomp{\value{section}}{>}{0}{%
\@errata@setvalue{labelref={section.\thesection}}%
\ifboolexpr{test {\ifuniquelabeltest{1}} }{\@errata@setvalue{labelname=\thesection}}{}%
%% Check subsection
\@ifundefined{thesubsection}{}{%
\ifnumcomp{\value{subsection}}{>}{0}{%
\@errata@setvalue{labelref={subsection.\thesubsection}}%
\ifboolexpr{test {\ifuniquelabeltest{2}} }{\@errata@setvalue{labelname=\thesubsection}}{}%
%% Check subsubsection
\@ifundefined{thesubsubsection}{}{%
\ifnumcomp{\value{subsubsection}}{>}{0}{%
\@errata@setvalue{labelref={subsubsection.\thesubsubsection}}%
\ifboolexpr{test {\ifuniquelabeltest{3}} }{\@errata@setvalue{labelname=\thesubsubsection}}{}%
}{}%
}%
}{}% END subsubsection
}% END subsection
}{}%
}% END section
}
%%
%% ARG1: Optional value to add before the content
%% ARG2: Optional value to add after the content
%% ARG3: Item title
%% ARG4: errata-format-text
\DeclareDocumentCommand{\erratumItem}{ O{} O{} m m } {#1#3#4#2}
%%
\DeclareDocumentCommand{\printerrata}{ O{-errata.tex} m } {%
\IfFileExists{#2#1}{%
\begin{errata}\input{#2#1}\end{errata}}{}%
}
%%
\DeclareDocumentCommand{\PrintErrata}{} {%
\if@errataOpt@record\immediate\closeout\@errata@file\fi%
\printerrata{\jobname}%
}
%%
\newcommand\ifdomargin[0]{%
\ifboolexpr{
bool{@errataOpt@margins}
and test{\ifthenelse{\equal{\@errata@getvalue{cmdkeys/margin}}{true}}}}}
\newcommand\ifdofoot[0]{%
\ifboolexpr{
bool{@errataOpt@foots}
and test{\ifthenelse{\equal{\@errata@getvalue{cmdkeys/foot}}{true}}}}}
\newcommand\ifdorecord[0]{%
\ifboolexpr{
bool{@errataOpt@record}
and test{\ifthenelse{\equal{\@errata@getvalue{cmdkeys/record}}{true}}}}}
%%
%% Ideally, the \ifdolineno test would include a test for bool{@errataOpt@linenos}
%% However, LineNumbers isn't available if the lineno package isn't loaded,
%% and as ifboolexpr doesn't do lazy evaluation, we can't test for that
%% unless we know the package is loaded.
\newcommand\ifdolineno[0]{%
\ifboolexpr{
and test{\ifthenelse{\equal{\@errata@getvalue{cmdkeys/lineno}}{true}}}
and bool{LineNumbers} }}
%%
\newenvironment{errata}{%
\StrKeyFmtgetformatted{listformats/erratalistbegin}{}{\@errata@tmp@erratalistbegin}%
\@errata@tmp@erratalistbegin%
}{\StrKeyFmtgetformatted{listformats/erratalistend}{}{\@errata@tmp@erratalistend}%
\@errata@tmp@erratalistend%
}
%%
\DeclareDocumentEnvironment{erratum}{ O{} m }% keys, explanation
{\@erratum@cmd{}{#1}{action={Long errata}, description={#2}}%
\expandafter\@errata@htargeterratum{\@errata@htargetname{\the@errata@erratum}}{}%
\if@errataOpt@foots%
\footnotetext[\value{@errata@erratum}]{{\@errata@getvalue{footnotebegin} #2}}%
\fi%
\protected@edef\@errata@tmp@marginargs{\@errata@getvalue{cmdkeys/marginargs}}%
\ifboolexpr{test {\ifdomargin} }%
{\StrKeyFmtgetformatted{errformats/eerrbeginfmt}{\@errata@hlinkerratumlist{\the@errata@erratum}{\arabic{@errata@erratum}}}{\@errata@tmpfmtvalue}%
\@errata@marginnote[\@errata@tmp@marginargs]{\@errata@tmpfmtvalue}%
}{}%
\@errata@dorecord{listformats}{\@errata@listformat}{\@errata@argsstring}%
\def\eAdd##1{[##1]$_a$}%
\def\eDelete##1{\erratum@mark[]$_d^{\@thefnmark}$\if@errataOpt@foots\@footnotetext{deleted: ##1}\fi}%
\def\eReplace##1##2{\erratum@mark[##2]$_r^{\@thefnmark}$\if@errataOpt@foots\@footnotetext{was: ##1}\fi}
\ignorespaces}%
{\ifboolexpr{test {\ifdomargin} }%
{\StrKeyFmtgetformatted{errformats/eerrendfmt}{\@errata@hlinkerratumlist{\the@errata@erratum}{\arabic{@errata@erratum}}}{\@errata@tmpfmtvalue}%
\@errata@marginnote[\@errata@tmp@marginargs]{\@errata@tmpfmtvalue}%
}{}%
}%
%%
\def\erratum@mark{\stepcounter{erratum@note}{}
\def\@thefnmark{\arabic{@errata@erratum}:\arabic{erratum@note}}}
%% Write info to log file
\NewDocumentCommand{\erratamessage}{ m } {% erratakeyvalues
\ifnum\value{@errata@erratum}>0\typeout{}%
\typeout{This document contains \arabic{@errata@erratum} Errata; see \jobname-errata.tex!}%
\typeout{}%
\fi}
%%
\NewDocumentCommand{\@errata@dorecord}{ m m m } {% formattype, listformat, argsstring
\ifboolexpr{ test {\ifdorecord} }{%
%% Get the formatted code for a new group
\ifboolexpr{ test {\ifthenelse{\equal{\@errata@newlabelgroup}{true}}} }%
{%
\StrKeyFmtgetformatted{listformats/listbeforenewgroup}{\@errata@labelname}{\@errata@tmp@before}%
\StrKeyFmtgetformatted{listformats/listafternewgroup}{\@errata@labelname}{\@errata@tmp@after}%
}%
{%
\StrKeyFmtgetformatted{listformats/listbeforesamegroup}{\@errata@labelname}{\@errata@tmp@before}%
\StrKeyFmtgetformatted{listformats/listaftersamegroup}{\@errata@labelname}{\@errata@tmp@after}%
}%
\@errata@record[\@errata@tmp@before][\@errata@tmp@after]{\noexpand\@errata@FormatKeywords{#1}{#3}{#2}}%
}{}%
}
%% Create an entry in the errata list produced by PrintErrata
\NewDocumentCommand{\@errata@record}{ O{} O{} m } {% erratakeyvalues
\@errata@setvalue{cmdkeys/erratumlistitemtitle/.get=\@errata@tmp@itemtitle}%
\StrKeyFmtgetformattedef{listformats/erratumlistitemtitle}{\@errata@tmp@itemtitle}{\@errata@tmp@formatteditemtitle}%
\StrKeyFmtgetformatted{listformats/erratumlistitem}{\@errata@tmp@formatteditemtitle}{\@errata@tmplistitem}%
\protected@write\@errata@file{}%
{\string\erratumItem[#1][#2]{\@errata@tmplistitem}{#3}}%
}
\newif\if@errata@inbadenvironment
\newif\if@errata@inknownbadenvironment
%%
\NewDocumentCommand{\@erratum@checkenvironment}{}{%
\@errata@inknownbadenvironmentfalse%
\@errata@inbadenvironmentfalse%
%%
\ifinner%
\@errata@inknownbadenvironmenttrue%
\fi%
\ifmmode%
\@errata@inknownbadenvironmenttrue%
\fi%
\ifthenelse{\equal{\@currenvir}{tcb@savebox}}%
{\@errata@inknownbadenvironmenttrue}%
{}%
%%
\ifnumgreater{\value{@errata@environmenttestmode}}{0}%
{% At least 1, so lets consider any environment with \@captype dangerous
\ifx\@captype\@undefined%
\else%
\@errata@inbadenvironmenttrue%
\fi%
\ifnumequal{\value{@errata@environmenttestmode}}{2}%
{%
\ifthenelse{\equal{\@currenvir}{document}}%
{}{\@errata@inbadenvironmenttrue}%
}{}% End == 2
}{}% End > 0
}
\edef\emptyval{}%
%% Create the margin note
\NewDocumentCommand{\@errata@marginnote}{ O{\emptyval} m }{%
%% We use marginpar if we can, as it handles stacking multiple values vertically
\let\@errata@marginnote@cmd\marginpar%
%% If captype is defined, we're probably inside a float
\if@errata@inknownbadenvironment%
\let\@errata@marginnote@cmd\marginnote%
\fi
\if@errata@inbadenvironment%
\let\@errata@marginnote@cmd\marginnote%
\fi
%% If user provided argument 'usemarginnote', we use \marginnote macro
\protected@edef\@errata@tmp@marginshift{\@errata@getvalue{cmdkeys/usemarginnote}}%
\@errata@ifnotempty{\@errata@tmp@marginshift}{%
\let\@errata@marginnote@cmd\marginnote%
\renewcommand*{\marginnotevadjust}{\@errata@tmp@marginshift}%
}%
\StrKeyFmtgetformatted{marginfmt/marginnote}{{#1}+{#2}}{\@errata@tmp@marginfmtvalue}%
\@errata@marginnote@cmd{\@errata@tmp@marginfmtvalue}%
}
%% Do the pagelayout of the errata (inline changes, margin, and footnote)
\NewDocumentCommand{\@errata@dolayoutonpage}{ m m m m }{% type(a,r,d), original, change, errata-formatted-text
\ifboolexpr{test {\ifdomargin} }%
{\StrKeyFmtgetformatted{errformats/errfmt}{\@errata@hlinkerratumlist{\the@errata@erratum}{\arabic{@errata@erratum}}}{\@errata@tmpfmtvalue}%
\protected@edef\@errata@tmp@marginargs{\@errata@getvalue{cmdkeys/marginargs}}%
\@errata@marginnote[\@errata@tmp@marginargs]{\@errata@tmpfmtvalue}%
}{}%
%% Handle inline changes
\ifboolexpr{ bool{@errataOpt@inlinechanges} and
test {\ifthenelse{\equal{\@errata@getvalue{cmdkeys/inlinechange}}{true}}} }%
{% Make inline change
%%\@errata@setvalues{lastcommandinlinevalue={#3}, inlinevalue={#3}}
\@errata@setvalue{lastcommandinlinevalue={#3}}%
\@errata@setvalue{inlinevalue={#3}}%
}%
{% Use original value
\@errata@setvalue{lastcommandinlinevalue={#2}}%
\@errata@setvalue{inlinevalue={#2}}%
}%
%% If trying to set lastcommandinlinevalue=inlinevalue here with
%% (\@errata@setvalue{lastcommandinlinevalue=\@errata@getvalue{inlinevalue}}%),
%% it adds an unwanted space to lastcommandinlinevalue for some reason. Therefore,
%% both lastcommandinlinevalue and inlinevalue are set to the same value separately.
%%
\ifboolexpr{ bool{@errataOpt@inlinemarks} and
test {\ifthenelse{\equal{\@errata@getvalue{cmdkeys/inlinemark}}{true}}} }%
{% Use add inlinemark
\@errata@setvalue{lastcommandinlinevalue={[]}}%
\@errata@setvalue{inlinevalue/.prefix={[}}%
\@errata@setvalue{inlinevalue/.append={]\ensuremath{_#1^{\arabic{@errata@erratum}}}}}%
}{}%
\protected@edef\@errata@tmp@dolabel{}%
\ifmmode% In math mode, we can't add a label
\eappto\@errata@tmp@dolabel{nolabel}%
\fi%
\@errata@htargeterratum[\@errata@tmp@dolabel][\@errata@getvalue{cmdkeys/label}]%
{\@errata@htargetname{\the@errata@erratum}}{\@errata@getvalue{inlinevalue}}%
%%
\ifboolexpr{test {\ifdofoot} }{%
\protected@edef\@errata@tmp@footprefix{\arabic{\@errata@getvalue{footnoteprefix}}}% Expand the formatting code here, and not inside the footnote macro
\expandafter\footnotetext\expandafter[\@errata@tmp@footprefix]%
{{\@errata@getvalue{footnotebegin}}%
\@errata@ifnotempty{#4}{#4}}%
}{}%
}%
%%
\errataset{%
setcmdkeyvalue/.code={%
%% Apply the registered formatter
\errataset{#1/.cd, .@formatter}%
%% Get the formatted output
\errataset{#1/.@formatter/.@formatted/.get=\@errata@tmp@cmdkeyargs}%
%% Update the cmdkey with the formatted output
\@errata@setvalue{#1/.expand once=\@errata@tmp@cmdkeyargs}%
},
setcmdkeyvalues/.style={setcmdkeyvalue=cmdkeys/#1},
setCmdKeyArgsGetTwo/.style n args={3}{%
cmdkeys/#1/.setStrKeyWithDefFmt={#2}{#3}{%
{{\@errata@getvalue{cmdkeys/##1}}+{\@errata@getvalue{cmdkeys/##2}}}}%
},
setCmdKeyArgsGetOne/.style n args={3}{%
cmdkeys/#1/.setStrKeyWithDefFmt={#2}{#3}{{\@errata@getvalue{cmdkeys/##1}}},%
},
}
%%
\errataset{%
setCmdKeyArgsGetOne={pageref}{#1}{{uselabel}},
cmdkeys/lineref/.setStrKeyWithDefFmt={#1}{}{\@errata@linenoname{\the@errata@erratum}},
cmdkeys/erratumnamedlink/.setStrKeyWithDefFmt={#1}{}{%
{{\@errata@getvalue{cmdkeys/uselabel}}+{\@errata@getvalue{cmdkeys/erratumname}}}},
%% setCmdKeyArgsTwo={erratumnamedlink}{#1+#2}{{labelref}+{erratumname}},
cmdkeys/erratumlistitemtitle/.setStrKeyWithDefFmt={#1}{defvalue}{%
{{\@errata@getvalue{labelref}}+{\@errata@labelname}}},
cmdkeys/erratumlisttarget/.setStrKeyWithDefFmt={#1}{}{{%
\@errata@htargetlisttname{\the@errata@erratum}}},%
%%
handleerratanamecmdkey/.code={%
\StrKeyFmtgetformatted{errformats/errfmt}{\arabic{@errata@erratum}}{\@errata@erratumname}%
\@errata@setvalues[cmdkeys/]{erratumname/.expand once={\@errata@erratumname}}%
},
handleactioncmdkeys/.code={%
\@errata@setvalues{cmdkeys/actionid/.get=\@errata@tmp@actionid}%
\@errata@ifelseempty{\@errata@tmp@actionid}{%
\@errata@setvalues[cmdkeys/]{actiondescription={}}%
\@errata@setvalues[cmdkeys/]{action={}}%
}{%
\@errata@setvalues{cmdkeys/actionargs/.get=\@errata@tmp@actionargs}%
\StrKeyFmtgetformattedeo{actionformat/\@errata@tmp@actionid}{\@errata@tmp@actionargs}{\@errata@tmpfmtvalue}%
\@errata@setvalues[cmdkeys/]{actiondescription/.expand once={\@errata@tmpfmtvalue}}%
\StrKeyFmtgetformattedeo{actionidformat/\@errata@tmp@actionid}{}{\@errata@tmpfmtvalue}%
\@errata@setvalues[cmdkeys/]{action/.expand once={\@errata@tmpfmtvalue}}%
}%
},
handlelabelcmdkey/.code={%
\@errata@setvalue{prevlabel=\@errata@labelname}%
\@errata@setlabelref{}%
\ifboolexpr{ test {\ifdorecord} }{%
%% Compare current label with previous. Print only if not already printed
\ifnumcomp{\value{@errata@uniquelistlabels}}{>}{0}%
{% True
\ifthenelse{\expandafter\equal{\@errata@lastuniquelabel}{\@errata@labelname}}%
{\@errata@setvalue{labelname={}}% Hide the label, if it equals the previous label
\@errata@setvalue{newlabelgroup={false}}}%
{\@errata@setvalue{prevlabel/.expand once=\@errata@labelname}%
\@errata@setvalue{lastuniquelabel/.expand once=\@errata@labelname}%
\@errata@setvalue{newlabelgroup={true}}%
}%
}{\@errata@setvalue{prevlabel=\@errata@labelname}}%
}{}%
},
handlecustomformatkeys/.code={%
\@errata@ifnotempty{\@errata@getvalue{customformatkeys}}{%
\pgfkeysalso{setcmdkeyvalues/.list={\@errata@getvalue{customformatkeys}}}%
}%
},
commandarghandlers/.code={%
\pgfkeysalso{%
handleerratanamecmdkey,
handlelabelcmdkey,
setcmdkeyvalues/.list={pageref, lineref},
setcmdkeyvalues/.list={erratumnamedlink, erratumlistitemtitle, erratumlisttarget},
handleactioncmdkeys,
handlecustomformatkeys,
}%
},
addtoargstring/.code={%
\protected@xappto\@errata@argsstring{, #1={\@errata@getvalue{cmdkeys/#1}}}%
},
addcustomkeystoargsstring/.code={%
\@errata@ifnotempty{\@errata@getvalue{customformatkeys}}{%
\pgfkeysalso{addtoargstring/.list={{\@errata@getvalue{customformatkeys}}}}%
}%
},
addtoargsstring/.style={%
addtoargstring/.list={actiondescription, action, pageref, lineref,
erratumlistitemtitle, erratumnamedlink, erratumlisttarget},
addcustomkeystoargsstring,
},
}
%%
\NewDocumentCommand{\@erratum@cmdinit}{}{%
\@erratum@setprevispace% Handle if there was a previous white space glue
\@erratum@checkenvironment%
}
%% ARG1: cmddefaultargs string
%% ARG2: Key/Args from cmd
%% ARG3: extra Key/Args
\NewDocumentCommand{\@erratum@cmd}{ m m m } {%
\refstepcounter{@errata@erratum}%
\@errata@setcmdkeys[]{\@errata@formatkeys}% Reset all values
%% Apply the default args
\@errata@setvalues[cmdkeys/]{defaultargs, #1, uselabel={\@errata@htargetname{\the@errata@erratum}}}%
\@errata@setvalues[cmdkeys/]{#2, #3}%
%% Execute the command key handlers
\errataset{commandarghandlers}%
%% Define macro for the args string
\protected@edef\@errata@argsstring{#2}%
\@errata@ifnotempty{\@errata@argsstring}{%
\eappto\@errata@argsstring{, }%
}%
\protected@eappto\@errata@argsstring{#3}%
%% Add rest of the arguments to \@errata@argsstring
\errataset{addtoargsstring}%
}
%%
%% Macros for handling spaces before and after macro call
%%
\newcommand\ifstrequalexpand{\expandafter\ifstrequal\expandafter}%
%%
%% Handle if space after macro call should be ignored
\NewDocumentCommand{\@erratum@handleprevisspace}{}{%
\ifhmode%
\ifboolexpr{ bool {@errata@prevspace} and test {\ifstrequalexpand{\lastcommandinlinevalue}{}} }{%
\ignorespaces}{}%
\fi%
}
%%
\newif\if@errata@prevspace
%%
\NewDocumentCommand{\@erratum@setprevispace}{}{%
\ifhmode%
\ifdim \lastskip=\z@%
\@errata@prevspacefalse%
\else%
\@errata@prevspacetrue%
\fi%
\fi%
}
%%
%% User commands for registering errata changes
%%
%% Macro for creating an Addition
%%
\NewDocumentCommand{\@erratum@Add}{ O{} m }{% keyvals, new
\@erratum@cmdinit%
{% Group is necessary here to handle cref reference format for label type `@errata@erratum'.
%% \@erratum@cmd must be within the group, as pgfkeys are group local
\@erratum@cmd{defaultargsadd}{#1}{actionid={add}, actionargs={#2}}%
\@errata@dolayoutonpage{a}{}{#2}{\@errata@FormatKeywords{footformats}{\@errata@argsstring}{\@errata@footformat}}%
\@errata@dorecord{listformats}{\@errata@listformat}{\@errata@argsstring}%
}%
%% Handle if the space after the macro call should be ignored
\@erratum@handleprevisspace%
}
%%
%% Macro for creating a Replacement
%%
\NewDocumentCommand{\@erratum@Replace}{ O{} m m }{% keyvals, old, new
\@erratum@cmdinit%
{% Group is necessary here to handle cref reference format for label type `@errata@erratum'.
%% \@erratum@cmd must be within the group, as pgfkeys are group local
\@erratum@cmd{defaultargsreplace}{#1}{actionid={replace}, actionargs={#3+#2}}%
\@errata@dolayoutonpage{r}{#2}{#3}{\@errata@FormatKeywords{footformats}{\@errata@argsstring}{\@errata@footformat}}%
\@errata@dorecord{listformats}{\@errata@listformat}{\@errata@argsstring}%
}%
%% Handle if the space after the macro call should be ignored
\@erratum@handleprevisspace%
}
%%
%% Macro for creating a Deletion
%%
\NewDocumentCommand{\@erratum@Delete}{ O{} m }{% keyvals, removed
\@erratum@cmdinit%
{% Group is necessary here to handle cref reference format for label type `@errata@erratum'.
%% \@erratum@cmd must be within the group, as pgfkeys are group local
\@erratum@cmd{defaultargsdelete}{#1}{actionid={delete}, actionargs={#2}}%
\@errata@dolayoutonpage{d}{#2}{}{\@errata@FormatKeywords{footformats}{\@errata@argsstring}{\@errata@footformat}}%
\@errata@dorecord{listformats}{\@errata@listformat}{\@errata@argsstring}%
}%
\@erratum@handleprevisspace%
}
%%
%% Macro for creating a Note entry
%%
\NewDocumentCommand{\@erratum@Note}{ O{} m }{% keyvals, message
\@erratum@cmdinit%
{% Group is necessary here to handle cref reference format for label type `@errata@erratum'.
%% \@erratum@cmd must be within the group, as pgfkeys are group local
\@erratum@cmd{defaultargsnote}{#1}{actionid={note}, actionargs={#2}}%
\@errata@dolayoutonpage{n}{}{#2}{\@errata@FormatKeywords{footformats}{\@errata@argsstring}{\@errata@footformat}}%
\@errata@dorecord{listformats}{\@errata@listformat}{\@errata@argsstring}%
}%
%% Handle if the space after the macro call should be ignored
\@erratum@handleprevisspace%
}
%% Define with mandatory description argument if the requirecmddescription option is true
\if@errataOpt@requirecmddescription
\NewDocumentCommand{\erratumAdd}{ O{} m m }{% keyvals, description, new
\@erratum@Add[#1,description={#2}]{#3}}%
\NewDocumentCommand{\erratumReplace}{ O{} m m m }{% keyvals, description, old, new
\@erratum@Replace[#1,description={#2}]{#3}{#4}}%
\NewDocumentCommand{\erratumDelete}{ O{} m m }{% keyvals, description, removed
\@erratum@Delete[#1,description={#2}]{#3}}%
\NewDocumentCommand{\erratumNote}{ O{} m m }{% keyvals, description, note
\@erratum@Note[#1,description={#2}]{#3}}%
%% And define without description if the requirecmddescription option is false
\else
\let\erratumDelete\@erratum@Delete
\let\erratumAdd\@erratum@Add
\let\erratumReplace\@erratum@Replace
\let\erratumNote\@erratum@Note
\fi
\endinput
%%
%% End of file `errata.sty'.