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
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
|
% \iffalse meta-comment
%
% File: undolabl.dtx
% Version: 2012/01/01 v1.0k
%
% Copyright (C) 2010 - 2012 by
% H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>
% Portions of code copyrighted by other people as marked.
%
% The main code of this package was invented by
% Ulrich Diez (eu_angelion AT web DOT de) and first published in the
% comp.text.tex newsgroup at Sun, 20 Apr 2008 16:39:26 +0200, with subject:
% Re: How to undefine/overwrite a label? (see e.g.
% http://groups.google.de/group/comp.text.tex/msg/af6cfe93917097da?dmode=source
% ). While Ulrich Diez neither wanted to create a package himself yet
% nor have one published under his name, he granted the
% publication of his code. Therefore: Thanks!
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3c of this license or (at your option) any later
% version. This version of this license is in
% http://www.latex-project.org/lppl/lppl-1-3c.txt
% and the latest version of this license is in
% http://www.latex-project.org/lppl.txt
% and version 1.3c 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 H.-Martin Muench.
%
% This work consists of the main source file undolabl.dtx,
% the README, and the derived files
% undolabl.sty, undolabl.pdf,
% undolabl.ins, undolabl.drv,
% undolabl-example.tex, undolabl-example.pdf.
%
% Distribution:
% CTAN:macros/latex/contrib/undolabl/undolabl.dtx
% CTAN:macros/latex/contrib/undolabl/undolabl.pdf
% CTAN:install/macros/latex/contrib/undolabl.tds.zip
%
% Cf. http://ctan.org/pkg/undolabl and
% http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/undolabl.html
%
% Unpacking:
% (a) If undolabl.ins is present:
% tex undolabl.ins
% (b) Without undolabl.ins:
% tex undolabl.dtx
% (c) If you insist on using LaTeX
% latex \let\install=y\input{undolabl.dtx}
% (quote the arguments according to the demands of your shell)
%
% Documentation:
% (a) If undolabl.drv is present:
% (pdf)latex undolabl.drv
% makeindex -s gind.ist undolabl.idx
% (pdf)latex undolabl.drv
% makeindex -s gind.ist undolabl.idx
% (pdf)latex undolabl.drv
% (b) Without undolabl.drv:
% (pdf)latex undolabl.dtx
% makeindex -s gind.ist undolabl.idx
% (pdf)latex undolabl.dtx
% makeindex -s gind.ist undolabl.idx
% (pdf)latex undolabl.dtx
%
% The class ltxdoc loads the configuration file ltxdoc.cfg
% if available. Here you can specify further options, e.g.
% use DIN A4 as paper format:
% \PassOptionsToClass{a4paper}{article}
%
% Installation:
% TDS:tex/latex/undolabl/undolabl.sty
% TDS:doc/latex/undolabl/undolabl.pdf
% TDS:doc/latex/undolabl/undolabl-example.tex
% TDS:doc/latex/undolabl/undolabl-example.pdf
% TDS:source/latex/undolabl/undolabl.dtx
%
%<*ignore>
\begingroup
\catcode123=1 %
\catcode125=2 %
\def\x{LaTeX2e}%
\expandafter\endgroup
\ifcase 0\ifx\install y1\fi\expandafter
\ifx\csname processbatchFile\endcsname\relax\else1\fi
\ifx\fmtname\x\else 1\fi\relax
\else\csname fi\endcsname
%</ignore>
%<*install>
\input docstrip.tex
\Msg{**************************************************************}
\Msg{* Installation *}
\Msg{* Package: undolabl 2012/01/01 v1.0k Overriding labels (HMM) *}
\Msg{**************************************************************}
\keepsilent
\askforoverwritefalse
\let\MetaPrefix\relax
\preamble
This is a generated file.
Project: undolabl
Version: 2012/01/01 v1.0k
Copyright (C) 2010 - 2012 by
H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>
Portions of code copyrighted by other people as marked.
The usual disclaimer applies:
If it doesn't work right that's your problem.
(Nevertheless, send an e-mail to the maintainer
when you find an error in this package.)
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3c of this license or (at your option) any later
version. This version of this license is in
http://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
http://www.latex-project.org/lppl.txt
and version 1.3c 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 H.-Martin Muench.
The main code of this package was invented by Ulrich Diez
(eu_angelion AT web DOT de) and first published in the comp.text.tex
newsgroup at Sun, 20 Apr 2008 16:39:26 +0200, with subject:
Re: How to undefine/overwrite a label? (see e.g.
http://groups.google.de/group/comp.text.tex/msg/af6cfe93917097da?dmode=source
). While Ulrich Diez neither wanted to create a package himself yet
nor have one published under his name, he granted the
publication of his code. Therefore: Thanks!
This work consists of the main source file undolabl.dtx,
the README, and the derived files
undolabl.sty, undolabl.pdf,
undolabl.ins, undolabl.drv,
undolabl-example.tex, undolabl-example.pdf.
\endpreamble
\let\MetaPrefix\DoubleperCent
\generate{%
\file{undolabl.ins}{\from{undolabl.dtx}{install}}%
\file{undolabl.drv}{\from{undolabl.dtx}{driver}}%
\usedir{tex/latex/undolabl}%
\file{undolabl.sty}{\from{undolabl.dtx}{package}}%
\usedir{doc/latex/undolabl}%
\file{undolabl-example.tex}{\from{undolabl.dtx}{example}}%
}
\catcode32=13\relax% active space
\let =\space%
\Msg{************************************************************************}
\Msg{*}
\Msg{* To finish the installation you have to move the following}
\Msg{* file into a directory searched by TeX:}
\Msg{*}
\Msg{* undolabl.sty}
\Msg{*}
\Msg{* To produce the documentation run the file `undolabl.drv'}
\Msg{* through (pdf)LaTeX, e.g.}
\Msg{* pdflatex undolabl.drv}
\Msg{* makeindex -s gind.ist undolabl.idx}
\Msg{* pdflatex undolabl.drv}
\Msg{* makeindex -s gind.ist undolabl.idx}
\Msg{* pdflatex undolabl.drv}
\Msg{*}
\Msg{* At least three runs are necessary e.g. to get the}
\Msg{* references right!}
\Msg{*}
\Msg{* Happy TeXing!}
\Msg{*}
\Msg{************************************************************************}
\endbatchfile
%</install>
%<*ignore>
\fi
%</ignore>
%
% \section{The documentation driver file}
%
% The next bit of code contains the documentation driver file for
% \TeX{}, i.\,e., the file that will produce the documentation you
% are currently reading. It will be extracted from this file by the
% \texttt{docstrip} programme. That is, run \LaTeX{} on \texttt{docstrip}
% and specify the \texttt{driver} option when \texttt{docstrip}
% asks for options.
%
% \begin{macrocode}
%<*driver>
\NeedsTeXFormat{LaTeX2e}[2011/06/27]
\ProvidesFile{undolabl.drv}%
[2012/01/01 v1.0k Overriding labels (HMM)]
\documentclass{ltxdoc}[2007/11/11]% v2.0u
\usepackage{holtxdoc}[2011/02/04]% v0.21
%% undolabl may work with earlier versions of LaTeX2e and those
%% class and package, but this was not tested.
%% Please consider updating your LaTeX, class, and package
%% to the most recent version (if they are not already the most
%% recent version).
\hypersetup{%
pdfsubject={LaTeX2e package for overriding labels (HMM)},%
pdfkeywords={LaTeX, undolabl, undolabel, undo label, label, override, H.-Martin Muench},%
pdfencoding=auto,%
pdflang={en},%
breaklinks=true,%
linktoc=all,%
pdfstartview=FitH,%
pdfpagelayout=OneColumn,%
bookmarksnumbered=true,%
bookmarksopen=true,%
bookmarksopenlevel=3,%
pdfmenubar=true,%
pdftoolbar=true,%
pdfwindowui=true,%
pdfnewwindow=true%
}
\CodelineIndex
\hyphenation{docu-ment}
\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
\begin{document}
\DocInput{undolabl.dtx}%
\end{document}
%</driver>
% \end{macrocode}
%
% \fi
%
% \CheckSum{79}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
% Digits \0\1\2\3\4\5\6\7\8\9
% Exclamation \! Double quote \" Hash (number) \#
% Dollar \$ Percent \% Ampersand \&
% Acute accent \' Left paren \( Right paren \)
% Asterisk \* Plus \+ Comma \,
% Minus \- Point \. Solidus \/
% Colon \: Semicolon \; Less than \<
% Equals \= Greater than \> Question mark \?
% Commercial at \@ Left bracket \[ Backslash \\
% Right bracket \] Circumflex \^ Underscore \_
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
% \GetFileInfo{undolabl.drv}
%
% \begingroup
% \def\x{\#,\$,\^,\_,\~,\ ,\&,\{,\},\%}%
% \makeatletter
% \@onelevel@sanitize\x
% \expandafter\endgroup
% \expandafter\DoNotIndex\expandafter{\x}
% \expandafter\DoNotIndex\expandafter{\string\ }
% \begingroup
% \makeatletter
% \lccode`9=32\relax
% \lowercase{%^^A
% \edef\x{\noexpand\DoNotIndex{\@backslashchar9}}%^^A
% }%^^A
% \expandafter\endgroup\x
%
% \DoNotIndex{\\}
% \DoNotIndex{\documentclass,\usepackage,\ProvidesPackage,\begin,\end}
% \DoNotIndex{\MessageBreak}
% \DoNotIndex{\NeedsTeXFormat,\DoNotIndex,\verb}
% \DoNotIndex{\def,\edef,\gdef,\global}
% \DoNotIndex{\ifx,\listfiles,\mathord,\mathrm}
% \DoNotIndex{\kvoptions,\SetupKeyvalOptions,\ProcessKeyvalOptions}
% \DoNotIndex{\bigskip,\space,\thinspace,\ldots}
% \DoNotIndex{\indent,\noindent,\newline,\linebreak,\pagebreak,\newpage}
% \DoNotIndex{\textbf,\textit,\textsf,\texttt,\textsc,\textquotedblleft,\textquotedblright}
% \DoNotIndex{\plainTeX,\TeX,\LaTeX,\pdfLaTeX}
% \DoNotIndex{\chapter,\section}
% \DoNotIndex{\Large}
%
% \title{The \xpackage{undolabl} package}
% \date{2012/01/01 v1.0k}
% \author{H.-Martin M\"{u}nch\\\xemail{Martin.Muench at Uni-Bonn.de}}
%
% \maketitle
%
% \begin{abstract}
% This \LaTeX{} package allows to override existing labels,
% especially automatically generated ones.
% \end{abstract}
%
% \noindent \textbf{WARNING}: Since version 1.0d [2010/07/15] the |\undonewlabel|
% command takes only one argument,\\
% \texttt{\textbackslash undonewlabel\{<\textit{label name}>\}},\\
% instead of two,\\
% \texttt{\textbackslash undonewlabel\{<\textit{label name}>\}\{\textbackslash on@line\}}.\\
% Packages or documents, which used older versions of the \xpackage{undolabl} package, must be
% updated by removing the second argument of |\undonewlabel|, i.\,e. the |{\on@line}|.\\
%
% \noindent Note: The main code of this package was invented by\\
% \textbf{ULRICH DIEZ} (\texttt{eu\_angelion@web.de})\\
% and first published in the \Newsgroup{comp.text.tex} newsgroup at\\
% \texttt{Sun,~20~Apr~2008~16:39:26~+0200}, with subject:\\
% \texttt{Re:~How~to~undefine/overwrite~a~label?} (see e.\,g.
% \url{http://groups.google.de/group/comp.text.tex/msg/af6cfe93917097da?dmode=source}
% ).\\
% While \textsc{Ulrich Diez} neither wanted to create a~package himself yet
% nor have one published under his name, he granted the publication of his code.
% Therefore: Thanks!
% I submitted this package to CTAN (after some updates of the documentation,
% mainly layout, typos and such things) and try to maintain it.
%
% \bigskip
%
% \noindent Disclaimer for web links: The author is not responsible for any contents
% referred to in this work unless he has full knowledge of illegal contents.
% If any damage occurs by the use of information presented there, only the
% author of the respective pages might be liable, not the one who has referred
% to these pages.
%
% \bigskip
%
% \noindent {\color{green} Save per page about $200\unit{ml}$ water,
% $2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\\
% Therefore please print only if this is really necessary.}
%
% \newpage
%
% \tableofcontents
%
% \newpage
%
% \section{Introduction\label{sec:Introduction}}
%
% \indent The package's name \texttt{undolabl} is an eight-letter
% abbreviation for the phrases ``undo'' and ``label''.\\
%
% This package allows to override existing labels,
% especially automatically generated ones.\\
%
% When an instance of the |\label|-macro occurs in the document\linebreak
% (e.\,g.~|\label{foo}|), then a delayed |\write| (a~write which is
% performed at shipout-time when the page-number is determined) to
% the \xfile{.aux} file is issued and you find in the \xfile{.aux} file
% something like:
% \begin{verbatim}
% \newlabel{foo}{{<page-no>}{<sectional no>}{<probably something else>}}
% \end{verbatim}
% During the beginning of the next \LaTeX{}-run, the \xfile{.aux} file will be
% read and
% \begin{verbatim}
% \newlabel{foo}{{<page-no>}{<sectional no>}{<probably something else>}}
% \end{verbatim}
% is expanded to
% \begin{verbatim}
% \@newl@bel r{foo}{{<page-no>}{<sectional no>}{<probably something else>}}
% \end{verbatim}
% which in turn gets expanded to something like (pseudo code):
% \begin{verbatim}
% IF (macro \r@foo is already defined)
% THEN
% - Issue an error-message,
% - Make sure that the multiply-defined-labels-warning occurs
% in the log-file
% ELSE
% \def\r@foo{{<page-no>}{<sectional no>}{<probably something else>}}
% ENDIF
% \end{verbatim}
%
% Referencing works as follows:\\
% |\ref{foo}| |->|
% \begin{description}
% \item[-] expand |\r@foo|: |{<page-no>}{<sectional no>}{<probably something else>}|
%
% \item[-] grab the second from the resulting arguments: |<sectional no>|
% \end{description}
% |\pageref{foo}| |->|
% \begin{description}
% \item[-] expand |\r@foo|: |{<page-no>}{<sectional no>}{<probably something else>}|
%
% \item[-] grab the first from the resulting arguments: |<page-no>|
% \end{description}
% Back to the |\label|-mechanism:
% \begin{description}
% \item[-] At the beginning of the \LaTeX{}-run, all the |\r@<label>|-macros
% get defined from reading the \xfile{.aux} file. The |\r@<label>|-macros
% get used by the referencing-macros (|\ref|, |\pageref|,\ldots{}) during
% the \LaTeX{}-run.
%
% \item[-] During the \LaTeX{}-run, the \xfile{.aux} file gets rewritten.
%
% \item[-] At the end of the \LaTeX{}-run, the \xfile{.aux} file (which was
% rewritten/newly created during the \LaTeX{}-run) is read in order
% to detect whether references have changed during the current
% \LaTeX{}-run.
% \end{description}
% But this time |\@newl@bel| is redefined (|\let| equal to |\@testdef|)
% and thus this time\\
% \begin{verbatim}
% \@newl@bel r{foo}{{<page-no>}{<sectional no>}{<probably something else>}}
% \end{verbatim}
% expands to something like (pseudo code):
% \begin{verbatim}
% Compare the (newly written) third argument (that is:
% {{<page-no>}{<sectional no>}{<probably something else>}} )
% to the (current/former) definition of \r@foo.
% If the two are different, then some page- or section-number
% related to referencing has changed from the last to the current
% LaTeX-run, thus in this case issue a message in the log-file:
% "References may have changed. Rerun LaTeX in order to get
% cross-references right".
% \end{verbatim}
% So what do you need to do in order to override a label:
% \begin{description}
% \item[-] First you need to write to the \xfile{.aux} file to silently undefine
% the associated |\r@<label>|-macro if it is already defined.
% That is why |\overridelabel| writes in terms of |\protected@write|
% to the \xfile{.aux} file:
% \begin{verbatim}
% \undonewlabel{<label>}
% \end{verbatim}
% |\undonewlabel| \textquotedblleft undefines\textquotedblright\ the
% |\r@<label>|-macro. (How this works will be explained below.)
%
% \item[-] Then |\overridelabel| can call |\label{<label>}| again
% and thus produce another |\newlabel{<label>}|-entry to the
% \xfile{.aux} file.
% \end{description}
% In the \xfile{.aux} file all this results in a sequence like:
% \begin{verbatim}
% % from the former \label-call:
% \newlabel{<label>}{...}
% |->| \r@<label>-macro gets produced.
% % from the \overrridelabel-call:
% % - call to \undonewlabel within \overrridelabel:
% \undonewlabel{<label>}
% |->| \r@<label>-macro gets destroyed.
% % - call to \label within \overrridelabel:
% \newlabel{<label>}{...}
% |->| a new \r@<label>-macro but no multiply-label-defined warning
% gets produced.
% \end{verbatim}
%
% There is another issue left:
% \begin{description}
% \item[-] It was said that \xfile{.aux} file is read at the beginning and at the
% end of the \LaTeX{}-run for detecting whether references have changed.
%
% \item[-] When overriding a |<label>|, there will be several
% |\newlabel{<label>}|-calls associated to the same label-name in
% the \xfile{.aux} file.
%
% \item[-] At the beginning of the \LaTeX{}-run only the last one counts for
% defining the associated |\r@<label>|-macro.
%
% \item[-] But at the end, when the new \xfile{.aux} file is read, they all count
% and thus with all these entries but the last one, the
% above-mentioned |\@testdef|-comparison will yield difference and thus
% in any case cause a warning-message about references having
% changed although that might not be a correct statement.
% \end{description}
%
% \textsc{Ulrich Diez} decided to catch this up by his |\undolabl@testdef| command.
% The |\undolabl@testdef|-comparison-mechanism gets enhanced via
% \textquotedblleft replacing\textquotedblright{}. This works as follows:
% When the \xfile{.aux} file is read at the beginning of the \LaTeX{}-run,
% |\@newl@bel| is \underline{not} let equal to |\@testdef|.
% When the \xfile{.aux} file is read at the end of the \LaTeX{}-run,
% |\@newl@bel| \underline{is} let equal to |\@testdef|.
% Thus it is sufficient to write into the beginning of the \xfile{.aux} file
% a direction which leads to \nolinebreak{|\let|ting} |\@newl@bel| equal to
% |\undolabl@testdef| in case its definition equals |\@testdef|. That direction
% is called \nolinebreak{\textquotedblleft |\reset@newl@bel|\textquotedblright{}.}
% Also, when the \xfile{.aux} file is read at the end of the \LaTeX{}-run,
% |\undonewlabel|-entries therein should do nothing, thus
% |\undonewlabel| is |\let| equal to |\@gobble|.
%
% \section{Usage}
%
% Load the package placing
% \begin{quote}
% |\usepackage{undolabl}|
% \end{quote}
% \noindent in the preamble of your \LaTeXe\ source file.\\
%
% When an existing label shall be replaced by a new one, say\\
% |\overridelabel{<label name>}|\\
% (where |<label name>| is the name of the label to be replaced
% by the new one), instead of just |\label{<label name>}|,
% which would produce a\\
% |LaTeX Warning: Label `<label name>' multiply defined.|
%
% \section{Example}
%
% \begin{macrocode}
%<*example>
\documentclass[british]{article}[2007/10/19]% v1.4h
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{undolabl}[2012/01/01]% v1.0k
%% There are no options for the undolabl package. %%
\usepackage[%
extension=pdf,%
plainpages=false,%
pdfpagelabels=true,%
hyperindex=false,%
pdflang={en},%
pdftitle={undolabl package example},%
pdfauthor={H.-Martin Muench, after Ulrich Diez},%
pdfsubject={Example for the undolabl package},%
pdfkeywords={LaTeX, undolabl, undolabel, H.-Martin Muench, Ulrich Diez},%
pdfview=FitH,%
pdfstartview=FitH,%
pdfpagelayout=OneColumn,%
bookmarksopen=true%
]{hyperref}[2011/12/04]% v6.82m; when you want to use nameref
\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
\listfiles
\begin{document}
\pagenumbering{arabic}
\section*{Example for undolabl}
This example demonstrates the use of package\newline
\textsf{undolabl}, v1.0k as of 2012/01/01 (HMM).\newline
For details please see the documentation!\newline
\noindent Save per page about $200\unit{ml}$~water,
$2\unit{g}$~CO$_{2}$ and $2\unit{g}$~wood:\newline
Therefore please print only if this is really necessary.\newline
I do NOT think, that it is necessary to print THIS file, really!
\bigskip
\section{Test}
text \label{testlabel}\\
page-reference: \pageref{testlabel}\\%% -> page 4
sectional-reference: \ref{testlabel}\\%% -> section 4
name-reference: \nameref{testlabel}%% -> Still another test
\newpage
\section{Another test}
text \overridelabel{testlabel}\\
page-reference: \pageref{testlabel}\\%% -> page 4
sectional-reference: \ref{testlabel}\\%% -> section 4
name-reference: \nameref{testlabel}%% -> Still another test
\newpage
\section{Yet another test}
text \overridelabel{testlabel}\\
page-reference: \pageref{testlabel}\\%% -> page 4
sectional-reference: \ref{testlabel}\\%% -> section 4
name-reference: \nameref{testlabel}%% -> Still another test
\newpage
\section{Still another test}
text \overridelabel{testlabel}\\
page-reference: \pageref{testlabel}\\%% -> page 4
sectional-reference: \ref{testlabel}\\%% -> section 4
name-reference: \nameref{testlabel}%% -> Still another test
\end{document}
%</example>
% \end{macrocode}
%
% \StopEventually{}
%
% \pagebreak
%
% \section{The implementation}
%
% For a somewhat longer description see section~\ref{sec:Introduction}.\\
% We start off by checking that we are loading into \LaTeXe{} and
% announcing the name and version of this package.\\
%
% \begin{macrocode}
%<*package>
% \end{macrocode}
%
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}[2011/06/27]
\ProvidesPackage{undolabl}[2012/01/01 v1.0k
Overriding labels (HMM)]
%% undolabl may work with earlier versions of LaTeX2e,
%% but this was not tested. Please consider updating
%% your LaTeX2e to the most recent version
%% (if it is not already the most recent version).
% \end{macrocode}
%
% \DescribeMacro{\overridelabel}
% In order to override a label, first you need to write to the
% \xfile{.aux} file to silently undefine the associated |\r@<label>|-macro
% if it is already defined. That is why |\overridelabel| writes in
% terms of |\protected@write| to the \xfile{.aux} file:
% |\undonewlabel{<label>}|,
% \textquotedblleft undefining\textquotedblright{} the |\r@<label>|-macro.
% And a message about this is given.
%
% \begin{macrocode}
\newcommand\overridelabel[1]{%
\@bsphack
\protected@write\@auxout{}{\string\undonewlabel{#1}}%
\@overriddenmessage s{#1}%
% \end{macrocode}
%
% Then |\overridelabel| can call |\label{<label>}| again
% and thus produce another |\newlabel{<label>}|-entry to the
% \xfile{.aux} file.
%
% \begin{macrocode}
\label{#1}%
\@esphack%
}
% \end{macrocode}
%
% \DescribeMacro{\undonewlabel}
%
% \begin{macrocode}
\newcommand\undonewlabel{\@und@newl@bel r}
% \end{macrocode}
%
% \DescribeMacro{\@und@newl@bel}
%
% If |\r@<label>| is undefined, give an error message:
%
% \begin{macrocode}
\newcommand\@und@newl@bel[2]{%
\@ifundefined{#1@#2}{%
\PackageError{undolabl}{Label `#2' shall be overridden ^^J%
although it does not yet exist}{%
A label which does not exist cannot be overridden.}%
}{%
% \end{macrocode}
%
% \noindent otherwise:\\
% Undefine |\r@label| via letting it equal to |\relax|:
%
% \begin{macrocode}
\expandafter\global
\expandafter\let
\csname #1@#2\endcsname\relax
}%
}
% \end{macrocode}
%
% \pagebreak
%
% \DescribeMacro{\@overriddenmessage}
% Command for the notification of overriding a label:
%
% \begin{macrocode}
\newcommand\@overriddenmessage[2]{%
\@ifundefined{#1@#2}{\global\@namedef{#1@#2}{i}}{%
\expandafter\g@addto@macro\csname #1@#2\endcsname{i}%
}%
\PackageWarning{undolabl}{Label `#2' overridden}%
}
% \end{macrocode}
%
% \DescribeMacro{\undolabl@testdef}
%
% \begin{macrocode}
\newcommand\undolabl@testdef[3]{%
\@ifundefined{s@#2}\@secondoftwo\@firstofone{%
\expandafter\ifx\csname s@#2\endcsname\empty
\expandafter\@firstofone
\else
\expandafter\xdef\csname s@#2\endcsname{%
\expandafter\expandafter
\expandafter\@gobble
\csname s@#2\endcsname
}%
\expandafter\@gobble
\fi
}{\@testdef{#1}{#2}{#3}%
}%
}
% \end{macrocode}
%
% \DescribeMacro{\protected@write\\@auxout}
%
% \begin{macrocode}
\protected@write\@auxout{}{\string\reset@newl@bel}
% \end{macrocode}
%
% \DescribeMacro{\reset@newl@bel}
%
% \begin{macrocode}
\newcommand\reset@newl@bel{%
\ifx\@newl@bel\@testdef
\let\@newl@bel\undolabl@testdef
\let\undonewlabel\@gobble
\fi
}
% \end{macrocode}
%
% \begin{macrocode}
%</package>
% \end{macrocode}
%
% \pagebreak
%
% \section{Installation}
%
% \subsection{Downloads\label{ss:Downloads}}
%
% Everything is available on \CTAN{}, \url{http://www.ctan.org/tex-archive/},
% but may need additional packages themselves.\\
%
% \DescribeMacro{undolabl.dtx}
% For unpacking the |undolabl.dtx| file and constructing the documentation
% it is required:
% \begin{description}
% \item[-] \TeX{} Format \LaTeXe{}, \url{http://www.CTAN.org/}
%
% \item[-] document class \xpackage{ltxdoc}, 2007/11/11, v2.0u,
% \url{http://ctan.org/pkg/ltxdoc}
%
% \item[-] package \xpackage{holtxdoc}, 2011/02/04, v0.21,
% \url{http://ctan.org/pkg/holtxdoc}
%
% \item[-] package \xpackage{hypdoc}, 2010/03/26, v1.9,
% \url{http://ctan.org/pkg/hypdoc}
% \end{description}
%
% \DescribeMacro{undolabl.sty}
% The |undolabl.sty| for \LaTeXe{} (i.\,e.~each document using
% the \xpackage{undolabl} package) requires:
% \begin{description}
% \item[-] \TeX{} Format \LaTeXe{}, \url{http://www.CTAN.org/}
% \end{description}
%
% \DescribeMacro{undolabl-example.tex}
% The |undolabl-example.tex| requires the same files as all
% documents using the \xpackage{undolabl} package and additionally:
% \begin{description}
% \item[-] class \xpackage{article}, 2007/10/19, v1.4h, from \xpackage{classes.dtx}:\\
% \CTAN{macros/latex/base/classes.dtx}
%
% \item[-] package \xpackage{hyperref}, 2011/12/04,~v6.82m:
% \url{http://ctan.org/pkg/hyperref},\\
% if |\nameref| shall be used\\
% (and when the references shall be hyperlinked, of course)
%
% \item[-] package \xpackage{undolabl}, 2012/01/01, v1.0k,
% \url{http://ctan.org/pkg/undolabl}\\
% (Well, it is the example file for this package, and because you are reading
% the documentation for the \xpackage{undolabl} package, it can be assumed
% that you already have some version of it -- is it the current one?)
% \end{description}
%
% \DescribeMacro{Oberdiek}
% \DescribeMacro{holtxdoc}
% \DescribeMacro{hypdoc}
% All packages of \textsc{Heiko Oberdiek}'s bundle `oberdiek'
% (especially \xpackage{holtxdoc} and \xpackage{hypdoc})
% are also available in a TDS compliant ZIP archive:\\
% \CTAN{install/macros/latex/contrib/oberdiek.tds.zip}.\\
% It is probably best to download and use this, because the packages in there
% are quite probably both recent and compatible among themselves.\\
%
% \DescribeMacro{hyperref}
% \noindent \xpackage{hyperref} is not included in that bundle and needs to be
% downloaded separately,\\
% \url{http://mirror.ctan.org/install/macros/latex/contrib/hyperref.tds.zip}.\\
%
% \DescribeMacro{M\"{u}nch}
% A hyperlinked list of my (other) packages can be found at
% \url{http://www.Uni-Bonn.de/~uzs5pv/LaTeX.html}.\\
%
% \pagebreak
% \subsection{Package, unpacking TDS}
% \paragraph{Package.} This package is available on \CTAN{}
% \begin{description}
% \item[\CTAN{macros/latex/contrib/undolabl/undolabl.dtx}]\hspace*{0.1cm} \\
% The source file.
% \item[\CTAN{macros/latex/contrib/undolabl/undolabl.pdf}]\hspace*{0.1cm} \\
% The documentation.
% \item[\CTAN{macros/latex/contrib/undolabl/undolabl-example.pdf}]\hspace*{0.1cm} \\
% The compiled example file, as it should look like.
% \item[\CTAN{macros/latex/contrib/undolabl/README}]\hspace*{0.1cm} \\
% The README file.
% \end{description}
% There is also an undolabl.tds.zip available:
% \begin{description}
% \item[\CTAN{install/macros/latex/contrib/undolabl.tds.zip}]\hspace*{0.1cm} \\
% Everything in \xfile{TDS} compliant, compiled format.
% \end{description}
% which additionally contains\\
% \begin{tabular}{ll}
% undolabl.ins & The installation file.\\
% undolabl.drv & The driver to generate the documentation.\\
% undolabl.sty & The \xext{sty}le file.\\
% undolabl-example.tex & The example file.
% \end{tabular}
%
% \bigskip
%
% \noindent For required other packages, please see the preceding subsection.
%
% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
% \docstrip{} archive. The files are extracted by running the
% \xext{.dtx} through \plainTeX{}:
% \begin{quote}
% \verb|tex undolabl.dtx|
% \end{quote}
%
% About generating the documentation see paragraph~\ref{GenDoc} below.\\
%
% \paragraph{TDS.} Now the different files must be moved into
% the different directories in your installation TDS tree
% (also known as \xfile{texmf} tree):
% \begin{quote}
% \def\t{^^A
% \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\ttfamily}l@{}}
% undolabl.sty & tex/latex/undolabl/undolabl.sty\\
% undolabl.pdf & doc/latex/undolabl/undolabl.pdf\\
% undolabl-example.tex & doc/latex/undolabl/undolabl-example.tex\\
% undolabl-example.pdf & doc/latex/undolabl/undolabl-example.pdf\\
% undolabl.dtx & source/latex/undolabl/undolabl.dtx\\
% \end{tabular}^^A
% }^^A
% \sbox0{\t}^^A
% \ifdim\wd0>\linewidth
% \begingroup
% \advance\linewidth by\leftmargin
% \advance\linewidth by\rightmargin
% \edef\x{\endgroup
% \def\noexpand\lw{\the\linewidth}^^A
% }\x
% \def\lwbox{^^A
% \leavevmode
% \hbox to \linewidth{^^A
% \kern-\leftmargin\relax
% \hss
% \usebox0
% \hss
% \kern-\rightmargin\relax
% }^^A
% }^^A
% \ifdim\wd0>\lw
% \sbox0{\small\t}^^A
% \ifdim\wd0>\linewidth
% \ifdim\wd0>\lw
% \sbox0{\footnotesize\t}^^A
% \ifdim\wd0>\linewidth
% \ifdim\wd0>\lw
% \sbox0{\scriptsize\t}^^A
% \ifdim\wd0>\linewidth
% \ifdim\wd0>\lw
% \sbox0{\tiny\t}^^A
% \ifdim\wd0>\linewidth
% \lwbox
% \else
% \usebox0
% \fi
% \else
% \lwbox
% \fi
% \else
% \usebox0
% \fi
% \else
% \lwbox
% \fi
% \else
% \usebox0
% \fi
% \else
% \lwbox
% \fi
% \else
% \usebox0
% \fi
% \else
% \lwbox
% \fi
% \else
% \usebox0
% \fi
% \end{quote}
% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip{}'s
% \xfile{TDS} installing feature, then some files can already be in the right
% place, see the documentation of \docstrip{}.
%
% \subsection{Refresh file name databases}
%
% If your \TeX{}~distribution (\teTeX{}, \mikTeX{},\dots{}) relies on file name
% databases, you must refresh these. For example, \teTeX{} users run
% \verb|texhash| or \verb|mktexlsr|.
%
% \subsection{Some details for the interested}
%
% \paragraph{Unpacking with \LaTeX{}.}
% The \xfile{.dtx} chooses its action depending on the format:
% \begin{description}
% \item[\plainTeX:] Run \docstrip{} and extract the files.
% \item[\LaTeX:] Generate the documentation.
% \end{description}
% If you insist on using \LaTeX{} for \docstrip{} (really,
% \docstrip{} does not need \LaTeX{}), then inform the autodetect routine
% about your intention:
% \begin{quote}
% \verb|latex \let\install=y\input{undolabl.dtx}|
% \end{quote}
% Do not forget to quote the argument according to the demands
% of your shell.
%
% \paragraph{Generating the documentation.\label{GenDoc}}
% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
% the documentation. The process can be configured by a
% configuration file \xfile{ltxdoc.cfg}. For instance, put the following
% line into this file, if you want to have A4 as paper format:
% \begin{quote}
% \verb|\PassOptionsToClass{a4paper}{article}|
% \end{quote}
%
% \noindent An example follows how to generate the
% documentation with \pdfLaTeX{}:
%
% \begin{quote}
%\begin{verbatim}
%pdflatex undolabl.dtx
%makeindex -s gind.ist undolabl.idx
%pdflatex undolabl.dtx
%makeindex -s gind.ist undolabl.idx
%pdflatex undolabl.dtx
%\end{verbatim}
% \end{quote}
%
% \section{Acknowledgements}
%
% The main code of this package was invented by \textbf{Ulrich Diez}
% (\texttt{eu\_angelion@web.de}) and first published in the \Newsgroup{comp.text.tex}
% newsgroup at\\
% \texttt{Sun,~20~Apr~2008~16:39:26~+0200}, with subject:\\
% \texttt{Re:~How~to~undefine/overwrite~a~label?} (see e.\,g.
% \url{http://groups.google.de/group/comp.text.tex/msg/5ba8d4722e5cd326?dmode=source}
% as well as \linebreak
% \url{http://groups.google.de/group/comp.text.tex/msg/af6cfe93917097da?dmode=source}).\\
% I (\textsc{H.-Martin M\"{u}nch}) would like to thank \textsc{Ulrich Diez}
% for this as well as for his permission to publish it on \CTAN{} as well as
% for his bug reports.
% I also thank those anonymous people who had published the package somewhere else
% on the internet, where I found it first.
% Further I would like to thank \textsc{Rainer Wintermute} for explaining the
% |\CheckSum|, \textsc{Heiko Oberdiek} for providing a~lot~(!) of useful packages
% (from which I also got everything I know about creating a file in \xfile{dtx} format,
% OK, say it: copying), \textsc{Robin Fairbairns} and everybody of the \CTAN{} team
% for managing \CTAN{}, and the \Newsgroup{comp.text.tex} and \Newsgroup{de.comp.text.tex}
% newsgroups for their help in all things \TeX{}.
%
% \pagebreak
%
% \phantomsection
% \begin{History}\label{History}
% \begin{Version}{2008/04/20 v0.3(a)}
% \item created by \textsc{Ulrich Diez}
% \end{Version}
% \begin{Version}{2010/04/08 v0.3b}
% \item \xfile{.dtx} updated by \textsc{H.-Martin M\"{u}nch},
% submitted to \CTAN{}\\
% (no changes in the style code).
% \end{Version}
% \begin{Version}{2010/06/01 v1.0(a)}
% \item \xfile{.dtx} updated by \textsc{H.-Martin M\"{u}nch}: some minor
% corrections in the documentation, an internal renaming for possible
% better compatibility with other packages.
% \item The main code of this package was invented in 2008 by \textsc{Ulrich Diez}
% (\texttt{eu\_angelion@web.de}) and published on the internet.
% Because \textsc{Ulrich Diez} neither wanted to create a package himself yet
% nor have one published under his name,
% but granted the publication of his code (Thanks!),
% I had to change author/maintainer of this package and resubmit it.
% \end{Version}
% \begin{Version}{2010/06/03 v1.0b}
% \item Found an unchanged reference to the package author/maintainer.
% \item Example adapted to other examples of mine.
% \item Updated references to other packages.
% \item \xfile{TDS} locations updated.
% \item Several changes in the documentation and the \texttt{README} file.
% \end{Version}
% \begin{Version}{2010/06/24 v1.0c}
% \item \xpackage{holtxdoc} warning in \xfile{drv} updated.
% \item Corrected the location of the package at CTAN. (\xfile{TDS} of
% this version was still missing due to a~packaging error.)
% \item Updated references to other packages: \xpackage{hyperref} and
% \xpackage{pagesLTS} (which has been renamed to \xpackage{pageslts}
% and is no longer referenced since v1.0h).
% \item Added a list of my other packages.
% \end{Version}
% \begin{Version}{2010/07/15 v1.0d}
% \item There was another update by \textsc{Ulrich Diez} on
% \Newsgroup{comp.text.tex} at
% \texttt{Mon,~21~Apr~2008~23:04:03~+0200}, see e.\,g.\\
% \url{http://groups.google.de/group/comp.text.tex/msg/af6cfe93917097da?dmode=source},
% which now has been included in this package.
% \item Put more emphasis on \textbf{Ulrich Diez} writing the initial code.
% \item Updated references to other packages: \xpackage{hyperref} and
% \xpackage{pagesLTS} (which has been renamed to \xpackage{pageslts}
% and is no longer referenced since v1.0h).
% \item Corrected the given location of the \textsf{undolabl.tds.zip} file
% at \CTAN{}.
% \end{Version}
% \begin{Version}{2010/07/25 v1.0e}
% \item Bugs reported by \textsc{Ulrich Diez} on \Newsgroup{comp.text.tex} at\\
% \texttt{Sat,~17~Jul~2010~12:27:10~+0200},
% subject \texttt{Re:~CTAN~Update:~undolabl}, see e.\,g.
% \url{http://groups.google.com/group/comp.text.tex/msg/d366821ce4f8b62e?dmode=source},
% eradicated.
% \item |\StopEventually| added and |\CheckSum| value corrected (was~$0$).
% \item Minor details.
% \end{Version}
% \begin{Version}{2010/07/29 v1.0f}
% \item Corrected diverse urls, updated references to other packages.
% \end{Version}
% \begin{Version}{2010/09/12 v1.0g}
% \item There was a wrong \texttt{\%} behind \texttt{2010/07/29 v1.0f},
% resulting in the version being displayed as
% \textquotedblleft \texttt{v1.0fOverriding}\textquotedblright.
% \item Changed the |\unit| definition (got rid of an old |\rm|).
% \item A lot of small changes.
% \end{Version}
% \begin{Version}{2011/02/01 v1.0h}
% \item Updated to new version of the \xpackage{hyperref} package.
% \item Removed |/muench/| from the path at diverse locations.
% \item Replaced the list of my packages with a link to a web page list of
% those, which has the advantage of showing the recent versions of
% all those packages.
% \item Some small changes.
% \end{Version}
% \begin{Version}{2011/06/26 v1.0i}
% \item The \xpackage{holtxdoc} package was fixed (recent: 2011/02/04, v0.21),
% therefore the warning in \xfile{drv} could be removed.~--
% Adapted the style of this documentation to new \textsc{Oberdiek}
% \xfile{dtx} style.
% \item There is a new version of the used \xpackage{hyperref} package.
% \item Quite some changes in the \xfile{.dtx}/documentation.
% \end{Version}
% \begin{Version}{2011/08/08 v1.0j}
% \item The \xpackage{pagesLTS} package has been renamed to
% \xpackage{pageslts}: 2011/08/08,~v1.2a.
% \item Some minor changes.
% \end{Version}
% \begin{Version}{2012/01/01 v1.0k}
% \item Bugfix: Obsolete installation path given in the documentation, updated.
% \item Bugfix: A section was broken in the documentation (text had been lost
% but was recovered now).
% \item Update of documentation, README, and \xfile{dtx} internals.
% \end{Version}
% \end{History}
%
% \bigskip
%
% When you find a mistake or have a suggestion for an improvement of this package,
% please send an e-mail to the maintainer, thanks! (Please see BUG REPORTS in the README.)
%
% \bigskip
%
% \PrintIndex
%
% \Finale
\endinput
|