| 1 | \C{output} Halibut output formats |
| 2 | |
| 3 | This chapter describes each of Halibut's current \i{output formats}. |
| 4 | It gives some general information about the format, and also |
| 5 | describes all the \i{configuration directives} which are specific to |
| 6 | that format. |
| 7 | |
| 8 | \H{output-text} Plain text |
| 9 | |
| 10 | This output format generates the document as a single \i{plain text} |
| 11 | file. No index is generated. |
| 12 | |
| 13 | The precise formatting of the text file can be controlled by a |
| 14 | variety of configuration directives. They are listed in the |
| 15 | following subsections. |
| 16 | |
| 17 | \S{output-text-file} Output file name |
| 18 | |
| 19 | \dt \I{\cw{\\cfg\{text-filename\}}}\cw{\\cfg\{text-filename\}\{}\e{filename}\cw{\}} |
| 20 | |
| 21 | \dd Sets the \i{output file name} in which to store the text file. |
| 22 | This directive is implicitly generated if you provide a file name |
| 23 | parameter after the command-line option \i\c{--text} (see |
| 24 | \k{running-options}). |
| 25 | |
| 26 | \S{output-text-dimensions} Indentation and line width |
| 27 | |
| 28 | This section describes the configuration directives which control |
| 29 | the \i{horizontal dimensions} of the output text file: how much |
| 30 | paragraphs are indented by and how long the lines are. |
| 31 | |
| 32 | \dt \I{\cw{\\cfg\{text-width\}}}\cw{\\cfg\{text-width\}\{}\e{width}\cw{\}} |
| 33 | |
| 34 | \dd Sets the \I{text width}width of the main part of the document, |
| 35 | in characters. This width will be used for wrapping paragraphs and |
| 36 | for centring titles (if you have asked for titles to be centred - |
| 37 | see \k{output-text-headings}). This width does \e{not} include the |
| 38 | left indentation set by \cw{\\cfg\{text-indent\}}; if you specify an |
| 39 | indent of 8 and a width of 64, your maximum output line length will |
| 40 | be 72. |
| 41 | |
| 42 | \dt \I{\cw{\\cfg\{text-indent\}}}\cw{\\cfg\{text-indent\}\{}\e{indent}\cw{\}} |
| 43 | |
| 44 | \dd Sets the left \i{indentation} for the document. If you set this |
| 45 | to zero, your document will look like an ordinary text file as |
| 46 | someone with a text editor might have written it; if you set it |
| 47 | above zero, the text file will have a \i{margin} down the left in |
| 48 | the style of some printed manuals, and you can then configure the |
| 49 | section numbers to appear in this margin (see |
| 50 | \k{output-text-headings}). |
| 51 | |
| 52 | \dt \I{\cw{\\cfg\{text-indent-code\}}}\cw{\\cfg\{text-indent-code\}\{}\e{indent}\cw{\}} |
| 53 | |
| 54 | \dd Specifies how many extra characters of indentation (on top of |
| 55 | the normal left indent) should be given to \I{code paragraphs, |
| 56 | indentation} code paragraphs. |
| 57 | |
| 58 | \dt \I{\cw{\\cfg\{text-list-indent\}}}\cw{\\cfg\{text-list-indent\}\{}\e{indent}\cw{\}} |
| 59 | |
| 60 | \dd Specifies how many extra spaces should be used to indent the |
| 61 | bullet or number in a \I{bulletted list, indentation}bulletted or |
| 62 | \I{numbered list, indentation}numbered \I{list, indentation}list. |
| 63 | The actual body of the list item will be indented by this much |
| 64 | \e{plus} the value configured by \cw{\\cfg\{text-listitem-indent\}}. |
| 65 | |
| 66 | \dt \I{\cw{\\cfg\{text-listitem-indent\}}}\cw{\\cfg\{text-listitem-indent\}\{}\e{indent}\cw{\}} |
| 67 | |
| 68 | \dd Specifies how many extra spaces should be used to indent the |
| 69 | body of a list item, over and above the number configured in |
| 70 | \cw{\\cfg\{text-list-indent\}}. |
| 71 | |
| 72 | \dt \I{\cw{\\cfg\{text-indent-preamble\}}}\cw{\\cfg\{text-indent-preamble\}\{}\e{boolean}\cw{\}} |
| 73 | |
| 74 | \dd When this is set to \c{true}, the document \i{preamble} (i.e. any |
| 75 | paragraphs appearing before the first chapter heading) will be |
| 76 | indented to the level specified by \cw{\\cfg\{text-indent\}}. If |
| 77 | this setting is \c{false}, the document preamble will not be |
| 78 | indented at all from the left margin. |
| 79 | |
| 80 | \S{output-text-headings} \ii{Configuring heading display} |
| 81 | |
| 82 | The directives in this section allow you to configure the appearance |
| 83 | of the title, chapter and section headings in your text file. |
| 84 | |
| 85 | Several of the directives listed below specify the \i{alignment} of |
| 86 | a heading. These alignment options have three possible values: |
| 87 | |
| 88 | \dt \i\c{left} |
| 89 | |
| 90 | \dd Align the heading to the very left of the text file (column zero). |
| 91 | |
| 92 | \dt \i\c{leftplus} |
| 93 | |
| 94 | \dd Align the section title to the left of the main display region |
| 95 | (in other words, indented to the level specified by |
| 96 | \cw{\\cfg\{text-indent\}}). The section \e{number} is placed to the |
| 97 | left of that (so that it goes in the margin if there is room). |
| 98 | |
| 99 | \dt \i\c{centre} |
| 100 | |
| 101 | \dd Centre the heading. |
| 102 | |
| 103 | Also, several of the directives below specify how a title should be |
| 104 | \I{underlining}underlined. The parameter to one of these directives |
| 105 | should be either blank (\cw{\{\}}) or a piece of text which will be |
| 106 | repeated to produce the underline. So you might want to specify, for |
| 107 | example, \cw{\\text-title-underline\{=\}} but |
| 108 | \cw{\\text-chapter-underline\{\-\}}. |
| 109 | |
| 110 | You can also specify more than one underline setting, and Halibut |
| 111 | will choose the first one that the output character set supports. |
| 112 | So, for example, you could write |
| 113 | \cw{\\text-chapter-underline\{\\u203e\}\{\-\}}, and Halibut would use |
| 114 | the Unicode \q{OVERLINE} character where possible and fall back to |
| 115 | the ASCII minus sign otherwise. |
| 116 | |
| 117 | \dt \I{\cw{\\cfg\{text-title-align\}}}\cw{\\cfg\{text-title-align\}\{}\e{alignment}\cw{\}} |
| 118 | |
| 119 | \dd Specifies the alignment of the overall document title: \c{left}, |
| 120 | \c{leftplus} or \c{centre}. |
| 121 | |
| 122 | \dt \I{\cw{\\cfg\{text-title-underline\}}}\cw{\\cfg\{text-title-underline\}\{}\e{underline-text}\cw{\}} |
| 123 | |
| 124 | \dd Specifies how the overall document title should be underlined. |
| 125 | |
| 126 | \dt \I{\cw{\\cfg\{text-chapter-align\}}}\cw{\\cfg\{text-chapter-align\}\{}\e{alignment}\cw{\}} |
| 127 | |
| 128 | \dd Specifies the alignment of chapter and appendix headings. |
| 129 | |
| 130 | \dt \I{\cw{\\cfg\{text-chapter-underline\}}}\cw{\\cfg\{text-chapter-underline\}\{}\e{underline-text}\cw{\}} |
| 131 | |
| 132 | \dd Specifies how chapter and appendix headings should be underlined. |
| 133 | |
| 134 | \dt \I{\cw{\\cfg\{text-chapter-numeric\}}}\cw{\\cfg\{text-chapter-numeric\}\{}\e{boolean}\cw{\}} |
| 135 | |
| 136 | \dd If this is set to \c{true}, then chapter headings will not |
| 137 | contain the word \q{Chapter} (or whatever other word you have |
| 138 | defined in its place - see \k{input-sections} and \k{input-config}); |
| 139 | they will just contain the chapter \e{number}, followed by the |
| 140 | chapter title. If you set this to \c{false}, chapter headings will |
| 141 | be prefixed by \q{Chapter} or equivalent. |
| 142 | |
| 143 | \dt \I{\cw{\\cfg\{text-chapter-suffix\}}}\cw{\\cfg\{text-chapter-suffix\}\{}\e{text}\cw{\}} |
| 144 | |
| 145 | \dd This specifies the suffix text to be appended to the chapter |
| 146 | number, before displaying the chapter title. For example, if you set |
| 147 | this to \q{\cw{:\_}}, then the chapter title might look something |
| 148 | like \q{Chapter 2: Doing Things}. |
| 149 | |
| 150 | \dt \I{\cw{\\cfg\{text-section-align\}}}\cw{\\cfg\{text-section-align\}\{}\e{level}\cw{\}\{}\e{alignment}\cw{\}} |
| 151 | |
| 152 | \dd Specifies the alignment of section headings at a particular |
| 153 | level. The \e{level} parameter specifies which level of section |
| 154 | headings you want to affect: 0 means first-level headings (\c{\\H}), |
| 155 | 1 means second-level headings (\c{\\S}), 2 means the level below |
| 156 | that (\c{\\S2}), and so on. The \e{alignment} parameter is treated |
| 157 | just like the other alignment directives listed above. |
| 158 | |
| 159 | \dt \I{\cw{\\cfg\{text-section-underline\}}}\cw{\\cfg\{text-section-underline\}\{}\e{level}\cw{\}\{}\e{underline-text}\cw{\}} |
| 160 | |
| 161 | \dd Specifies how to underline section headings at a particular level. |
| 162 | |
| 163 | \dt \I{\cw{\\cfg\{text-section-numeric\}}}\cw{\\cfg\{text-section-numeric\}\{}\e{level}\cw{\}\{}\e{boolean}\cw{\}} |
| 164 | |
| 165 | \dd Specifies whether section headings at a particular level should |
| 166 | contain the word \q{Section} or equivalent (if \c{false}), or should |
| 167 | be numeric only (if \c{true}). |
| 168 | |
| 169 | \dt \I{\cw{\\cfg\{text-section-suffix\}}}\cw{\\cfg\{text-section-suffix\}\{}\e{level}\cw{\}\{}\e{text}\cw{\}} |
| 170 | |
| 171 | \dd Specifies the \I{suffix text, in section titles}suffix text to |
| 172 | be appended to section numbers at a particular level, before |
| 173 | displaying the section title. |
| 174 | |
| 175 | \S{output-text-characters} Configuring the characters used |
| 176 | |
| 177 | \dt \I{\cw{\\cfg\{text-bullet\}}}\cw{\\cfg\{text-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}...\cw{\}}] |
| 178 | |
| 179 | \dd This specifies the text which should be used as the \i{bullet} |
| 180 | in bulletted lists. It can be one character |
| 181 | (\cw{\\cfg\{text-bullet\}\{-\}}), or more than one |
| 182 | (\cw{\\cfg\{text-bullet\}\{(*)\}}). |
| 183 | |
| 184 | \lcont{ |
| 185 | |
| 186 | Like \cw{\\cfg\{quotes\}} (see \k{input-config}), you can specify multiple |
| 187 | possible options after this command, and Halibut will choose the first one |
| 188 | which the output character set supports. For example, you might write |
| 189 | \cw{\\cfg\{text-bullet\}\{\\u2022\}\{\\u00b7\}\{*\}}, in which case |
| 190 | Halibut would use the Unicode \q{BULLET} character where possible, |
| 191 | fall back to the ISO-8859-1 \q{MIDDLE DOT} if that wasn't available, |
| 192 | and resort to the ASCII asterisk if all else failed. |
| 193 | |
| 194 | } |
| 195 | |
| 196 | \dt \I{\cw{\\cfg\{text-rule\}}}\cw{\\cfg\{text-rule\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}...\cw{\}}] |
| 197 | |
| 198 | \dd This specifies the text which should be used for drawing |
| 199 | \i{horizontal rules} (generated by \i\c{\\rule}; see |
| 200 | \k{input-rule}). It can be one character, or more than one. The |
| 201 | string you specify will be repeated to reach the required width, so |
| 202 | you can specify something like \q{\cw{-=}} to get a rule that looks |
| 203 | like \cw{-=-=-=}. |
| 204 | |
| 205 | \lcont{ |
| 206 | |
| 207 | Like \cw{\\cfg\{text-bullet\}}, you can specify multiple fallback |
| 208 | options in this command. |
| 209 | |
| 210 | } |
| 211 | |
| 212 | \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{\}}] |
| 213 | |
| 214 | \dd This specifies a set of quote characters for the text backend, |
| 215 | overriding any defined by \cw{\\cfg\{quotes\}}. It has the same syntax |
| 216 | (see \k{input-config}). |
| 217 | |
| 218 | \lcont{ |
| 219 | |
| 220 | In this backend, these quotes will also be used to mark text enclosed |
| 221 | in the \c{\\c} command (see \k{input-code}). |
| 222 | |
| 223 | } |
| 224 | |
| 225 | \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{\}}] |
| 226 | |
| 227 | \dd This specifies the characters which should be used to surround |
| 228 | emphasised text (written using the \c{\\e} command; see |
| 229 | \k{input-emph}). |
| 230 | |
| 231 | \lcont{ |
| 232 | |
| 233 | You should separately specify the start-emphasis and end-emphasis |
| 234 | text, each of which can be more than one character if you want. |
| 235 | Also, like \cw{\\cfg\{text-quotes\}}, you can specify multiple pairs |
| 236 | of fallback options in this command, and Halibut will always use a |
| 237 | matching pair. |
| 238 | |
| 239 | } |
| 240 | |
| 241 | \S{output-text-misc} Miscellaneous configuration options |
| 242 | |
| 243 | \dt \I\cw{\\cfg\{text-charset\}}\cw{\\cfg\{text-charset\}\{}\e{character set name}\cw{\}} |
| 244 | |
| 245 | \dd This tells Halibut what \i{character set} the output should be |
| 246 | in. Any Unicode characters representable in this set will be output |
| 247 | verbatim; any other characters will not be output and their |
| 248 | \i{fallback text} (if any) will be used instead. |
| 249 | |
| 250 | \lcont{ |
| 251 | |
| 252 | The character set names are the same as for |
| 253 | \cw{\\cfg\{input-charset\}} (see \k{input-config}). However, unlike |
| 254 | \cw{\\cfg\{input-charset\}}, this directive affects the \e{entire} |
| 255 | output; it's not possible to switch encodings halfway through. |
| 256 | |
| 257 | } |
| 258 | |
| 259 | \dt \I{\cw{\\cfg\{text-list-suffix\}}}\cw{\\cfg\{text-list-suffix\}\{}\e{text}\cw{\}} |
| 260 | |
| 261 | \dd This text is appended to the number on a \i{numbered list} item |
| 262 | (see \k{input-list-number}). So if you want to label your lists as |
| 263 | \q{1)}, \q{2)} and so on, then you would write |
| 264 | \cw{\\cfg\{text-list-suffix\}\{)\}}. |
| 265 | |
| 266 | \dt \I{\cw{\\cfg\{text-versionid\}}}\cw{\\cfg\{text-versionid\}\{}\e{boolean}\cw{\}} |
| 267 | |
| 268 | \dd If this is set to \c{true}, \i{version ID paragraphs} (defined |
| 269 | using the \i\c{\\versionid} command - see \k{input-blurb}) will be |
| 270 | included at the bottom of the text file. If it is set to \c{false}, |
| 271 | they will be omitted completely. |
| 272 | |
| 273 | \# FIXME: code indentation is configurable, therefore \quote |
| 274 | \# indentation probably ought to be as well. |
| 275 | |
| 276 | \# FIXME: text-indent-* should be consistently named. |
| 277 | |
| 278 | \S{output-text-defaults} Default settings |
| 279 | |
| 280 | The \i{default settings} for Halibut's plain text output format are: |
| 281 | |
| 282 | \c \cfg{text-filename}{output.txt} |
| 283 | \c |
| 284 | \c \cfg{text-width}{68} |
| 285 | \c \cfg{text-indent}{7} |
| 286 | \c \cfg{text-indent-code}{2} |
| 287 | \c \cfg{text-list-indent}{1} |
| 288 | \c \cfg{text-listitem-indent}{3} |
| 289 | \c \cfg{text-indent-preamble}{false} |
| 290 | \c |
| 291 | \c \cfg{text-title-align}{centre} |
| 292 | \c \cfg{text-title-underline}{\u2550}{=} |
| 293 | \c |
| 294 | \c \cfg{text-chapter-align}{left} |
| 295 | \c \cfg{text-chapter-underline}{\u203e}{-} |
| 296 | \c \cfg{text-chapter-numeric}{false} |
| 297 | \c \cfg{text-chapter-suffix}{: } |
| 298 | \c |
| 299 | \c \cfg{text-section-align}{0}{leftplus} |
| 300 | \c \cfg{text-section-underline}{0}{} |
| 301 | \c \cfg{text-section-numeric}{0}{true} |
| 302 | \c \cfg{text-section-suffix}{0}{ } |
| 303 | \c |
| 304 | \c \cfg{text-section-align}{1}{leftplus} |
| 305 | \c \cfg{text-section-underline}{1}{} |
| 306 | \c \cfg{text-section-numeric}{1}{true} |
| 307 | \c \cfg{text-section-suffix}{1}{ } |
| 308 | \c |
| 309 | \c ... and so on for all section levels below this ... |
| 310 | \e iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii |
| 311 | \c |
| 312 | \c \cfg{text-bullet}{\u2022}{-} |
| 313 | \c \cfg{text-rule}{\u2500}{-} |
| 314 | \c \cfg{text-quotes}{\u2018}{\u2019}{`}{'} |
| 315 | \c \cfg{text-emphasis}{_}{_} |
| 316 | \c |
| 317 | \c \cfg{text-charset}{ASCII} |
| 318 | \c \cfg{text-list-suffix}{.} |
| 319 | \c \cfg{text-versionid}{true} |
| 320 | |
| 321 | \H{output-html} HTML |
| 322 | |
| 323 | This output format generates an \i{HTML} version of the document. By |
| 324 | default, this will be in multiple files, starting with |
| 325 | \c{Contents.html} and splitting the document into files by chapter |
| 326 | and/or subsection. You can configure precisely how the text is split |
| 327 | between HTML files using the configuration commands described in |
| 328 | this section. In particular, you can configure Halibut to output one |
| 329 | single HTML file instead of multiple ones. |
| 330 | |
| 331 | Strictly speaking, the output format is \i{XHTML} 1.0 Transitional, |
| 332 | which is why all of the configuration directives start with the word |
| 333 | \c{xhtml} rather than \c{html}. |
| 334 | |
| 335 | \S{output-html-file} Controlling the output file names |
| 336 | |
| 337 | \dt \I{\cw{\\cfg\{xhtml-contents-filename\}}}\cw{\\cfg\{xhtml-contents-filename\}\{}\e{filename}\cw{\}} |
| 338 | |
| 339 | \dd Sets the \i{output file name} in which to store the top-level |
| 340 | contents page. Since this is the first page a user ought to see when |
| 341 | beginning to read the document, a good choice in many cases might be |
| 342 | \c{index.html} (although this is not the default, for historical |
| 343 | reasons). |
| 344 | |
| 345 | \dt \I{\cw{\\cfg\{xhtml-index-filename\}}}\cw{\\cfg\{xhtml-index-filename\}\{}\e{filename}\cw{\}} |
| 346 | |
| 347 | \dd Sets the file name in which to store the document's index. |
| 348 | |
| 349 | \dt \I{\cw{\\cfg\{xhtml-template-filename\}}}\cw{\\cfg\{xhtml-template-filename\}\{}\e{template}\cw{\}} |
| 350 | |
| 351 | \dd Provides a \i{template} to be used when constructing the file |
| 352 | names of each chapter or section of the document. This template |
| 353 | should contain at least one \i\e{formatting command}, in the form of |
| 354 | a per cent sign followed by a letter. (If you need a literal per |
| 355 | cent sign, you can write \c{%%}.) |
| 356 | |
| 357 | \lcont{ |
| 358 | |
| 359 | The formatting commands used in this template are: |
| 360 | |
| 361 | \dt \I{%N-upper}\c{%N} |
| 362 | |
| 363 | \dd Expands to the visible title of the section, with white space |
| 364 | removed. So in a chapter declared as \q{\cw{\\C\{fish\} Catching |
| 365 | Fish}}, this formatting command would expand to |
| 366 | \q{\cw{CatchingFish}}. |
| 367 | |
| 368 | \dt \i\c{%n} |
| 369 | |
| 370 | \dd Expands to the type and number of the section, without white |
| 371 | space. So in chapter 1 this would expand to \q{\cw{Chapter1}}; in |
| 372 | section A.4.3 it would expand to \q{\cw{SectionA.4.3}}, and so on. |
| 373 | If the section has no number (an unnumbered chapter created using |
| 374 | \c{\\U}), this directive falls back to doing the same thing as |
| 375 | \c{%N}. |
| 376 | |
| 377 | \dt \i\c{%b} |
| 378 | |
| 379 | \dd Expands to the bare number of the section. So in chapter 1 this |
| 380 | would expand to \q{\cw{1}}; in section A.4.3 it would expand to |
| 381 | \q{\cw{A.4.3}}, and so on. If the section has no number (an |
| 382 | unnumbered chapter created using \c{\\U}), this directive falls back |
| 383 | to doing the same thing as \c{%N}. |
| 384 | |
| 385 | \dt \i\c{%k} |
| 386 | |
| 387 | \dd Expands to the internal keyword specified in the section title. |
| 388 | So in a chapter declared as \q{\cw{\\C\{fish\} Catching Fish}}, this |
| 389 | formatting command would expand to \q{\cw{fish}}. If the section has |
| 390 | no keyword (an unnumbered chapter created using \c{\\U}), this |
| 391 | directive falls back to doing the same thing as \c{%N}. |
| 392 | |
| 393 | These formatting directives can also be used in the |
| 394 | \cw{\\cfg\{xhtml-template-fragment\}} configuration directive (see |
| 395 | \k{output-html-misc}). |
| 396 | |
| 397 | } |
| 398 | |
| 399 | \dt \I{\cw{\\cfg\{xhtml-single-filename\}}}\cw{\\cfg\{xhtml-single-filename\}\{}\e{filename}\cw{\}} |
| 400 | |
| 401 | \dd Sets the file name in which to store the entire document, if |
| 402 | Halibut is configured (using \c{\\cfg\{xhtml-leaf-level\}\{0\}} to |
| 403 | produce a single self-contained file. Both this directive \e{and} |
| 404 | \c{\\cfg\{xhtml-leaf-level\}\{0\}} are implicitly generated if you |
| 405 | provide a file name parameter after the command-line option |
| 406 | \i\c{--html} (see \k{running-options}). |
| 407 | |
| 408 | \S{output-html-split} Controlling the splitting into HTML files |
| 409 | |
| 410 | By default, the HTML output from Halibut is split into multiple |
| 411 | files. Each file typically contains a single chapter or section and |
| 412 | everything below it, unless subsections of that chapter are |
| 413 | themselves split off into further files. |
| 414 | |
| 415 | Most files also contain a contents section, giving hyperlinks to the |
| 416 | sections in the file and/or the sections below it. |
| 417 | |
| 418 | The configuration directives listed below allow you to configure the |
| 419 | splitting into files, and the details of the contents sections. |
| 420 | |
| 421 | \dt \I{\cw{\\cfg\{xhtml-leaf-level\}}}\cw{\\cfg\{xhtml-leaf-level\}\{}\e{depth}\cw{\}} |
| 422 | |
| 423 | \dd This setting indicates the depth of section which should be |
| 424 | given a \I{leaf file}\q{leaf} file (a file with no sub-files). So if |
| 425 | you set it to 1, for example, then every chapter will be given its |
| 426 | own HTML file, plus a top-level \i{contents file}. If you set this |
| 427 | to 2, then each chapter \e{and} each \c{\\H} section will have a |
| 428 | file, and the chapter files will mostly just contain links to their |
| 429 | \i{sub-file}s. |
| 430 | |
| 431 | \lcont{ |
| 432 | |
| 433 | If you set this option to zero, then the whole document will appear |
| 434 | in a single file. If you do this, Halibut will call that file |
| 435 | \i\c{Manual.html} instead of \i\c{Contents.html}. |
| 436 | |
| 437 | This option is automatically set to zero if you provide a file name |
| 438 | parameter after the command-line option \i\c{--html} (see |
| 439 | \k{running-options}), because you have specified a single file name |
| 440 | and so Halibut assumes you want the whole document to be placed in |
| 441 | that file. |
| 442 | |
| 443 | } |
| 444 | |
| 445 | \dt \I{\cw{\\cfg\{xhtml-contents-depth\}}}\cw{\\cfg\{xhtml-contents-depth-}\e{level}\cw{\}\{}\e{depth}\cw{\}} |
| 446 | |
| 447 | \dd This directive allows you to specify how \I{depth of |
| 448 | contents}deep the contents section in a particular file should go. |
| 449 | |
| 450 | \lcont{ |
| 451 | |
| 452 | The \e{level} parameter indicates which level of contents section |
| 453 | you are dealing with. 0 denotes the main contents section in the |
| 454 | topmost file \c{Contents.html}; 1 denotes a contents section in a |
| 455 | chapter file; 2 is a contents section in a file containing a \c{\\H} |
| 456 | heading, and so on. Currently you can't go below level 5 (which |
| 457 | corresponds to a \c{\\S3} heading). |
| 458 | |
| 459 | The \e{depth} parameter indicates the maximum depth of heading which |
| 460 | will be shown in this contents section. Again, 1 denotes a chapter, |
| 461 | 2 is a \c{\\H} heading, 3 is a \c{\\S} heading, and so on. |
| 462 | |
| 463 | So, for example: \cw{\\cfg\{xhtml-contents-depth-1\}\{3\}} instructs |
| 464 | Halibut to put contents links in chapter files for all sections down |
| 465 | to \c{\\S} level, but not to go into any more detail than that. |
| 466 | |
| 467 | } |
| 468 | |
| 469 | \# FIXME: this is utterly ghastly. For a start, it should include |
| 470 | \# the level as a separate argument, like the text section config |
| 471 | \# directives. Secondly, it shouldn't be limited in depth! |
| 472 | |
| 473 | \dt \I{\cw{\\cfg\{xhtml-leaf-contains-contents\}}}\cw{\\cfg\{xhtml-leaf-contains-contents\}\{}\e{boolean}\cw{\}} |
| 474 | |
| 475 | \dd If you set this to \c{true}, then each leaf file will contain |
| 476 | its own contents section which summarises the text within it. |
| 477 | |
| 478 | \dt \I{\cw{\\cfg\{xhtml-leaf-smallest-contents\}}}\cw{\\cfg\{xhtml-leaf-smallest-contents\}\{}\e{number}\cw{\}} |
| 479 | |
| 480 | \dd Contents sections in leaf files are not output at all if they |
| 481 | contain very few entries (on the assumption that it just isn't worth |
| 482 | bothering). This directive configures the minimum number of entries |
| 483 | required in a leaf contents section to make Halibut bother |
| 484 | generating it at all. |
| 485 | |
| 486 | \S{output-html-html} Including pieces of your own HTML |
| 487 | |
| 488 | The directives in this section allow you to supply pieces of |
| 489 | \I{HTML}\i{verbatim HTML} code, which will be included in various |
| 490 | parts of the output files. |
| 491 | |
| 492 | \dt \I{\cw{\\cfg\{xhtml-head-end\}}}\cw{\\cfg\{xhtml-head-end\}\{}\e{HTML text}\cw{\}} |
| 493 | |
| 494 | \dd The text you provide in this directive is placed at the end of |
| 495 | the \i\cw{<HEAD>} section of each output HTML file. So this is a |
| 496 | good place to put, for example, a link to a \i{CSS} \i{stylesheet}. |
| 497 | |
| 498 | \dt \I{\cw{\\cfg\{xhtml-body-tag\}}}\cw{\\cfg\{xhtml-body-tag\}\{}\e{HTML text}\cw{\}} |
| 499 | |
| 500 | \dd The text you provide in this directive is used in place of the |
| 501 | \i\cw{<BODY>} tag in each output file. So if you wanted to define a |
| 502 | \i{background colour}, for example, you could write |
| 503 | \cw{\\cfg\{xhtml-body-tag\}\{<body bg="#123456">\}}. |
| 504 | |
| 505 | \dt \I{\cw{\\cfg\{xhtml-body-start\}}}\cw{\\cfg\{xhtml-body-start\}\{}\e{HTML text}\cw{\}} |
| 506 | |
| 507 | \dd The text you provide in this directive is placed at the |
| 508 | beginning of the \i\cw{<BODY>} section of each output HTML file. So |
| 509 | if you intend your HTML files to be part of a web site with a |
| 510 | standard \i{house style}, and the style needs a \i{header} at the |
| 511 | top of every page, this is where you can add that header. |
| 512 | |
| 513 | \dt \I{\cw{\\cfg\{xhtml-body-end\}}}\cw{\\cfg\{xhtml-body-end\}\{}\e{HTML text}\cw{\}} |
| 514 | |
| 515 | \dd The text you provide in this directive is placed at the end of |
| 516 | the \i\cw{<BODY>} section of each output HTML file. So if you intend |
| 517 | your HTML files to be part of a web site with a standard \i{house |
| 518 | style}, and the style needs a \i{footer} at the bottom of every |
| 519 | page, this is where you can add that footer. |
| 520 | |
| 521 | \dt \I{\cw{\\cfg\{xhtml-address-start\}}}\cw{\\cfg\{xhtml-address-start\}\{}\e{HTML text}\cw{\}} |
| 522 | |
| 523 | \dd The text you provide in this directive is placed at the |
| 524 | beginning of the \i\cw{<ADDRESS>} section at the bottom of each |
| 525 | output HTML file. This might be a good place to put authors' |
| 526 | \i{contact details}, for example. |
| 527 | |
| 528 | \dt \I{\cw{\\cfg\{xhtml-address-end\}}}\cw{\\cfg\{xhtml-address-end\}\{}\e{HTML text}\cw{\}} |
| 529 | |
| 530 | \dd The text you provide in this directive is placed at the end of |
| 531 | the \i\cw{<ADDRESS>} section at the bottom of each output HTML file, |
| 532 | after the version IDs (if present). |
| 533 | |
| 534 | \dt \I{\cw{\\cfg\{xhtml-navigation-attributes\}}}\cw{\\cfg\{xhtml-navigation-attributes\}\{}\e{HTML attributes}\cw{\}} |
| 535 | |
| 536 | \dd The text you provide in this directive is included inside the |
| 537 | \cw{<P>} tag containing the \i{navigation links} at the top of each |
| 538 | page (\i{\q{Previous}} / \i{\q{Contents}} / \i{\q{Next}}). So if you |
| 539 | wanted the navigation links to have a particular CSS style, you |
| 540 | could write |
| 541 | \cw{\\cfg\{xhtml-navigation-attributes\}\{class="foo"\}}, and the |
| 542 | navigation-links paragraph would then begin with the tag \cw{<p |
| 543 | class="foo">}. |
| 544 | |
| 545 | \S{output-html-headings} \ii{Configuring heading display} |
| 546 | |
| 547 | \dt \I{\cw{\\cfg\{xhtml-chapter-numeric\}}}\cw{\\cfg\{xhtml-chapter-numeric\}\{}\e{boolean}\cw{\}} |
| 548 | |
| 549 | \dd If this is set to \c{true}, then chapter headings will not |
| 550 | contain the word \q{Chapter} (or whatever other word you have |
| 551 | defined in its place - see \k{input-sections} and \k{input-config}); |
| 552 | they will just contain the chapter \e{number}, followed by the |
| 553 | chapter title. If you set this to \c{false}, chapter headings will |
| 554 | be prefixed by \q{Chapter} or equivalent. |
| 555 | |
| 556 | \dt \I{\cw{\\cfg\{xhtml-chapter-suffix\}}}\cw{\\cfg\{xhtml-chapter-suffix\}\{}\e{text}\cw{\}} |
| 557 | |
| 558 | \dd This specifies the suffix text to be appended to the chapter |
| 559 | number, before displaying the chapter title. For example, if you set |
| 560 | this to \q{\cw{:\_}}, then the chapter title might look something |
| 561 | like \q{Chapter 2: Doing Things}. |
| 562 | |
| 563 | \dt \I{\cw{\\cfg\{xhtml-section-numeric\}}}\cw{\\cfg\{xhtml-section-numeric\}\{}\e{level}\cw{\}\{}\e{boolean}\cw{\}} |
| 564 | |
| 565 | \dd Specifies whether section headings at a particular level should |
| 566 | contain the word \q{Section} or equivalent (if \c{false}), or should |
| 567 | be numeric only (if \c{true}). The \e{level} parameter specifies |
| 568 | which level of section headings you want to affect: 0 means |
| 569 | first-level headings (\c{\\H}), 1 means second-level headings |
| 570 | (\c{\\S}), 2 means the level below that (\c{\\S2}), and so on. |
| 571 | |
| 572 | \dt \I{\cw{\\cfg\{xhtml-section-suffix\}}}\cw{\\cfg\{xhtml-section-suffix\}\{}\e{level}\cw{\}\{}\e{text}\cw{\}} |
| 573 | |
| 574 | \dd Specifies the suffix text to be appended to section numbers at a |
| 575 | particular level, before displaying the section title. |
| 576 | |
| 577 | \S{output-html-misc} Miscellaneous options |
| 578 | |
| 579 | \dt \I{\cw{\\cfg\{xhtml-template-fragment\}}}\cw{\\cfg\{xhtml-template-fragment\}\{}\e{template}\cw{\}} |
| 580 | |
| 581 | \dd This directive lets you specify a \i{template}, with exactly the |
| 582 | same syntax used in \cw{\\cfg\{xhtml-template-filename\}} (see |
| 583 | \k{output-html-file}), to be used for the anchor names (\i\cw{<A |
| 584 | NAME="...">}) used to allow URLs to refer to specific sections |
| 585 | within a particular HTML file. So if you set this to \q{\cw{%k}}, |
| 586 | for example, then each individual section in your document will be |
| 587 | addressable by means of a URL ending in a \c{#} followed by your |
| 588 | internal section keyword. |
| 589 | |
| 590 | \dt \I{\cw{\\cfg\{xhtml-versionid\}}}\cw{\\cfg\{xhtml-versionid\}\{}\e{boolean}\cw{\}} |
| 591 | |
| 592 | \dd If this is set to \c{true}, \i{version ID paragraphs} (defined using |
| 593 | the \i\c{\\versionid} command - see \k{input-blurb}) will be included |
| 594 | visibly in the \i\cw{<ADDRESS>} section at the bottom of each HTML |
| 595 | file. If it is set to \c{false}, they will be omitted completely. |
| 596 | |
| 597 | \# FIXME: surely it would be better to include them in HTML |
| 598 | \# comments? The only question is whether they should be _visible_. |
| 599 | |
| 600 | \dt \I{\cw{\\cfg\{xhtml-suppress-address\}}}\cw{\\cfg\{xhtml-suppress-address\}\{}\e{boolean}\cw{\}} |
| 601 | |
| 602 | \dd If this is set to \c{true}, the \i\cw{<ADDRESS>} section at the |
| 603 | bottom of each HTML file will be omitted completely. (This will |
| 604 | therefore also cause \i{version IDs} not to be included.) |
| 605 | |
| 606 | \dt \I{\cw{\\cfg\{xhtml-author\}}}\cw{\\cfg\{xhtml-author\}\{}\e{text}\cw{\}} |
| 607 | |
| 608 | \dd The text supplied here goes in a \I{\cw{<META>} tags}\cw{<META |
| 609 | name="author">} tag in the output HTML files, so that browsers which |
| 610 | support this can automatically identify the \i{author} of the document. |
| 611 | |
| 612 | \dt \I{\cw{\\cfg\{xhtml-description\}}}\cw{\\cfg\{xhtml-description\}\{}\e{text}\cw{\}} |
| 613 | |
| 614 | \dd The text supplied here goes in a \I{\cw{<META>} tags}\cw{<META |
| 615 | name="description">} tag in the output HTML files, so that browsers |
| 616 | which support this can easily pick out a brief \I{description, of |
| 617 | document}description of the document. |
| 618 | |
| 619 | \S{output-html-defaults} Default settings |
| 620 | |
| 621 | The \i{default settings} for Halibut's HTML output format are: |
| 622 | |
| 623 | \c \cfg{xhtml-contents-filename}{Contents.html} |
| 624 | \c \cfg{xhtml-index-filename}{IndexPage.html} |
| 625 | \c \cfg{xhtml-template-filename}{%n.html} |
| 626 | \c \cfg{xhtml-single-filename}{Manual.html} |
| 627 | \c \cfg{xhtml-template-fragment}{%b} |
| 628 | \c |
| 629 | \c \cfg{xhtml-leaf-level}{2} |
| 630 | \c \cfg{xhtml-leaf-contains-contents}{false} |
| 631 | \c \cfg{xhtml-leaf-smallest-contents}{4} |
| 632 | \c \cfg{xhtml-contents-depth-0}{2} |
| 633 | \c \cfg{xhtml-contents-depth-1}{3} |
| 634 | \c \cfg{xhtml-contents-depth-2}{4} |
| 635 | \c \cfg{xhtml-contents-depth-3}{5} |
| 636 | \c \cfg{xhtml-contents-depth-4}{6} |
| 637 | \c \cfg{xhtml-contents-depth-5}{7} |
| 638 | \c |
| 639 | \c \cfg{xhtml-head-end}{} |
| 640 | \c \cfg{xhtml-body-tag}{<body>} |
| 641 | \c \cfg{xhtml-body-start}{} |
| 642 | \c \cfg{xhtml-body-end}{} |
| 643 | \c \cfg{xhtml-address-start}{} |
| 644 | \c \cfg{xhtml-address-end}{} |
| 645 | \c \cfg{xhtml-navigation-attributes}{} |
| 646 | \c |
| 647 | \c \cfg{xhtml-versionid}{true} |
| 648 | \c \cfg{xhtml-suppress-address}{false} |
| 649 | \c \cfg{xhtml-author}{} |
| 650 | \c \cfg{xhtml-description}{} |
| 651 | \c |
| 652 | \c \cfg{xhtml-chapter-numeric}{false} |
| 653 | \c \cfg{xhtml-chapter-suffix}{: } |
| 654 | \c |
| 655 | \c \cfg{xhtml-section-numeric}{0}{true} |
| 656 | \c \cfg{xhtml-section-suffix}{0}{ } |
| 657 | \c |
| 658 | \c \cfg{xhtml-section-numeric}{1}{true} |
| 659 | \c \cfg{xhtml-section-suffix}{1}{ } |
| 660 | \c |
| 661 | \c ... and so on for all section levels below this ... |
| 662 | \e iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii |
| 663 | |
| 664 | \H{output-whlp} Windows Help |
| 665 | |
| 666 | This output format generates data that can be used by the \i{Windows |
| 667 | Help} program \cw{WINHELP.EXE}. There are two actual files |
| 668 | generated, one ending in \c{.hlp} and the other ending in \c{.cnt}. |
| 669 | |
| 670 | The output is in the \q{\i{Win1252}} character set. |
| 671 | |
| 672 | The Windows Help output format supports the following configuration |
| 673 | directives: |
| 674 | |
| 675 | \dt \I{\cw{\\cfg\{winhelp-filename\}}}\cw{\\cfg\{winhelp-filename\}\{}\e{filename}\cw{\}} |
| 676 | |
| 677 | \dd Sets the \i{output file name} in which to store the man page. |
| 678 | This directive is implicitly generated if you provide a file name |
| 679 | parameter after the command-line option \i\c{--winhelp} (see |
| 680 | \k{running-options}). |
| 681 | |
| 682 | \lcont{ |
| 683 | |
| 684 | Your output file name should end with \c{.hlp}; if it doesn't, |
| 685 | Halibut will append it. Halibut will also generate a contents file |
| 686 | (ending in \c{.cnt}) alongside the file name you specify. |
| 687 | |
| 688 | } |
| 689 | |
| 690 | \dt \I{\cw{\\cfg\{winhelp-contents-titlepage\}}}\cw{\\cfg\{winhelp-contents-titlepage\}\{}\e{title}\cw{\}} |
| 691 | |
| 692 | \dd Sets the text used to describe the help page containing the blurb |
| 693 | (see \k{input-blurb}) and table of contents. |
| 694 | |
| 695 | \dt |
| 696 | \I{\cw{\\cfg\{winhelp-section-suffix\}}}\cw{\\cfg\{winhelp-section-suffix\}\{}\e{text}\cw{\}} |
| 697 | |
| 698 | \dd Specifies the \I{suffix text, in section titles}suffix text to |
| 699 | be appended to section numbers, before displaying the section title. |
| 700 | (Applies to all levels.) |
| 701 | |
| 702 | \dt \I{\cw{\\cfg\{winhelp-list-suffix\}}}\cw{\\cfg\{winhelp-list-suffix\}\{}\e{text}\cw{\}} |
| 703 | |
| 704 | \dd This text is appended to the number on a \i{numbered list} item, |
| 705 | in exactly the same way as \cw{\\cfg\{text-list-suffix\}} (see |
| 706 | \k{output-text-misc}). |
| 707 | |
| 708 | \dt \I{\cw{\\cfg\{winhelp-bullet\}}}\cw{\\cfg\{winhelp-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...] |
| 709 | |
| 710 | \dd Specifies the text to use as the \i{bullet} in bulletted lists. |
| 711 | You can specify multiple fallback options. Works exactly like the |
| 712 | \cw{\\cfg\{text-bullet\}} directive (see |
| 713 | \k{output-text-characters}). |
| 714 | |
| 715 | \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{\}}] |
| 716 | |
| 717 | \dd Specifies the quotation marks to use, overriding any |
| 718 | \cw{\\cfg\{quotes\}} directive. You can specify multiple |
| 719 | fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}} |
| 720 | directive (see \k{output-text-characters}). |
| 721 | |
| 722 | \dt \I{\cw{\\cfg\{winhelp-topic\}}}\cw{\\cfg\{winhelp-topic\}\{}\e{topic-name}\cw{\}} |
| 723 | |
| 724 | \dd This directive defines a Windows \i{Help topic} name in the current |
| 725 | section. Topic names can be used by the program invoking |
| 726 | \cw{WINHELP.EXE} to jump straight to a particular section. So you |
| 727 | can use this for \i{context-sensitive help}. |
| 728 | |
| 729 | \lcont{ |
| 730 | |
| 731 | For example, if you used this directive in a particular section: |
| 732 | |
| 733 | \c \cfg{winhelp-topic}{savingfiles} |
| 734 | |
| 735 | then a Windows application could invoke Windows Help to jump to that |
| 736 | particular section in the help file like this: |
| 737 | |
| 738 | \c WinHelp(hwnd, "mydoc.hlp", HELP_COMMAND, |
| 739 | \c (DWORD)"JI(`',`savingfiles')"); |
| 740 | |
| 741 | You can use this configuration directive many times, in many |
| 742 | different subsections of your document, in order to define a lot of |
| 743 | different help contexts which you can use in this way. |
| 744 | |
| 745 | } |
| 746 | |
| 747 | The \i{default settings} for the Windows Help output format are: |
| 748 | |
| 749 | \c \cfg{winhelp-filename}{output.hlp} |
| 750 | \c \cfg{winhelp-contents-titlepage}{Title page} |
| 751 | \c \cfg{winhelp-section-suffix}{: } |
| 752 | \c \cfg{winhelp-list-suffix}{.} |
| 753 | \c \cfg{winhelp-bullet}{\u2022}{-} |
| 754 | \c \cfg{winhelp-quotes}{\u2018}{\u2019}{"}{"} |
| 755 | |
| 756 | and no \c{\\cfg\{winhelp-topic\}} directives anywhere. |
| 757 | |
| 758 | \H{output-man} Unix \cw{man} pages |
| 759 | |
| 760 | This output format generates a Unix \i{\cw{man} page}. That is to say, |
| 761 | it generates \i\c{nroff} input designed to work with the \c{-mandoc} |
| 762 | macro package. |
| 763 | |
| 764 | The available configuration options for this format are as follows: |
| 765 | |
| 766 | \dt \I{\cw{\\cfg\{man-filename\}}}\cw{\\cfg\{man-filename\}\{}\e{filename}\cw{\}} |
| 767 | |
| 768 | \dd Sets the \i{output file name} in which to store the man page. |
| 769 | This directive is implicitly generated if you provide a file name |
| 770 | parameter after the command-line option \i\c{--man} (see |
| 771 | \k{running-options}). |
| 772 | |
| 773 | \dt \I{\cw{\\cfg\{man-identity\}}}\cw{\\cfg\{man-identity\}\{}\e{text}\cw{\}\{}\e{text...}\cw{\}} |
| 774 | |
| 775 | \dd This directive is used to generate the initial \i{\c{.TH} |
| 776 | directive} that appears at the top of a \cw{man} page. It expects to |
| 777 | be followed by some number of brace pairs containing text, which will |
| 778 | be used in the \i{headers} and \i{footers} of the formatted output. |
| 779 | |
| 780 | \lcont{ |
| 781 | |
| 782 | A traditional order for the arguments appears to be: |
| 783 | |
| 784 | \n The name of the program. |
| 785 | |
| 786 | \n The (numeric) manual section. |
| 787 | |
| 788 | \n The date that the \cw{man} page was written. |
| 789 | |
| 790 | \n The name of any containing suite of which the program is a part. |
| 791 | |
| 792 | \n The name of the \i{author} of the \cw{man} page. |
| 793 | |
| 794 | For example, a typical \cw{man} page might contain |
| 795 | |
| 796 | \c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred |
| 797 | \c Bloggs} |
| 798 | |
| 799 | } |
| 800 | |
| 801 | \dt \I{\cw{\\cfg\{man-headnumbers\}}}\cw{\\cfg\{man-headnumbers\}\{}\e{boolean}\cw{\}} |
| 802 | |
| 803 | \dd If this is set to \c{true}, then \i{section headings} in the |
| 804 | \cw{man} page will have their \i{section numbers} displayed as usual. If |
| 805 | set to \c{false}, the section numbers will be omitted. (\cw{man} |
| 806 | pages traditionally have section names such as \q{SYNOPSIS}, |
| 807 | \q{OPTIONS} and \q{BUGS}, and do not typically number them, so |
| 808 | \c{false} is the setting which conforms most closely to normal |
| 809 | \cw{man} style.) |
| 810 | |
| 811 | \dt \I{\cw{\\cfg\{man-mindepth\}}}\cw{\\cfg\{man-mindepth\}\{}\e{depth}\cw{\}} |
| 812 | |
| 813 | \dd If this is set to a number greater than 0, then section headings |
| 814 | \e{higher} than the given depth will not be displayed. If it is set |
| 815 | to zero, all section headings will be displayed as normal. |
| 816 | |
| 817 | \lcont{ |
| 818 | |
| 819 | The point of this is so that you can use the same Halibut input file |
| 820 | to generate a quick-reference \cw{man} page for a program, \e{and} to |
| 821 | include that \cw{man} page as an appendix in your program's full manual. |
| 822 | If you are to include the \cw{man} page as an appendix, then the internal |
| 823 | headings within the page will probably need to be at \c{\\H} or |
| 824 | \c{\\S} level; therefore, when you format that input file on its own |
| 825 | to create the \cw{man} page itself, you will need to have defined a |
| 826 | \c{\\C} and possibly a \c{\\H} heading beforehand, which you don't |
| 827 | want to see displayed. |
| 828 | |
| 829 | Here's an example. You might have a file \c{appendix.but}, which |
| 830 | simply says |
| 831 | |
| 832 | \c \A{manpages} \cw{man} pages for the Foo tool suite |
| 833 | \c |
| 834 | \c \cfg{man-mindepth}{2} |
| 835 | |
| 836 | Then you have a file \c{make-foo.but}, and probably others like it |
| 837 | as well, each of which looks something like this: |
| 838 | |
| 839 | \c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred |
| 840 | \c Bloggs} |
| 841 | \c |
| 842 | \c \H{man-foo} \cw{man} page for \c{make-foo} |
| 843 | \c |
| 844 | \c \S{man-foo-name} NAME |
| 845 | \c |
| 846 | \c \c{make-foo} - create Foo files for the Foo tool suite |
| 847 | \c |
| 848 | \c \S{man-foo-synopsis} SYNOPSIS |
| 849 | \c |
| 850 | \c ... and so on ... |
| 851 | \e iiiiiiiiiiiiiiiii |
| 852 | |
| 853 | So when you're generating your main manual, you can include |
| 854 | \c{appendix.but} followed by \c{make-foo.but} and any other \cw{man} |
| 855 | pages you have, and your \cw{man} pages will be formatted neatly as |
| 856 | part of an appendix. Then, in a separate run of Halibut, you can |
| 857 | just do |
| 858 | |
| 859 | \c halibut appendix.but make-foo.but |
| 860 | |
| 861 | and this will generate a \cw{man} page \c{output.1}, in which the |
| 862 | headings \q{\cw{man} pages for the Foo tool suite} and \q{\cw{man} |
| 863 | page for \c{make-foo}} will not be displayed because of the |
| 864 | \c{man-mindepth} directive. So the first visible heading in the |
| 865 | output \cw{man} page will be \q{NAME}, exactly as a user would |
| 866 | expect. |
| 867 | |
| 868 | } |
| 869 | |
| 870 | \dt \I{\cw{\\cfg\{man-charset\}}}\cw{\\cfg\{man-charset\}\{}\e{character set}\cw{\}} |
| 871 | |
| 872 | \dd Specifies what character set the output should be in, similarly to |
| 873 | \cw{\\cfg\{text-charset\}} (see \k{output-text-misc}). |
| 874 | |
| 875 | \# FIXME: you're probably on your own in making sure that it's |
| 876 | sensible to output man pages in that charset. |
| 877 | |
| 878 | \dt \I{\cw{\\cfg\{man-bullet\}}}\cw{\\cfg\{man-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...] |
| 879 | |
| 880 | \dd Specifies the text to use as the \i{bullet} in bulletted lists. |
| 881 | You can specify multiple fallback options. Works exactly like the |
| 882 | \cw{\\cfg\{text-bullet\}} directive (see \k{output-text-characters}). |
| 883 | |
| 884 | \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{\}}] |
| 885 | |
| 886 | \dd Specifies the quotation marks to use, overriding any |
| 887 | \cw{\\cfg\{quotes\}} directive. You can specify multiple |
| 888 | fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}} |
| 889 | directive (see \k{output-text-characters}). |
| 890 | |
| 891 | The \i{default settings} for the \cw{man} page output format are: |
| 892 | |
| 893 | \c \cfg{man-filename}{output.1} |
| 894 | \c \cfg{man-identity}{} |
| 895 | \c \cfg{man-headnumbers}{false} |
| 896 | \c \cfg{man-mindepth}{0} |
| 897 | \c \cfg{man-charset}{ASCII} |
| 898 | \c \cfg{man-bullet}{\u2022}{o} |
| 899 | \c \cfg{man-quotes}{\u2018}{\u2019}{"}{"} |
| 900 | |
| 901 | \H{output-info} GNU \c{info} |
| 902 | |
| 903 | This output format generates files which can be used with the \i{GNU |
| 904 | \c{info}} program. |
| 905 | |
| 906 | There are typically multiple output files: a primary file whose name |
| 907 | usually ends in \c{.info}, and one or more subsidiary files whose |
| 908 | names have numbers on the end, so that they end in \c{.info-1}, |
| 909 | \c{.info-2} and so on. Alternatively, this output format can be |
| 910 | configured to output a single large file containing the whole |
| 911 | document. |
| 912 | |
| 913 | The \c{info} output format supports the following configuration |
| 914 | directives: |
| 915 | |
| 916 | \dt \I{\cw{\\cfg\{info-filename\}}}\cw{\\cfg\{info-filename\}\{}\e{filename}\cw{\}} |
| 917 | |
| 918 | \dd Sets the output file name in which to store the \c{info} file. |
| 919 | This directive is implicitly generated if you provide a file name |
| 920 | parameter after the command-line option \i\c{--info} (see |
| 921 | \k{running-options}). |
| 922 | |
| 923 | \lcont{ |
| 924 | |
| 925 | The suffixes \c{-1}, \c{-2}, \c{-3} and so on will be appended to |
| 926 | your output file name to produce any subsidiary files required. |
| 927 | |
| 928 | Note that \c{info} files refer to their own names internally, so |
| 929 | these files cannot be \I{renaming \c{info} files}renamed after |
| 930 | creation and remain useful. |
| 931 | |
| 932 | } |
| 933 | |
| 934 | \dt \I{\cw{\\cfg\{info-width\}}}\cw{\\cfg\{info-width\}\{}\e{width}\cw{\}} |
| 935 | |
| 936 | \dd Sets the \I{text width}width of the main part of the document, |
| 937 | in characters. Works exactly like the \cw{\\cfg\{text-width\}} |
| 938 | directive (see \k{output-text-dimensions}). |
| 939 | |
| 940 | \dt \I{\cw{\\cfg\{info-indent-code\}}}\cw{\\cfg\{info-indent-code\}\{}\e{indent}\cw{\}} |
| 941 | |
| 942 | \dd Specifies the extra indentation for \I{code paragraphs, |
| 943 | indentation} code paragraphs. Works exactly like the |
| 944 | \cw{\\cfg\{text-indent-code\}} directive (see |
| 945 | \k{output-text-dimensions}). |
| 946 | |
| 947 | \dt \I{\cw{\\cfg\{info-index-width\}}}\cw{\\cfg\{info-index-width\}\{}\e{width}\cw{\}} |
| 948 | |
| 949 | \dd Specifies how much horizontal space to leave in the index node |
| 950 | for the text of \i{index terms}, before displaying the sections the |
| 951 | terms occur in. |
| 952 | |
| 953 | \dt \I{\cw{\\cfg\{info-list-indent\}}}\cw{\\cfg\{info-list-indent\}\{}\e{indent}\cw{\}} |
| 954 | |
| 955 | \dd Specifies the extra indentation before the bullet or number in a |
| 956 | \I{bulletted list, indentation}\I{numbered list, indentation}list |
| 957 | item. Works exactly like the \cw{\\cfg\{text-list-indent\}} |
| 958 | directive (see \k{output-text-dimensions}). |
| 959 | |
| 960 | \dt \I{\cw{\\cfg\{info-listitem-indent\}}}\cw{\\cfg\{info-listitem-indent\}\{}\e{indent}\cw{\}} |
| 961 | |
| 962 | \dd Specifies the additional indentation before the body of a list |
| 963 | item. Works exactly like the \cw{\\cfg\{text-listitem-indent\}} |
| 964 | directive (see \k{output-text-dimensions}). |
| 965 | |
| 966 | \dt \I{\cw{\\cfg\{info-charset\}}}\cw{\\cfg\{info-charset\}\{}\e{character set}\cw{\}} |
| 967 | |
| 968 | \dd Specifies what character set the output should be in, similarly to |
| 969 | \cw{\\cfg\{text-charset\}} (see \k{output-text-misc}). |
| 970 | |
| 971 | \# FIXME: if you try sufficiently hard, you can probably find an |
| 972 | output encoding that will break the info format by trampling on its |
| 973 | special characters. So either don't do that, or tell us what we should |
| 974 | do about it. |
| 975 | |
| 976 | \dt \I{\cw{\\cfg\{info-section-suffix\}}}\cw{\\cfg\{info-section-suffix\}\{}\e{text}\cw{\}} |
| 977 | |
| 978 | \dd Specifies the suffix text to be appended to each section number |
| 979 | before displaying the section title. For example, if you set this to |
| 980 | \q{\cw{:\_}}, then a typical section title might look something like |
| 981 | \q{Section 3.1: Something Like This}. |
| 982 | |
| 983 | \dt \I{\cw{\\cfg\{info-underline\}}}\cw{\\cfg\{info-underline\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...] |
| 984 | |
| 985 | \dd Specifies the text to be used to underline section titles. Works |
| 986 | very much like the \cw{\\cfg\{text-chapter-underline\}} directive |
| 987 | (see \k{output-text-headings}). You can specify more than one |
| 988 | option, and Halibut will choose the first one supported by the |
| 989 | character set. |
| 990 | |
| 991 | \dt \I{\cw{\\cfg\{info-bullet\}}}\cw{\\cfg\{info-bullet\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...] |
| 992 | |
| 993 | \dd Specifies the text to use as the \i{bullet} in bulletted lists. |
| 994 | You can specify multiple fallback options. Works exactly like the |
| 995 | \cw{\\cfg\{text-bullet\}} directive (see |
| 996 | \k{output-text-characters}). |
| 997 | |
| 998 | \dt \I{\cw{\\cfg\{info-rule\}}}\cw{\\cfg\{info-rule\}\{}\e{text}\cw{\}}[\cw{\{}\e{text}\cw{\}}...] |
| 999 | |
| 1000 | \dd Specifies the text used to draw \i{horizontal rules}. You can |
| 1001 | specify multiple fallback options. Works exactly like the |
| 1002 | \cw{\\cfg\{text-rule\}} directive (see \k{output-text-characters}). |
| 1003 | |
| 1004 | \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{\}}] |
| 1005 | |
| 1006 | \dd Specifies the quotation marks to use, overriding any |
| 1007 | \cw{\\cfg\{quotes\}} directive. You can specify multiple |
| 1008 | fallback options. Works exactly like the \cw{\\cfg\{text-quotes\}} |
| 1009 | directive (see \k{output-text-characters}). |
| 1010 | |
| 1011 | \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{\}}] |
| 1012 | |
| 1013 | \dd Specifies how to display emphasised text. You can specify |
| 1014 | multiple fallback options. Works exactly like the |
| 1015 | \cw{\\cfg\{text-emphasis\}} directive (see |
| 1016 | \k{output-text-characters}). |
| 1017 | |
| 1018 | \dt \I{\cw{\\cfg\{info-list-suffix\}}}\cw{\\cfg\{info-list-suffix\}\{}\e{text}\cw{\}} |
| 1019 | |
| 1020 | \dd Specifies the text to append to the item numbers in a |
| 1021 | \i{numbered list}. Works exactly like the |
| 1022 | \cw{\\cfg\{text-list-suffix\}} directive (see |
| 1023 | \k{output-text-misc}). |
| 1024 | |
| 1025 | \dt \I{\cw{\\cfg\{info-max-file-size\}}}\cw{\\cfg\{info-max-file-size\}\{}\e{bytes}\cw{\}} |
| 1026 | |
| 1027 | \dd Sets the preferred \i{maximum file size} for each subsidiary |
| 1028 | file. As a special case, if you set this to zero, there will be no |
| 1029 | subsidiary files and the whole document will be placed in a single |
| 1030 | self-contained output file. (However, note that this file can still |
| 1031 | not be renamed usefully.) |
| 1032 | |
| 1033 | \lcont{ |
| 1034 | |
| 1035 | The preferred maximum file size is only a guideline. Halibut may be |
| 1036 | forced to exceed it if a single section of the document is larger |
| 1037 | than the maximum size (since individual \c{info} nodes may not be |
| 1038 | split between files). |
| 1039 | |
| 1040 | } |
| 1041 | |
| 1042 | \dt \I{\cw{\\cfg\{info-dir-entry\}}}\cw{\\cfg\{info-dir-entry\}\{}\e{section}\cw{\}\{}\e{short |
| 1043 | name}\cw{\}\{}\e{long name}\cw{\}}[\cw{\{}\e{keyword}\cw{\}}] |
| 1044 | |
| 1045 | \dd Constructs an \i\cw{INFO-DIR-ENTRY} section and places it in the |
| 1046 | header of the Info file. This mechanism is used to automatically |
| 1047 | generate the \i{\c{dir} file} at the root of a Unix system's |
| 1048 | \c{info} collection. |
| 1049 | |
| 1050 | \lcont{ |
| 1051 | |
| 1052 | The parameters to this directive are: |
| 1053 | |
| 1054 | \dt \e{section} |
| 1055 | |
| 1056 | \dd Specifies the section of the \c{dir} file in which you want your |
| 1057 | document referenced. For example, \q{Development}, or \q{Games}, or |
| 1058 | \q{Miscellaneous}. |
| 1059 | |
| 1060 | \dt \e{short name} |
| 1061 | |
| 1062 | \dd Specifies a short name for the directory entry, which will |
| 1063 | appear at the start of the menu line. |
| 1064 | |
| 1065 | \dt \e{long name} |
| 1066 | |
| 1067 | \dd Specifies a long name for the directory entry, which will appear |
| 1068 | at the end of the menu line. |
| 1069 | |
| 1070 | \dt \e{keyword} |
| 1071 | |
| 1072 | \dd This parameter is optional. If it is present, then the directory |
| 1073 | entry will cause a jump to a particular subsection of your document, |
| 1074 | rather than starting at the top. The subsection will be the one |
| 1075 | referred to by the given keyword (see \k{input-sections} for details |
| 1076 | about assigning keywords to document sections). |
| 1077 | |
| 1078 | For example, in a document describing many game programs, the |
| 1079 | configuration directive |
| 1080 | |
| 1081 | \c \cfg{info-dir-entry}{Games}{Chess}{Electronic chess |
| 1082 | \c game}{chess} |
| 1083 | |
| 1084 | might produce text in the \c{dir} file looking something like this: |
| 1085 | |
| 1086 | \c Games |
| 1087 | \c * Chess: (mygames)Chapter 3. Electronic chess game |
| 1088 | |
| 1089 | if the output file were called \c{mygames.info} and the keyword |
| 1090 | \c{chess} had been used to define Chapter 3 of the document. |
| 1091 | |
| 1092 | } |
| 1093 | |
| 1094 | The \i{default settings} for the \c{info} output format are: |
| 1095 | |
| 1096 | \c \cfg{info-filename}{output.info} |
| 1097 | \c |
| 1098 | \c \cfg{info-width}{70} |
| 1099 | \c \cfg{info-indent-code}{2} |
| 1100 | \c \cfg{info-index-width}{40} |
| 1101 | \c \cfg{info-list-indent}{1} |
| 1102 | \c \cfg{info-listitem-indent}{3} |
| 1103 | \c |
| 1104 | \c \cfg{info-charset}{ASCII} |
| 1105 | \c |
| 1106 | \c \cfg{info-section-suffix}{: } |
| 1107 | \c |
| 1108 | \c \cfg{info-underline}{\u203e}{-} |
| 1109 | \c \cfg{info-bullet}{\u2022}{-} |
| 1110 | \c \cfg{info-rule}{\u2500}{-} |
| 1111 | \c \cfg{info-quotes}{\u2018}{\u2019}{`}{'} |
| 1112 | \c \cfg{info-emphasis}{_}{_} |
| 1113 | \c |
| 1114 | \c \cfg{info-list-suffix}{.} |
| 1115 | \c \cfg{info-max-file-size}{65536} |
| 1116 | |
| 1117 | and no \cw{\\cfg\{info-dir-entry\}} directives. |
| 1118 | |
| 1119 | \H{output-ps} \i{PostScript} |
| 1120 | |
| 1121 | This output format generates a printable manual in PostScript format. |
| 1122 | |
| 1123 | This format is currently very new and is not yet configurable. There |
| 1124 | is only one available configuration option: |
| 1125 | |
| 1126 | \dt \I{\cw{\\cfg\{ps-filename\}}}\cw{\\cfg\{ps-filename\}\{}\e{filename}\cw{\}} |
| 1127 | |
| 1128 | \dd Sets the \i{output file name} in which to store the PostScript |
| 1129 | file. This directive is implicitly generated if you provide a file |
| 1130 | name parameter after the command-line option \i\c{--ps} (see |
| 1131 | \k{running-options}). |
| 1132 | |
| 1133 | The \i{default settings} for the PostScript output format are: |
| 1134 | |
| 1135 | \c \cfg{ps-filename}{output.ps} |
| 1136 | |
| 1137 | \H{output-pdf} \i{PDF} |
| 1138 | |
| 1139 | This output format generates a printable manual in PDF format. This |
| 1140 | should look exactly identical to the PostScript output (see |
| 1141 | \k{output-ps}), but also uses some PDF interactive features to |
| 1142 | provide an outline of all the document's sections and clickable |
| 1143 | cross-references between sections. |
| 1144 | |
| 1145 | This format is currently very new and is not yet configurable. There |
| 1146 | is only one available configuration option: |
| 1147 | |
| 1148 | \dt \I{\cw{\\cfg\{pdf-filename\}}}\cw{\\cfg\{pdf-filename\}\{}\e{filename}\cw{\}} |
| 1149 | |
| 1150 | \dd Sets the \i{output file name} in which to store the PDF file. |
| 1151 | This directive is implicitly generated if you provide a file name |
| 1152 | parameter after the command-line option \i\c{--pdf} (see |
| 1153 | \k{running-options}). |
| 1154 | |
| 1155 | The \i{default settings} for the PDF output format are: |
| 1156 | |
| 1157 | \c \cfg{pdf-filename}{output.pdf} |