Debian Codegraph @

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

raw
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %
3 % Module: ZzTeX Help Text
4 %
5 % Synopsis: This file contains the help text for each error and
6 % warning signaled by ZzTeX.
7 %
8 % Author: Paul C. Anagnostopoulos
9 % Created: 3 July 1990
10 %
11 % Copyright 1989--2020 by Paul C. Anagnostopoulos
12 % under The MIT License (opensource.org/licenses/MIT)
13 %
14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15
16
17 \long\def \definehelp #1#2{% {help-id}{text}
18 \withname\gdef{\=zH:#1}{#2}}
19
20
21 \definehelp{adjheads}{
22 You must eliminate the inter-row space between two adjacent rows_
23 of column heads. This is done with the \closeuprows command.}
24
25 \definehelp{altinv}{
26 The design alternative named above was specified with an_
27 invalid value in a \designalternative command.}
28
29 \definehelp{altreq}{
30 The design alternative named above must be specifed with a_
31 \designalternative command preceding the \loaddesign in_
32 your root file. There is no default.}
33
34 \definehelp{artpos}{
35 The \art command is in the wrong position relative to the_
36 \caption command.}
37
38 \definehelp{blkcantnest}{
39 The file contains an occurence of the first block mentioned above_
40 nested inside the second block. This is not allowed.}
41
42 \definehelp{blkinvnest}{
43 A command to end a block is not properly associated with the command_
44 to begin the block. For example, an \endtext is matched with a \list._
45 All blocks must be properly nested.}
46
47 \definehelp{blkmustend}{
48 The file contains an occurence of the block ending command_
49 mentioned first, but it is not preceded by the block starting_
50 command mentioned second. Each block must have a starting command.}
51
52 \definehelp{blkmustnest}{
53 The file contains an occurence of the first block mentioned above,_
54 but it is not nested inside the second block. The first block_
55 must be nested in the second.}
56
57 \definehelp{cananchor}{
58 The object anchor specified mentioned above is invalid._
59 Valid anchors are 'a' -- 'h'.}
60
61 \definehelp{celldecpt}{
62 The picutre for this decimal-aligned cell did not include a decimal_
63 point, but the number to be typeset does. You must include a_
64 decimal point in the template or remove it from the number.}
65
66 \definehelp{citelet}{
67 It appears that you have used \let to define a \citexxx command_
68 in the design file. This done not work; use \def instead.}
69
70 \definehelp{desjunk}{
71 The design file named above contains some paragraph (horizontal mode)_
72 text that should not be there.__
73 You probably left a percent sign off a comment.}
74
75 \definehelp{divnotexist}{
76 The division specified in the message is not included with a_
77 \division command in the root file.}
78
79 \definehelp{dupart}{
80 The art file named above is used more than once in the book.__
81 If a figure really is used more than once, you must copy it with
82 another name and change one of the \art commands.}
83
84 \definehelp{dupreg}{
85 The register named above has already been defined with another_
86 \definexxx command.}
87
88 \definehelp{divortah}{
89 The \overridetextareaheight command has been used to override the_
90 text area height, but the override crosses from one division to the next.__
91 If you continue from the warning, the override will be cancelled.}
92
93 \definehelp{empshape}{
94 The \shapepar command must be specified with at least one pair of_
95 indent/width arguments. You have specified one with no arguments.}
96
97 \definehelp{hereonlybot}{
98 ZzTeX cannot position the float `here' because there is already_
99 a float positioned at the bottom of the page. Floats must be_
100 positioned in order.}
101
102 \definehelp{invindexlvl}{
103 The level specified in an indexing command must be 1, 2, or 3.}
104
105 \definehelp{invoper}{
106 The operator shown above is not valid in the expression argument_
107 of the \calculate command.}
108
109 \definehelp{invsubpart}{
110 The subpart argument to \markinfo(upcased) must be 1 or 2._
111 You have specified the invalid subpart number shown above.}
112
113 \definehelp{locattr}{
114 The attributes of the index locator are not valid. You must specify_
115 at least one of \page or \text.}
116
117 \definehelp{missbb}{
118 The specified art file does not have a bounding box comment, so_
119 ZzTeX cannot determine the size of the art.}
120
121 \definehelp{misset}{
122 A tabular column template must begin with \set, so that the column
123 type will be correctly interpreted.}
124
125 \definehelp{misstah}{
126 The value of \textareaheight must be established by the document_
127 design macro before \calculatetypeareaheight can be used.__
128 You can set it directly or calculate it with \calculatetextareaheight.}
129
130 \definehelp{misstopskip}{
131 The value of \topskip must be established by the document design_
132 macro before \calculatetextareaheight can be used.}
133
134 \definehelp{misstrim}{
135 The values of \trimwidth and \trimheight must be established by the_
136 document design macro before \calculateoffsets can be used}
137
138 \definehelp{needheads}{
139 The \tabheadrule and \skipbelowcolhead commands require that the_
140 previous row is a row of heads.}
141
142 \definehelp{negtabvsp}{
143 A negative \tabvspace will not work; it produces no spacing at all._
144 You must use \tabcloseup.}
145
146 \definehelp{noartfile}{
147 You have requested the art file named above for an \art block,_
148 but the file does not exist.__
149 If you continue from this warning, the art space will be framed_
150 with corner marks and contain the name of the missing file.}
151
152 \definehelp{nobblfile}{
153 You have requested a bibliography list with the \biblio command,_
154 but there is no bibliography item file.__
155 If you continue from this warning, the bibliography list will not_
156 be typeset. You must first run BibTeX to produce the item file.}
157
158 \definehelp{nodesfile}{
159 The design file named above is required for this book, but it_
160 does not exist.__
161 You may have misspelled the name of the design file in the_
162 \loaddesign command. If not, the design file must be created.}
163
164 \definehelp{nodesign}{
165 The file contains a use of the block named above, but the_
166 book's design file does not contain a design macro_
167 for the block.__
168 It's possible you have misspelled the name of the block_
169 or its type (if any). If not, a design macro must be_
170 added to the design file.}
171
172 \definehelp{nodivs}{
173 The \setdivisions command must specify one or more divisions to set.}
174
175 \definehelp{noend}{
176 Do not use the \end command in ZzTeX. The root file is terminated_
177 with the \enddocument command.__
178 If you are trying to end a block, such as a \list block, you must_
179 use the corresponding ending command, such as \endlist.}
180
181 \definehelp{nofloatpos}{
182 The \position parameter for a float does not specify any_
183 page positions for the float. The page positions are \alone,_
184 \bottom, \here, \separate, and \top. Without a page_
185 position, the float cannot be placed on the page.__
186 This error could be due to a missing position in the design file._
187 Or, you may have specified the \position parameter in a \with_
188 command on the float block and forgotten to include any of the_
189 page positions.__
190 If you continue, the float will be placed alone on a page. This_
191 message may appear again for the same float.}
192
193 \definehelp{nofontset}{
194 The file has requested a font of the size and style mentioned above._
195 No font has been set for this size/style in the book's design file.__
196 You may have misspelled the name of the size or style. If not,_
197 the appropriate font must be established in the design file.}
198
199 \definehelp{noheadfoot}{
200 The design file does not contain a definition for the header_
201 or footer format specified in the message. These definitions_
202 must be included in the design file.}
203
204 \definehelp{noinclfile}{
205 The file mentioned above has been requested with an \include or_
206 \division command, but it does not exist.__
207 You may have misspelled the name of the file. If not, you must_
208 create it before processing the book again.__
209 If you continue from this error, ZzTeX will prompt you for another_
210 file name.}
211
212 \definehelp{nomarks}{
213 The \markinfo command is being used to format a running head_
214 or foot, but no mark information has been provided for the_
215 current page.__
216 This only happens at the beginning of a book, before the first_
217 chapter or quasichapter. You may have set running heads and_
218 feet with \setrunners before the first chapter or quasichapter.}
219
220 \definehelp{nomnpos}{
221 The \position parameter for a margin note does not specify any_
222 horizontal position for the float. The positions are \leftmargin,_
223 \rightmargin, and \outsidemargin.}
224
225 \definehelp{noreftitle}{
226 The use of the \reftitle command has been disabled in the_
227 design file with the \allowreftitle document parameter.__
228 If you did not intend to use the \reftitle command, you must_
229 remove it from the file. If you need to use it, then modify_
230 the design file appropriately.}
231
232 \definehelp{noregsleft}{
233 All of the available registers of the type specified in the_
234 message have been allocated for use, but a request for another_
235 such register has been made.}
236
237 \definehelp{norelstyle}{
238 You have requested a type style related to the current style,_
239 but no such relation has been established. For example, the_
240 current style is \tt and you want to emphasize text with the_
241 \emph command, but no style for emphasizing monospaced text_
242 has been established.__
243 Use the \definestylerelation command to establish the appropriate_
244 relationship.}
245
246 \definehelp{notaginfo}{
247 A \tag command has been specified in the current block, but_
248 the composite number and title has not been established yet.}
249
250 \definehelp{notindexing}{
251 ZzTeX has encountered an indexing command (e.g., \xpage), but_
252 you have not included a \produceindex command in the root file._
253 At least one \produceindex command is required if the files contain_
254 indexing commands.__
255 If you continue from the warning, the index entries will be written_
256 to the log file.}
257
258 \definehelp{notps}{
259 The feature show above is only available when you are producing_
260 PostScript output. It requires PostScript capabilities.}
261
262 \definehelp{nowith}{
263 The \with modifier is not allowed on the command specified in the_
264 message. You must remove the \with modifier.__
265 If you continue from this warning, the \with will be ignored._
266 If you used \with on an \item command, use it on the \list_
267 command instead (it will apply to the entire list).}
268
269 \definehelp{obsolete}{
270 The command named above is obsolete in this version of ZzTeX.}
271
272 \definehelp{openblock}{
273 One or more blocks are in progress at the end of a chapter,_
274 appendix, or quasichapter. The names of the blocks are listed_
275 in messages preceding this warning.__
276 The problem is caused by missing \endxxx commands. For example,_
277 you have coded a list but forgotten the \endlist command. You_
278 will probably see the message `(\end occurred inside a group at_
279 level 1)' at the end of the log.}
280
281 \definehelp{overortah}{
282 The \overridetextareaheight command has been used to override the_
283 text area height, but a previous override is still in progress.__
284 If you continue from the warning, the first command will be cancelled_
285 and the second one will take effect. However, the height of the current_
286 page may be incorrect.}
287
288 \definehelp{pagepar}{
289 A command has been used to request a page break in the middle of_
290 a paragraph.__
291 You must terminate the paragraph before using the command.}
292
293 \definehelp{plaintex}{
294 The Plain TeX command shown below cannot be used in ZzTeX.}
295
296 \definehelp{scinmath}{
297 You have tried to use a special character that is not available_
298 in math mode.__
299 If you need it, use it in a \text command.}
300
301 \definehelp{setminus}{
302 When using the MathTime fonts, it is better to use \setdiff than_
303 \setminus. If you really want to use \setminus, you will need_
304 to define it in the design file.}
305
306 \definehelp{spectah}{
307 The design spec's text area height, as specified by \spectextareaheight,_
308 differs from the calculated text area height by more than 3 points._
309 You should contact the designer about this.}
310
311 \definehelp{skipab}{
312 A sequence of elements in the book has resulted in a request_
313 for a `skip below an element' followed immediately by a_
314 `skip above an element'. Such a sequence is invalid.__
315 There is probably an error in the design file.}
316
317 \definehelp{toomanyflt}{
318 There are more than the specified number of floats pending for_
319 page makeup. A float is pending for makeup when it has been_
320 encountered in a file but not yet placed on a page of the book.__
321 You must reorganize the file so that the floats are more spread_
322 out in the text, this giving ZzTeX an opportunity to place the_
323 floats on pages as soon as they are encountered.}
324
325 \definehelp{undefat}{
326 The atsign command sequence specified above has not been defined_
327 in this block. It must be defined before you can use it.__
328 Use the \defineatsigncommand command to define the command.}
329
330 \definehelp{undefflt}{
331 The float type specified above has not been defined. It must be_
332 defined before you can use it.__
333 Use the \definefloattype command to define the float.}
334
335 \definehelp{unimpl}{
336 The ZzTeX feature mentioned above is not yet implemented.__
337 Please contact Windfall Software if you need the feature.}
338
339 \definehelp{lockedfont}{
340 The font specified above is locked, which means it was not correctly_
341 installed with ZzTFM.__
342 Please contact Windfall Software to determine a remedy.}
343
344 \definehelp{varmod}{
345 A variant definition must include between 1 and 8 modifier commands.__
346 Modifier commands are specified as a comma-separated list in the third_
347 argument to \definevariant.}
348
349 \definehelp{xtran}{
350 An error flag from the XTran H converter is still present in this_
351 file. The flag message is shown in the above error message.__
352 You should fix the error flagged by XTran and remove the flag_
353 message from the source file.}
354
355 \definehelp{zztran}{
356 An error flag from the ZzTran converter is still present in this_
357 file. The flag message is shown in the above error message.__
358 You should fix the error flagged by ZzTran and remove the flag_
359 message from the source file.}