Debian Codegraph @

texmf-dist/tex/plain/zztex/zzlist.tex

raw
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %
3 % Module: ZzTeX List Facilities
4 %
5 % Synopsis:
6 %
7 % Author: Paul C. Anagnostopoulos
8 % Created: 12 September 1989
9 %
10 % Copyright 1989--2020 by Paul C. Anagnostopoulos
11 % under The MIT License (opensource.org/licenses/MIT)
12 %
13 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14
15 % List Block
16 % ---- -----
17
18
19 \defineblock{\list}{\endlist}{\false}{}
20 \resetinvcontext{\list}
21
22 %~block list Type, Level
23 % \abovepenalty = integer % Penalty above list.
24 % \aboveskip = glue % Space b/b above list.
25 % \setflag \allowitemtag = flag % Allow \tag command on item.
26 % \belowpenalty = integer % Penalty below list.
27 % \belowskip = glue % Space b/b below list.
28 % \bodyfont = {...} % Font for text.
29 % \def \endpartext {...} % Text at end of each paragraph.
30 % \interitemskip = skip % Extra space between items.
31 % \itemnumber = integer % Number of first item.
32 % \def \labelformat ##1{...} % Item label formatter.
33 % \labelshift = dimen % Horizontal shift of label.
34 % \def \labeltext {...} % Label text or \arg if \item{...}.
35 % \labelwidth = dimen % Width of label or \naturalwidth.
36 % \leftindent = glue % Left indentation.
37 % \parindent = glue % Paragraph indent.
38 % \parrag = dimen % Paragraph raggedness.
39 % \parskip = glue % Paragraph skip.
40 % \rightindent = glue % Right indentation.
41 % \def \tagcomptext {...} % Composite text for tag, if not label.
42 % \width = dimen % Width of text.
43 %~end
44
45 \defineskip{\interitemskip}{0pt}
46 \definedimen{\labelshift}{0pt}
47 \definedimen{\labelwidth}{0pt}
48
49 \definecount{\nextitemnumber}{0}
50
51
52 \def \list #1{% {type}
53 \endgraf
54 \beginblockscope{list}%
55 \global\increment \listdepth
56 \abovepenalty = \breakgood %~default hard
57 \setflag \allowitemtag = \false %~default soft
58 \belowpenalty = \breakgood %~default hard
59 \def \endpartext {}% %~default hard
60 \itemnumber = 1 %~default with
61 \def \tagcomptext {}% %~default soft
62 \processdesign{\list}{#1\romannumeral\listdepth}%
63 \global\increment \listnumber
64 \decrement \itemnumber
65 \listformat
66 \def \par {\endpartext \endgraf}%
67 \settaginfo{}{}} % No tag info so far.
68
69 \def \endlist {%
70 \par
71 \futurelet\nexttoken \zendlist}
72
73 \def \zendlist {%
74 \closeifinblock{\item}{\enditem}%
75 \endlistformat
76 \if \onep{\listdepth}%
77 \global\nextitemnumber = \itemnumber
78 \global\increment \nextitemnumber
79 \fi
80 \global\decrement \listdepth
81 \endblockscope{list}%
82 \parnext}
83
84 \def \listformat {%
85 \the\bodyfont
86 \bbskipabove{\abovepenalty}{\aboveskip}%
87 \alterindentation{\leftindent}{\rightindent}%
88 \settextwidth{\width}%
89 \setparrag{\parrag}%
90 \advance \interitemskip by \baselineskip}
91
92 \def \endlistformat{%
93 \bbskipbelowblockpar{\nexttoken}{\belowpenalty}{\belowskip}}
94
95
96 % This macro helps with a list design that involves measuring some text.
97
98 \def \setmeasuredlabel #1#2#3{% {extra-indent}{template}{formatter}
99 \def \labelformat ##1{#3}%
100 \measuretextwidth{\labelwidth}{#2}%
101 \labelshift = -\labelwidth
102 \leftindent = \labelwidth
103 \advance \leftindent by #1\relax}
104
105 \def \adjustinteritemskip #1{% {amount} %^modifier
106 \with{\advance\interitemskip by #1}}
107
108 %~ This modifier on |\list| is used when a list immediately follows
109 %~ an |\item| command; that is, when an item is a sublist.
110 %~ It eliminates the vertical space above the sublist.
111
112 \def \immediatesublist {% %^modifier
113 \with{\abovepenalty = \breaknever
114 \aboveskip = 0pt}}
115
116 % Item Block
117 % ---- -----
118
119 % The \item block is subordinate to the \list block, and thus inherits all
120 % of its design parameters from \list.
121
122
123 \defineblock{\item}{\enditem}{\false}{}
124
125 %~block item
126 % \difficulty = integer % Level of difficulty.
127 %~end
128
129 \def \item {% [{label}]
130 \blockmustbein{\item}{\list}%
131 \closeifinblock{\item}{\enditem}%
132 % Don't bother with block scope.
133 \difficulty = 0 %~default with
134 \zprocesswith % Instead of \processdesign.
135 \increment \itemnumber
136 \bbskipabove{\breakgood}{\interitemskip}%
137 \def \zarg {\arg}%
138 \if \tokeqlp{\labeltext}{\zarg}%
139 \def \znext {\itemformat}%
140 \else
141 \def \znext {\itemformat{\labeltext}}%
142 \fi
143 \znext}
144
145 \def \enditem {%
146 \par}
147
148 \def \itemformat #1{% {label}
149 \noindent
150 \kern \labelshift
151 \if \dimeqlp{\labelwidth}{\naturalwidth}%
152 {\labelformat{#1}}%
153 \else
154 \hbox to \labelwidth{\labelformat{#1}}%
155 \fi
156 \if \allowitemtag
157 \if \emptydefp{\tagcomptext}%
158 \settaginfo{#1}{???}%
159 \else
160 \settaginfo{\tagcomptext}{???}%
161 \fi
162 \fi
163 \ignorespaces}