]> mj.ucw.cz Git - ucwmac.git/blobdiff - ucwmac.tex
Introduced \footfont
[ucwmac.git] / ucwmac.tex
index 3bb1091146d7f71806812b0b67e52ddec8b003d1..67a9c4d332803bacfcd8fa34bb7f4f92b4226bd2 100644 (file)
@@ -1,7 +1,13 @@
+% The UCW Macro Collection (a successor of mjmac.tex)
+% Written by Martin Mares <mj@ucw.cz> in 2010 and placed into public domain
+% -------------------------------------------------------------------------
+
+%%% Prolog %%%
+
 % We'll use internal macros of plain TeX
 \catcode`@=11
 
-%%% PDF output switch %%%
+%%% PDF output detection %%%
 
 \newif\ifpdf
 \pdffalse
@@ -13,6 +19,7 @@
 
 %%% Page size and margins %%%
 
+% If you modify these registers, call \setuppage afterwards
 \newdimen\pagewidth
 \newdimen\pageheight
 \newdimen\leftmargin
        \fi
 }
 
+% Set multiple margins to the same value
 \def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
 \def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
 \def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}
 
+% Define inner/outer margin instead of left/right
 \def\setinneroutermargin#1#2{\sethmargins{#1}{#2}\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}
 
-\def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
+% Use a predefined paper format, calls \setuppage automagically
 \def\setpaper#1{%
        \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
        \ifx\currentpaper\relax
@@ -53,6 +62,7 @@
        \currentpaper
 }
 
+% Switch to landscape orientation, calls \setuppage automagically
 \def\landscape{%
        \dimen0=\pageheight
        \pageheight=\pagewidth
@@ -60,6 +70,8 @@
        \setuppage
 }
 
+% Common paper sizes
+\def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
 \defpaper{a3}{297truemm}{420truemm}
 \defpaper{a4}{210truemm}{297truemm}
 \defpaper{a5}{148truemm}{210truemm}
@@ -67,6 +79,7 @@
 \defpaper{letter}{8.5truein}{11truein}
 \defpaper{legal}{8.5truein}{14truein}
 
+% Default page parameters
 \setmargins{1truein}
 \setpaper{a4}
 
 \newbox\commonunderlays
 \newbox\commonoverlays
 
-% Adding to {over,under}-lays
+% In addition to the normal page contents, you can define page overlays
+% and underlays, which are zero-size vboxes positioned absolutely in the
+% front / in the back of the normal material. Also, there are global
+% versions of both which are not reset after every page.
 \def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\smashedvbox{#2}}}
 \def\pageunderlay{\addlay\pageunderlays}
 \def\pageoverlay{\addlay\pageoverlays}
 \def\commonunderlay{\addlay\commonoverlays}
 \def\commonoverlay{\addlay\commonoverlays}
 
+% Our variation on \plainoutput, which manages inner/outer margins and overlays
 \output{\ucwoutput}
 \def\ucwoutput{\wigglepage\shipout\vbox{%
        \makeheadline
 
 \def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}
 
-%%% Cleanup %%%
+% Make it easier to redefine footline font (also, fix it so that OFS won't change it unless asked)
+\let\footfont=\tenrm
+\footline={\hss\footfont\folio\hss}
+
+%%% Itemization %%%
+
+% Default dimensions of itemized lists
+\newdimen\itemindent           \itemindent=0.5in
+\newdimen\itemnarrow           \itemnarrow=0.5in                       % make lines narrower by this amount
+\newskip\itemmarkerskip                \itemmarkerskip=0.4em                   % between marker and the item
+\newskip\preitemizeskip                \preitemizeskip=3pt plus 2pt minus 1pt  % before the list
+\newskip\postitemizeskip       \postitemizeskip=3pt plus 2pt minus 1pt % after the list
+\newskip\interitemskip         \interitemskip=2pt plus 1pt minus 0.5pt % between two items
+
+% Analogues for nested lists
+\newdimen\nesteditemindent     \nesteditemindent=0.25in
+\newdimen\nesteditemnarrow     \nesteditemnarrow=0.25in
+\newskip\prenesteditemizeskip  \prenesteditemizeskip=0pt
+\newskip\postnesteditemizeskip \postnesteditemizeskip=0pt
+
+\newif\ifitems\itemsfalse
+\newbox\itembox
+\newcount\itemcount
+
+\def\preitemize{
+       \ifitems
+               \vskip\prenesteditemizeskip
+               \advance\leftskip by \nesteditemindent
+               \advance\rightskip by \nesteditemnarrow
+       \else
+               \vskip\preitemizeskip
+               \advance\leftskip by \itemindent
+               \advance\rightskip by \itemnarrow
+       \fi
+       \parskip=\interitemskip
+}
+
+\def\postitemize{
+       \ifitems
+               \vskip\postnesteditemizeskip
+       \else
+               \vskip\postitemizeskip
+       \fi
+}
+
+\def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}
+
+\def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
+\let\:=\singleitem}
+
+\def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}
+
+\def\endlist{\par\endgroup\postitemize}
+
+\def\ibull{\raise0.2ex\hbox{$\bullet$}} % Signs frequently used for \itemize
+\def\idot{\raise0.2ex\hbox{$\cdot$}}
+\def\istar{\raise0.2ex\hbox{$\ast$}}
+
+\def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
+\let\itemnumbering=#1}
+
+\def\numbereditem{\par\leavevmode\advance\itemcount by 1
+\llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
+
+\def\nnorm{\the\itemcount}
+\def\ndotted{\nnorm.}
+\def\nparen{\nnorm)}
+\def\nroman{\romannumeral\itemcount}
+\def\nromanp{\nroman)}
+\def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
+\def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
+\def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
+\zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
+\or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}
+
+%%% Miscellanea %%%
+
+% {\I italic} with automatic italic correction
+\def\I{\it\aftergroup\/}
+
+% A breakable dash, to be repeated on the next line
+\def\={\discretionary{-}{-}{-}}
+
+% Non-breakable identifiers
+\def\<#1>{\leavevmode\hbox{\I #1}}
+
+% A handy shortcut
+\let\>=\noindent
+
+%%% Epilog %%%
 
 % Let's hide all internal macros
 \catcode`@=12