summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xwatermark/tab-globaloptions.tex
blob: 775e2b31323d32981b3530c3c56bee2b197e7de1 (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
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%
% This is file xwatermark-guide (global options), version 1.5.2c             %
%                                                                            %
% Copyright (c) 2009-2012 Ahmed Musa (amusa22@gmail.com).                    %
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%

\documentclass[
  a4paper,10pt,final,UK-English,subsidfile
]{amltxdoc}

\makeatletter
\InputIfFileExists{xwatermark-guide.cfg}{}{%
  \@latex@error{No file 'xwatermark-guide.cfg' or wrong path}\@ehc
}
\WrapQuotes
\usecsifdef\NoPrintNotes
\makeindex

\begin{document}

\colone4cm\coltwo2.5cm
\colthree=\dimexpr\textwidth-(\colone+\coltwo+1.5cm)\relax
\coltotal=\dimexpr\colone+\coltwo+\colthree\relax
\extrarowheight=2pt
\arrayrulecolor{orange}
\noindent
\begin{longtable}[c]{>{\hspace{0pt}\raggedright}m{\colone}m{\coltwo}W}
\caption{Global options of the package\label{tab:globaloptions}}\\\whline

\multicolumn{3}{M}{All the keys in this table are \quoted{option keys}, \ie, they can appear only in \hx{\documentclass} or \hx{\usepackage}. If a key is an option key and it is issued in functions other than \hx{\documentclass} or \hx{\usepackage}, the package will alert the user to that effect.}\\\hline

\bfblue Option & \bfblue Default & \bfblue Meaning\\\hline
\endfirsthead
\hline
\multicolumn{3}{l}{\emph{Continued from last page}}\\\hline
\bfblue Option & \bfblue Default & \bfblue Meaning %\\\hline
\endhead
\multicolumn{3}{r}{\emph{Continued on next page}}\\\hline
\endfoot
\hline
\endlastfoot
\ffx{defaultfirstpage, default-first-page} & 1 & The default first page of document, when the first page hasn't been known yet. \\\hline
\ffx{defaultlastpage, default-last-page} & 1 & The default last page of document, when the last page has't been shipped out yet. \\\hline
\fx{draft} & \hx{false} & The document is in draft mode.\ltablenote{\ffx'{draft,final} are complementary (biboolean) options, \ie, when one is true, the other is automatically set to false.}\\\hline
\fx{final} & \hx{true} & The document is in final mode.\\\hline
\ffx{disablegeometry, disable-geometry} & \hx{false} & This option determines whether the page layout settings by the \pkg'{geometry} should be disabled so that the watermarks can be set more readily by \pkg{xwatermark}.\ltablenote{Version~5.6 and higher of the \pkg'{geometry} make this option less likely to be needed, unlike the earlier versions of \pkg{geometry}.}\\\hline
\ffx{frontpagestyle, front-page-style} & empty & The style of the front page, in the sense of the \pkg'{fancyhdr}. \\\hline
\ffx{picontoptext,pic-on-top-text, picture-on-top-text} & \hx{true} & The boolean that determines if picture watermark is placed on top of text watermark or otherwise, when they occur at the same location on a page.\\\hline
\ffx{printwatermark, print-watermark} & \hx{true} & The global boolean switch that determines whether watermarks should be printed or not.\ltablenote{This option can be passed to package as either \fx{true} or \fx{false} and can appear in the \hx{\documentclass} options list or \hx{\usepackage}. If for any reason you don't want the watermark printed in any run, you can enter \fx{printwatermark}=\hx{false}. If the option \fx{draft} or \fx{final} appears in the \hx{\documentclass} or \hx{\usepackage}, it won't affect the printing or otherwise of the watermark, apart from determining if graphics watermarks are actually inserted instead of framed empty boxes. The printing of the watermark is determined by the option \fx{printwatermark}.}\\\hline
\ffx{resetpaperorigin,reset-paper-origin} & \hx{false} & The boolean to call to reset the paper origin (\hhx'{\pdfhorigin, \pdfvorigin, \hoffset, \voffset}) to zero unit. \\\hline
\ffx{showpagecenter, show-page-center} & \hx{false} & Boolean that indicates if the center of the paper should be shown with a cross (and circle).\ltablenote{The \pkg'{xwmgrid}, which provides a full gridding functionality consistent with the \pkg'{xwatermark}, will be released shortly.}\\\hline
\ffx{textontoppic,text-on-top-pic,text-on-top-picture} & \hx{false} & The reverse of  \fx{picontoptext}.\\\hline
\ffx{usedummymarks, use-dummy-marks} & \hx{true} & The boolean that instructs \pkg{xwatermark} to print watermarks that have been defined by the \fx{\dummywatermark} or \fx{\dummywallpaper} in addition to those defined by \fx{\newwatermark} and/or \fx{\newwallpaper}.\\\hline
\ffx{watermarkparser, watermark-parser} & \fx{;}~(semicolon) & The option determines the watermark parser, a quantity that is used internally to build watermarks into lists.\ltablenote{If you do have the \fx{watermarkparser} in your watermark, it must be enclosed in curly braces, otherwise the package will flag a fatal error. You can change the \fx{watermarkparser} to say \quoted{\fx{|}} (vertical bar), in case you have too many \quoted{\fx{;}} (semicolons) in your watermarks and you are fed up with enclosing them in braces.}\\\hline
\end{longtable}

\normalfont\normalsize


\end{document}