]> mj.ucw.cz Git - ucwmac.git/commitdiff
More comments
authorMartin Mares <mj@ucw.cz>
Wed, 6 Jun 2018 10:04:48 +0000 (12:04 +0200)
committerMartin Mares <mj@ucw.cz>
Wed, 6 Jun 2018 10:04:48 +0000 (12:04 +0200)
ucwmac.tex

index 6f28ef07e37b9bbb58e4f6021fe9fa8534a2bb70..87c0b4608ac2cbc83a85d371aa5e06992f2f44bf 100644 (file)
 
 %%% Itemization %%%
 
+% Usage:
+%
+% \itemize\ibull       % or other marker
+% \:first item
+% \:second item
+% \endlist
+%
+% \numlist\ndotted     % or other numbering style
+% \:first
+% \:second
+% \endlist
+
 % Default dimensions of itemized lists
 \newdimen\itemindent           \itemindent=0.5in
 \newdimen\itemnarrow           \itemnarrow=0.5in                       % make lines narrower by this amount
 
 \def\endlist{\par\endgroup\postitemize}
 
-\def\ibull{\raise0.2ex\hbox{$\bullet$}} % Signs frequently used for \itemize
+% Markers for \itemize
+\def\ibull{\raise0.2ex\hbox{$\bullet$}}
 \def\idot{\raise0.2ex\hbox{$\cdot$}}
 \def\istar{\raise0.2ex\hbox{$\ast$}}
 
 \def\numbereditem{\par\leavevmode\advance\itemcount by 1
 \llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
 
+% Numbering styles for \numlist
 \def\nnorm{\the\itemcount}
 \def\ndotted{\nnorm.}
 \def\nparen{\nnorm)}
 
 %%% Modules %%%
 
+% Require a module: load it if it is not already loaded
 \def\ucwmodule#1{
        \ifcsname ucwmod:#1\endcsname
        \else
        \fi
 }
 
+% Definition of a new module (to be placed at the beginning of its file)
+% (Also guards against repeated loading if somebody uses \input instead of \ucwmodule.)
 \def\ucwdefmodule#1{
        \ifcsname ucwmod:#1\endcsname\endinput\fi
        \expandafter\let\csname ucwmod:#1\endcsname=\relax