summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/pagecolor/pagecolor.dtx
blob: f8a02ecdf531d742395c8708072665f7658402d7 (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
% \iffalse meta-comment
%
% File: pagecolor.dtx
% Version: 2011/08/06 v1.0b
%
% Copyright (C) 2011 by
%    H.-Martin M"unch <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
%    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 pagecolor.dtx
% and the derived files
%    pagecolor.sty, pagecolor.pdf, pagecolor.ins, pagecolor.drv,
%    pagecolor-example.tex.
%
% Distribution:
%    CTAN:macros/latex/contrib/pagecolor/pagecolor.dtx
%    CTAN:macros/latex/contrib/pagecolor/pagecolor.pdf
%    CTAN:install/macros/latex/contrib/pagecolor.tds.zip
%
% Unpacking:
%    (a) If pagecolor.ins is present:
%           tex pagecolor.ins
%    (b) Without pagecolor.ins:
%           tex pagecolor.dtx
%    (c) If you insist on using LaTeX
%           latex \let\install=y\input{pagecolor.dtx}
%        (quote the arguments according to the demands of your shell)
%
% Documentation:
%    (a) If pagecolor.drv is present:
%           (pdf)latex pagecolor.drv
%           makeindex -s gind.ist pagecolor.idx
%           (pdf)latex pagecolor.drv
%           makeindex -s gind.ist pagecolor.idx
%           (pdf)latex pagecolor.drv
%    (b) Without pagecolor.drv:
%           (pdf)latex pagecolor.dtx
%           makeindex -s gind.ist pagecolor.idx
%           (pdf)latex pagecolor.dtx
%           makeindex -s gind.ist pagecolor.idx
%           (pdf)latex pagecolor.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/pagecolor/pagecolor.sty
%    TDS:doc/latex/pagecolor/pagecolor.pdf
%    TDS:doc/latex/pagecolor/pagecolor-example.tex
%    TDS:doc/latex/pagecolor/pagecolor-example.log
%    TDS:source/latex/pagecolor/pagecolor.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: pagecolor 2011/08/06 v1.0b Provides thepagecolor (HMM)}
\Msg{*****************************************************************}

\keepsilent
\askforoverwritefalse

\let\MetaPrefix\relax
\preamble

This is a generated file.

Project: pagecolor
Version: 2011/08/06 v1.0b

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

The usual disclaimer applys:
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.

This work consists of the main source file pagecolor.dtx
and the derived files
   pagecolor.sty, pagecolor.pdf, pagecolor.ins, pagecolor.drv,
   pagecolor-example.tex.

\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}[2009/09/24]
\ProvidesFile{pagecolor.drv}%
  [2011/08/06 v1.0b Provides thepagecolor (HMM)]%
\documentclass{ltxdoc}[2007/11/11]% v2.0u
\usepackage{holtxdoc}[2011/02/04]% v0.21
%% pagecolor 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={Providing the thepagecolor command (HMM)},%
 pdfkeywords={LaTeX, pagecolor, thepagecolor, Hans-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{printing docu-ment}
\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
\begin{document}
  \DocInput{pagecolor.dtx}%
\end{document}
%</driver>
%    \end{macrocode}
%
% \fi
%
% \CheckSum{111}
%
% \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{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{\\}
% \DoNotIndex{\documentclass,\usepackage,\ProvidesPackage}
% \DoNotIndex{\NeedsTeXFormat,\DoNotIndex,\verb}
% \DoNotIndex{\def,\edef,\gdef,\global}
% \DoNotIndex{\kvoptions,\listfiles,\mathord,\mathrm}
% \DoNotIndex{\SetupKeyvalOptions,\ProcessKeyvalOptions}
% \DoNotIndex{\bigskip,\thinspace,\section}
% \DoNotIndex{\ldots,\indent,\noindent,\newline,\pagebreak}
% \DoNotIndex{\textbf,\textit,\textsf,\texttt}
% \DoNotIndex{\plainTeX,\TeX,\LaTeX,\pdfLaTeX}
% \DoNotIndex{\begin,\end,\color,\pagenumbering}
% \DoNotIndex{\@ifundefined,\@ifpackageloaded}
% \DoNotIndex{\DeclareStringOption,\ifx,\MessageBreak,\space}
%
% \title{The \xpackage{pagecolor} package}
% \date{2011/08/06 v1.0b}
% \author{H.-Martin M\"{u}nch\\\xemail{Martin.Muench at Uni-Bonn.de}}
%
% \maketitle
%
% \begin{abstract}
%  This \LaTeX\ package provides the command |\thepagecolor|,
% which gives the current page (background) colour,
% i.\,e.~the argument used with the most recent call of |\pagecolor{...}|.
% The command |\thepagecolornone| gives the same colour as |\thepagecolor|,
% except when the page background colour is
% \textquotedblleft|none|\textquotedblright. In that case |\thepagecolor| is
% |white| and |\thepagecolornone| is |none|.
% \end{abstract}
%
% \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.}
%
% \pagebreak
%
% \tableofcontents
%
% \bigskip
%
% \section{Introduction}
%
% \indent This \LaTeX\ package provides the command |\thepagecolor|,
% which gives the current page (background) colour,
% i.\,e.~the argument used with the most recent call of |\pagecolor{...}|.
% The package should be loaded before any package sets a page (background)
% colour, but after \xpackage{color} or \xpackage{xcolor} package.
% Its option |pagecolor={...}| is used to set the |\pagecolor{...}|.\\
% The command |\thepagecolornone| gives the same colour as |\thepagecolor|,
% except when the page background colour is
% \textquotedblleft|none|\textquotedblright (e.\,g. result of using the
% |\nopagecolor| command). In that case |\thepagecolor| is |white| and\linebreak
% |\thepagecolornone| is |none|.
%
% %\pagebreak
%
% \section{Usage}
%
% \indent Just load the package placing
% \begin{quote}
%   |\usepackage[<|\textit{option}|>]{pagecolor}|
% \end{quote}
% \noindent in the preamble of your \LaTeXe\ source file.
% This should be done before another package uses |\pagecolor|,
% but after |\nopagecolor| is defined (if that is defined in the document
% at all).\\
% Afterwards |\pagecolor{...}| can be used to change the page (background)
% colour as usual. Then |\thepagecolor| gives the current page (background)
% colour (in the same format as given with |\pagecolor{...}|).\\
%
% \subsection{Option}
% \DescribeMacro{option}
% \indent The \xpackage{pagecolor} package takes the following option:
%
% \subsubsection{pagecolor\label{sss:pagecolor}}
% \DescribeMacro{pagecolor}
% \indent The option |pagecolor={...}| takes as value a colour. This
% could be as simple as |white| or |black|, but when e.\,g.~the
% \xpackage{xcolor} package is used (loaded before \xpackage{pagecolor}!),
% also colours like |red!50!green!20!blue| are possible.
% The default is |pagecolor={none}|.
%
% \section{Alternatives\label{sec: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 some possible alternatives:\\
%
% \DescribeMacro{transparent}
% \begin{description}
% \item[-] \xpackage{transparent} package: With it some object can be made
%  (fully or partially) transparent.
% \end{description}
%
% \DescribeMacro{hrefhide}
% \begin{description}
% \item[-] \xpackage{transparent} package: It allows to
%  \textquotedblleft hide\textquotedblright\ some (hyperlinked) text when printing
%  the document while keeping the layout.
% \end{description}
%
% \bigskip
%
% \noindent (You programmed or found another alternative,
%  which is available at \CTAN{}?\\
%  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.)\\
%
% \smallskip
%
% \noindent About how to get those packages, please see subsection~\ref{ss:Downloads}.
%
% \newpage
%
% \section{Example}
%
%    \begin{macrocode}
%<*example>
\documentclass[british]{article}[2007/10/19]% v1.4h
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{hyperref}[2011/04/17]% v6.82g
\hypersetup{extension=pdf,%
 plainpages=false,%
 pdfpagelabels=true,%
 hyperindex=false,%
 pdflang={en},%
 pdftitle={pagecolor package example},%
 pdfauthor={Hans-Martin Muench},%
 pdfsubject={Example for the pagecolor package},%
 pdfkeywords={LaTeX, pagecolor, thepagecolor, page colour, Hans-Martin Muench},%
 pdfview=Fit,pdfstartview=Fit,%
 pdfpagelayout=SinglePage%
}
\usepackage[x11names]{xcolor}[2007/01/21]% v2.11
 % The xcolor package would not be needed for just using the base colours.
 % The color package would be sufficient for that.
\usepackage[pagecolor={LightGoldenrod1}]{pagecolor}[2011/08/06]% v1.0b
\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
\listfiles
\begin{document}
\pagenumbering{arabic}
\section*{Example for pagecolor}

This example demonstrates the use of package\newline
\textsf{pagecolor}, v1.0b as of 2011/08/06 (HMM).\newline
The used option was \verb|pagecolor={LightGoldenrod1}|.\newline
\verb|pagecolor={none}| would be the default.\newline

For more details please see the documentation!\newline

\noindent {\color{teal} 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

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

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

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

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

Which made the preceding line of text practically invisible.

\end{document}
%</example>
%    \end{macrocode}
%
% \StopEventually{}
%
% \newpage
%
% \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}[2009/09/24]
\ProvidesPackage{pagecolor}[2011/08/06 v1.0b
            Provides thepagecolor (HMM)]%
%    \end{macrocode}
%
% A short description of the \xpackage{pagecolor} package:
%
%    \begin{macrocode}
%% Provides the \thepagecolor and \thepagecolornone commands.
%    \end{macrocode}
%
% We need the \xpackage{kvoptions} package by \textsc{Heiko Oberdiek}:
%
%    \begin{macrocode}
\RequirePackage{kvoptions}[2010/12/23]% v3.10
%    \end{macrocode}
%
% and either the \xpackage{color} or the \xpackage{xcolor} package:
%
%    \begin{macrocode}
%% \RequirePackage{ either color or xcolor }:
\@ifpackageloaded{color}{%
  \RequirePackage{color}[2005/11/14]% v1.0j
  }{% else
   \@ifpackageloaded{xcolor}{% ok
    }{% else
     \PackageWarning{pagecolor}{%
       The pagecolor package must be loaded after either\MessageBreak%
       package color or after package xcolor (at your\MessageBreak%
       option). Neither package was loaded before package\MessageBreak%
       pagecolor. Loading of package xcolor will now be\MessageBreak%
       tried automatically.\MessageBreak%
       }
    }% fi
   \RequirePackage{xcolor}[2007/01/21]% v2.11
  }% fi
%    \end{macrocode}
%
% Replacing \xpackage{color}, \xpackage{xcolor}, \xpackage{xcolor-patch},
% and \xpackage{pagecolor} by one new package would be appreciated.\\
% A last information for the user:
%
%    \begin{macrocode}
%% pagecolor may work with earlier versions of LaTeX and the
%% packages, but this was not tested. Please consider updating
%% your LaTeX and packages to the most recent version
%% (if they are not already the most recent version).

%    \end{macrocode}
%
% \indent See subsection~\ref{ss:Downloads} about how to get them.\\
%
% We process the options:
%
%    \begin{macrocode}
\SetupKeyvalOptions{family=pagecolor,prefix=pagecolor@}
\DeclareStringOption[none]{pagecolor}% \pagecolor@pagecolor
\ProcessKeyvalOptions*

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

%    \end{macrocode}
%
% before we redefine it to include a definition of |\thepagecolor|
% and \linebreak
% |\thepagecolornone|:
%
% \pagebreak
%
%    \begin{macrocode}
\renewcommand{\pagecolor}[1]{%
  \edef\pagecolourtmpa{#1}
  \def\pagecolourtmpb{none}
  \ifx\pagecolourtmpa\pagecolourtmpb
    \@ifundefined{nopagecolor}{%
      \PackageError{pagecolor}{%
        pagecolor=none requested but \string\nopagecolor\space unknown%
       }{%
        \string\pagecolor{none} was used, but the command \string\nopagecolor\space%
        is undefined.\MessageBreak%
        Please use another colour. pagecolor=white will be used now.\MessageBreak%
        }
      \xdef\thepagecolor{white}
      \xdef\thepagecolornone{white}% although it should be "none"
      \origpagecolour{white}
     }{%
      \nopagecolor
     }
  \else
    \xdef\thepagecolor{#1}
    \xdef\thepagecolornone{#1}
    \origpagecolour{\thepagecolor}
  \fi
  }

%    \end{macrocode}
%
% When |\pagecolor{none}| is used and |\nopagecolor| is defined,
% |\pagecolor{none}| is made into a synonym for |\nopagecolor|.\\
% If |\nopagecolor| has not been defined, nothing needs to be done.
% Otherwise we redefine |\nopagecolor|, thus that |\thepagecolor| is
% set to |white| and |\thepagecolornone| to |none| whenever
% |\nopagecolor| is used.
%
%    \begin{macrocode}
\@ifundefined{nopagecolor}{%
  \PackageWarning{pagecolor}{%
    \string\nopagecolor\space is undefined.\MessageBreak%
    (As long as it is neither used anywhere\MessageBreak%
    \space nor defined later, that will be no problem.)\MessageBreak%
   }
  \AtEndDocument{%
  \@ifundefined{nopagecolor}{% no problem
    }{%
    \PackageError{pagecolor}{%
      \string\nopagecolor\space defined after loading package\MessageBreak%
      pagecolor%
      }{\string\nopagecolor\space was defined after loading the pagecolor
       package.\MessageBreak%
       Either define \string\nopagecolor\space earlier or load the pagecolor
       package later.\MessageBreak%
      }
    }%
  }%
  }{% \else
    \let\orignopagecolour\nopagecolor
    \renewcommand{\nopagecolor}{%
      \xdef\thepagecolor{white}
      \xdef\thepagecolornone{none}
      \orignopagecolour
      }
  }

%    \end{macrocode}
%
% If the pagecolour as given with option |pagecolor={...}| is |none|,
% but |\nopagecolor| is not known, |\pagecolor@pagecolor| is set to
% |white| and a warning is given.
%
%    \begin{macrocode}
\def\pagecolourtmpb{none}
\ifx\pagecolor@pagecolor\pagecolourtmpb
  \@ifundefined{nopagecolor}{%
    \PackageWarning{pagecolor}{%
      Option pagecolor=none (maybe by default) used,\MessageBreak%
      but \string\nopagecolor\space is unknown. Please use another\MessageBreak%
      option value; white will be used now.\MessageBreak%
     }
    \gdef\pagecolor@pagecolor{white}%
  }{% ok
  }%
\fi

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

%    \end{macrocode}
%
% Now the page (background) colour and |\thepagecolor| and
% |\thepagecolornone| are |\pagecolor@pagecolor| (or page (background) colour
% and |\thepagecolornone| are |none|=|\pagecolor@pagecolor| and
% |\thepagecolor| is |white|), and when the page (background) colour
% is changed, |\thepagecolor| and |\thepagecolornone| are changed
% accordingly.
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}
%
% \newpage
%
% \section{Installation}
%
% \subsection{Downloads\label{ss:Downloads}}
%
% Everything should be available at \CTAN{}, \url{http://www.ctan.org/tex-archive/},
% 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{}: \url{http://www.CTAN.org/}
%
% \item[-] document class \xpackage{ltxdoc}, 2007/11/11, v2.0u,\\
%           \CTAN{macros/latex/base/ltxdoc.dtx}
%
% \item[-] package \xpackage{holtxdoc}, 2011/02/04, v0.21,\\
%           \CTAN{macros/latex/contrib/oberdiek/holtxdoc.dtx}
%
% \item[-] package \xpackage{hypdoc}, 2010/03/26, v1.9,\\
%           \CTAN{macros/latex/contrib/oberdiek/hypdoc.dtx}
% \end{description}
%
% \DescribeMacro{pagecolor.sty}
% The \texttt{pagecolor.sty} for \LaTeXe\ (i.\,e. each document using
% the \xpackage{pagecolor} package) requires:
% \begin{description}
% \item[-] \TeX Format \LaTeXe{}, \url{http://www.CTAN.org/}
%
% \item[-] package \xpackage{kvoptions}, 2010/12/23, v3.10,\\
%           \CTAN{macros/latex/contrib/oberdiek/kvoptions.dtx}
% \end{description}
% and either
% \begin{description}
% \item[-] package \xpackage{color}, 2005/11/14, v1.0j,\\
%           \CTAN{macros/latex/required/graphics/color.dtx}
% \end{description}
% or
% \begin{description}
% \item[-] package \xpackage{xcolor}, 2007/01/21, v2.11,\\
%           \CTAN{macros/latex/contrib/xcolor/xcolor.dtx}
% \end{description}
%
% \DescribeMacro{pagecolor-example.tex}
% The \texttt{pagecolor-example.tex} requires the same files as all
% documents using the \xpackage{pagecolor} package, i.\,e. the ones
% named above 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{pagecolor}, 2011/08/06, v1.0b,\\
%           \CTAN{macros/latex/contrib/pagecolor/pagecolor.dtx}\\
%           (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?)
%
% \item[-] package \xpackage{xcolor}, 2007/01/21, v2.11,\\
%           \CTAN{macros/latex/contrib/xcolor/xcolor.dtx}\\
%           This package would not be needed for the use of just base colours only,
%           the \xpackage{color} package would be sufficient for that.
% \end{description}
%
% \DescribeMacro{transparent}
% \DescribeMacro{hrefhide}
% As possible alternatives in section \ref{sec:Alternatives} there are listed
% \begin{description}
% \item[-] package \xpackage{transparent}, 2007/01/08, v1.0, \\
%           \CTAN{macros/latex/contrib/oberdiek/transparent.dtx}
%
% \item[-] package \xpackage{hrefhide}, 2011/04/29, v1.0f, \\
%           \CTAN{macros/latex/contrib/hrefhide/hrefhide.dtx}
% \end{description}
%
% \pagebreak
%
% \DescribeMacro{Oberdiek}
% \DescribeMacro{holtxdoc}
% \DescribeMacro{kvoptions}
% All packages of \textsc{Heiko Oberdiek's} bundle `oberdiek'
% (especially \xpackage{holtxdoc} and \xpackage{kvoptions})
% 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}.\\
%
% \subsection{Package, unpacking TDS}
%
% \paragraph{Package.} This package is available on \CTAN{}
% \begin{description}
% \item[\CTAN{macros/latex/contrib/pagecolor/pagecolor.dtx}]\hspace*{0.1cm} \\
%       The source file.
% \item[\CTAN{macros/latex/contrib/pagecolor/pagecolor.pdf}]\hspace*{0.1cm} \\
%       The documentation.
% \item[\CTAN{macros/latex/contrib/pagecolor/pagecolor-example.pdf}]\hspace*{0.1cm} \\
%       The compiled example file, as it should look like.
% \item[\CTAN{macros/latex/contrib/pagecolor/README}]\hspace*{0.1cm} \\
%       The README file.
% \item[\CTAN{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, see the preceding subsection.
%
% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
% \docstrip\ archive. The files are extracted by running the
% \xfile{.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.sty\\
%   pagecolor.pdf & doc/latex/pagecolor.pdf\\
%   pagecolor-example.tex & doc/latex/pagecolor-example.tex\\
%   pagecolor-example.pdf & doc/latex/pagecolor-example.pdf\\
%   pagecolor.dtx & source/latex/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 (\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{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 this
% 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|.\\
%
% \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{http://groups.google.com/group/comp.text.tex/browse_thread/thread/533576ebe44d60f6/e1654d70a19de63c?lnk=gst&q=Determination+of+the+current+page+colour#e1654d70a19de63c}
% \ (\textsc{H.~Oberdiek} \& \textsc{Gouailles}).
%
% \pagebreak
%
% \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 \CTAN{}.
%   \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