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