ucwmac.tex

   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 % -------------------------------------------------------------------------------
   4
   5 %%% Prolog %%%
   6
   7 % We'll use internal macros of plain TeX
   8 \catcode`@=11
   9
  10 \ifx\eTeXversion\undefined
  11 \errmessage{ucwmac requires the e-TeX engine or its successor}
  12 \fi
  13
  14 %%% PDF output detection %%%
  15
  16 \newif\ifpdf
  17 \pdffalse
  18
  19 \ifx\pdfoutput\undefined
  20 \else\ifnum\pdfoutput>0
  21         \pdftrue
  22         \pdfpkresolution=600    % Provide a reasonable default
  23 \fi\fi
  24
  25 %%% Page size and margins %%%
  26
  27 % If you modify these registers, call \setuppage afterwards
  28 \newdimen\pagewidth
  29 \newdimen\pageheight
  30 \newdimen\leftmargin
  31 \newdimen\rightmargin
  32 \newdimen\topmargin
  33 \newdimen\bottommargin
  34 \newdimen\evenpageshift
  35
  36 \def\setuppage{%
  37         \hsize=\pagewidth
  38         \advance\hsize by -\leftmargin
  39         \advance\hsize by -\rightmargin
  40         \vsize=\pageheight
  41         \advance\vsize by -\topmargin
  42         \advance\vsize by -\bottommargin
  43         \hoffset=\leftmargin
  44         \advance\hoffset by -1truein
  45         \voffset=\topmargin
  46         \advance\voffset by -1truein
  47         \ifpdf
  48                 \pdfhorigin=1truein
  49                 \pdfvorigin=1truein
  50                 \pdfpagewidth=\pagewidth
  51                 \pdfpageheight=\pageheight
  52         \fi
  53 }
  54
  55 % Set multiple margins to the same value
  56 \def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
  57 \def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
  58 \def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}
  59
  60 % Define inner/outer margin instead of left/right
  61 \def\setinneroutermargin#1#2{\leftmargin#1\relax\rightmargin#2\relax\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}
  62
  63 % Use a predefined paper format, calls \setuppage automagically
  64 \def\setpaper#1{%
  65         \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
  66         \ifx\currentpaper\relax
  67                 \errmessage{Undefined paper format #1}
  68         \fi
  69         \currentpaper
  70 }
  71
  72 % Switch to landscape orientation, calls \setuppage automagically
  73 \def\landscape{%
  74         \dimen0=\pageheight
  75         \pageheight=\pagewidth
  76         \pagewidth=\dimen0
  77         \setuppage
  78 }
  79
  80 % Common paper sizes
  81 \def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
  82 \defpaper{a3}{297truemm}{420truemm}
  83 \defpaper{a4}{210truemm}{297truemm}
  84 \defpaper{a5}{148truemm}{210truemm}
  85 \defpaper{letter}{8.5truein}{11truein}
  86 \defpaper{legal}{8.5truein}{14truein}
  87
  88 % Default page parameters
  89 \setmargins{1truein}
  90 \setpaper{a4}
  91
  92 %%% Placing material at specified coordinates %%%
  93
  94 % Set all dimensions of a given box register to zero
  95 \def\smashbox#1{\ht#1=0pt \dp#1=0pt \wd#1=0pt}
  96 \long\def\smashedhbox#1{{\setbox0=\hbox{#1}\smashbox0\box0}}
  97 \long\def\smashedvbox#1{{\setbox0=\vbox{#1}\smashbox0\box0}}
  98
  99 % Variants of \llap and \rlap working equally on both sides and/or vertically
 100 \def\hlap#1{\hbox to 0pt{\hss #1\hss}}
 101 \def\vlap#1{\vbox to 0pt{\vss #1\vss}}
 102 \def\clap#1{\vlap{\hlap{#1}}}
 103
 104 % \placeat{right}{down}{hmaterial} places <hmaterial>, so that its
 105 % reference point lies at the given position wrt. the current ref point
 106 \long\def\placeat#1#2#3{\smashedhbox{\hskip #1\lower #2\hbox{#3}}}
 107
 108 % Like \vbox, but with reference point in the upper left corner
 109 \long\def\vhang#1{\vtop{\hrule height 0pt\relax #1}}
 110
 111 % Like \vhang, but respecting interline skips
 112 \long\def\vhanglines#1{\vtop{\hbox to 0pt{}#1}}
 113
 114 % Crosshair with reference point in its center
 115 \def\crosshair#1{\clap{\vrule height 0.2pt width #1}\clap{\vrule height #1 width 0.2pt}}
 116
 117 %%% Output routine %%%
 118
 119 \newbox\pageunderlays
 120 \newbox\pageoverlays
 121 \newbox\commonunderlays
 122 \newbox\commonoverlays
 123
 124 % In addition to the normal page contents, you can define page overlays
 125 % and underlays, which are zero-size vboxes positioned absolutely in the
 126 % front / in the back of the normal material. Also, there are global
 127 % versions of both which are not reset after every page.
 128 \def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\nointerlineskip\smashedvbox{#2}}}
 129 \def\pageunderlay{\addlay\pageunderlays}
 130 \def\pageoverlay{\addlay\pageoverlays}
 131 \def\commonunderlay{\addlay\commonoverlays}
 132 \def\commonoverlay{\addlay\commonoverlays}
 133
 134 % Our variation on \plainoutput, which manages inner/outer margins and overlays
 135 \output{\ucwoutput}
 136 \newdimen\pagebodydepth
 137 \def\ucwoutput{\wigglepage\shipout\vbox{%
 138         \makeheadline
 139         \ifvbox\commonunderlays\copy\commonunderlays\nointerlineskip\fi
 140         \ifvbox\pageunderlays\box\pageunderlays\nointerlineskip\fi
 141         \pagebody
 142         \pagebodydepth=\prevdepth
 143         \nointerlineskip
 144         \ifvbox\commonoverlays\vbox to 0pt{\vskip -\vsize\copy\commonoverlays\vss}\nointerlineskip\fi
 145         \ifvbox\pageoverlays\vbox to 0pt{\vskip -\vsize\box\pageoverlays\vss}\nointerlineskip\fi
 146         \prevdepth=\pagebodydepth
 147         \makefootline
 148 }\advancepageno
 149 \ifnum\outputpenalty>-\@MM \else\dosupereject\fi}
 150
 151 \def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}
 152
 153 % Make it easier to redefine footline font (also, fix it so that OFS won't change it unless asked)
 154 \let\footfont=\tenrm
 155 \footline={\hss\footfont\folio\hss}
 156
 157 %%% Itemization %%%
 158
 159 % Default dimensions of itemized lists
 160 \newdimen\itemindent            \itemindent=0.5in
 161 \newdimen\itemnarrow            \itemnarrow=0.5in                       % make lines narrower by this amount
 162 \newskip\itemmarkerskip         \itemmarkerskip=0.4em                   % between marker and the item
 163 \newskip\preitemizeskip         \preitemizeskip=3pt plus 2pt minus 1pt  % before the list
 164 \newskip\postitemizeskip        \postitemizeskip=3pt plus 2pt minus 1pt % after the list
 165 \newskip\interitemskip          \interitemskip=2pt plus 1pt minus 0.5pt % between two items
 166
 167 % Analogues for nested lists
 168 \newdimen\nesteditemindent      \nesteditemindent=0.25in
 169 \newdimen\nesteditemnarrow      \nesteditemnarrow=0.25in
 170 \newskip\prenesteditemizeskip   \prenesteditemizeskip=0pt
 171 \newskip\postnesteditemizeskip  \postnesteditemizeskip=0pt
 172
 173 \newif\ifitems\itemsfalse
 174 \newbox\itembox
 175 \newcount\itemcount
 176
 177 \def\preitemize{
 178         \ifitems
 179                 \vskip\prenesteditemizeskip
 180                 \advance\leftskip by \nesteditemindent
 181                 \advance\rightskip by \nesteditemnarrow
 182         \else
 183                 \vskip\preitemizeskip
 184                 \advance\leftskip by \itemindent
 185                 \advance\rightskip by \itemnarrow
 186         \fi
 187         \parskip=\interitemskip
 188 }
 189
 190 \def\postitemize{
 191         \ifitems
 192                 \vskip\postnesteditemizeskip
 193         \else
 194                 \vskip\postitemizeskip
 195         \fi
 196 }
 197
 198 \def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}
 199
 200 \def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
 201 \let\:=\singleitem}
 202
 203 \def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}
 204
 205 \def\endlist{\par\endgroup\postitemize}
 206
 207 \def\ibull{\raise0.2ex\hbox{$\bullet$}} % Signs frequently used for \itemize
 208 \def\idot{\raise0.2ex\hbox{$\cdot$}}
 209 \def\istar{\raise0.2ex\hbox{$\ast$}}
 210
 211 \def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
 212 \let\itemnumbering=#1}
 213
 214 \def\numbereditem{\par\leavevmode\advance\itemcount by 1
 215 \llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
 216
 217 \def\nnorm{\the\itemcount}
 218 \def\ndotted{\nnorm.}
 219 \def\nparen{\nnorm)}
 220 \def\nparenp{(\nnorm)}
 221 \def\nroman{\romannumeral\itemcount}
 222 \def\nromanp{\nroman)}
 223 \def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
 224 \def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
 225 \def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
 226 \zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
 227 \or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}
 228
 229 %%% Miscellanea %%%
 230
 231 % {\I italic} with automatic italic correction
 232 \def\I{\it\aftergroup\/}
 233
 234 % A breakable dash, to be repeated on the next line
 235 \def\={\discretionary{-}{-}{-}}
 236
 237 % Non-breakable identifiers
 238 \def\<#1>{\leavevmode\hbox{\I #1}}
 239
 240 % A handy shortcut
 241 \let\>=\noindent
 242
 243 % Variants of \centerline, \leftline and \rightline, which are compatible with
 244 % verbatim environments and other catcode hacks
 245 \def\cline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
 246 \def\lline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
 247 \def\rline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
 248
 249 %%% Epilog %%%
 250
 251 % Let's hide all internal macros
 252 \catcode`@=12