summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/pagecolor/pagecolor.dtx
blob: 3c57dacf55072c7633ab3cbe07eafee756507a0b (plain)
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
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
% \iffalse meta-comment
%
% File: pagecolor.dtx
% Version: 2022-11-27 v1.2a
% Info: Provides thepagecolor
%
% Copyright (C) 2011 - 2022 by
%    H.-Martin Muench <Martin dot Muench at Uni-Bonn dot de>
%
% 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
%    https://www.latex-project.org/lppl/lppl-1-3c.txt
% and the latest version of this license is in
%    https://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 pagecolor.dtx,
% the README, and the derived files
%    pagecolor.sty, pagecolor.pdf,
%    pagecolor.ins, pagecolor.drv,
%    pagecolor-example.tex, pagecolor-example.pdf.
%
% "pagecolor" is available on CTAN:
% https://www.ctan.org/pkg/pagecolor
%
% Also a TDS.ZIP file is provided that contains all the files
% already sorted in a TDS tree:
% https://mirror.ctan.org/install/macros/latex/contrib/pagecolor.tds.zip
%
%<*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: pagecolor 2022-11-27 v1.2a Provides thepagecolor (HMM)*}
\Msg{******************************************************************}

\keepsilent
\askforoverwritefalse

\let\MetaPrefix\relax
\preamble

This is a generated file.

Project: pagecolor
Version: 2022-11-27 v1.2a

Copyright (C) 2011 - 2022 by
    H.-Martin Muench <Martin dot Muench at Uni-Bonn dot de>

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
   https://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
   https://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 pagecolor.dtx,
the README, and the derived files
   pagecolor.sty, pagecolor.pdf,
   pagecolor.ins, pagecolor.drv,
   pagecolor-example.tex, pagecolor-example.pdf.

In memoriam
 Claudia Simone Barth + 1996-01-30
 Tommy Muench         + 2014-01-02
 Hans-Klaus Muench    + 2014-08-24

\endpreamble
\let\MetaPrefix\DoubleperCent

\generate{%
  \file{pagecolor.ins}{\from{pagecolor.dtx}{install}}%
  \file{pagecolor.drv}{\from{pagecolor.dtx}{driver}}%
  \usedir{tex/latex/pagecolor}%
  \file{pagecolor.sty}{\from{pagecolor.dtx}{package}}%
  \usedir{doc/latex/pagecolor}%
  \file{pagecolor-example.tex}{\from{pagecolor.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{*  pagecolor.sty}
\Msg{*}
\Msg{* To produce the documentation run the file `pagecolor.drv'}
\Msg{* through (pdf)LaTeX, e.g.}
\Msg{*  pdflatex pagecolor.drv}
\Msg{*  makeindex -s gind.ist pagecolor.idx}
\Msg{*  pdflatex pagecolor.drv}
\Msg{*  makeindex -s gind.ist pagecolor.idx}
\Msg{*  pdflatex pagecolor.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}[2021-11-15]
\ProvidesFile{pagecolor.drv}%
  [2022-11-27 v1.2a Provides thepagecolor (HMM)]
\documentclass{ltxdoc}[2020/12/05]% v2.1b
\usepackage{xcolor}[2021/10/31]% v2.13
\usepackage{holtxdoc}[2019/12/09]% v0.30
\hypersetup{%
 pdfsubject={Providing the thepagecolor command (HMM)},%
 pdfkeywords={LaTeX, pagecolor, thepagecolor},%
 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}
\begin{document}
  \DocInput{pagecolor.dtx}%
\end{document}
%</driver>
%    \end{macrocode}
% \fi
%
% \GetFileInfo{pagecolor.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{\,,\@bsphack,\@esphack,\\}
% \DoNotIndex{\documentclass,\usepackage,\begin,\end,\pagenumbering,\bigskip,\smallskip}
% \DoNotIndex{\space,\newline,\noindent,\linebreak,\pagebreak,\section,\textbf,\textsf,\textit}
% \DoNotIndex{\GenerateLogMacros,\holtxdoc,\Oberdiek,\hyperref,\kvoptions,\options,\OCG}
% \DoNotIndex{\color,\gdef,\lipsum,\ifdefined,\IfPackageAtLeastTF,\IfPackageLoadedTF,\ifx}
% \DoNotIndex{\M\"{u}nch,\Alternatives,\transparent,\newcommand,\verb,\listfiles}
% \DoNotIndex{\pagecolor@info,\pagecolor@info@noline,\pagecolor@warning,\pagecolor@warning@noline}
%
% \title{The \xpackage{pagecolor} package}
% \date{2022-11-27 v1.2a}
% \author{H.-Martin Münch\\\xemail{Martin.Muench at Uni-Bonn.de}}
%
% \maketitle
%
% \begin{abstract}
% \noindent This \LaTeX{} package provides the command |\thepagecolor|,
% which gives the current page (background) color,
% \hbox{i.\,e. the} argument used with the most recent call of |\pagecolor{...}|.
% The command |\thepagecolornone| gives the same color as |\thepagecolor|,
% except when the page background color is
% \textquotedblleft|none|\textquotedblright. In that case |\thepagecolor| is
% |white| and |\thepagecolornone| is |none|.\\
% When |\nopagecolor| is unknown or in case of the \xpackage{crop} package
% broken, this package provides a replacement.\\
% Similar to |\newgeometry| and |\restoregeometry| of the \xpackage{geometry}
% package |\newpagecolor{<|\textit{some color}|>}| and |\restorepagecolor|
% are provided.\\
% For use with the \xpackage{crop} package |\backgroundpagecolor{<|\textit{some color}|>}|
% as well as |\newbackgroundpagecolor{<|\textit{some color}|>}| and \newline
% |\restorebackgroundpagecolor| are provided.
% \end{abstract}
%
% \bigskip
%
% \noindent Disclaimer for web links: The author is not responsible for any contents
% referred to in this work unless having 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.
%
% \tableofcontents
%
% \bigskip
%
% \section{Introduction}
% \indent This \LaTeX{} package provides the command |\thepagecolor|,
% which gives the current page (background) color,
% \hbox{i.\,e. the} argument used with the most recent call of |\pagecolor{...}|.
% (\verb|\pagecolor| needs to be defined before by the \xpackage{xcolor} or
% \xpackage{color} package.) The \xpackage{pagecolor} package should be loaded
% before any package sets a page (background) color, but obviously after
% the \xpackage{xcolor} or \xpackage{color} package.
% Its option |pagecolor={...}| is used to set the initial |\pagecolor{...}|.
% \newline
% The command |\thepagecolornone| gives the same color as |\thepagecolor|,
% except when the page background color is
% \textquotedblleft|none|\textquotedblright (e.\,g. result of using the
% |\nopagecolor| command). In that case |\thepagecolor| is |white| and
% |\thepagecolornone| is |none|.
% When |\nopagecolor| is unknown or in case of the \xpackage{crop} package
% broken, this package provides a replacement depending on option |nopagecolor|.
% Commands to change the background/outer/physical page color when using
% \xpackage{crop} are provided. Similar to |\newgeometry| and |\restoregeometry|
% of the \xpackage{geometry} package |\newpagecolor{<|\textit{some color}|>}|
% and |\restorepagecolor| are provided.\\
% For use with the \xpackage{crop} package |\backgroundpagecolor{<|\textit{some color}|>}|
% as well as |\newbackgroundpagecolor{<|\textit{some color}|>}| and
% |\restorebackgroundpagecolor| are provided.
%
% \section{Usage}
%
% \indent Just load the package placing
% \begin{quote}
%   |\usepackage[<|\textit{options}|>]{pagecolor}|
% \end{quote}
% \noindent in the preamble of your \LaTeXe{} source file.
% This should be done before another package uses |\pagecolor|.
% Afterwards |\pagecolor{...}| can be used to change the page (background)
% color as usual. Then |\thepagecolor| gives the current page (background)
% color (in the same format as given with |\pagecolor{...}|).\\
% Similar to |\newgeometry| and |\restoregeometry| of the \xpackage{geometry}
% package\\
% |\newpagecolor{<|\textit{some color}|>}| and |\restorepagecolor|
% are provided:\\
% |\newpagecolor{<|\textit{some color}|>}| will execute
% |\pagecolor{<|\textit{some color}|>}| and remember the page color used before.
% |\restorecolor| (without argument) restores the page color to the one used before
%  use of the |\newpagecolor{...}| command. When you want to change the color for
%  just one page and do not want to (or cannot) manually determine where that page ends,\\
% |\newpagecolor{<|\textit{some color}|>}\afterpage{\restorepagecolor}|\\
% does the trick (and requires a |\usepackage{afterpage}| in the document's
% preamble), or for short
%
% \newpage
%
% \noindent|\newcommand{\onepagecolor}[1]{%|\\
% |  \newpagecolor{#1}\afterpage{\restorepagecolor}}|\\
% in the preamble and |\onepagecolor{<|\textit{some color}|>}| in the document.\\
% When the \xpackage{crop} package is used, |\backgroundpagecolor{<|\textit{some color}|>}|
% can be used to change the background/outer/physical page color and\\
% |\newbackgroundpagecolor{<|\textit{some color}|>}%|\\
% |\afterpage{\restorebackgroundpagecolor}%|\\
% for changing just one background/outer/physical page color.
%
% \subsection{Options}
% \DescribeMacro{options}
% \indent The \xpackage{pagecolor} package takes the following options:
%
% \subsubsection{pagecolor}
% \DescribeMacro{pagecolor}
% \indent The option |pagecolor={...}| takes as value a color. This
% could be as simple as |black| or |white|, but when \hbox{e.\,g. the}
% \xpackage{xcolor} package is used (loaded before \xpackage{pagecolor}!),
% also colors like |red!50!green!20!blue| are possible.
% The default is |pagecolor={none}|. A |\pagecolor{...}| command with
% the given color is used to initialise the pagecolor.
% 
%
% \subsubsection{nopagecolor}
% \DescribeMacro{nopagecolor}
% \indent The option |nopagecolor={...}| takes as value a color. This
% could be as simple as |white| or |black|, but when \hbox{e.\,g. the}
% \xpackage{xcolor} package is used (loaded before \xpackage{pagecolor}!),
% also colors like |red!50!green!20!blue| are possible.
% The default is |nopagecolor={none}|. When |\nopagecolor| is unknown
% or broken \hbox{(e.\,g.} \xpackage{crop} package)
% |\nopagecolor| is replaced by a |\pagecolor| command
% using the color defined with the |nopagecolor| option.
% If |\nopagecolor| is not available and |nopagecolor| is |none|,
% it is used |white| instead of |none|.
%
% \section{Alternatives\label{s:Alternatives}}
%
% As I neither know what exactly you want to accomplish
% when using this package (e.\,g.~hiding text), nor what resources you have
% (e.\,g.~\pdfTeX{} version), here is a list of possible alternatives:\\
%
% \begin{description}
%  \item[-] \xpackage{transparent} package: With it some object can be made
%  (fully or partially) transparent,
%  \url{https://www.ctan.org/pkg/transparent}.
%
%  \item[-] OCG (Optional Content Groups): It allows for example
%  to \textquotedblleft hide\textquotedblright{} something when
%  printing the document while keeping the layout,
%  \url{https://www.ctan.org/search?phrase=ocg}.
% \end{description}
%
% \bigskip
%
% \noindent You programmed or found another alternative,
% which is available at \url{https://www.CTAN.org/}?
% OK, send an e-mail to me with the name, location at CTAN,
% and a short notice, and I will probably include it in the list above.
%
% \newpage
%
% \section{Example}
%
%    \begin{macrocode}
%<*example>
\NeedsTeXFormat{LaTeX2e}[2021-11-15]
\documentclass[british]{article}[2021/10/04]% v1.4n 
\usepackage[%
 extension=pdf,%
 plainpages=false,%
 pdfpagelabels=true,%
 hyperindex=false,%
 pdflang={en},%
 pdftitle={pagecolor package example},%
 pdfauthor={H.-Martin Muench},%
 pdfsubject={Example for the pagecolor package},%
 pdfkeywords={LaTeX, pagecolor, thepagecolor, page color, page colour},%
 pdfview=Fit,pdfstartview=Fit,%
 pdfpagelayout=SinglePage%
]{hyperref}[2022-02-21]% v7.00n

\usepackage[x11names]{xcolor}[2021/10/31]% v2.13
 % The xcolor package would not be needed for just using the base colors.
 % The color package would be sufficient for that.

 % \usepackage[cam,center,a3]{crop}[2017/11/19]% 1.10 

\usepackage[pagecolor={LightGoldenrod1},%
  nopagecolor={none}]{pagecolor}[2022-11-27]% v1.2a

\usepackage{afterpage}[2014/10/28]% v1.08
 % The afterpage package is generally not needed,
 % but the |\newpagecolor{somecolor}\afterpage{\restorepagecolor}|
 % construct shall be demonstrated.

\usepackage{lipsum}[2021-09-20]% v2.7
 % The lipsum package is generally not needed,
 % but some blind text is needed for the example.

\listfiles
\begin{document}
\pagenumbering{arabic}
\section*{Example for pagecolor}

This example demonstrates the use of package\newline
\textsf{pagecolor}, v1.2a as of 2022-11-27 (HMM).\newline
The used options were\newline
\verb|pagecolor={LightGoldenrod1}|\newline
(\verb|pagecolor={none}| would be the default), and\newline
\verb|nopagecolor={none}| (which is the default).

\noindent For more details please see the documentation!

\noindent The current page (background) color is\newline
\verb|\thepagecolor|\ =\ \thepagecolor \newline
(and \verb|\thepagecolornone|\ =\ \thepagecolornone ,
which would only be different from \verb|\thepagecolor|,
when the page color would be \verb|none|).

\pagebreak
\pagecolor{rgb:-green!40!yellow,3;green!40!yellow,2;red,1}

{\color{white} The current page (background) color is\newline
\verb|\thepagecolor|\ =\ \thepagecolor .}

{\color{\thepagecolor} And that makes this text practically invisible.}

{\color{white} Which made the preceding line of text practically
invisible, but it can be copied and pasted.}

\pagebreak
\newpagecolor{red}

This page uses \verb|\newpagecolor{red}|.

\pagebreak
\restorepagecolor

{\color{white}And this page uses \verb|\restorepagecolor| to restore
the page color to the value it had before the red page.}

\pagebreak
\pagecolor{none}

This page uses \verb|\pagecolor{none}|. If the \verb|\nopagecolor|
command is known, the page color is now
\verb|none| (because option \verb|nopagecolor={none}|), otherwise
\verb|white| (or the color given with option \verb|nopagecolor={...}|):
\newline
\verb|\thepagecolor|\ =\ \thepagecolor\ and
\verb|\thepagecolornone|\ =\ \thepagecolornone .

\pagebreak
\restorepagecolor

{\color{white}\verb|\restorepagecolor| restored the page color again.}

\pagebreak
\pagecolor{green}

This page is green due to \verb|\pagecolor{green}|.

\pagebreak
\newpagecolor{blue}\afterpage{\restorepagecolor}

{\color{white}\verb|\newpagecolor{blue}\afterpage{\restorepagecolor}|%
\newline
was used here, i.\,e.~this page is blue, and the next one will
automatically have the same page color before it was changed to blue
here (i.\,e. green).}

\smallskip
{\color{red}\textbf{\lipsum[1-11]}}
\bigskip

The page color was changed back at the end of the page -- 
in mid-sentence!

\pagebreak

\backgroundpagecolor{pink}

When activating the loading of the crop package in the preamble of this
document, \verb|\backgroundpagecolor{<|\textit{some color}\verb|>}|
changes the color of the background/outer/physical page.


Analogous to \verb|\newpagecolor{...}| and \verb|\restorepagecolor|,
for the background/outer/physical page
\verb|\newbackgroundpagecolor{<|\textit{some color}\verb|>}| and\linebreak
\verb|\restorebackgroundpagecolor| are provided (but not demonstrated
here).
\end{document}
%</example>
%    \end{macrocode}
%
% \StopEventually{}
%
% \section{The implementation}
%
% 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}[2021-11-15]
\ProvidesPackage{pagecolor}[2022-11-27 1.2a
            Provides thepagecolor (HMM)]
%    \end{macrocode}
%
% A short description of the \xpackage{pagecolor} package:
%
%    \begin{macrocode}
%% Provides the \thepagecolor, \thepagecolornone, \newpagecolor{...},
%% \restorepagecolor, \backgroundpagecolor, \newbackgroundpagecolor{...},
%% and \restorebackgroundpagecolor commands and a replacement for the
%% \nopagecolor command, if this is not available.
%    \end{macrocode}
%
% We want to wrap the messages nicely:
%
%    \begin{macrocode}
\RequirePackage{hardwrap}[2011/02/12]% v0.2
\GenerateLogMacros{package}{pagecolor}

%    \end{macrocode}
%
% We need the \xpackage{kvoptions} package:
%
%    \begin{macrocode}
\RequirePackage{kvoptions}[2020-10-07]% v3.14
%    \end{macrocode}
%
% and either the \xpackage{color} or the \xpackage{xcolor} package:
%
%    \begin{macrocode}
%% \RequirePackage{ either color or xcolor }:
\IfPackageLoadedTF{xcolor}{% xcolor loaded
   \RequirePackage{xcolor}[2021/10/31]% v2.13
 }{% xcolor not loaded
   \IfPackageLoadedTF{color}{%
      \RequirePackage{color}[2021/12/07]% v1.3c
    }{\pagecolor@warning@noline{%
        The pagecolor package must be loaded after either %
        package color or after package xcolor (at your %
        option). Neither package was loaded before package %
        pagecolor. Loading of package xcolor will now be %
        tried automatically. \\%
        When the pagecolor package is used with option %
        pagecolor using a color requiring e.g. x11names %
        option for xcolor package, this will not work!%
       }
     }
   \RequirePackage{xcolor}[2021/10/31]% v2.13
  }

%    \end{macrocode}
%
% We process the options:
%
%    \begin{macrocode}
\SetupKeyvalOptions{family=pagecolor,prefix=pagecolor@}
\DeclareStringOption[none]{pagecolor}%   \pagecolor@pagecolor
\DeclareStringOption[none]{nopagecolor}% \pagecolor@nopagecolor
\ProcessKeyvalOptions*

%    \end{macrocode}
%    \begin{macro}{\nopagecolor}\label{nopagecolor}
%
% \verb|\nopagecolor| is nowadays readily available. Let us test nevertheless:
%
%    \begin{macrocode}
\ifdefined\nopagecolor\relax
\else
  \pagecolor@info@noline{\string\nopagecolor\ is undefined!}
  \def\pagecolortmpb{none}
  \edef\pagecolortmpa{\pagecolor@nopagecolor}
  \ifx\pagecolortmpa\pagecolortmpb
    \pagecolor@warning@noline{%
      Option nopagecolor=none requested but \string\nopagecolor\ %
      unknown: \\%
      By option nopagecolor the "color" to be used with %
      \string\nopagecolor\ %
      is set. The current value is "none" (maybe by default), %
      but command \string\nopagecolor\ is undefined. %
      Therefore the color cannot be "none". %
      Please change the option accordingly! - %
      As first aid nopagecolor is now set to white.%
     }
    \setkeys{pagecolor}{nopagecolor=white}
  \fi
  \edef\pagecolortmpa{\pagecolor@pagecolor}
  \ifx\pagecolortmpa\pagecolortmpb\relax
    \pagecolor@warning@noline{%
      Option pagecolor=none (maybe by default) used, %
      but \string\nopagecolor\ is unknown. %
      Please use another option value; %
      \pagecolor@nopagecolor\ will be used now.%
     }
    \setkeys{pagecolor}{pagecolor={\pagecolor@nopagecolor}}
  \fi
  \newcommand{\nopagecolor}{\pagecolor{\pagecolor@nopagecolor}}
\fi


%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\pagecolor}
% 
% We save the original |\pagecolor| command,
%
%    \begin{macrocode}
\let\origpagecolor\pagecolor

%    \end{macrocode}
%
% before we redefine it to include a definition of |\thepagecolor|
% and \linebreak |\thepagecolornone|:
%
%    \begin{macrocode}
\renewcommand{\pagecolor}[1]{\@bsphack%
  \edef\pagecolortmpa{#1}%
  \def\pagecolortmpb{none}%
  \ifx\pagecolortmpa\pagecolortmpb\relax%
    \ifdefined\nopagecolor\relax%
      \nopagecolor%
    \else%
      \pagecolor@warning{%
        pagecolor=none requested but \string\nopagecolor\ %
        unknown: \\%
        \string\pagecolor{none} was used, but the command %
        \string\nopagecolor\ is undefined. %
        Please use another color. \\%
        pagecolor=\pagecolor@nopagecolor\ \\%
        will be used now.%
       }%
      \xdef\thepagecolor{\pagecolor@nopagecolor}%
      \xdef\thepagecolornone{\pagecolor@nopagecolor}%
        % although it should be "none"
      \origpagecolor{\pagecolor@nopagecolor}%
    \fi%
  \else%
    \xdef\thepagecolor{#1}%
    \xdef\thepagecolornone{#1}%
    \origpagecolor{\thepagecolornone}%
  \fi%
  \@esphack%
}

%    \end{macrocode}
%    \end{macro}
%
% |\nopagecolor| regularly is defined. If it was not, we already defined a replacement,
% see page~\pageref{nopagecolor}. But additionally |\nopagecolor| does not work
% if the \xpackage{crop} package is used. A workaround needs to be defined:
%
%    \begin{macrocode}
\let\orignopagecolor\nopagecolor\relax

\gdef\pagecolor@cl{0}
\IfPackageLoadedTF{crop}{% crop loaded
  \gdef\pagecolor@cl{1}
  \pagecolor@info{\string\nopagecolor\space did not work with the crop package %
    2017/11/19 v1.10. Using \\%
    \pagecolor@nopagecolor\ \\%
    as nopagecolor now.%
    }
  \def\pagecolortmpb{none}
  \edef\pagecolortmpa{\pagecolor@nopagecolor}
  \ifx\pagecolortmpa\pagecolortmpb\relax
    \pagecolor@warning@noline{%
      Option nopagecolor=none requested but this does not work with the %
      crop package. By option nopagecolor the "color" to be used with %
      \string\nopagecolor\ is set. The current value is "none" (maybe by %
      default), but the crop package broke \string\nopagecolor . %
      Therefore the color cannot be "none". %
      Please change the option accordingly! %
      As first aid nopagecolor is now set to white.%
     }
    \setkeys{pagecolor}{nopagecolor=white}
  \fi
  \renewcommand{\nopagecolor}{\pagecolor{\pagecolor@nopagecolor}}
 }{% crop not loaded
   \ifdefined\nopagecolor\relax
     \gdef\pagecolortmpa{none}
   \else
     \gdef\pagecolortmpa{\pagecolor@nopagecolor}
   \fi
   \renewcommand{\nopagecolor}{%
     \xdef\thepagecolor{white}%
     \xdef\thepagecolornone{\pagecolortmpa}%
     \orignopagecolor%
     }
  }


%    \end{macrocode}
%
% The (new) |\pagecolor| is now just carried out.
%
%    \begin{macrocode}
\pagecolor{\pagecolor@pagecolor}

%    \end{macrocode}
%
% Now the page (background) color as well as |\thepagecolor| are\\
% |\pagecolor@pagecolor|. |\thepagecolornone| is |none|, if that color is known,
% otherwise it is |\pagecolor@nopagecolor|, and if that was |none| (but that unknown),
% it is |white|. If |\pagecolor@pagecolor| was |none|,
% the page (background) color is |none|, when known, otherwise
% |\pagecolor@nopagecolor|, and if that was |none| (but that unknown),
% it is |white|, and |\thepagecolor| is |\pagecolor@nopagecolor|,
% and if that was also |none| but |none| unknown, then it is |white|.
% When the page (background) color is changed, |\thepagecolor| and
% |\thepagecolornone| are changed accordingly.
%
%    \begin{macro}{\newpagecolor}
% There have been requests (via e-mail and at 
% \url{https://tex.stackexchange.com/q/25137/6865}) to change the color of just one
% (or two) page(s) only, similar to |\newgeometry| and |\restoregeometry| of the
% \xpackage{geometry} package (\url{https://www.ctan.org/pkg/geometry}).
% Therefore |\newpagecolor| and |\restorepagecolor| are introduced (as suggested by
% \textsc{haoyun\_tex}):
%
%    \begin{macrocode}
\newcommand{\newpagecolor}[1]{%
\xdef\pagecolortmpc{\thepagecolornone}%
\pagecolor{#1}%
}

%    \end{macrocode}
%    \end{macro}
%
% |\newpagecolor{<|\textit{some color}|>}| will execute |\pagecolor{some color}|
% and remember the page color used before.
%
%    \begin{macro}{\restorepagecolor}
%    \begin{macrocode}
\newcommand{\restorepagecolor}{\pagecolor{\pagecolortmpc}}

%    \end{macrocode}
%    \end{macro}
%
% |\restorecolor| (without argument) restores the page color to the one used before
% use of the |\newpagecolor{...}| command.
%
%    \begin{macrocode}
\gdef\pagecolortmpc{\thepagecolor}

%    \end{macrocode}
% is just a precaution for |\restorecolor| being used when no |\newpagecolor{...}|
% was used before it.
%
% When you want to change the color for just one page and do not want to
% (or cannot) manually determine where the page ends,\\
% |\newpagecolor{<|\textit{some color}|>}\afterpage{\restorepagecolor}|\\
% does the trick (and requires an additional |\usepackage{afterpage}| in the
% document's preamble).
%
%    \begin{macro}{\backgroundpagecolor}
% When the \xpackage{crop} package has been loaded, the background/outer/physical page color
% is determined by the last |\pagecolor{...}| in the preamble after \newline
% |\usepackage[...]{crop}| and cannot be changed in the document. When the |\pagecolor{...}|
% is given before |\usepackage[...]{crop}|, a |\nopagecolor| works at the
% background/outer/physical page and not at the inner/foreground/logic page.
% |\nopagecolor| is fixed above. To change the background/outer/physical page color
% during the document, |\backgroundpagecolor{<|\textit{some color}|>}| is provided:
%
%    \begin{macrocode}
\newcommand{\backgroundpagecolor}[1]{%
  \IfPackageLoadedTF{crop}{%
%    \end{macrocode}
% Remember current inner/foreground/logic page color:
%    \begin{macrocode}
    \xdef\pagecolortmpd{\thepagecolor}%
%    \end{macrocode}
% Set inner/foreground page color to color whished for background/\allowbreak outer/\allowbreak
% physical page color:
%    \begin{macrocode}
    \pagecolor{#1}%
%    \end{macrocode}
% Get that color, for example, |\pagecolor{blue}| might result in |\CROP@pagecolor|
% to be |0 0 1 rg 0 0 1 RG|:
%    \begin{macrocode}
    \xdef\pagecolortmpe{\CROP@pagecolor}%
%    \end{macrocode}
% Set the inner/foreground/logic page color back to the color before changing it:
%    \begin{macrocode}
    \pagecolor{\pagecolortmpd}%
%    \end{macrocode}
% Set the background/outer/physical page color:
%    \begin{macrocode}
    \xdef\CROP@stockcolor{\pagecolortmpe}%
    }{\pagecolor@info{\string\backgroundpagecolor\ does not do %
           anything when the crop package has not been loaded.}%
%    \end{macrocode}
% - except giving this information.
%    \begin{macrocode}
    }%
  }

%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\newbackgroundpagecolor}
% Analogous to |\newpagecolor| and |\restorepagecolor|,
% for the background/\allowbreak outer/\allowbreak physical page we define:
%
%    \begin{macrocode}
\newcommand{\newbackgroundpagecolor}[1]{%
  \IfPackageLoadedTF{crop}{%
    \xdef\pagecolortmpf{\CROP@stockcolor}%
    \backgroundpagecolor{#1}%
    }{\pagecolor@info{\string\newbackgroundpagecolor\ does not do %
              anything when the crop package has not been loaded.}%
     }%
  }

%    \end{macrocode}
%    \end{macro}
%    \begin{macro}{\newbackgroundpagecolor}
%    \begin{macrocode}
\newcommand{\restorebackgroundpagecolor}{%
  \IfPackageLoadedTF{crop}{\xdef\CROP@stockcolor{\pagecolortmpf}}{%
    \pagecolor@info{\string\newbackgroundpagecolor\ does not do %
             anything when the crop package has not been loaded.}}%
  }

%    \end{macrocode}
%    \end{macro}
%
% We checked whether the \xpackage{crop} package had been loaded before
% the \xpackage{pagecolor} package, but maybe it has been loaded afterwards.
% This is checked at the end of |\begin{document}|:
%
%    \begin{macrocode}
\AddToHook{begindocument/end}{%
  \def\pagecolortmpb{0}%
  \ifx\pagecolor@cl\pagecolortmpb\relax%
    % crop not loaded before pagecolor, but maybe afterwards:
    \IfPackageLoadedTF{crop}{% crop indeed loaded afterwards.
      \gdef\pagecolor@cl{1}%
      \pagecolor@info{\string\nopagecolor\space did not work with the crop package %
        2017/11/19 v1.10. Using \\%
        \pagecolor@nopagecolor\ \\%
        as nopagecolor now.%
        }%
      \def\pagecolortmpb{none}%
      \edef\pagecolortmpa{\pagecolor@nopagecolor}%
      \ifx\pagecolortmpa\pagecolortmpb\relax%
        \pagecolor@warning@noline{%
          Option nopagecolor=none requested but this does not work with %
          the crop package. By option nopagecolor the "color" to be used %
          with \string\nopagecolor\ is set. The current value is "none" %
          (maybe by default), but the crop package broke %
          \string\nopagecolor . Therefore the color cannot be "none". %
          Please change the option accordingly! %
          As first aid nopagecolor is now set to white.%
         }%
        \setkeys{pagecolor}{nopagecolor=white}%
      \fi%
      \renewcommand{\nopagecolor}{\pagecolor{\pagecolor@nopagecolor}}%
     }{% crop neither loaded afterwards.
      }%
  \fi%
  }

%    \end{macrocode}
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}
%
% \section{Installation}
% \subsection{Downloads}
% Everything is available at \url{https://www.ctan.org},
% but may need additional packages themselves.\\
%
% \DescribeMacro{pagecolor.dtx}
% For unpacking the |pagecolor.dtx| file and constructing the documentation
% it is required:
% \begin{description}
% \item[-] \TeX Format \LaTeXe{} 2021-11-15 or newer: \url{https://www.CTAN.org}
%
% \item[-] document class \xclass{ltxdoc}, 2020/12/05, v2.1b,
%   \url{https://www.ctan.org/pkg/ltxdoc}
%
% \item[-] package \xpackage{holtxdoc}, 2019/12/09, v0.30,
%   \url{https://www.ctan.org/pkg/holtxdoc}
% \end{description}
%
% \DescribeMacro{pagecolor.sty}
% The |pagecolor.sty| for \LaTeXe{} (i.\,e. each document using
% the \xpackage{pagecolor} package) requires:
% \begin{description}
% \item[-] \TeX{} Format \LaTeXe{} 2021-11-15 or newer, \url{https://www.CTAN.org}
%
% \item[-] package \xpackage{hardwrap}, 2011/02/12, v0.2,
%   \url{https://www.ctan.org/pkg/hardwrap}
%
% \item[-] package \xpackage{kvoptions}, 2020-10-07, v3.14,
%   \url{https://www.ctan.org/pkg/kvoptions}
% \end{description}
% and either
% \begin{description}
% \item[-] package \xpackage{xcolor}, 2021/10/31, v2.13,
%           \url{https://www.ctan.org/pkg/xcolor}
% \end{description}
% or
% \begin{description}
% \item[-] package \xpackage{color}, 2021/12/07, v1.3c,
%           \url{https://www.ctan.org/pkg/color} (from the\\
%           \xpackage{graphics} package bundle).
% \end{description}
%
% \DescribeMacro{pagecolor-example.tex}
% The |pagecolor-example.tex| requires the same file as all
% documents using the \xpackage{pagecolor} package, i.\,e.
% \begin{description}
% \item[-] package \xpackage{pagecolor}, 2022-11-27, v1.2a,
%   \url{https://www.ctan.org/pkg/pagecolor}\\
%   (Well, it is the example file for this package, and because you are reading the
%    documentation for the \xpackage{pagecolor} package, it~can be assumed that you already
%    have some version of it -- is it the current one?)
% \end{description}
% and additionally:
% \begin{description}
% \item[-] class \xpackage{article}, 2021/10/04, v1.4n, from \xpackage{classes}:\\
%           \url{https://www.ctan.org/pkg/classes}
%
% \item[-] package \xpackage{xcolor}, 2021/10/31, v2.13,
%           \url{https://www.ctan.org/pkg/xcolor}\\
%           This package would not be needed for the use of just base colors only,
%           the \xpackage{color} package would be sufficient for that.
%
% \item[-] package \xpackage{afterpage}, 2014/10/28, v1.08,
%           \url{https://www.ctan.org/pkg/afterpage}\\
%           This package is only needed for demonstrating the\\
%           |\newpagecolor{somecolor}\afterpage{\restorepagecolor}| construct.
%
% \item[-] package \xpackage{lipsum}, 2021-09-20, v2.7,
%           \url{https://www.ctan.org/pkg/lipsum}\\
%           This package is only needed for some blind text.
% \end{description}
%
% \newpage
%
% \DescribeMacro{Alternatives}
% \DescribeMacro{transparent}
% \DescribeMacro{OCG}
% As possible alternatives in section~\ref{s:Alternatives}, Alternatives,
% there are listed (newer versions might be available):
% \begin{description}
% \item[-] package \xpackage{transparent}, 2022-10-27, v1.5,\\
%           \url{https://www.ctan.org/pkg/transparent}
%
% \item[-] OCG (Optional Content Groups),\\
%           \url{https://www.ctan.org/search?phrase=ocg}
% \end{description}
%
% \DescribeMacro{Oberdiek}
% \DescribeMacro{holtxdoc}
% \DescribeMacro{kvoptions}
% All packages of the `oberdiek' bundle
% (especially \xpackage{holtxdoc} and \xpackage{kvoptions})
% are also available in a TDS compliant ZIP archive:\\
% \url{https://mirror.ctan.org/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{https://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{https://www.ctan.org/author/muench-hm}.\\
%
% \subsection{Package, unpacking TDS}
% \paragraph{Package.} This package is available on \url{https://www.CTAN.org}.
% \begin{description}
% \item[\url{https://mirror.ctan.org/macros/latex/contrib/pagecolor/pagecolor.dtx}]\hspace*{0.1cm} 
%       The source file.
% \item[\url{https://mirror.ctan.org/macros/latex/contrib/pagecolor/pagecolor.pdf}]\hspace*{0.1cm} 
%       The documentation.
% \item[\url{https://mirror.ctan.org/macros/latex/contrib/pagecolor/pagecolor-example.pdf}]\hspace*{0.1cm} 
%       The compiled example file, as it should look like.
% \item[\url{https://mirror.ctan.org/macros/latex/contrib/pagecolor/README}]\hspace*{0.1cm}\\
%       \hspace*{1em}The README file.
% \end{description}
%
% There is also a |pagecolor.tds.zip| available:
% \begin{description}
% \item[\url{https://mirror.ctan.org/install/macros/latex/contrib/pagecolor.tds.zip}]\hspace*{0.1cm} 
%       Everything in TDS compliant, compiled format.
% \end{description}
% which additionally contains\\
% \begin{tabular}{ll}
% pagecolor.ins & The installation file.\\
% pagecolor.drv & The driver to generate the documentation.\\
% pagecolor.sty & The \xext{sty}le file.\\
% pagecolor-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 pagecolor.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@{}}
%   pagecolor.sty & tex/latex/pagecolor/pagecolor.sty\\
%   pagecolor.pdf & doc/latex/pagecolor/pagecolor.pdf\\
%   pagecolor-example.tex & doc/latex/pagecolor/pagecolor-example.tex\\
%   pagecolor-example.pdf & doc/latex/pagecolor/pagecolor-example.pdf\\
%   pagecolor.dtx & source/latex/pagecolor/pagecolor.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
% 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 (\TeX\,Live, \mikTeX, \dots) relies on
% file name databases, you must refresh these. For example, \TeX\,Live\ 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{pagecolor.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 pagecolor.dtx
%makeindex -s gind.ist pagecolor.idx
%pdflatex pagecolor.dtx
%makeindex -s gind.ist pagecolor.idx
%pdflatex pagecolor.dtx
%\end{verbatim}
% \end{quote}
%
% \subsection{Compiling the example}
%
% The example file, \textsf{pagecolor-example.tex}, can be compiled via\\
% |(pdf)latex pagecolor-example.tex|.
%
% \newpage
%
% \section{Acknowledgements}
%
% I would like to thank \textsc{Heiko Oberdiek} for providing a lot of
% useful packages (from which I also got everything I know about creating
% a file in \xext{dtx} format, ok, say it: copying), and the
% \Newsgroup{comp.text.tex} and \Newsgroup{de.comp.text.tex} newsgroups
% for their help in all things \TeX{}, especially all contributors to the
% discussion at
% \url{https://groups.google.com/g/comp.text.tex/c/UzV26-RNYPY}%
% \ (\textsc{H.~Oberdiek} \& \textsc{Gouailles}).\\
% I thank \textsc{haoyun\_tex} for suggesting the |\newpagecolor|/|\restorepagecolor|
% pair of commands and everyone at \url{https://tex.stackexchange.com/q/25137/6865}
% for their contributions there. Thanks go to \textsc{Heiner Richter}
% for finding a bug, to \textsc{Johannes B\"{o}ttcher} for reporting it,
% and to \textsc{Reuben Thomas} for suggestions for improvements
% of this documentation.
%
% \phantomsection
% \begin{History}\label{History}
%   \begin{Version}{2011/07/16 v1.0a}
%     \item First version discussed at \Newsgroup{comp.text.tex}.
%   \end{Version}
%   \begin{Version}{2011/08/06 v1.0b}
%     \item Changed version uploaded to the CTAN.
%   \end{Version}
%   \begin{Version}{2011/08/08 v1.0c}
%     \item Fixed a |\setkeys|.
%   \end{Version}
%   \begin{Version}{2012/02/01 v1.0d}
%     \item Bugfix: Obsolete installation path given in the documentation, updated.
%     \item New commands: |\newpagecolor{...}|, |\restorepagecolor|.
%     \item Update of documentation, README, and \xfile{dtx} internals.
%   \end{Version}
%   \begin{Version}{2012/02/23 v1.0e}
%     \item Fixed an error in the documentation.
%     \item Check for loading of \xpackage{color} or \xpackage{xcolor} package
%             and their versions has been changed, because \xpackage{xcolor} sets\\
%             |\@namedef{ver@color.sty}{1999/02/16}|\\
%             which gave a warning about old \xpackage{color} package even if a new
%             version was used.
%   \end{Version}
%   \begin{Version}{2015/06/21 v1.0f}
%     \item Fixed the urls in the documentation.
%     \item Handle |\nopagecolor| when it is not defined or broken by \xpackage{crop},
%             new option |nopagecolor| introduced.
%     \item Update of documentation, README, and \xfile{dtx} internals.
%   \end{Version}
%   \begin{Version}{2015/06/22 v1.0g}
%     \item Replaced all error messages by warnings.
%   \end{Version}
%   \begin{Version}{2015/08/30 v1.0h}
%     \item Bugfix: Checking for \xpackage{crop} package done |\AtBeginDocument|,
%             but some of the related code must already be performed earlier.
%             Bug found by \textsc{Heiner Richter} and reported by
%             \textsc{Johannes B\"{o}ttcher}, thanks!
%   \end{Version}
%   \begin{Version}{2017/05/29 v1.0i}
%     \item Documentation update following suggestions for improvements by
%             \textsc{Reuben Thomas}, thanks!
%     \item This version has been archived at\\
%             \url{https://web.archive.org/web/20220120221237/https://mirror.ctan.org/install/macros/latex/contrib/pagecolor.tds.zip}
%   \end{Version}
%   \begin{Version}{2022-11-20 v1.1a}
%     \item Replaced all |colour| (with |u|) by |color| (without |u|).
%     \item Converted to UTF-8.
%     \item Updated to \LaTeX{} format 2021-11-15.
%     \item Corrected an error in the example.
%     \item \XeLaTeX{} and others now do know |\nopagecolor|.
%     \item Package \xpackage{crop} has been updated, but |\nopagecolor|
%             still applies to the physical background sheet instead of the logical foreground area.
%     \item Now using the \xpackage{hardwrap} package.
%   \end{Version}
%   \begin{Version}{2022-11-27 v1.2a}
%     \item Now also handling the background/outer/physical page color,
%             when the \xpackage{crop} package is used.
%     \item Documentation updates.
%   \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.)
%
% \newpage
%
% \PrintIndex
%
% \Finale
\endinput