From: Martin Mares <mj@ucw.cz>
Date: Wed, 6 Jun 2018 10:04:48 +0000 (+0200)
Subject: More comments
X-Git-Tag: v1.99~1^2~14
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=f858ee391f0a68981e4a5e5a88411966b73c60e6;p=ucwmac.git

More comments
---

diff --git a/ucwmac.tex b/ucwmac.tex
index 6f28ef0..87c0b46 100644
--- a/ucwmac.tex
+++ b/ucwmac.tex
@@ -201,6 +201,18 @@
 
 %%% 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
@@ -249,7 +261,8 @@
 
 \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$}}
 
@@ -259,6 +272,7 @@
 \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)}
@@ -328,6 +342,7 @@
 
 %%% Modules %%%
 
+% Require a module: load it if it is not already loaded
 \def\ucwmodule#1{
 	\ifcsname ucwmod:#1\endcsname
 	\else
@@ -335,6 +350,8 @@
 	\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