1 % The UCW Macro Collection (a successor of mjmac.tex)
2 % Written by Martin Mares <mj@ucw.cz> in 2010--2018 and placed into public domain
3 % -------------------------------------------------------------------------------
7 % We'll use internal macros of plain TeX
10 \ifx\eTeXversion\undefined
11 \errmessage{ucwmac requires the e-TeX engine or its successor}
14 %%% PDF output detection %%%
19 \ifx\pdfoutput\undefined
20 \else\ifnum\pdfoutput>0
22 \pdfpkresolution=600 % Provide a reasonable default
25 %%% Auxiliary macros %%%
27 % Prepend/append #2 to the definition of #1
28 \long\def\prependef#1#2{\expandafter\def\expandafter#1\expandafter{#2#1}}
29 \long\def\appendef#1#2{\expandafter\def\expandafter#1\expandafter{#1#2}}
31 %%% Page size and margins %%%
33 % If you modify these registers, call \setuppage afterwards
34 \ifx\luatexversion\undefined
35 % In LuaTeX, \pagewidth and \pageheight are primitive
42 \newdimen\bottommargin
43 \newdimen\evenpageshift
47 \advance\hsize by -\leftmargin
48 \advance\hsize by -\rightmargin
50 \advance\vsize by -\topmargin
51 \advance\vsize by -\bottommargin
53 \advance\hoffset by -1truein
55 \advance\voffset by -1truein
59 \ifx\luatexversion\undefined
60 \pdfpagewidth=\pagewidth
61 \pdfpageheight=\pageheight
66 % Set multiple margins to the same value
67 \def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
68 \def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
69 \def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}
71 % Define inner/outer margin instead of left/right
72 \def\setinneroutermargin#1#2{\leftmargin#1\relax\rightmargin#2\relax\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}
74 % Use a predefined paper format, calls \setuppage automagically
76 \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
77 \ifx\currentpaper\relax
78 \errmessage{Undefined paper format #1}
83 % Switch to landscape orientation, calls \setuppage automagically
86 \pageheight=\pagewidth
92 \def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
93 \defpaper{a3}{297truemm}{420truemm}
94 \defpaper{a4}{210truemm}{297truemm}
95 \defpaper{a5}{148truemm}{210truemm}
96 \defpaper{letter}{8.5truein}{11truein}
97 \defpaper{legal}{8.5truein}{14truein}
99 % Default page parameters
103 %%% Macros with optional arguments %%%
105 % After \def\a{\withoptarg\b}, the macro \a behaves in this way:
106 % \a[arg] does \def\optarg{arg} and then it expands \b
107 % \a does \let\optarg=\relax and then it expands \b
108 \def\withoptarg#1{\let\xoptcall=#1\futurelet\next\xopt}
109 \def\xopt{\ifx\next[\expandafter\xoptwith\else\let\optarg=\relax\expandafter\xoptcall\fi}
110 \def\xoptwith[#1]{\def\optarg{#1}\xoptcall}
112 % A shortcut for defining macros with optional arguments:
113 % \optdef\macro behaves as \def\domacro, while \macro itself is defined
114 % as a wrapper calling \domacro using \withoptarg.
116 \edef\xoptname{\expandafter\eatbackslash\string#1}%
117 \edef#1{\noexpand\withoptarg\csname do\xoptname\endcsname}%
118 \expandafter\def\csname do\xoptname\endcsname
121 % Trick: \eatbackslash eats the next backslash of category 12
122 \begingroup\lccode`\+=`\\
123 \lowercase{\endgroup\def\eatbackslash+{}}
125 % Expand to the optional argument if it exists
126 \def\optargorempty{\ifx\optarg\relax\else\optarg\fi}
128 %%% Placing material at specified coordinates %%%
130 % Set all dimensions of a given box register to zero
131 \def\smashbox#1{\ht#1=0pt \dp#1=0pt \wd#1=0pt}
132 \long\def\smashedhbox#1{{\setbox0=\hbox{#1}\smashbox0\box0}}
133 \long\def\smashedvbox#1{{\setbox0=\vbox{#1}\smashbox0\box0}}
135 % Variants of \llap and \rlap working equally on both sides and/or vertically
136 \def\hlap#1{\hbox to 0pt{\hss #1\hss}}
137 \def\vlap#1{\vbox to 0pt{\vss #1\vss}}
138 \def\clap#1{\vlap{\hlap{#1}}}
140 % \placeat{right}{down}{hmaterial} places <hmaterial>, so that its
141 % reference point lies at the given position wrt. the current ref point
142 \long\def\placeat#1#2#3{\smashedhbox{\hskip #1\lower #2\hbox{#3}}}
144 % Like \vbox, but with reference point in the upper left corner
145 \long\def\vhang#1{\vtop{\hrule height 0pt\relax #1}}
147 % Like \vhang, but respecting interline skips
148 \long\def\vhanglines#1{\vtop{\hbox to 0pt{}#1}}
150 % Crosshair with reference point in its center
151 \def\crosshair#1{\clap{\vrule height 0.2pt width #1}\clap{\vrule height #1 width 0.2pt}}
153 %%% Output routine %%%
155 \newbox\pageunderlays
157 \newbox\commonunderlays
158 \newbox\commonoverlays
160 % In addition to the normal page contents, you can define page overlays
161 % and underlays, which are zero-size vboxes positioned absolutely in the
162 % front / in the back of the normal material. Also, there are global
163 % versions of both which are not reset after every page.
164 \def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\nointerlineskip\smashedvbox{#2}}}
165 \def\pageunderlay{\addlay\pageunderlays}
166 \def\pageoverlay{\addlay\pageoverlays}
167 \def\commonunderlay{\addlay\commonoverlays}
168 \def\commonoverlay{\addlay\commonoverlays}
170 % Our variation on \plainoutput, which manages inner/outer margins and overlays
172 \newdimen\pagebodydepth
173 \def\ucwoutput{\wigglepage\shipout\vbox{%
175 \ifvbox\commonunderlays\copy\commonunderlays\nointerlineskip\fi
176 \ifvbox\pageunderlays\box\pageunderlays\nointerlineskip\fi
178 \pagebodydepth=\prevdepth
180 \ifvbox\commonoverlays\vbox to 0pt{\vskip -\vsize\copy\commonoverlays\vss}\nointerlineskip\fi
181 \ifvbox\pageoverlays\vbox to 0pt{\vskip -\vsize\box\pageoverlays\vss}\nointerlineskip\fi
182 \prevdepth=\pagebodydepth
185 \ifnum\outputpenalty>-\@MM \else\dosupereject\fi}
187 \def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}
189 % Make it easier to redefine footline font (also, fix it so that OFS won't change it unless asked)
191 \footline={\hss\footfont\folio\hss}
195 % Default dimensions of itemized lists
196 \newdimen\itemindent \itemindent=0.5in
197 \newdimen\itemnarrow \itemnarrow=0.5in % make lines narrower by this amount
198 \newskip\itemmarkerskip \itemmarkerskip=0.4em % between marker and the item
199 \newskip\preitemizeskip \preitemizeskip=3pt plus 2pt minus 1pt % before the list
200 \newskip\postitemizeskip \postitemizeskip=3pt plus 2pt minus 1pt % after the list
201 \newskip\interitemskip \interitemskip=2pt plus 1pt minus 0.5pt % between two items
203 % Analogues for nested lists
204 \newdimen\nesteditemindent \nesteditemindent=0.25in
205 \newdimen\nesteditemnarrow \nesteditemnarrow=0.25in
206 \newskip\prenesteditemizeskip \prenesteditemizeskip=0pt
207 \newskip\postnesteditemizeskip \postnesteditemizeskip=0pt
209 \newif\ifitems\itemsfalse
215 \vskip\prenesteditemizeskip
216 \advance\leftskip by \nesteditemindent
217 \advance\rightskip by \nesteditemnarrow
219 \vskip\preitemizeskip
220 \advance\leftskip by \itemindent
221 \advance\rightskip by \itemnarrow
223 \parskip=\interitemskip
228 \vskip\postnesteditemizeskip
230 \vskip\postitemizeskip
234 \def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}
236 \def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
239 \def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}
241 \def\endlist{\par\endgroup\postitemize}
243 \def\ibull{\raise0.2ex\hbox{$\bullet$}} % Signs frequently used for \itemize
244 \def\idot{\raise0.2ex\hbox{$\cdot$}}
245 \def\istar{\raise0.2ex\hbox{$\ast$}}
247 \def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
248 \let\itemnumbering=#1}
250 \def\numbereditem{\par\leavevmode\advance\itemcount by 1
251 \llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
253 \def\nnorm{\the\itemcount}
254 \def\ndotted{\nnorm.}
256 \def\nparenp{(\nnorm)}
257 \def\nroman{\romannumeral\itemcount}
258 \def\nromanp{\nroman)}
259 \def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
260 \def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
261 \def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
262 \zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
263 \or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}
267 % {\I italic} with automatic italic correction
268 \def\I{\it\aftergroup\/}
270 % A breakable dash, to be repeated on the next line
271 \def\={\discretionary{-}{-}{-}}
273 % Non-breakable identifiers
274 \def\<#1>{\leavevmode\hbox{\I #1}}
280 % Variants of \centerline, \leftline and \rightline, which are compatible with
281 % verbatim environments and other catcode hacks
282 \def\cline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
283 \def\lline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
284 \def\rline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
286 % Insert a PDF picture
287 % \putimage{width specification}{file}
288 \def\putimage#1#2{\hbox{\pdfximage #1{#2}\pdfrefximage\pdflastximage}}
292 \protected\def~{\plaintilde}
296 % Let's hide all internal macros