mdw@git.distorted.org.uk Git - sgt/halibut/blob - inputs/test.but

   1 \title Halibut: A Test Document With A Stupidly Long Title Just To
   2 See If Wrapping Titles Works OK. In Fact This Title Will Span Three
   3 Lines, Not Just Two. How's That For Ludicrous?
   4
   5 \cfg{xhtml-leaf-smallest-contents}{2}
   6 \cfg{xhtml-leaf-contains-contents}{true}
   7 \cfg{info-dir-entry}{Sillinesses}{test.but}{Halibut test document}
   8 \cfg{info-dir-entry}{Florbles}{test.but}{Subsection of Halibut test
   9 document}{sub-sub}
  10 \cfg{man-headnumbers}{true}
  11
  12 This paragraph is not labelled \q{preamble}, but should still appear
  13 as it.
  14
  15 \preamble This manual is a small joke effort, designed to use every
  16 feature \#{ comment } that Halibut's input format supports. Creation
  17 date \date{%Y.%m.%d} (default format is \date).
  18
  19 \c Here is a code paragraph in the preamble, just to stress that all
  20 \c things are possible. Ooh!
  21
  22 \copyright Copyright 1999 Simon \#{second comment}Tatham. All rights
  23 reserved.
  24
  25 Here's another \i{preamble paragraph}, which goes after the copyright.
  26
  27 \define{metacoopt} [this is a nested,
  28 multi-line macro, talking about \coopt
  29 a bit]
  30
  31 \define{coopt} co\u00F6{-o}pt
  32
  33 \define{eur} \u20AC{EUR }
  34
  35 \versionid $Id$
  36
  37 \C{ch\\ap} First chapter title; for similar wrapping reasons this
  38 chapter title will be ludicrously long. I wonder how much more
  39 chapter title I can write before feeling silly.
  40
  41 This is a para\#{another{} comment}graph of text. It
  42 has line\#{yet another one} breaks in   between words, multiple
  43   spaces (ignored), and \e{emphasised text} as well as \c{code
  44 fragments}.
  45
  46 \cw{This} is weak code; \cq{this} is quoted code. And \k{head}
  47 contains some other stuff. \K{subhead} does too.
  48
  49 To test the man page back end:
  50
  51 .Directive
  52
  53 'Directive
  54
  55 \cw{.Directive}
  56
  57 \cw{'Directive}
  58
  59 \\Sping\\Spong\\Spoing
  60
  61 \H{head} First section title (very long again, no prizes for
  62 guessing the reason why this time, and here's yet more text to pad
  63 it out to three lines of output)
  64
  65 \cfg{winhelp-topic}{M359HPEHGW}
  66
  67 Here's a code paragraph:
  68
  69 \c No leading spaces
  70 \c  One leading space
  71 \c Two blank lines follow this one.
  72 \c
  73 \c
  74 \c Two blank lines precede this one.
  75 \c   Two leading spaces
  76 \c We can use \ { and } with impunity here.
  77 \c We can use discretionary bold and italic in code paragraphs!
  78 \e                          bbbb     iiiiii
  79 \c Isn't that ludicrous?
  80
  81 This is a list:
  82
  83 \b Ooh.
  84
  85 \b Aah.
  86
  87 \lcont{
  88
  89 This bulletted list contains a list continuation. This is an
  90 additional paragraph, or more than one, indented at the same level
  91 as the list items, and able to contain nested sublists and other
  92 features. For example, here's a code paragraph:
  93
  94 \c spingle:~$ whoami
  95 \c spoggler
  96
  97 And here's a sublist. Numbered, just for variety.
  98
  99 \n One.
 100
 101 \lcont{
 102
 103 \n 1a.
 104
 105 \n 1b.
 106
 107 \lcont{
 108 \c Code
 109 \c Paragraph
 110 }
 111
 112 \n 1c.
 113
 114 \lcont{This is an even sillier one: a continuation of a list item in
 115 a continuation of a list item in a continuation of a list item!}
 116
 117 }
 118
 119 \n Two.
 120
 121 \n Threeeee!
 122
 123 }
 124
 125 \b Eek.
 126
 127 This is a horizontal rule:
 128
 129 \rule
 130
 131 This is a numbered list:
 132
 133 \n Ooh.
 134
 135 \n{keyword} Aah.
 136
 137 \n Eek. \q{Aah} is point \k{keyword}.
 138
 139 This is a description list:
 140
 141 \dt FISH
 142
 143 \dd A piscine creature, often to be found swimming aimlessly around
 144 in the sea eating things and not contributing to the global economy.
 145
 146 \lcont{
 147
 148 Here's another of those funky list continuation things, just to keep
 149 Halibut on its toes.
 150
 151 }
 152
 153 \dt BADGER
 154
 155 \dd A non-piscine creature, often to be found snuffling around on
 156 land, not contributing to the global economy, and not even swimming
 157 to make up for it. I don't know. These mammals. Pa-thetic.
 158
 159 \dt "SAUSAGE SALESMAN"
 160
 161 \dd An exemplary contributor to the global economy. Unless he's CMOT
 162 Dibbler.
 163
 164 This is a much more interesting description list, testing
 165 consecutive \c{\\dt}s and consecutive \c{\\dd}s:
 166
 167 \dt One
 168
 169 \dt Two
 170
 171 \dt Three
 172
 173 \dd Ay
 174
 175 \dt Four
 176
 177 \dd Bee
 178
 179 \dd Cee
 180
 181 \dd Dee
 182
 183 A-paragraph-full-of-hyphens-to-test-the-idea-that-word-wrapping-can-happen-somewhere-in-all-this-hyphenatory-nonsense.
 184
 185 A\-paragraph\-full\-of\-nonbreaking\-hyphens\-to\-test\-the\-idea\-that\-word\-wrapping\-misses\-them.
 186
 187 A\_paragraph\_full\_of\_nonbreaking\_spaces\_to\_test\_the\_idea\_that\_word\_wrapping\_misses\_them\_too.
 188
 189 Use of macros: let's talk about \coopt. And about \coopt some more.
 190 And a nested macro: \metacoopt.
 191
 192 A slightly more difficult macro: \eur\.2500.
 193
 194 Test of input character set switching.
 195
 196 \n 8859 character in ASCII mode: expect nothing useful. [coöpt]
 197
 198 \cfg{input-charset}{ISO-8859-1}
 199
 200 \n 8859 character in 8859 mode: expect the right thing. [coöpt]
 201
 202 \cfg{input-charset}{UTF-8}
 203
 204 \n 8859 character in UTF-8 mode: expect the wrong thing. [coöpt]
 205
 206 \cfg{silliness}{coöpt}
 207
 208 \n UTF-8 sequence in UTF-8 mode: expect the right thing again. [coöpt]
 209
 210 \cfg{input-charset}{ASCII}
 211
 212 Back to ASCII again.
 213
 214 Oh, while I'm here: some special characters. The \\, \{ and \}
 215 characters, to be precise. And their code equivalents, \c{\\},
 216 \i\c{\{}, \c{\}}.
 217
 218 \S{subhead} First subheading
 219
 220 So here's a \I{subheading}\I{subsection}subsection. Just
 221 incidentally, \q{this} is in quotes. \ii{Those} quotes had better work
 222 in all formats.
 223
 224 We'll try for some Unicode here: \i{Schr\u00F6{oe}dinger}.
 225
 226 An index tag containing non-alternatived Unicode: \i{\u00BFChe?}
 227
 228 An invisible index tag: \I{she seems to have an invisible tag}yeah.
 229
 230 \S2{sub-sub}{Florble} Smaller heading still
 231
 232 A tiny section. Awww. How cute. Actually, this one's a \e{florble},
 233 and here's a reference to it: \k{sub-sub}.
 234
 235 \A{app} Needless appendix
 236
 237 \# \cfg{winhelp-topic}{Y5VQEXZQVJ} (uncomment this and it clashes)
 238
 239 Here's an \i{appendix}, for no terribly good reason at all. See
 240 __\k{book}__ (please excuse those underscores, I'm testing
 241 whitespace).
 242
 243 It also contains a \W{http://www.tartarus.org/}{hyperlink}.
 244
 245 Also I'm going to index \i\c{-output} to ensure that its two
 246 components are displayed as a joined-up code fragment in the index.
 247
 248 Here are \I{testone}some \I{testtwo}subsections \I{testthree}with
 249 silly chapter titles and interesting use of Unicode. The Unicode
 250 oddities are in the titles rather than the body text because that
 251 way I get to test their handling in the PDF document outline.
 252
 253 \H{app-one} The 1024 \u00D7{x} 768 screen resolution
 254
 255 Err.
 256
 257 \H{app-two} How about Spongletech\u2122{(TM)}?
 258
 259 Umm.
 260
 261 \# I'm going to label one of these with a carefully chosen fragment
 262 \# name "i1", because I know this will also be generated as an index
 263 \# fragment name and this allows me to test the fragment name clash
 264 \# detection.
 265 \#
 266 \# To actually run this test you need to configure html-leaf-level
 267 \# to 0 and html-template-fragment to %k.
 268
 269 \H{i1} Or just Erd\u0151{\u00F6{o}}s?
 270
 271 Ahh.
 272
 273 \U Bibliography
 274
 275 \B{book} Some text describing a book.
 276
 277 \B{nocite} Some text describing a book. This text should appear in
 278 the document even though there is no \cw{\\k} citing it.
 279
 280 \BR{book} [SillyCitation]
 281 \BR{uncited} Badger.
 282
 283 \nocite{nocite}
 284
 285 \B{uncited} If this text appears, there's an actual error.
 286
 287 \# This is a comment.
 288
 289 \# Now for the index section.
 290
 291 \IM{she seems to have an invisible tag}{appendix} Invisible tags
 292 and/or appendices
 293
 294 \# The display forms of these three index terms differ only in case.
 295 \# This is a fiddly special case in the Windows Help backend,
 296 \# because Windows Help's index mechanism is case-insensitive...
 297
 298 \IM{testone} Test
 299 \IM{testtwo} TesT
 300 \IM{testthree} test