3 \C{output} Halibut output formats
5 This chapter describes each of Halibut's current \i{output formats}.
6 It gives some general information about the format, and also
7 describes all the \i{configuration directives} which are specific to
10 \H{output-text} Plain text
12 This output format generates the document as a single \i{plain text}
13 file. No table of contents or index is generated.
15 The precise formatting of the text file can be controlled by a
16 variety of configuration directives. They are listed in the
17 following subsections.
19 \S{output-text-file} Output file name
21 \dt \I{\cw{\\cfg\{text-filename\}}}\cw{\\cfg\{text-filename\}\{}\e{filename}\cw{\}}
23 \dd Sets the \i{output file name} in which to store the text file.
24 This directive is implicitly generated if you provide a file name
25 parameter after the command-line option \i\c{--text} (see
28 \S{output-text-dimensions} Indentation and line width
30 This section describes the configuration directives which control
31 the \i{horizontal dimensions} of the output text file: how much
32 paragraphs are indented by and how long the lines are.
34 \dt \I{\cw{\\cfg\{text-width\}}}\cw{\\cfg\{text-width\}\{}\e{width}\cw{\}}
36 \dd Sets the \I{text width}width of the main part of the document,
37 in characters. This width will be used for wrapping paragraphs and
38 for centring titles (if you have asked for titles to be centred -
39 see \k{output-text-headings}). This width does \e{not} include the
40 left indentation set by \cw{\\cfg\{text-indent\}}; if you specify an
41 indent of 8 and a width of 64, your maximum output line length will
44 \dt \I{\cw{\\cfg\{text-indent\}}}\cw{\\cfg\{text-indent\}\{}\e{indent}\cw{\}}
46 \dd Sets the left \i{indentation} for the document. If you set this
47 to zero, your document will look like an ordinary text file as
48 someone with a text editor might have written it; if you set it
49 above zero, the text file will have a \i{margin} down the left in
50 the style of some printed manuals, and you can then configure the
51 section numbers to appear in this margin (see
52 \k{output-text-headings}).
54 \dt \I{\cw{\\cfg\{text-indent-code\}}}\cw{\\cfg\{text-indent-code\}\{}\e{indent}\cw{\}}
56 \dd Specifies how many extra characters of indentation (on top of
57 the normal left indent) should be given to \I{code paragraphs,
58 indentation} code paragraphs.
60 \dt \I{\cw{\\cfg\{text-list-indent\}}}\cw{\\cfg\{text-list-indent\}\{}\e{indent}\cw{\}}
62 \dd Specifies how many extra spaces should be used to indent the
63 bullet or number in a \I{bulletted list, indentation}bulletted or
64 \I{numbered list, indentation}numbered \I{list, indentation}list.
65 The actual body of the list item will be indented by this much
66 \e{plus} the value configured by \cw{\\cfg\{text-listitem-indent\}}.
68 \dt \I{\cw{\\cfg\{text-listitem-indent\}}}\cw{\\cfg\{text-listitem-indent\}\{}\e{indent}\cw{\}}
70 \dd Specifies how many extra spaces should be used to indent the
71 body of a list item, over and above the number configured in
72 \cw{\\cfg\{text-list-indent\}}.
74 \dt \I{\cw{\\cfg\{text-indent-preamble\}}}\cw{\\cfg\{text-indent-preamble\}\{}\e{boolean}\cw{\}}
76 \dd When this is set to \c{true}, the document \i{preamble} (i.e. any
77 paragraphs appearing before the first chapter heading) will be
78 indented to the level specified by \cw{\\cfg\{text-indent\}}. If
79 this setting is \c{false}, the document preamble will not be
80 indented at all from the left margin.
82 \S{output-text-headings} \ii{Configuring heading display}
84 The directives in this section allow you to configure the appearance
85 of the title, chapter and section headings in your text file.
87 Several of the directives listed below specify the \i{alignment} of
88 a heading. These alignment options have three possible values:
92 \dd Align the heading to the very left of the text file (column zero).
96 \dd Align the section title to the left of the main display region
97 (in other words, indented to the level specified by
98 \cw{\\cfg\{text-indent\}}). The section \e{number} is placed to the
99 left of that (so that it goes in the margin if there is room).
103 \dd Centre the heading.
105 Also, several of the directives below specify how a title should be
106 \I{underlining}underlined. The parameter to one of these directives
107 should be either blank (\cw{\{\}}) or a piece of text which will be
108 repeated to produce the underline. So you might want to specify, for
109 example, \cw{\\text-title-underline\{=\}} but
110 \cw{\\text-chapter-underline\{\-\}}.
112 You can also specify more than one underline setting, and Halibut
113 will choose the first one that the output character set supports.
114 So, for example, you could write
115 \cw{\\text-chapter-underline\{\\u203e\}\{\-\}}, and Halibut would use
116 the Unicode \q{OVERLINE} character where possible and fall back to
117 the ASCII minus sign otherwise.
119 \dt \I{\cw{\\cfg\{text-title-align\}}}\cw{\\cfg\{text-title-align\}\{}\e{alignment}\cw{\}}
121 \dd Specifies the alignment of the overall document title: \c{left},
122 \c{leftplus} or \c{centre}.
124 \dt \I{\cw{\\cfg\{text-title-underline\}}}\cw{\\cfg\{text-title-underline\}\{}\e{underline-text}\cw{\}}
126 \dd Specifies how the overall document title should be underlined.
128 \dt \I{\cw{\\cfg\{text-chapter-align\}}}\cw{\\cfg\{text-chapter-align\}\{}\e{alignment}\cw{\}}
130 \dd Specifies the alignment of chapter and appendix headings.
132 \dt \I{\cw{\\cfg\{text-chapter-underline\}}}\cw{\\cfg\{text-chapter-underline\}\{}\e{underline-text}\cw{\}}
134 \dd Specifies how chapter and appendix headings should be underlined.
136 \dt \I{\cw{\\cfg\{text-chapter-numeric\}}}\cw{\\cfg\{text-chapter-numeric\}\{}\e{boolean}\cw{\}}
138 \dd If this is set to \c{true}, then chapter headings will not
139 contain the word \q{Chapter} (or whatever other word you have
140 defined in its place - see \k{input-sections} and \k{input-config});
141 they will just contain the chapter \e{number}, followed by the
142 chapter title. If you set this to \c{false}, chapter headings will
143 be prefixed by \q{Chapter} or equivalent.
145 \dt \I{\cw{\\cfg\{text-chapter-suffix\}}}\cw{\\cfg\{text-chapter-suffix\}\{}\e{text}\cw{\}}
147 \dd This specifies the suffix text to be appended to the chapter
148 number, before displaying the chapter title. For example, if you set
149 this to \cq{:\_}, then the chapter title might look something
150 like \q{Chapter 2: Doing Things}.
152 \dt \I{\cw{\\cfg\{text-section-align\}}}\cw{\\cfg\{text-section-align\}\{}\e{level}\cw{\}\{}\e{alignment}\cw{\}}
154 \dd Specifies the alignment of section headings at a particular
155 level. The \e{level} parameter specifies which level of section
156 headings you want to affect: 0 means first-level headings (\c{\\H}),
157 1 means second-level headings (\c{\\S}), 2 means the level below
158 that (\c{\\S2}), and so on. The \e{alignment} parameter is treated
159 just like the other alignment directives listed above.
161 \dt \I{\cw{\\cfg\{text-section-underline\}}}\cw{\\cfg\{text-section-underline\}\{}\e{level}\cw{\}\{}\e{underline-text}\cw{\}}
163 \dd Specifies how to underline section headings at a particular level.
165 \dt \I{\cw{\\cfg\{text-section-numeric\}}}\cw{\\cfg\{text-section-numeric\}\{}\e{level}\cw{\}\{}\e{boolean}\cw{\}}
167 \dd Specifies whether section headings at a particular level should
168 contain the word \q{Section} or equivalent (if \c{false}), or should
169 be numeric only (if \c{true}).
171 \dt \I{\cw{\\cfg\{text-section-suffix\}}}\cw{\\cfg\{text-section-suffix\}\{}\e{level}\cw{\}\{}\e{text}\cw{\}}
173 \dd Specifies the \I{suffix text, in section titles}suffix text to
174 be appended to section numbers at a particular level, before
175 displaying the section title.
177 \S{output-text-characters} Configuring the characters used
179 \dt \I\cw{\\cfg\{text-charset\}}\cw{\\cfg\{text-charset\}\{}\e{character set name}\cw{\}}
181 \dd This tells Halibut what \i{character set} the output should be
182 in. Any Unicode characters representable in this set will be output
183 verbatim; any other characters will not be output and their
184 \i{fallback text} (if any) will be used instead.
188 The character set names are the same as for
189 \cw{\\cfg\{input-charset\}} (see \k{input-config}). However, unlike
190 \cw{\\cfg\{input-charset\}}, this directive affects the \e{entire}
191 output; it's not possible to switch encodings halfway through.
195 \dt \I{\cw{\\cfg\{text-bullet\}}}\cw{\\cfg\{text-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}...\cw{\}}]
197 \dd This specifies the text which should be used as the \i{bullet}
198 in bulletted lists. It can be one character
199 (\cw{\\cfg\{text-bullet\}\{-\}}), or more than one
200 (\cw{\\cfg\{text-bullet\}\{(*)\}}).
204 Like \cw{\\cfg\{quotes\}} (see \k{input-config}), you can specify multiple
205 possible options after this command, and Halibut will choose the first one
206 which the output character set supports. For example, you might write
207 \cw{\\cfg\{text-bullet\}\{\\u2022\}\{\\u00b7\}\{*\}}, in which case
208 Halibut would use the Unicode \q{BULLET} character where possible,
209 fall back to the ISO-8859-1 \q{MIDDLE DOT} if that wasn't available,
210 and resort to the ASCII asterisk if all else failed.
214 \dt \I{\cw{\\cfg\{text-rule\}}}\cw{\\cfg\{text-rule\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}...\cw{\}}]
216 \dd This specifies the text which should be used for drawing
217 \i{horizontal rules} (generated by \i\c{\\rule}; see
218 \k{input-rule}). It can be one character, or more than one. The
219 string you specify will be repeated to reach the required width, so
220 you can specify something like \cq{-=} to get a rule that looks
225 Like \cw{\\cfg\{text-bullet\}}, you can specify multiple fallback
226 options in this command.
230 \dt \I{\cw{\\cfg\{text-quotes\}}}\cw{\\cfg\{text-quotes\}\{}\e{open-quote}\cw{\}\{}\e{close-quote}\cw{\}}[\cw{\{}\e{open-quote}\cw{\}\{}\e{close-quote}...\cw{\}}]
232 \dd This specifies a set of quote characters for the text backend,
233 overriding any defined by \cw{\\cfg\{quotes\}}. It has the same syntax
234 (see \k{input-config}).
238 In this backend, these quotes will also be used to mark text enclosed
239 in the \c{\\c} command (see \k{input-code}).
243 \dt \I{\cw{\\cfg\{text-emphasis\}}}\cw{\\cfg\{text-emphasis\}\{}\e{start-emph}\cw{\}\{}\e{end-emph}\cw{\}}[\cw{\{}\e{start-emph}\cw{\}\{}\e{end-emph}...\cw{\}}]
245 \dd This specifies the characters which should be used to surround
246 emphasised text (written using the \c{\\e} command; see
251 You should separately specify the start-emphasis and end-emphasis
252 text, each of which can be more than one character if you want.
253 Also, like \cw{\\cfg\{text-quotes\}}, you can specify multiple pairs
254 of fallback options in this command, and Halibut will always use a
259 \S{output-text-misc} Miscellaneous configuration options
261 \dt \I{\cw{\\cfg\{text-list-suffix\}}}\cw{\\cfg\{text-list-suffix\}\{}\e{text}\cw{\}}
263 \dd This text is appended to the number on a \i{numbered list} item
264 (see \k{input-list-number}). So if you want to label your lists as
265 \q{1)}, \q{2)} and so on, then you would write
266 \cw{\\cfg\{text-list-suffix\}\{)\}}.
268 \dt \I{\cw{\\cfg\{text-versionid\}}}\cw{\\cfg\{text-versionid\}\{}\e{boolean}\cw{\}}
270 \dd If this is set to \c{true}, \i{version ID paragraphs} (defined
271 using the \i\c{\\versionid} command - see \k{input-blurb}) will be
272 included at the bottom of the text file. If it is set to \c{false},
273 they will be omitted completely.
275 \# FIXME: code indentation is configurable, therefore \quote
276 \# indentation probably ought to be as well.
278 \# FIXME: text-indent-* should be consistently named.
280 \S{output-text-defaults} Default settings
282 The \i{default settings} for Halibut's plain text output format are:
284 \c \cfg{text-filename}{output.txt}
286 \c \cfg{text-width}{68}
287 \c \cfg{text-indent}{7}
288 \c \cfg{text-indent-code}{2}
289 \c \cfg{text-list-indent}{1}
290 \c \cfg{text-listitem-indent}{3}
291 \c \cfg{text-indent-preamble}{false}
293 \c \cfg{text-title-align}{centre}
294 \c \cfg{text-title-underline}{\u2550}{=}
296 \c \cfg{text-chapter-align}{left}
297 \c \cfg{text-chapter-underline}{\u203e}{-}
298 \c \cfg{text-chapter-numeric}{false}
299 \c \cfg{text-chapter-suffix}{: }
301 \c \cfg{text-section-align}{0}{leftplus}
302 \c \cfg{text-section-underline}{0}{}
303 \c \cfg{text-section-numeric}{0}{true}
304 \c \cfg{text-section-suffix}{0}{ }
306 \c \cfg{text-section-align}{1}{leftplus}
307 \c \cfg{text-section-underline}{1}{}
308 \c \cfg{text-section-numeric}{1}{true}
309 \c \cfg{text-section-suffix}{1}{ }
311 \c ... and so on for all section levels below this ...
312 \e iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii
314 \c \cfg{text-charset}{ASCII}
315 \c \cfg{text-bullet}{\u2022}{-}
316 \c \cfg{text-rule}{\u2500}{-}
317 \c \cfg{text-quotes}{\u2018}{\u2019}{`}{'}
318 \c \cfg{text-emphasis}{_}{_}
320 \c \cfg{text-list-suffix}{.}
321 \c \cfg{text-versionid}{true}
325 This output format generates an \i{HTML} version of the document. By
326 default, this will be in multiple files, starting with
327 \c{Contents.html} and splitting the document into files by chapter
328 and/or subsection. You can configure precisely how the text is split
329 between HTML files using the configuration commands described in
330 this section. In particular, you can configure Halibut to output one
331 single HTML file instead of multiple ones.
333 \I{\cw{\\cfg\{xhtml-anything\}}}Configuration directives with an
334 \c{xhtml-} prefix are synonyms for those with an \c{html-} prefix.
336 \S{output-html-file} Controlling the output file names
338 \dt \I{\cw{\\cfg\{html-contents-filename\}}}\cw{\\cfg\{html-contents-filename\}\{}\e{filename}\cw{\}}
340 \dd Sets the \i{output file name} in which to store the top-level
341 contents page. Since this is the first page a user ought to see when
342 beginning to read the document, a good choice in many cases might be
343 \c{index.html} (although this is not the default, for historical
346 \dt \I{\cw{\\cfg\{html-index-filename\}}}\cw{\\cfg\{html-index-filename\}\{}\e{filename}\cw{\}}
348 \dd Sets the file name in which to store the document's index.
350 \dt \I{\cw{\\cfg\{html-template-filename\}}}\cw{\\cfg\{html-template-filename\}\{}\e{template}\cw{\}}
352 \dd Provides a \i{template} to be used when constructing the file
353 names of each chapter or section of the document. This template
354 should contain at least one \i\e{formatting command}, in the form of
355 a per cent sign followed by a letter. (If you need a literal per
356 cent sign, you can write \c{%%}.)
360 The formatting commands used in this template are:
362 \dt \I{%N-upper}\c{%N}
364 \dd Expands to the visible title of the section, with white space
365 removed. So in a chapter declared as \cq{\\C\{fish\} Catching
366 Fish}, this formatting command would expand to
371 \dd Expands to the type and number of the section, without white
372 space. So in chapter 1 this would expand to \cq{Chapter1}; in
373 section A.4.3 it would expand to \cq{SectionA.4.3}, and so on.
374 If the section has no number (an unnumbered chapter created using
375 \c{\\U}), this directive falls back to doing the same thing as
380 \dd Expands to the number of the section, in a format suitable for an
381 HTML fragment name. The first character of the section type is
382 prepended to the section number. So in chapter 1 this would expand to
383 \cq{C1}; in section A.4.3 it would expand to \cq{SA.4.3}, and so on.
384 If the section has no number (an unnumbered chapter created using
385 \c{\\U}), this directive falls back to doing the same thing as \c{%N}.
389 \dd Expands to the internal keyword specified in the section title.
390 So in a chapter declared as \cq{\\C\{fish\} Catching Fish}, this
391 formatting command would expand to \cq{fish}. If the section has
392 no keyword (an unnumbered chapter created using \c{\\U}), this
393 directive falls back to doing the same thing as \c{%N}.
395 These formatting directives can also be used in the
396 \cw{\\cfg\{html-template-fragment\}} configuration directive (see
397 \k{output-html-misc}).
401 \dt \I{\cw{\\cfg\{html-single-filename\}}}\cw{\\cfg\{html-single-filename\}\{}\e{filename}\cw{\}}
403 \dd Sets the file name in which to store the entire document, if
404 Halibut is configured (using \c{\\cfg\{html-leaf-level\}\{0\}} to
405 produce a single self-contained file. Both this directive \e{and}
406 \c{\\cfg\{html-leaf-level\}\{0\}} are implicitly generated if you
407 provide a file name parameter after the command-line option
408 \i\c{--html} (see \k{running-options}).
410 \S{output-html-split} Controlling the splitting into HTML files
412 By default, the HTML output from Halibut is split into multiple
413 files. Each file typically contains a single chapter or section and
414 everything below it, unless subsections of that chapter are
415 themselves split off into further files.
417 Most files also contain a contents section, giving hyperlinks to the
418 sections in the file and/or the sections below it.
420 The configuration directives listed below allow you to configure the
421 splitting into files, and the details of the contents sections.
423 \dt \I{\cw{\\cfg\{html-leaf-level\}}}\cw{\\cfg\{html-leaf-level\}\{}\e{depth}\cw{\}}
425 \dd This setting indicates the depth of section which should be
426 given a \I{leaf file}\q{leaf} file (a file with no sub-files). So if
427 you set it to 1, for example, then every chapter will be given its
428 own HTML file, plus a top-level \i{contents file}. If you set this
429 to 2, then each chapter \e{and} each \c{\\H} section will have a
430 file, and the chapter files will mostly just contain links to their
435 If you set this option to zero, then the whole document will appear
436 in a single file. If you do this, Halibut will call that file
437 \i\c{Manual.html} instead of \i\c{Contents.html} by default.
439 This option is automatically set to zero if you provide a file name
440 parameter after the command-line option \i\c{--html} (see
441 \k{running-options}), because you have specified a single file name
442 and so Halibut assumes you want the whole document to be placed in
447 \dt \I{\cw{\\cfg\{html-contents-depth\}}}\cw{\\cfg\{html-contents-depth\}\{}\e{level}\cw{\}\{}\e{depth}\cw{\}}
449 \dd This directive allows you to specify how \I{depth of
450 contents}deep any contents section in a particular level of file
455 The \e{level} parameter indicates which level of contents section
456 you are dealing with. 0 denotes the main contents section in the
457 topmost file \c{Contents.html}; 1 denotes a contents section in a
458 chapter file; 2 is a contents section in a file containing a \c{\\H}
461 The \e{depth} parameter indicates the maximum depth of heading which
462 will be shown in this contents section. Again, 1 denotes a chapter,
463 2 is a \c{\\H} heading, 3 is a \c{\\S} heading, and so on.
465 So, for example: \cw{\\cfg\{html-contents-depth\}\{1\}\{3\}} instructs
466 Halibut to put contents links in chapter files for all sections down
467 to \c{\\S} level, but not to go into any more detail than that.
469 For backwards compatibility, the alternative syntax
470 \cw{\\cfg\{html-contents-depth-}\e{level}\cw{\}\{}\e{depth}\cw{\}}
475 \dt \I{\cw{\\cfg\{html-leaf-contains-contents\}}}\cw{\\cfg\{html-leaf-contains-contents\}\{}\e{boolean}\cw{\}}
477 \dd If you set this to \c{true}, then each leaf file will contain
478 its own contents section which summarises the text within it.
480 \dt \I{\cw{\\cfg\{html-leaf-smallest-contents\}}}\cw{\\cfg\{html-leaf-smallest-contents\}\{}\e{number}\cw{\}}
482 \dd Contents sections in leaf files are not output at all if they
483 contain very few entries (on the assumption that it just isn't worth
484 bothering). This directive configures the minimum number of entries
485 required in a leaf contents section to make Halibut bother
486 generating it at all.
488 \S{output-html-html} Including pieces of your own HTML
490 The directives in this section allow you to supply pieces of
491 \I{HTML}\i{verbatim HTML} code, which will be included in various
492 parts of the output files.
494 Note that none of Halibut's usual character set translation is applied
495 to this code; it is assumed to already be in a suitable encoding for
496 the target HTML files.
498 \dt \I{\cw{\\cfg\{html-head-end\}}}\cw{\\cfg\{html-head-end\}\{}\e{HTML text}\cw{\}}
500 \dd The text you provide in this directive is placed at the end of
501 the \i\cw{<HEAD>} section of each output HTML file. So this is a
502 good place to put, for example, a link to a \i{CSS} \i{stylesheet}.
504 \dt \I{\cw{\\cfg\{html-local-head\}}}\cw{\\cfg\{html-local-head\}\{}\e{HTML text}\cw{\}}
506 \dd This configuration directive is local: you specify it within a
507 document section, and it acts on that section only.
511 The text you provide in this directive is placed at the end of the
512 \i\cw{<HEAD>} section of whichever output HTML file contains the
513 section in which the directive was placed. You can specify this
514 directive multiple times in multiple sections if you like.
516 This directive is particularly useful for constructing \i{MacOS
517 on-line help}, which is mostly normal HTML but which requires a
518 special \i\cw{<META NAME="AppleTitle">} tag in the topmost source
519 file. You can arrange this by placing this configuration directive
520 in the preamble or the introduction section, something like this:
522 \c \cfg{html-local-head}{<meta name="AppleTitle"
523 \c content="MyApp Help">}
527 \dt \I{\cw{\\cfg\{html-body-tag\}}}\cw{\\cfg\{html-body-tag\}\{}\e{HTML text}\cw{\}}
529 \dd The text you provide in this directive is used in place of the
530 \i\cw{<BODY>} tag in each output file. So if you wanted to define a
531 \i{background colour}, for example, you could write
532 \cw{\\cfg\{html-body-tag\}\{<body bg="#123456">\}}.
534 \dt \I{\cw{\\cfg\{html-body-start\}}}\cw{\\cfg\{html-body-start\}\{}\e{HTML text}\cw{\}}
536 \dd The text you provide in this directive is placed at the
537 beginning of the \i\cw{<BODY>} section of each output HTML file. So
538 if you intend your HTML files to be part of a web site with a
539 standard \i{house style}, and the style needs a \i{header} at the
540 top of every page, this is where you can add that header.
542 \dt \I{\cw{\\cfg\{html-body-end\}}}\cw{\\cfg\{html-body-end\}\{}\e{HTML text}\cw{\}}
544 \dd The text you provide in this directive is placed at the end of
545 the \i\cw{<BODY>} section of each output HTML file, before any address
546 section. So if you intend your HTML files to be part of a web site
547 with a standard \i{house style}, and the style needs a \i{footer} at
548 the bottom of every page, this is where you can add that footer.
550 \dt \I{\cw{\\cfg\{html-address-start\}}}\cw{\\cfg\{html-address-start\}\{}\e{HTML text}\cw{\}}
552 \dd The text you provide in this directive is placed at the
553 beginning of the \i\cw{<ADDRESS>} section at the bottom of each
554 output HTML file. This might be a good place to put authors'
555 \i{contact details}, for example.
557 \dt \I{\cw{\\cfg\{html-address-end\}}}\cw{\\cfg\{html-address-end\}\{}\e{HTML text}\cw{\}}
559 \dd The text you provide in this directive is placed at the end of
560 the \i\cw{<ADDRESS>} section at the bottom of each output HTML file,
561 after the version IDs (if present).
563 \dt \I{\cw{\\cfg\{html-navigation-attributes\}}}\cw{\\cfg\{html-navigation-attributes\}\{}\e{HTML attributes}\cw{\}}
565 \dd The text you provide in this directive is included inside the
566 \cw{<P>} tag containing the \i{navigation links} at the top of each
567 page (\i{\q{Previous}} / \i{\q{Contents}} / \i{\q{Next}}). So if you
568 wanted the navigation links to have a particular CSS style, you
570 \cw{\\cfg\{html-navigation-attributes\}\{class="foo"\}}, and the
571 navigation-links paragraph would then begin with the tag \cw{<p
574 \S{output-html-headings} \ii{Configuring heading display}
576 \dt \I{\cw{\\cfg\{html-chapter-numeric\}}}\cw{\\cfg\{html-chapter-numeric\}\{}\e{boolean}\cw{\}}
578 \dd If this is set to \c{true}, then chapter headings will not
579 contain the word \q{Chapter} (or whatever other word you have
580 defined in its place - see \k{input-sections} and \k{input-config});
581 they will just contain the chapter \e{number}, followed by the
582 chapter title. If you set this to \c{false}, chapter headings will
583 be prefixed by \q{Chapter} or equivalent.
585 \dt \I{\cw{\\cfg\{html-chapter-suffix\}}}\cw{\\cfg\{html-chapter-suffix\}\{}\e{text}\cw{\}}
587 \dd This specifies the suffix text to be appended to the chapter
588 number, before displaying the chapter title. For example, if you set
589 this to \cq{:\_}, then the chapter title might look something
590 like \q{Chapter 2: Doing Things}.
592 \dt \I{\cw{\\cfg\{html-section-numeric\}}}\cw{\\cfg\{html-section-numeric\}\{}\e{level}\cw{\}\{}\e{boolean}\cw{\}}
594 \# {level} can be omitted (defaults to 0). Is this intentional?
596 \dd Specifies whether section headings at a particular level should
597 contain the word \q{Section} or equivalent (if \c{false}), or should
598 be numeric only (if \c{true}). The \e{level} parameter specifies
599 which level of section headings you want to affect: 0 means
600 first-level headings (\c{\\H}), 1 means second-level headings
601 (\c{\\S}), 2 means the level below that (\c{\\S2}), and so on.
603 \dt \I{\cw{\\cfg\{html-section-suffix\}}}\cw{\\cfg\{html-section-suffix\}\{}\e{level}\cw{\}\{}\e{text}\cw{\}}
605 \# {level} can be omitted (defaults to 0). Is this intentional?
607 \dd Specifies the suffix text to be appended to section numbers at a
608 particular level, before displaying the section title.
610 \S{output-html-names} Configuring standard text
612 These directives let you fine-tune the names Halibut uses in places
613 such as the navigation bar to refer to various parts of the document,
614 and other standard pieces of text, for instance to change them to a
617 \dt \I{\cw{\\cfg\{html-preamble-text\}}}\cw{\\cfg\{html-preamble-text\}\{}\e{text}\cw{\}}
619 \dt \I{\cw{\\cfg\{html-contents-text\}}}\cw{\\cfg\{html-contents-text\}\{}\e{text}\cw{\}}
621 \dt \I{\cw{\\cfg\{html-index-text\}}}\cw{\\cfg\{html-index-text\}\{}\e{text}\cw{\}}
623 \dd Text used to refer to the preamble (i.e., any paragraphs before
624 the first chapter heading), contents, and index respectively, in the
625 navigation bar, contents, and index.
627 \dt \I{\cw{\\cfg\{html-title-separator\}}}\cw{\\cfg\{html-title-separator\}\{}\e{text}\cw{\}}
629 \dd If multiple headings are used in a file's \cw{<TITLE>} tag, this
630 text is used to separate them.
632 \# Under what circumstances can this occur?
634 \dt \I{\cw{\\cfg\{html-index-main-separator\}}}\cw{\\cfg\{html-index-main-separator\}\{}\e{text}\cw{\}}
636 \dd Separator between index term and references in the index.
638 \dt \I{\cw{\\cfg\{html-index-multiple-separator\}}}\cw{\\cfg\{html-index-multiple-separator\}\{}\e{text}\cw{\}}
640 \dd Separator between multiple references for a single index term in
643 \dt \I{\cw{\\cfg\{html-pre-versionid\}}}\cw{\\cfg\{html-pre-versionid\}\{}\e{text}\cw{\}}
645 \dt \I{\cw{\\cfg\{html-post-versionid\}}}\cw{\\cfg\{html-post-versionid\}\{}\e{text}\cw{\}}
647 \dd Text surrounding each output \i{version ID paragraph}.
649 \dt \I{\cw{\\cfg\{html-nav-prev-text\}}}\cw{\\cfg\{html-nav-prev-text\}\{}\e{text}\cw{\}}
651 \dt \I{\cw{\\cfg\{html-nav-next-text\}}}\cw{\\cfg\{html-nav-next-text\}\{}\e{text}\cw{\}}
653 \dd The text used for the \q{previous page} and \q{next page} links on
656 \dt \I{\cw{\\cfg\{html-nav-separator\}}}\cw{\\cfg\{html-nav-separator\}\{}\e{text}\cw{\}}
658 \dd Separator between links in the navigation bar.
660 \S{output-html-characters} Configuring the characters used
662 Unlike the other backends, HTML does not have a single
663 \i\cw{\\cfg\{html-charset\}} directive, as there are several levels of
664 character encoding to consider.
666 The character set names are the same as for
667 \cw{\\cfg\{input-charset\}} (see \k{input-config}). However, unlike
668 \cw{\\cfg\{input-charset\}}, these directives affect the \e{entire}
669 output; it's not possible to switch encodings halfway through.
671 \dt \I\cw{\\cfg\{html-output-charset\}}\cw{\\cfg\{html-output-charset\}\{}\e{character set name}\cw{\}}
673 \dd The character encoding of the HTML file to be output. Unicode
674 characters in this encoding's repertoire are included literally rather
675 than as \i{HTML entities}.
677 \dt \I\cw{\\cfg\{html-restrict-charset\}}\cw{\\cfg\{html-restrict-charset\}\{}\e{character set name}\cw{\}}
679 \dd Only Unicode characters representable in this character set will be
680 output; any others will be omitted and use their fallback text, if
681 any. Characters not in \q{html-output-charset} will be represented as
682 HTML numeric entities.
684 \dt \I{\cw{\\cfg\{html-quotes\}}}\cw{\\cfg\{html-quotes\}\{}\e{open-quote}\cw{\}\{}\e{close-quote}\cw{\}}[\cw{\{}\e{open-quote}\cw{\}\{}\e{close-quote}...\cw{\}}]
686 \dd Specifies the quotation marks to use, overriding any
687 \cw{\\cfg\{quotes\}} directive. You can specify multiple
688 fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}}
689 directive (see \k{output-text-characters}).
691 \S{output-html-misc} Miscellaneous options
693 \dt \I\cw{\\cfg\{html-version\}}\cw{\\cfg\{html-version\}\{}\e{version}\cw{\}}
695 \dd Identifies the precise version of HTML that is output. This
696 affects the declaration within the HTML, and also has minor effects on
697 the body of the HTML so that it is valid for the declare version. The
698 available variants are:
708 \b \cw{xhtml1.0transitional}
710 \b \cw{xhtml1.0strict}
714 \dt \I{\cw{\\cfg\{html-template-fragment\}}}\cw{\\cfg\{html-template-fragment\}\{}\e{template}\cw{\}}[\cw{\{}\e{template}\cw{\}\{}...\cw{\}}]
716 \dd This directive lets you specify a \i{template}, with exactly the
717 same syntax used in \cw{\\cfg\{html-template-filename\}} (see
718 \k{output-html-file}), to be used for the anchor names (\i\cw{<a
719 name="...">}) used to allow URLs to refer to specific sections
720 within a particular HTML file. So if you set this to \cq{%k},
721 for example, then each individual section in your document will be
722 addressable by means of a URL ending in a \c{#} followed by your
723 internal section keyword.
727 If more than one template is specified, anchors are generated in all
728 the specified formats; Halibut's own cross-references are generated
729 with the first template.
731 Characters that are not permitted in anchor names are stripped. If
732 there are no valid characters left, or a fragment is non-unique,
733 Halibut starts inventing fragment names and suffixes as appropriate.
735 Note that there are potentially fragment names that are not controlled
736 by this mechanism, such as index references.
740 \dt \I{\cw{\\cfg\{html-versionid\}}}\cw{\\cfg\{html-versionid\}\{}\e{boolean}\cw{\}}
742 \dd If this is set to \c{true}, \i{version ID paragraphs} (defined using
743 the \i\c{\\versionid} command - see \k{input-blurb}) will be included
744 visibly in the \i\cw{<ADDRESS>} section at the bottom of each HTML
745 file. If it is set to \c{false}, they will only be included as HTML
748 \dt \I{\cw{\\cfg\{html-suppress-address\}}}\cw{\\cfg\{html-suppress-address\}\{}\e{boolean}\cw{\}}
750 \dd If this is set to \c{true}, the \i\cw{<ADDRESS>} section at the
751 bottom of each HTML file will be omitted completely. (This will
752 therefore also cause \i{version IDs} not to be included visibly.)
754 \dt \I{\cw{\\cfg\{html-author\}}}\cw{\\cfg\{html-author\}\{}\e{text}\cw{\}}
756 \dd The text supplied here goes in a \I{\cw{<META>} tags}\cw{<META
757 name="author">} tag in the output HTML files, so that browsers which
758 support this can automatically identify the \i{author} of the document.
760 \dt \I{\cw{\\cfg\{html-description\}}}\cw{\\cfg\{html-description\}\{}\e{text}\cw{\}}
762 \dd The text supplied here goes in a \I{\cw{<META>} tags}\cw{<META
763 name="description">} tag in the output HTML files, so that browsers
764 which support this can easily pick out a brief \I{description, of
765 document}description of the document.
767 \S{output-html-defaults} Default settings
769 The \i{default settings} for Halibut's HTML output format are:
771 \c \cfg{html-contents-filename}{Contents.html}
772 \c \cfg{html-index-filename}{IndexPage.html}
773 \c \cfg{html-template-filename}{%n.html}
774 \c \cfg{html-single-filename}{Manual.html}
776 \c \cfg{html-leaf-level}{2}
777 \c \cfg{html-leaf-contains-contents}{false}
778 \c \cfg{html-leaf-smallest-contents}{4}
779 \c \cfg{html-contents-depth}{0}{2}
780 \c \cfg{html-contents-depth}{1}{3}
781 \c ... and so on for all section levels below this ...
782 \e iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii
784 \c \cfg{html-head-end}{}
785 \c \cfg{html-body-tag}{<body>}
786 \c \cfg{html-body-start}{}
787 \c \cfg{html-body-end}{}
788 \c \cfg{html-address-start}{}
789 \c \cfg{html-address-end}{}
790 \c \cfg{html-navigation-attributes}{}
792 \c \cfg{html-chapter-numeric}{false}
793 \c \cfg{html-chapter-suffix}{: }
795 \c \cfg{html-section-numeric}{0}{true}
796 \c \cfg{html-section-suffix}{0}{ }
798 \c \cfg{html-section-numeric}{1}{true}
799 \c \cfg{html-section-suffix}{1}{ }
801 \c ... and so on for all section levels below this ...
802 \e iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii
804 \c \cfg{html-preamble-text}{Preamble}
805 \c \cfg{html-contents-text}{Contents}
806 \c \cfg{html-index-text}{Index}
807 \c \cfg{html-title-separator}{ - }
808 \c \cfg{html-index-main-separator}{: }
809 \c \cfg{html-index-multiple-separator}{, }
810 \c \cfg{html-pre-versionid}{[}
811 \c \cfg{html-post-versionid}{]}
812 \c \cfg{html-nav-prev-text}{Previous}
813 \c \cfg{html-nav-next-text}{Next}
814 \c \cfg{html-nav-separator}{ | }
816 \c \cfg{html-output-charset}{ASCII}
817 \c \cfg{html-restrict-charset}{UTF-8}
818 \c \cfg{html-quotes}{\u2018}{\u2019}{"}{"}
820 \c \cfg{html-version}{html4}
821 \c \cfg{html-template-fragment}{%b}
822 \c \cfg{html-versionid}{true}
823 \c \cfg{html-suppress-address}{false}
824 \c \cfg{html-author}{}
825 \c \cfg{html-description}{}
827 \H{output-whlp} Windows Help
829 This output format generates data that can be used by the \i{Windows
830 Help} program \cw{WINHELP.EXE}. There are two actual files
831 generated, one ending in \c{.hlp} and the other ending in \c{.cnt}.
833 Currently, the output is hardcoded to be in the \q{\i{Win1252}}
834 character set. (If anyone knows how character sets are encoded in
835 Windows Help, we'd appreciate help.)
837 The Windows Help output format supports the following configuration
840 \S{output-whlp-file} Output file name
842 \dt \I{\cw{\\cfg\{winhelp-filename\}}}\cw{\\cfg\{winhelp-filename\}\{}\e{filename}\cw{\}}
844 \dd Sets the \i{output file name} in which to store the man page.
845 This directive is implicitly generated if you provide a file name
846 parameter after the command-line option \i\c{--winhelp} (see
847 \k{running-options}).
851 Your output file name should end with \c{.hlp}; if it doesn't,
852 Halibut will append it. Halibut will also generate a contents file
853 (ending in \c{.cnt}) alongside the file name you specify.
857 \S{output-whlp-characters} Configuring the characters used
859 \dt \I{\cw{\\cfg\{winhelp-bullet\}}}\cw{\\cfg\{winhelp-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]
861 \dd Specifies the text to use as the \i{bullet} in bulletted lists.
862 You can specify multiple fallback options. Works exactly like the
863 \cw{\\cfg\{text-bullet\}} directive (see
864 \k{output-text-characters}).
866 \dt \I{\cw{\\cfg\{winhelp-quotes\}}}\cw{\\cfg\{winhelp-quotes\}\{}\e{open-quote}\cw{\}\{}\e{close-quote}\cw{\}}[\cw{\{}\e{open-quote}\cw{\}\{}\e{close-quote}...\cw{\}}]
868 \dd Specifies the quotation marks to use, overriding any
869 \cw{\\cfg\{quotes\}} directive. You can specify multiple
870 fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}}
871 directive (see \k{output-text-characters}).
873 \S{output-whlp-misc} Miscellaneous configuration options
875 \dt \I{\cw{\\cfg\{winhelp-contents-titlepage\}}}\cw{\\cfg\{winhelp-contents-titlepage\}\{}\e{title}\cw{\}}
877 \dd Sets the text used to describe the help page containing the blurb
878 (see \k{input-blurb}) and table of contents.
881 \I{\cw{\\cfg\{winhelp-section-suffix\}}}\cw{\\cfg\{winhelp-section-suffix\}\{}\e{text}\cw{\}}
883 \dd Specifies the \I{suffix text, in section titles}suffix text to
884 be appended to section numbers, before displaying the section title.
885 (Applies to all levels.)
887 \dt \I{\cw{\\cfg\{winhelp-list-suffix\}}}\cw{\\cfg\{winhelp-list-suffix\}\{}\e{text}\cw{\}}
889 \dd This text is appended to the number on a \i{numbered list} item,
890 in exactly the same way as \cw{\\cfg\{text-list-suffix\}} (see
891 \k{output-text-characters}).
893 \dt \I{\cw{\\cfg\{winhelp-topic\}}}\cw{\\cfg\{winhelp-topic\}\{}\e{topic-name}\cw{\}}
895 \dd This directive defines a Windows \i{Help topic} name in the current
896 section. Topic names can be used by the program invoking
897 \cw{WINHELP.EXE} to jump straight to a particular section. So you
898 can use this for \i{context-sensitive help}.
902 For example, if you used this directive in a particular section:
904 \c \cfg{winhelp-topic}{savingfiles}
906 then a Windows application could invoke Windows Help to jump to that
907 particular section in the help file like this:
909 \c WinHelp(hwnd, "mydoc.hlp", HELP_COMMAND,
910 \c (DWORD)"JI(`',`savingfiles')");
912 You can use this configuration directive many times, in many
913 different subsections of your document, in order to define a lot of
914 different help contexts which you can use in this way.
918 \S{output-whlp-defaults} Default settings
920 The \i{default settings} for the Windows Help output format are:
922 \c \cfg{winhelp-filename}{output.hlp}
924 \c \cfg{winhelp-bullet}{\u2022}{-}
925 \c \cfg{winhelp-quotes}{\u2018}{\u2019}{"}{"}
927 \c \cfg{winhelp-contents-titlepage}{Title page}
928 \c \cfg{winhelp-section-suffix}{: }
929 \c \cfg{winhelp-list-suffix}{.}
931 and no \c{\\cfg\{winhelp-topic\}} directives anywhere.
933 \H{output-man} Unix \cw{man} pages
935 This output format generates a Unix \i{\cw{man} page}. That is to say,
936 it generates \i\c{nroff} input designed to work with the \c{-mandoc}
939 The available configuration options for this format are as follows:
941 \S{output-man-file} Output file name
943 \dt \I{\cw{\\cfg\{man-filename\}}}\cw{\\cfg\{man-filename\}\{}\e{filename}\cw{\}}
945 \dd Sets the \i{output file name} in which to store the man page.
946 This directive is implicitly generated if you provide a file name
947 parameter after the command-line option \i\c{--man} (see
948 \k{running-options}).
950 \S{output-man-identity} Configuring headers and footers
952 \dt \I{\cw{\\cfg\{man-identity\}}}\cw{\\cfg\{man-identity\}\{}\e{text}\cw{\}\{}\e{text...}\cw{\}}
954 \dd This directive is used to generate the initial \i{\c{.TH}
955 directive} that appears at the top of a \cw{man} page. It expects to
956 be followed by some number of brace pairs containing text, which will
957 be used in the \i{headers} and \i{footers} of the formatted output.
961 A traditional order for the arguments appears to be:
963 \n The name of the program.
965 \n The (numeric) manual section.
967 \n The date that the \cw{man} page was written.
969 \n The name of any containing suite of which the program is a part.
971 \n The name of the \i{author} of the \cw{man} page.
973 For example, a typical \cw{man} page might contain
975 \c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred
980 \S{output-man-headings} Configuring heading display
982 \dt \I{\cw{\\cfg\{man-headnumbers\}}}\cw{\\cfg\{man-headnumbers\}\{}\e{boolean}\cw{\}}
984 \dd If this is set to \c{true}, then \i{section headings} in the
985 \cw{man} page will have their \i{section numbers} displayed as usual. If
986 set to \c{false}, the section numbers will be omitted. (\cw{man}
987 pages traditionally have section names such as \q{SYNOPSIS},
988 \q{OPTIONS} and \q{BUGS}, and do not typically number them, so
989 \c{false} is the setting which conforms most closely to normal
992 \dt \I{\cw{\\cfg\{man-mindepth\}}}\cw{\\cfg\{man-mindepth\}\{}\e{depth}\cw{\}}
994 \dd If this is set to a number greater than 0, then section headings
995 \e{higher} than the given depth will not be displayed. If it is set
996 to zero, all section headings will be displayed as normal.
1000 The point of this is so that you can use the same Halibut input file
1001 to generate a quick-reference \cw{man} page for a program, \e{and} to
1002 include that \cw{man} page as an appendix in your program's full manual.
1003 If you are to include the \cw{man} page as an appendix, then the internal
1004 headings within the page will probably need to be at \c{\\H} or
1005 \c{\\S} level; therefore, when you format that input file on its own
1006 to create the \cw{man} page itself, you will need to have defined a
1007 \c{\\C} and possibly a \c{\\H} heading beforehand, which you don't
1008 want to see displayed.
1010 Here's an example. You might have a file \c{appendix.but}, which
1013 \c \A{manpages} \cw{man} pages for the Foo tool suite
1015 \c \cfg{man-mindepth}{2}
1017 Then you have a file \c{make-foo.but}, and probably others like it
1018 as well, each of which looks something like this:
1020 \c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred
1023 \c \H{man-foo} \cw{man} page for \c{make-foo}
1025 \c \S{man-foo-name} NAME
1027 \c \c{make-foo} - create Foo files for the Foo tool suite
1029 \c \S{man-foo-synopsis} SYNOPSIS
1031 \c ... and so on ...
1032 \e iiiiiiiiiiiiiiiii
1034 So when you're generating your main manual, you can include
1035 \c{appendix.but} followed by \c{make-foo.but} and any other \cw{man}
1036 pages you have, and your \cw{man} pages will be formatted neatly as
1037 part of an appendix. Then, in a separate run of Halibut, you can
1040 \c halibut appendix.but make-foo.but
1042 and this will generate a \cw{man} page \c{output.1}, in which the
1043 headings \q{\cw{man} pages for the Foo tool suite} and \q{\cw{man}
1044 page for \c{make-foo}} will not be displayed because of the
1045 \c{man-mindepth} directive. So the first visible heading in the
1046 output \cw{man} page will be \q{NAME}, exactly as a user would
1051 \S{output-man-characters} Configuring the characters used
1053 \dt \I{\cw{\\cfg\{man-charset\}}}\cw{\\cfg\{man-charset\}\{}\e{character set}\cw{\}}
1055 \dd Specifies what character set the output should be in, similarly to
1056 \cw{\\cfg\{text-charset\}} (see \k{output-text-characters}).
1058 \# FIXME: you're probably on your own in making sure that it's
1059 sensible to output man pages in that charset.
1061 \dt \I{\cw{\\cfg\{man-bullet\}}}\cw{\\cfg\{man-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]
1063 \dd Specifies the text to use as the \i{bullet} in bulletted lists.
1064 You can specify multiple fallback options. Works exactly like the
1065 \cw{\\cfg\{text-bullet\}} directive (see \k{output-text-characters}).
1067 \dt \I{\cw{\\cfg\{man-rule\}}}\cw{\\cfg\{man-rule\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}...\cw{\}}]
1069 \dd This specifies the text which should be used for drawing
1070 \i{horizontal rules} (generated by \i\c{\\rule}; see
1071 \k{input-rule}) when the manual page is rendered into text.
1072 It should only be one character long, but otherwise
1073 it works like the \cw{\\cfg\{text-rule\}} directive
1074 (see \k{output-text-characters}).
1076 \dt \I{\cw{\\cfg\{man-quotes\}}}\cw{\\cfg\{man-quotes\}\{}\e{open-quote}\cw{\}\{}\e{close-quote}\cw{\}}[\cw{\{}\e{open-quote}\cw{\}\{}\e{close-quote}...\cw{\}}]
1078 \dd Specifies the quotation marks to use, overriding any
1079 \cw{\\cfg\{quotes\}} directive. You can specify multiple
1080 fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}}
1081 directive (see \k{output-text-characters}).
1083 \S{output-man-defaults} Default settings
1085 The \i{default settings} for the \cw{man} page output format are:
1087 \c \cfg{man-filename}{output.1}
1089 \c \cfg{man-identity}{}
1091 \c \cfg{man-headnumbers}{false}
1092 \c \cfg{man-mindepth}{0}
1094 \c \cfg{man-charset}{ASCII}
1095 \c \cfg{man-bullet}{\u2022}{o}
1096 \c \cfg{man-rule}{\u2500}{-}
1097 \c \cfg{man-quotes}{\u2018}{\u2019}{"}{"}
1099 \H{output-info} GNU \c{info}
1101 This output format generates files which can be used with the \i{GNU
1104 There are typically multiple output files: a primary file whose name
1105 usually ends in \c{.info}, and one or more subsidiary files whose
1106 names have numbers on the end, so that they end in \c{.info-1},
1107 \c{.info-2} and so on. Alternatively, this output format can be
1108 configured to output a single large file containing the whole
1111 The \c{info} output format supports the following configuration
1114 \S{output-info-file} Controlling the output filenames
1116 \dt \I{\cw{\\cfg\{info-filename\}}}\cw{\\cfg\{info-filename\}\{}\e{filename}\cw{\}}
1118 \dd Sets the output file name in which to store the \c{info} file.
1119 This directive is implicitly generated if you provide a file name
1120 parameter after the command-line option \i\c{--info} (see
1121 \k{running-options}).
1125 The suffixes \c{-1}, \c{-2}, \c{-3} and so on will be appended to
1126 your output file name to produce any subsidiary files required.
1128 Note that \c{info} files refer to their own names internally, so
1129 these files cannot be \I{renaming \c{info} files}renamed after
1130 creation and remain useful.
1134 \dt \I{\cw{\\cfg\{info-max-file-size\}}}\cw{\\cfg\{info-max-file-size\}\{}\e{bytes}\cw{\}}
1136 \dd Sets the preferred \i{maximum file size} for each subsidiary
1137 file. As a special case, if you set this to zero, there will be no
1138 subsidiary files and the whole document will be placed in a single
1139 self-contained output file. (However, note that this file can still
1140 not be renamed usefully.)
1144 The preferred maximum file size is only a guideline. Halibut may be
1145 forced to exceed it if a single section of the document is larger
1146 than the maximum size (since individual \c{info} nodes may not be
1147 split between files).
1151 \S{output-info-dimensions} Indentation and line width
1153 \dt \I{\cw{\\cfg\{info-width\}}}\cw{\\cfg\{info-width\}\{}\e{width}\cw{\}}
1155 \dd Sets the \I{text width}width of the main part of the document,
1156 in characters. Works exactly like the \cw{\\cfg\{text-width\}}
1157 directive (see \k{output-text-dimensions}).
1159 \dt \I{\cw{\\cfg\{info-indent-code\}}}\cw{\\cfg\{info-indent-code\}\{}\e{indent}\cw{\}}
1161 \dd Specifies the extra indentation for \I{code paragraphs,
1162 indentation} code paragraphs. Works exactly like the
1163 \cw{\\cfg\{text-indent-code\}} directive (see
1164 \k{output-text-dimensions}).
1166 \dt \I{\cw{\\cfg\{info-index-width\}}}\cw{\\cfg\{info-index-width\}\{}\e{width}\cw{\}}
1168 \dd Specifies how much horizontal space to leave in the index node
1169 for the text of \i{index terms}, before displaying the sections the
1172 \dt \I{\cw{\\cfg\{info-list-indent\}}}\cw{\\cfg\{info-list-indent\}\{}\e{indent}\cw{\}}
1174 \dd Specifies the extra indentation before the bullet or number in a
1175 \I{bulletted list, indentation}\I{numbered list, indentation}list
1176 item. Works exactly like the \cw{\\cfg\{text-list-indent\}}
1177 directive (see \k{output-text-dimensions}).
1179 \dt \I{\cw{\\cfg\{info-listitem-indent\}}}\cw{\\cfg\{info-listitem-indent\}\{}\e{indent}\cw{\}}
1181 \dd Specifies the additional indentation before the body of a list
1182 item. Works exactly like the \cw{\\cfg\{text-listitem-indent\}}
1183 directive (see \k{output-text-dimensions}).
1185 \S{output-info-headings} Configuring heading display
1187 \dt \I{\cw{\\cfg\{info-section-suffix\}}}\cw{\\cfg\{info-section-suffix\}\{}\e{text}\cw{\}}
1189 \dd Specifies the suffix text to be appended to each section number
1190 before displaying the section title. For example, if you set this to
1191 \cq{:\_}, then a typical section title might look something like
1192 \q{Section 3.1: Something Like This}.
1194 \dt \I{\cw{\\cfg\{info-underline\}}}\cw{\\cfg\{info-underline\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]
1196 \dd Specifies the text to be used to underline section titles. Works
1197 very much like the \cw{\\cfg\{text-chapter-underline\}} directive
1198 (see \k{output-text-headings}). You can specify more than one
1199 option, and Halibut will choose the first one supported by the
1202 \S{output-info-characters} Controlling the characters used
1204 \dt \I{\cw{\\cfg\{info-charset\}}}\cw{\\cfg\{info-charset\}\{}\e{character set}\cw{\}}
1206 \dd Specifies what character set the output should be in, similarly to
1207 \cw{\\cfg\{text-charset\}} (see \k{output-text-characters}).
1209 \# FIXME: if you try sufficiently hard, you can probably find an
1210 output encoding that will break the info format by trampling on its
1211 special characters. So either don't do that, or tell us what we should
1214 \dt \I{\cw{\\cfg\{info-bullet\}}}\cw{\\cfg\{info-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]
1216 \dd Specifies the text to use as the \i{bullet} in bulletted lists.
1217 You can specify multiple fallback options. Works exactly like the
1218 \cw{\\cfg\{text-bullet\}} directive (see
1219 \k{output-text-characters}).
1221 \dt \I{\cw{\\cfg\{info-rule\}}}\cw{\\cfg\{info-rule\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]
1223 \dd Specifies the text used to draw \i{horizontal rules}. You can
1224 specify multiple fallback options. Works exactly like the
1225 \cw{\\cfg\{text-rule\}} directive (see \k{output-text-characters}).
1227 \dt \I{\cw{\\cfg\{info-quotes\}}}\cw{\\cfg\{info-quotes\}\{}\e{open-quote}\cw{\}\{}\e{close-quote}\cw{\}}[\cw{\{}\e{open-quote}\cw{\}\{}\e{close-quote}...\cw{\}}]
1229 \dd Specifies the quotation marks to use, overriding any
1230 \cw{\\cfg\{quotes\}} directive. You can specify multiple
1231 fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}}
1232 directive (see \k{output-text-characters}).
1234 \dt \I{\cw{\\cfg\{info-emphasis\}}}\cw{\\cfg\{info-emphasis\}\{}\e{start-emph}\cw{\}\{}\e{end-emph}\cw{\}}[\cw{\{}\e{start-emph}\cw{\}\{}\e{end-emph}...\cw{\}}]
1236 \dd Specifies how to display emphasised text. You can specify
1237 multiple fallback options. Works exactly like the
1238 \cw{\\cfg\{text-emphasis\}} directive (see
1239 \k{output-text-characters}).
1241 \S{output-info-misc} Miscellaneous configuration options
1243 \dt \I{\cw{\\cfg\{info-list-suffix\}}}\cw{\\cfg\{info-list-suffix\}\{}\e{text}\cw{\}}
1245 \dd Specifies the text to append to the item numbers in a
1246 \i{numbered list}. Works exactly like the
1247 \cw{\\cfg\{text-list-suffix\}} directive (see
1248 \k{output-text-misc}).
1250 \dt \I{\cw{\\cfg\{info-dir-entry\}}}\cw{\\cfg\{info-dir-entry\}\{}\e{section}\cw{\}\{}\e{short
1251 name}\cw{\}\{}\e{long name}\cw{\}}[\cw{\{}\e{keyword}\cw{\}}]
1253 \dd Constructs an \i\cw{INFO-DIR-ENTRY} section and places it in the
1254 header of the Info file. This mechanism is used to automatically
1255 generate the \i{\c{dir} file} at the root of a Unix system's
1256 \c{info} collection.
1260 The parameters to this directive are:
1264 \dd Specifies the section of the \c{dir} file in which you want your
1265 document referenced. For example, \q{Development}, or \q{Games}, or
1270 \dd Specifies a short name for the directory entry, which will
1271 appear at the start of the menu line.
1275 \dd Specifies a long name for the directory entry, which will appear
1276 at the end of the menu line.
1280 \dd This parameter is optional. If it is present, then the directory
1281 entry will cause a jump to a particular subsection of your document,
1282 rather than starting at the top. The subsection will be the one
1283 referred to by the given keyword (see \k{input-sections} for details
1284 about assigning keywords to document sections).
1286 For example, in a document describing many game programs, the
1287 configuration directive
1289 \c \cfg{info-dir-entry}{Games}{Chess}{Electronic chess
1292 might produce text in the \c{dir} file looking something like this:
1295 \c * Chess: (mygames)Chapter 3. Electronic chess game
1297 if the output file were called \c{mygames.info} and the keyword
1298 \c{chess} had been used to define Chapter 3 of the document.
1302 \S{output-info-defaults} Default settings
1304 The \i{default settings} for the \c{info} output format are:
1306 \c \cfg{info-filename}{output.info}
1307 \c \cfg{info-max-file-size}{65536}
1309 \c \cfg{info-width}{70}
1310 \c \cfg{info-indent-code}{2}
1311 \c \cfg{info-index-width}{40}
1312 \c \cfg{info-list-indent}{1}
1313 \c \cfg{info-listitem-indent}{3}
1315 \c \cfg{info-section-suffix}{: }
1316 \c \cfg{info-underline}{\u203e}{-}
1318 \c \cfg{info-charset}{ASCII}
1319 \c \cfg{info-bullet}{\u2022}{-}
1320 \c \cfg{info-rule}{\u2500}{-}
1321 \c \cfg{info-quotes}{\u2018}{\u2019}{`}{'}
1322 \c \cfg{info-emphasis}{_}{_}
1324 \c \cfg{info-list-suffix}{.}
1326 and no \cw{\\cfg\{info-dir-entry\}} directives.
1328 \H{output-paper} Paper formats
1330 These output formats (currently PostScript and PDF) generate printable
1331 manuals. As such, they share a number of configuration directives.
1333 \S{output-ps} \i{PostScript}
1335 This output format generates a printable manual in PostScript format.
1337 There is one configuration option specific to PostScript:
1339 \dt \I{\cw{\\cfg\{ps-filename\}}}\cw{\\cfg\{ps-filename\}\{}\e{filename}\cw{\}}
1341 \dd Sets the \i{output file name} in which to store the PostScript
1342 file. This directive is implicitly generated if you provide a file
1343 name parameter after the command-line option \i\c{--ps} (see
1344 \k{running-options}).
1346 The \i{default settings} for the PostScript output format are:
1348 \c \cfg{ps-filename}{output.ps}
1350 \S{output-pdf} \i{PDF}
1352 This output format generates a printable manual in PDF format. This
1353 should look exactly identical to the PostScript output (see
1354 \k{output-ps}), but also uses some PDF interactive features to
1355 provide an outline of all the document's sections and clickable
1356 cross-references between sections.
1358 There is one configuration option specific to PDF:
1360 \dt \I{\cw{\\cfg\{pdf-filename\}}}\cw{\\cfg\{pdf-filename\}\{}\e{filename}\cw{\}}
1362 \dd Sets the \i{output file name} in which to store the PDF file.
1363 This directive is implicitly generated if you provide a file name
1364 parameter after the command-line option \i\c{--pdf} (see
1365 \k{running-options}).
1367 The \i{default settings} for the PDF output format are:
1369 \c \cfg{pdf-filename}{output.pdf}
1371 \S{output-paper-dimensions} Configuring layout and \i{measurements}
1373 All measurements are in PostScript \i{points} (72 points to the inch).
1375 \S2{output-paper-pagesize} Page properties
1377 \dt \I{\cw{\\cfg\{paper-page-width\}}}\cw{\\cfg\{paper-page-width\}\{}\e{points}\cw{\}}
1379 \dt \I{\cw{\\cfg\{paper-page-height\}}}\cw{\\cfg\{paper-page-height\}\{}\e{points}\cw{\}}
1381 \dd Specify the absolute limits of the paper.
1383 \dt \I{\cw{\\cfg\{paper-left-margin\}}}\cw{\\cfg\{paper-left-margin\}\{}\e{points}\cw{\}}
1385 \dt \I{\cw{\\cfg\{paper-top-margin\}}}\cw{\\cfg\{paper-top-margin\}\{}\e{points}\cw{\}}
1387 \dt \I{\cw{\\cfg\{paper-right-margin\}}}\cw{\\cfg\{paper-right-margin\}\{}\e{points}\cw{\}}
1389 \dt \I{\cw{\\cfg\{paper-bottom-margin\}}}\cw{\\cfg\{paper-bottom-margin\}\{}\e{points}\cw{\}}
1391 \dd Specify the margins. Most text appears within these margins,
1396 \b Section numbers, which appear in the left margin.
1398 \b The footer (containing page numbers), which appears in the bottom
1403 \S2{output-paper-line} Vertical spacing
1405 \dt \I{\cw{\\cfg\{paper-base-leading\}}}\cw{\\cfg\{paper-base-leading\}\{}\e{points}\cw{\}}
1407 \dd Specifies the amount of space between lines of text within a
1408 paragraph. (So, if the font size is 12pt and there is 2pt of leading,
1409 there will be 14pt between successive baselines.)
1411 \dt \I{\cw{\\cfg\{paper-base-para-spacing\}}}\cw{\\cfg\{paper-base-para-spacing\}\{}\e{points}\cw{\}}
1413 \dd Specifies the amount of vertical space between paragraphs. (The
1414 vertical space between paragraphs does \e{not} include
1415 \c{paper-base-leading}.)
1417 \S2{output-paper-indentation} Indentation
1419 \dt \I{\cw{\\cfg\{paper-list-indent\}}}\cw{\\cfg\{paper-list-indent\}\{}\e{points}\cw{\}}
1421 \dd Specifies the indentation of the bullet or number in a
1422 \I{bulletted list, indentation}bulletted or \I{numbered list,
1423 indentation}numbers \I{list, indentation}list, similarly to
1424 \cw{\\cfg\{text-list-indent\}} (see \k{output-text-dimensions}).
1426 \dt \I{\cw{\\cfg\{paper-listitem-indent\}}}\cw{\\cfg\{paper-listitem-indent\}\{}\e{points}\cw{\}}
1428 \dd Specifies the \e{extra} indentation for the body of a list item,
1429 over and above the amount configured in \cw{\\cfg\{paper-list-indent\}}.
1431 \# FIXME: doesn't actually work, AFAICT.
1433 \dt \I{\cw{\\cfg\{paper-quote-indent\}}}\cw{\\cfg\{paper-quote-indent\}\{}\e{points}\cw{\}}
1435 \dd Specifies the amount of indentation for a level of quoting. Used
1436 for \cw{\\quote} (see \k{input-quote}) and code quotes with \cw{\\c}
1437 (see \k{input-code}).
1439 \S2{output-paper-headings} Headings
1441 \dt \I{\cw{\\cfg\{paper-chapter-top-space\}}}\cw{\\cfg\{paper-chapter-top-space\}\{}\e{points}\cw{\}}
1443 \dd Specifies the space between the top margin and the top of the
1444 chapter heading. (Each chapter begins on a new page.)
1446 \dt \I{\cw{\\cfg\{paper-chapter-underline-thickness\}}}\cw{\\cfg\{paper-chapter-underline-thickness\}\{}\e{points}\cw{\}}
1448 \dd Specifies the vertical thickness of the black rule under chapter
1451 \dt \I{\cw{\\cfg\{paper-chapter-underline-depth\}}}\cw{\\cfg\{paper-chapter-underline-depth\}\{}\e{points}\cw{\}}
1453 \dd Specifies the distance between the base of the chapter heading and
1454 the \e{base} of the underlying rule.
1456 \dt \I{\cw{\\cfg\{paper-sect-num-left-space\}}}\cw{\\cfg\{paper-sect-num-left-space\}\{}\e{points}\cw{\}}
1458 \dd Specifies the distance between the left margin and the \e{right}
1459 of section numbers (which are in the left margin).
1461 \S2{output-paper-index} Contents and index
1463 \dt \I{\cw{\\cfg\{paper-contents-index-step\}}}\cw{\\cfg\{paper-contents-index-step\}\{}\e{points}\cw{\}}
1465 \dt \I{\cw{\\cfg\{paper-contents-margin\}}}\cw{\\cfg\{paper-contents-margin\}\{}\e{points}\cw{\}}
1467 \# FIXME: I do not know what dees one does. (I couldn't get either of
1468 them to do anything obvious, although the source indicates they should
1471 \dt \I{\cw{\\cfg\{paper-leader-separation\}}}\cw{\\cfg\{paper-leader-separation\}\{}\e{points}\cw{\}}
1473 \dd Specifies the horizontal spacing between dots in \i\e{leaders}
1474 (the dotted lines that appear between section headings and page
1475 numbers in the table of contents).
1477 \dt \I{\cw{\\cfg\{paper-footer-distance\}}}\cw{\\cfg\{paper-footer-distance\}\{}\e{points}\cw{\}}
1479 \dd Specifies the distance between the bottom margin and the \e{base}
1480 of the footer (which contains page numbers).
1482 \dt \I{\cw{\\cfg\{paper-index-columns\}}}\cw{\\cfg\{paper-index-columns\}\{}\e{columns}\cw{\}}
1484 \dd Specifies the number of columns the index should be divided into.
1486 \# FIXME: with this set to 1, the right-alignment of some index entry
1487 page numbers in the Halibut manual is decidedly wonky.
1489 \dt \I{\cw{\\cfg\{paper-index-gutter\}}}\cw{\\cfg\{paper-index-gutter\}\{}\e{points}\cw{\}}
1491 \dd Specifies the amount of \I{gutter} horizontal space between index
1494 \dt \I{\cw{\\cfg\{paper-index-minsep\}}}\cw{\\cfg\{paper-index-minsep\}\{}\e{points}\cw{\}}
1496 \dd Specifies the minimum allowable horizontal space between an index
1497 entry and its page number. If the gap is smaller, the page number is
1498 moved to the next line.
1500 \S2{output-paper-fonts} Fonts
1502 \dt \I{\cw{\\cfg\{paper-base-font-size\}}}\cw{\\cfg\{paper-base-font-size\}\{}\e{points}\cw{\}}
1504 \dd Specifies the font size of body text.
1506 \# FIXME: actually, this doesn't appear to do anything at all - most
1507 font sizes are still hardcoded.
1509 \dt \I{\cw{\\cfg\{paper-pagenum-font-size\}}}\cw{\\cfg\{paper-pagenum-font-size\}\{}\e{points}\cw{\}}
1511 \dd Specifies the font size to use for page numbers.
1513 \S2{output-paper-misc} Miscellaneous
1515 \dt \I{\cw{\\cfg\{paper-rule-thickness\}}}\cw{\\cfg\{paper-rule-thickness\}\{}\e{points}\cw{\}}
1517 \dd Specifies the vertical thickness of the rule produced by the
1518 \cw{\\rule} command (see \k{input-rule}). (Note that no extra space is
1519 reserved for thicker rules.)
1521 \S{output-paper-characters} Configuring the characters used
1523 \dt \I{\cw{\\cfg\{paper-bullet\}}}\cw{\\cfg\{paper-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...]
1525 \dd Specifies the text to use as the \i{bullet} in bulletted lists.
1526 You can specify multiple fallback options. Works exactly like the
1527 \cw{\\cfg\{text-bullet\}} directive (see
1528 \k{output-text-characters}).
1530 \dt \I{\cw{\\cfg\{paper-quotes\}}}\cw{\\cfg\{paper-quotes\}\{}\e{open-quote}\cw{\}\{}\e{close-quote}\cw{\}}[\cw{\{}\e{open-quote}\cw{\}\{}\e{close-quote}...\cw{\}}]
1532 \dd Specifies the quotation marks to use, overriding any
1533 \cw{\\cfg\{quotes\}} directive. You can specify multiple
1534 fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}}
1535 directive (see \k{output-text-characters}).
1537 \S{output-paper-defaults} Default settings for paper formats
1539 The default page size corresponds to 210\_\u00D7{x}\_297\_mm, i.e.,
1542 \c \cfg{paper-page-width}{595}
1543 \c \cfg{paper-page-height}{841}
1545 \c \cfg{paper-left-margin}{72}
1546 \c \cfg{paper-top-margin}{72}
1547 \c \cfg{paper-right-margin}{72}
1548 \c \cfg{paper-bottom-margin}{108}
1550 \c \cfg{paper-base-leading}{1}
1551 \c \cfg{paper-base-para-spacing}{10}
1553 \c \cfg{paper-list-indent}{6}
1554 \c \cfg{paper-listitem-indent}{18}
1555 \c \cfg{paper-quote-indent}{18}
1557 \c \cfg{paper-chapter-top-space}{72}
1558 \c \cfg{paper-chapter-underline-thickness}{3}
1559 \c \cfg{paper-chapter-underline-depth}{14}
1560 \c \cfg{paper-sect-num-left-space}{12}
1562 \c \cfg{paper-contents-index-step}{24}
1563 \c \cfg{paper-contents-margin}{84}
1564 \c \cfg{paper-leader-separation}{12}
1565 \c \cfg{paper-footer-distance}{32}
1566 \c \cfg{paper-index-columns}{2}
1567 \c \cfg{paper-index-gutter}{36}
1568 \c \cfg{paper-index-minsep}{18}
1570 \c \cfg{paper-base-font-size}{12}
1571 \c \cfg{paper-pagenum-font-size}{12}
1573 \c \cfg{paper-rule-thickness}{1}
1575 \c \cfg{paper-bullet}{\u2022}{-}
1576 \c \cfg{paper-quotes}{\u2018}{\u2019}{'}{'}