Debian Codegraph @

doc/4-htmlref.html

raw
1 <HTML>
2 <BODY>
3
4 <!-- FOOTER RIGHT "4-$CHAPTERPAGE" -->
5 <DIV ALIGN="justify">
6
7 <H1 ALIGN="RIGHT"><A NAME="HTMLREF">Chapter 4 - HTML Reference</A></H1>
8
9 This chapter defines all of the HTML elements and attributes that are
10 recognized and supported by HTMLDOC.
11
12 <H2>General Usage</H2>
13
14 <P>There are two types of HTML files - structured documents using
15 headings (H1, H2, etc.) which HTMLDOC calls "books", and
16 unstructured documents that do not use headings which HTMLDOC
17 calls "web pages".
18
19 <P>A very common mistake is to try converting a web page using:
20
21 <PRE>
22 htmldoc -f filename.pdf filename.html
23 </PRE>
24
25 <P>which will likely produce a PDF file with no pages. To convert web
26 page files you <B>must</B> use the <CODE>--webpage</CODE> option at the
27 command-line or choose <VAR>Web Page</VAR> in the input tab of the GUI.</p>
28
29 <blockquote><b>Note:</b> HTMLDOC does not support HTML 4.0 elements, attributes, stylesheets, or scripting.</blockquote>
30
31 <!-- NEED 5in -->
32 <H2>Elements</H2>
33
34 <P>The following HTML elements are recognized by HTMLDOC:</P>
35
36 <CENTER>
37 <TABLE BORDER="1" CELLPADDING="5">
38 <TR><TH>Element</TH><TH>Version</TH><TH>Supported?</TH><TH>Notes</TH></TR>
39 <TR><TD>!DOCTYPE</TD><TD ALIGN="CENTER">3.0</TD><TD ALIGN="CENTER">Yes</TD><TD>DTD is ignored</TD></TR>
40 <TR><TD>A</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD><A HREF="#LINKS">See Below</A></TD></TR>
41 <TR><TD>ACRONYM</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>No font change</TD></TR>
42 <TR><TD>ADDRESS</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
43 <TR><TD>AREA</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
44 <TR><TD>B</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
45 <TR><TD>BASE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
46 <TR><TD>BASEFONT</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
47 <TR><TD>BIG</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
48 <TR><TD>BLINK</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
49 <TR><TD>BLOCKQUOTE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
50 <TR><TD>BODY</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
51 <TR><TD>BR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
52 <TR><TD>CAPTION</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
53 <TR><TD>CENTER</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
54 <TR><TD>CITE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Italic/Oblique</TD></TR>
55 <TR><TD>CODE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Courier</TD></TR>
56 <TR><TD>DD</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
57 <TR><TD>DEL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Strikethrough</TD></TR>
58 <TR><TD>DFN</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Helvetica</TD></TR>
59 <TR><TD>DIR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
60 <TR><TD>DIV</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
61 <TR><TD>DL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
62 <TR><TD>DT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Italic/Oblique</TD></TR>
63 <TR><TD>EM</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Italic/Oblique</TD></TR>
64 <TR><TD>EMBED</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>HTML Only</TD></TR>
65 <TR><TD>FONT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD><A HREF="#FONT">See Below</A></TD></TR>
66 <TR><TD>FORM</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
67 <TR><TD>FRAME</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
68 <TR><TD>FRAMESET</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
69 <TR><TD>H1</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
70 <TR><TD>H2</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
71 <TR><TD>H3</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
72 <TR><TD>H4</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
73 <TR><TD>H5</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
74 <TR><TD>H6</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface, <A HREF="#HEADING">See Below</A></TD></TR>
75 <TR><TD>HEAD</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
76 <TR><TD>HR</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
77 <TR><TD>HTML</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
78 <TR><TD>I</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
79 <TR><TD>IMG</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD><A HREF="#IMAGES">See Below</A></TD></TR>
80 <TR><TD>INPUT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
81 <TR><TD>INS</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Underline</TD></TR>
82 <TR><TD>ISINDEX</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
83 <TR><TD>KBD</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Courier Bold</TD></TR>
84 <TR><TD>LI</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
85 <TR><TD>LINK</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
86 <TR><TD>MAP</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
87 <TR><TD>MENU</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
88 <TR><TD>META</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD><A HREF="#META">See Below</A></TD></TR>
89 <TR><TD>MULTICOL</TD><TD ALIGN="CENTER">N3.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
90 <TR><TD>NOBR</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
91 <TR><TD>NOFRAMES</TD><TD ALIGN="CENTER">3.2</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
92 <TR><TD>OL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
93 <TR><TD>OPTION</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
94 <TR><TD>P</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
95 <TR><TD>PRE</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
96 <TR><TD>S</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Strikethrough</TD></TR>
97 <TR><TD>SAMP</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Courier</TD></TR>
98 <TR><TD>SCRIPT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
99 <TR><TD>SELECT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
100 <TR><TD>SMALL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
101 <TR><TD>SPACER</TD><TD ALIGN="CENTER">N3.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
102 <TR><TD>STRIKE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
103 <TR><TD>STRONG</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface Italic/Oblique</TD></TR>
104 <TR><TD>SUB</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Reduced Fontsize</TD></TR>
105 <TR><TD>SUP</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Reduced Fontsize</TD></TR>
106 <TR><TD>TABLE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD><A HREF="#TABLE">See Below</A></TD></TR>
107 <TR><TD>TD</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
108 <TR><TD>TEXTAREA</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
109 <TR><TD>TH</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Boldface Center</TD></TR>
110 <TR><TD>TITLE</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
111 <TR><TD>TR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
112 <TR><TD>TT</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Courier</TD></TR>
113 <TR><TD>U</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
114 <TR><TD>UL</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>&nbsp;</TD></TR>
115 <TR><TD>VAR</TD><TD ALIGN="CENTER">2.0</TD><TD ALIGN="CENTER">Yes</TD><TD>Helvetica Oblique</TD></TR>
116 <TR><TD>WBR</TD><TD ALIGN="CENTER">1.0</TD><TD ALIGN="CENTER">No</TD><TD>&nbsp;</TD></TR>
117 </TABLE>
118 </CENTER>
119
120 <H2><A NAME="COMMENTS">Comments</A></H2>
121
122 <P>HTMLDOC supports many special HTML comments to
123 initiate page breaks, set the header and footer text, and
124 control the current media options:</P>
125
126 <DL>
127
128 <!-- NEED 1in -->
129 <DT><CODE>&lt;!-- FOOTER LEFT "foo" --&gt;</CODE>
130 <DD>Sets the left footer text; the test is applied to
131 the current page if empty, or the next page otherwise.
132
133 <!-- NEED 1in -->
134 <DT><CODE>&lt;!-- FOOTER CENTER "foo" --&gt;</CODE>
135 <DD>Sets the center footer text; the test is applied to
136 the current page if empty, or the next page otherwise.
137
138 <!-- NEED 1in -->
139 <DT><CODE>&lt;!-- FOOTER RIGHT "foo" --&gt;</CODE>
140 <DD>Sets the right footer text; the test is applied to
141 the current page if empty, or the next page otherwise.
142
143 <!-- NEED 1in -->
144 <DT><CODE>&lt;!-- HALF PAGE --&gt;</CODE>
145 <DD>Break to the next half page.
146
147 <!-- NEED 1in -->
148 <DT><CODE>&lt;!-- HEADER LEFT "foo" --&gt;</CODE>
149 <DD>Sets the left header text; the test is applied to
150 the current page if empty, or the next page otherwise.
151
152 <!-- NEED 1in -->
153 <DT><CODE>&lt;!-- HEADER CENTER "foo" --&gt;</CODE>
154 <DD>Sets the center header text; the test is applied to
155 the current page if empty, or the next page otherwise.
156
157 <!-- NEED 1in -->
158 <DT><CODE>&lt;!-- HEADER RIGHT "foo" --&gt;</CODE>
159 <DD>Sets the right header text; the test is applied to
160 the current page if empty, or the next page otherwise.
161
162 <!-- NEED 1in -->
163 <DT><CODE>&lt;!-- MEDIA BOTTOM nnn --&gt;</CODE>
164 <DD>Sets the bottom margin of the page. The "nnn" string can
165 be any standard measurement value, e.g. 0.5in, 36, 12mm, etc.
166 Breaks to a new page if the current page is already marked.
167
168 <!-- NEED 1in -->
169 <DT><CODE>&lt;!-- MEDIA COLOR "foo" --&gt;</CODE>
170 <DD>Sets the media color attribute for the page. The
171 "foo" string is any color name that is supported by the
172 printer, e.g. "Blue", "White", etc. Breaks to a new
173 page or sheet if the current page is already marked.
174
175 <!-- NEED 1in -->
176 <DT><CODE>&lt;!-- MEDIA DUPLEX NO --&gt;</CODE>
177 <DD>Chooses single-sided printing for the page; breaks to a
178 new page or sheet if the current page is already marked.
179
180 <!-- NEED 1in -->
181 <DT><CODE>&lt;!-- MEDIA DUPLEX YES --&gt;</CODE>
182 <DD>Chooses double-sided printing for the page; breaks to a
183 new sheet if the current page is already marked.
184
185 <!-- NEED 1in -->
186 <DT><CODE>&lt;!-- MEDIA LANDSCAPE NO --&gt;</CODE>
187 <DD>Chooses portrait orientation for the page; breaks to a
188 new page if the current page is already marked.
189
190 <!-- NEED 1in -->
191 <DT><CODE>&lt;!-- MEDIA LANDSCAPE YES --&gt;</CODE>
192 <DD>Chooses landscape orientation for the page; breaks to a
193 new page if the current page is already marked.
194
195 <!-- NEED 1in -->
196 <DT><CODE>&lt;!-- MEDIA LEFT nnn --&gt;</CODE>
197 <DD>Sets the left margin of the page. The "nnn" string can
198 be any standard measurement value, e.g. 0.5in, 36, 12mm, etc.
199 Breaks to a new page if the current page is already marked.
200
201 <!-- NEED 1in -->
202 <DT><CODE>&lt;!-- MEDIA POSITION nnn --&gt;</CODE>
203 <DD>Sets the media position attribute (input tray) for
204 the page. The "nnn" string is an integer that usually
205 specifies the tray number. Breaks to a new page or sheet
206 if the current page is already marked.
207
208 <!-- NEED 1in -->
209 <DT><CODE>&lt;!-- MEDIA RIGHT nnn --&gt;</CODE>
210 <DD>Sets the right margin of the page. The "nnn" string can
211 be any standard measurement value, e.g. 0.5in, 36, 12mm, etc.
212 Breaks to a new page if the current page is already marked.
213
214 <!-- NEED 1in -->
215 <DT><CODE>&lt;!-- MEDIA SIZE foo --&gt;</CODE>
216 <DD>Sets the media size to the specified size. The "foo"
217 string can be "Letter", "Legal", "Universal", or "A4"
218 for standard sizes or "WIDTHxHEIGHTunits" for custom
219 sizes, e.g. "8.5x11in"; breaks to a new page or sheet if
220 the current page is already marked.
221
222 <!-- NEED 1in -->
223 <DT><CODE>&lt;!-- MEDIA TOP nnn --&gt;</CODE>
224 <DD>Sets the top margin of the page. The "nnn" string can
225 be any standard measurement value, e.g. 0.5in, 36, 12mm, etc.
226 Breaks to a new page if the current page is already marked.
227
228 <!-- NEED 1in -->
229 <DT><CODE>&lt;!-- MEDIA TYPE "foo" --&gt;</CODE>
230 <DD>Sets the media type attribute for the page. The
231 "foo" string is any type name that is supported by the
232 printer, e.g. "Plain", "Glossy", etc. Breaks to a new
233 page or sheet if the current page is already marked.
234
235 <!-- NEED 1in -->
236 <DT><CODE>&lt;!-- NEED length --&gt;</CODE>
237 <DD>Break if there is less than <CODE>length</CODE>
238 units left on the current page. The <CODE>length</CODE>
239 value defaults to lines of text but can be suffixed by
240 <CODE>in</CODE>, <CODE>mm</CODE>, or <CODE>cm</CODE> to
241 convert from the corresponding units.
242
243 <!-- NEED 1in -->
244 <DT><CODE>&lt;!-- NEW PAGE --&gt;</CODE>
245 <DD>Break to the next page.
246
247 <!-- NEED 1in -->
248 <DT><CODE>&lt;!-- NEW SHEET --&gt;</CODE>
249 <DD>Break to the next sheet.
250
251 <!-- NEED 1in -->
252 <DT><CODE>&lt;!-- NUMBER-UP nn --&gt;</CODE>
253 <DD>Sets the number of pages that are placed on each
254 output page. Valid values are 1, 2, 4, 6, 9, and 16.
255
256 <!-- NEED 1in -->
257 <DT><CODE>&lt;!-- PAGE BREAK --&gt;</CODE>
258 <DD>Break to the next page.
259
260 </DL>
261
262 <!-- NEED 2in -->
263 <H3>Header/Footer Strings</H3>
264
265 <P>The <CODE>HEADER</CODE> and <CODE>FOOTER</CODE> comments
266 allow you to set an arbitrary string of text for the left,
267 center, and right headers and footers. Each string consists of
268 plain text; special values or strings can be inserted using the
269 dollar sign (<CODE>$</CODE>):</P>
270
271 <DL>
272
273 <!-- NEED 1in -->
274 <DT><CODE>$$</CODE>
275 <DD>Inserts a single dollar sign in the header.
276
277 <!-- NEED 1in -->
278 <DT><CODE>$CHAPTER</CODE>
279 <DD>Inserts the current chapter heading.
280
281 <!-- NEED 1.5in -->
282 <DT><CODE>$CHAPTERPAGE</CODE>
283 <DT><CODE>$CHAPTERPAGE(format)</CODE>
284 <DD>Inserts the current page number within a chapter or
285 file. When a format is specified, uses that numeric
286 format (1 = decimal, i = lowercase roman numerals, I =
287 uppercase roman numerals, a = lowercase ascii, A =
288 uppercase ascii) for the page numbers.
289
290 <!-- NEED 1.5in -->
291 <DT><CODE>$CHAPTERPAGES</CODE>
292 <DT><CODE>$CHAPTERPAGES(format)</CODE>
293 <DD>Inserts the total page count within a chapter or
294 file. When a format is specified, uses that numeric
295 format (1 = decimal, i = lowercase roman numerals, I =
296 uppercase roman numerals, a = lowercase ascii, A =
297 uppercase ascii) for the page count.
298
299 <!-- NEED 1in -->
300 <DT><CODE>$DATE</CODE>
301 <DT><CODE>$DATE(format)</CODE>
302 <DD>Inserts the current date. See <a href="#DATETIME">Date/Time
303 Formats</a> for details on the format string. When no format is
304 supplied, the default date format for the current locale is used.
305
306 <!-- NEED 1in -->
307 <DT><CODE>$HEADING</CODE>
308 <DD>Inserts the current heading.
309
310 <!-- NEED 1in -->
311 <DT><CODE>$HFIMAGE1</CODE>
312 <DT><CODE>$HFIMAGE2</CODE>
313 <DT><CODE>$HFIMAGE3</CODE>
314 <DT><CODE>$HFIMAGE4</CODE>
315 <DT><CODE>$HFIMAGE5</CODE>
316 <DT><CODE>$HFIMAGE6</CODE>
317 <DT><CODE>$HFIMAGE7</CODE>
318 <DT><CODE>$HFIMAGE8</CODE>
319 <DT><CODE>$HFIMAGE9</CODE>
320 <DT><CODE>$HFIMAGE10</CODE>
321 <DD>Inserts the specified header/footer image; all other text in the
322 string will be ignored.
323
324 <!-- NEED 1in -->
325 <DT><CODE>$LETTERHEAD</CODE>
326 <DD>Inserts the logo image as a letterhead with no down-scaling; all
327 other text in the string will be ignored.
328
329 <!-- NEED 1in -->
330 <DT><CODE>$LOGOIMAGE</CODE>
331 <DD>Inserts the logo image; all other text in the string
332 will be ignored.
333
334 <!-- NEED 1in -->
335 <DT><CODE>$PAGE</CODE>
336 <DT><CODE>$PAGE(format)</CODE>
337 <DD>Inserts the current page number. When a format is
338 specified, uses that numeric format (1 = decimal, i =
339 lowercase roman numerals, I = uppercase roman numerals,
340 a = lowercase ascii, A = uppercase ascii) for the page
341 numbers.
342
343 <!-- NEED 1.5in -->
344 <DT><CODE>$PAGES</CODE>
345 <DT><CODE>$PAGES(format)</CODE>
346 <DD>Inserts the total page count. When a format is
347 specified, uses that numeric format (1 = decimal, i =
348 lowercase roman numerals, I = uppercase roman numerals,
349 a = lowercase ascii, A = uppercase ascii) for the page
350 count.
351
352 <!-- NEED 1in -->
353 <DT><CODE>$TIME</CODE>
354 <DT><CODE>$TIME(format)</CODE>
355 <DD>Inserts the current time. See <a href="#DATETIME">Date/Time
356 Formats</a> for details on the format string. When no format is
357 supplied, the default time format for the current locale is used.
358
359 <!-- NEED 1in -->
360 <DT><CODE>$TITLE</CODE>
361 <DD>Inserts the document title.
362
363 <!-- NEED 1in -->
364 <DT><CODE>$URL</CODE>
365 <DD>Inserts the document filename or URL.
366
367 </DL>
368
369 <H3><A NAME="DATETIME">Date/Time Formats</A></H3>
370
371 <p>The <CODE>$DATE</CODE> and <CODE>$TIME</CODE> header/footer strings support
372 an optional format string in parenthesis. Letters represent date/time values
373 while other characters are inserted verbatim. The following letters are
374 supported:</p>
375
376 <center>
377 <table border="1" cellpadding="5">
378 <tr><th>Letter</th><th>Description</th></tr>
379 <tr><td><code>A</code></td><td>Full weekday name</td></tr>
380 <tr><td><code>a</code></td><td>Abbreviated weekday name</td></tr>
381 <tr><td><code>B</code></td><td>Full month name</td></tr>
382 <tr><td><code>b</code></td><td>Abbreviated month name</td></tr>
383 <tr><td><code>C</code></td><td>Century (CC)</td></tr>
384 <tr><td><code>c</code></td><td>Default date and time format</td></tr>
385 <tr><td><code>d</code></td><td>Day of the month ("01" to "31")</td></tr>
386 <tr><td><code>e</code></td><td>Day of the month (" 1" to "31")</td></tr>
387 <tr><td><code>F</code></td><td>YYYY-MM-DD</td></tr>
388 <tr><td><code>H</code></td><td>Hours for 24-hour clock ("00" to "23")</td></tr>
389 <tr><td><code>I</code></td><td>Hours for 12-hour clock ("01" to "12")</td></tr>
390 <tr><td><code>j</code></td><td>Day of the year ("001" to "366")</td></tr>
391 <tr><td><code>k</code></td><td>Hours for 24-hour clock (" 0" to "23")</td></tr>
392 <tr><td><code>l</code></td><td>Hours for 12-hour clock (" 1" to "12")</td></tr>
393 <tr><td><code>M</code></td><td>Minutes ("00" to "59")</td></tr>
394 <tr><td><code>m</code></td><td>Month number ("01" to "12")</td></tr>
395 <tr><td><code>p</code></td><td>"am" or "pm"</td></tr>
396 <tr><td><code>R</code></td><td>Hours and minutes ("HH:MM")</td></tr>
397 <tr><td><code>r</code></td><td>Hours, minutes, seconds, and am/pm ("HH:MM:SS am/pm")</td></tr>
398 <tr><td><code>S</code></td><td>Seconds ("00" to "60")</td></tr>
399 <tr><td><code>T</code></td><td>Hours, minutes, and seconds ("HH:MM:SS")</td></tr>
400 <tr><td><code>X</code></td><td>Default time format</td></tr>
401 <tr><td><code>x</code></td><td>Default date format</td></tr>
402 <tr><td><code>Y</code></td><td>Year with century (CCYY)</td></tr>
403 <tr><td><code>y</code></td><td>Year without century (YY)</td></tr>
404 <tr><td><code>Z</code></td><td>Time zone name</td></tr>
405 <tr><td><code>z</code></td><td>Time zone offset from UTC</td></tr>
406 </table>
407 </center>
408
409
410 <!-- NEED 5in -->
411 <H2><A NAME="FONT">FONT Attributes</A></H2>
412
413 <P>Limited typeface specification is currently supported to ensure
414 portability across platforms and for older PostScript printers:</P>
415
416 <CENTER><TABLE BORDER="1" CELLPADDING="5">
417 <TR><TH>Requested Font</TH><TH>Actual Font</TH></TR>
418 <TR><TD>Arial</TD><TD>Helvetica</TD></TR>
419 <TR><TD>Courier</TD><TD>Courier</TD></TR>
420 <TR><TD>Dingbats</TD><TD>Dingbats</TD></TR>
421 <TR><TD>Helvetica</TD><TD>Helvetica</TD></TR>
422 <TR><TD>Monospace</TD><TD>DejaVu Sans Mono</TD></TR>
423 <TR><TD>Sans</TD><TD>DejaVu Sans</TD></TR>
424 <TR><TD>Serif</TD><TD>DejaVu Serif</TD></TR>
425 <TR><TD>Symbol</TD><TD>Symbol</TD></TR>
426 <TR><TD>Times</TD><TD>Times</TD></TR>
427 </TABLE></CENTER>
428
429 <P>All other unrecognized typefaces are silently ignored.</P>
430
431 <H2><A NAME="HEADING">Headings</A></H2>
432
433 <P>Currently HTMLDOC supports a maximum of 1000 chapters
434 (H1 headings). This limit can be increased by changing the
435 <CODE>MAX_CHAPTERS</CODE> constant in the <VAR>config.h</VAR>
436 file included with the source code.
437
438 <P>All chapters start with a top-level heading (H1) markup. Any
439 headings within a chapter must be of a lower level (H2 to H15). Each
440 chapter starts a new page or the next odd-numbered page if duplexing is
441 selected.</p>
442
443 <blockquote><b>Note:</b> Heading levels 7 to 15 are not standard HTML and will not likely be recognized by most web browsers.</blockquote>
444
445 <P>The headings you use within a chapter must start at level 2 (H2). If
446 you skip levels the heading will be shown under the last level that was
447 known. For example, if you use the following hierarchy of headings:
448
449 <PRE>
450 &lt;H1&gt;Chapter Heading&lt;/H1&gt;
451 ...
452 &lt;H2&gt;Section Heading 1&lt;/H2&gt;
453 ...
454 &lt;H2&gt;Section Heading 2&lt;/H2&gt;
455 ...
456 &lt;H3&gt;Sub-Section Heading 1&lt;/H3&gt;
457 ...
458 &lt;H4&gt;Sub-Sub-Section Heading 1&lt;/H4&gt;
459 ...
460 &lt;H4&gt;Sub-Sub-Section Heading 2&lt;/H4&gt;
461 ...
462 &lt;H3&gt;Sub-Section Heading 2&lt;/H3&gt;
463 ...
464 &lt;H2&gt;Section Heading 3&lt;/H2&gt;
465 ...
466 &lt;H4&gt;Sub-Sub-Section Heading 3&lt;/H4&gt;
467 ...
468 </PRE>
469
470 the table-of-contents that is generated will show:
471
472 <ul>
473 <li><b>Chapter Heading</b><ul>
474 <li>Section Heading 1</li>
475 <li>Section Heading 2<ul>
476 <li>Sub-Section Heading 1<ul>
477 <li>Sub-Sub-Section Heading 1</li>
478 <li>Sub-Sub-Section Heading 2</li>
479 </ul></li>
480 <li>Sub-Section Heading 2<ul>
481 <li>Sub-Sub-Section Heading 3</li>
482 </ul></li>
483 </ul></li>
484 <li>Section Heading 3</li>
485 </ul></li>
486 </ul>
487
488 <!-- NEED 4in -->
489 <H3>Numbered Headings</H3>
490
491 When the numbered headings option is enabled, HTMLDOC recognizes the
492 following additional attributes for all heading elements:
493
494 <DL>
495
496 <DT><CODE>VALUE="#"</CODE>
497 <DD>Specifies the starting value for this heading level
498 (default is "1" for all new levels).
499
500 <DT><CODE>TYPE="1"</CODE>
501 <DD>Specifies that decimal numbers should be generated for this
502 heading level.
503
504 <DT><CODE>TYPE="a"</CODE>
505 <DD>Specifies that lowercase letters should be generated for
506 this heading level.
507
508 <DT><CODE>TYPE="A"</CODE>
509 <DD>Specifies that uppercase letters should be generated for
510 this heading level.
511
512 <DT><CODE>TYPE="i"</CODE>
513 <DD>Specifies that lowercase roman numerals should be generated
514 for this heading level.
515
516 <DT><CODE>TYPE="I"</CODE>
517 <DD>Specifies that uppercase roman numerals should be generated
518 for this heading level.
519
520 </DL>
521
522 <!-- NEED 2in -->
523
524 <H2><A NAME="IMAGES">Images</A></H2>
525
526 HTMLDOC supports loading of GIF, JPEG, and PNG image files. BMP image support
527 is deprecated and will be removed in a future version of HTMLDOC. EPS and other
528 types of image files are not supported at this time.
529
530 <!-- NEED 2in -->
531
532 <H2><A NAME="LINKS">Links</A></H2>
533
534 <P>External URL and internal (<CODE>#target</CODE> and
535 <CODE>filename.html</CODE>) links are fully supported for HTML
536 and PDF output.
537
538 <P>When generating PDF files, local PDF file links will be
539 converted to external file links for the PDF viewer instead of
540 URL links. That is, you can directly link to another local PDF
541 file from your HTML document with:
542
543 <PRE>
544 &lt;A HREF="filename.pdf"&gt;...&lt;/A&gt;
545 </PRE>
546
547 <!-- NEED 5in -->
548 <H2><A NAME="META">META Attributes</A></H2>
549
550 <P>HTMLDOC supports the following <CODE>META</CODE>
551 attributes for the title page and document information:
552
553 <DL>
554
555 <DT><CODE>&lt;META NAME="AUTHOR" CONTENT="..."</CODE>
556 <DD>Specifies the document author.
557
558 <DT><CODE>&lt;META NAME="COPYRIGHT" CONTENT="..."</CODE>
559 <DD>Specifies the document copyright.
560
561 <DT><CODE>&lt;META NAME="DOCNUMBER" CONTENT="..."</CODE>
562 <DD>Specifies the document number.
563
564 <DT><CODE>&lt;META NAME="GENERATOR" CONTENT="..."</CODE>
565 <DD>Specifies the application that generated the HTML file.
566
567 <DT><CODE>&lt;META NAME="HTMLDOC.filename" CONTENT="..."</CODE>
568 <DD>Specifies the filename that is reported in CGI mode.
569
570 <DT><CODE>&lt;META NAME="KEYWORDS" CONTENT="..."</CODE>
571 <DD>Specifies document search keywords.
572
573 <DT><CODE>&lt;META NAME="SUBJECT" CONTENT="..."</CODE>
574 <DD>Specifies document subject.
575
576 </DL>
577
578 <H2><A NAME="TABLE">Tables</A></H2>
579
580 Currently HTMLDOC supports a maximum of 200 columns within a
581 single table. This limit can be increased by changing the
582 <CODE>MAX_COLUMNS</CODE> constant in the <VAR>config.h</VAR> file
583 included with the source code.
584
585 <P><B>HTMLDOC does not support HTML 4.0 table elements or
586 attributes, such as <CODE>TBODY</CODE>, <CODE>THEAD</CODE>,
587 <CODE>TFOOT</CODE>, or <CODE>RULES</CODE>.</B>
588
589 </DIV>
590
591 </BODY>
592 </HTML>