ucwmac.tex

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