Obsoleted the `\preamble' command. Preamble text is now taken to be
[sgt/halibut] / 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{man-headnumbers}{true}
8
9 This paragraph is not labelled \q{preamble}, but should still appear
10 as it.
11
12 \preamble This manual is a small joke effort, designed to use every
13 feature \#{ comment } that Halibut's input format supports. Creation
14 date \date{%Y.%m.%d} (default format is \date).
15
16 \c Here is a code paragraph in the preamble, just to stress that all
17 \c things are possible. Ooh!
18
19 \copyright Copyright 1999 Simon \#{second comment}Tatham. All rights
20 reserved.
21
22 \define{metacoopt} [this is a nested,
23 multi-line macro, talking about \coopt
24 a bit]
25
26 \define{coopt} co\u00F6{-o}pt
27
28 \versionid $Id: test.but,v 1.22 2004/03/25 19:16:28 simon Exp $
29
30 \C{ch\\ap} First chapter title; for similar wrapping reasons this
31 chapter title will be ludicrously long. I wonder how much more
32 chapter title I can write before feeling silly.
33
34 This is a para\#{another{} comment}graph of text. It
35 has line\#{yet another one} breaks in between words, multiple
36 spaces (ignored), and \e{emphasised text} as well as \c{code
37 fragments}.
38
39 \cw{This} is weak code. And \k{head} contains some other stuff.
40 \K{subhead} does too.
41
42 To test the man page back end:
43
44 .Directive
45
46 'Directive
47
48 \\Sping\\Spong\\Spoing
49
50 \H{head} First section title (very long again, no prizes for
51 guessing the reason why this time, and here's yet more text to pad
52 it out to three lines of output)
53
54 \cfg{winhelp-topic}{M359HPEHGW}
55
56 Here's a code paragraph:
57
58 \c No leading spaces
59 \c One leading space
60 \c Two blank lines follow this one.
61 \c
62 \c
63 \c Two blank lines precede this one.
64 \c Two leading spaces
65 \c We can use \ { and } with impunity here.
66 \c We can use discretionary bold and italic in code paragraphs!
67 \e bbbb iiiiii
68 \c Isn't that ludicrous?
69
70 This is a list:
71
72 \b Ooh.
73
74 \b Aah.
75
76 \lcont{
77
78 This bulletted list contains a list continuation. This is an
79 additional paragraph, or more than one, indented at the same level
80 as the list items, and able to contain nested sublists and other
81 features. For example, here's a code paragraph:
82
83 \c spingle:~$ whoami
84 \c spoggler
85
86 And here's a sublist. Numbered, just for variety.
87
88 \n One.
89
90 \lcont{
91
92 \n 1a.
93
94 \n 1b.
95
96 \n 1c.
97
98 \lcont{This is an even sillier one: a continuation of a list item in
99 a continuation of a list item in a continuation of a list item!}
100
101 }
102
103 \n Two.
104
105 \n Threeeee!
106
107 }
108
109 \b Eek.
110
111 This is a horizontal rule:
112
113 \rule
114
115 This is a numbered list:
116
117 \n Ooh.
118
119 \n{keyword} Aah.
120
121 \n Eek. \q{Aah} is point \k{keyword}.
122
123 This is a description list:
124
125 \dt FISH
126
127 \dd A piscine creature, often to be found swimming aimlessly around
128 in the sea eating things and not contributing to the global economy.
129
130 \lcont{
131
132 Here's another of those funky list continuation things, just to keep
133 Halibut on its toes.
134
135 }
136
137 \dt BADGER
138
139 \dd A non-piscine creature, often to be found snuffling around on
140 land, not contributing to the global economy, and not even swimming
141 to make up for it. I don't know. These mammals. Pa-thetic.
142
143 \dt "SAUSAGE SALESMAN"
144
145 \dd An exemplary contributor to the global economy. Unless he's CMOT
146 Dibbler.
147
148 A-paragraph-full-of-hyphens-to-test-the-idea-that-word-wrapping-can-happen-somewhere-in-all-this-hyphenatory-nonsense.
149
150 A\-paragraph\-full\-of\-nonbreaking\-hyphens\-to\-test\-the\-idea\-that\-word\-wrapping\-misses\-them.
151
152 A\_paragraph\_full\_of\_nonbreaking\_spaces\_to\_test\_the\_idea\_that\_word\_wrapping\_misses\_them\_too.
153
154 Use of macros: let's talk about \coopt. And about \coopt some more.
155 And a nested macro: \metacoopt.
156
157 Oh, while I'm here: some special characters. The \\, \{ and \}
158 characters, to be precise. And their code equivalents, \c{\\},
159 \i\c{\{}, \c{\}}.
160
161 \S{subhead} First subheading
162
163 So here's a \I{subheading}\I{subsection}subsection. Just
164 incidentally, \q{this} is in quotes. \ii{Those} quotes had better work
165 in all formats.
166
167 We'll try for some Unicode here: \i{Schr\u00F6{oe}dinger}.
168
169 An index tag containing non-alternatived Unicode: \i{\u00BFChe?}
170
171 An invisible index tag: \I{she seems to have an invisible tag}yeah.
172
173 \S2{sub-sub}{Florble} Smaller heading still
174
175 A tiny section. Awww. How cute. Actually, this one's a \e{florble},
176 and here's a reference to it: \k{sub-sub}.
177
178 \A{app} Needless appendix
179
180 \# \cfg{winhelp-topic}{Y5VQEXZQVJ} (uncomment this and it clashes)
181
182 Here's an \i{appendix}, for no terribly good reason at all. See
183 __\k{book}__ (please excuse those underscores, I'm testing
184 whitespace).
185
186 It also contains a \W{http://www.tartarus.org/}{hyperlink}.
187
188 \U Bibliography
189
190 \B{book} Some text describing a book.
191
192 \B{nocite} Some text describing a book. This text should appear in
193 the document even though there is no \cw{\\k} citing it.
194
195 \BR{book} [SillyCitation]
196 \BR{uncited} Badger.
197
198 \nocite{nocite}
199
200 \B{uncited} If this text appears, there's an actual error.
201
202 \# This is a comment.
203
204 \# Now for the index section.
205
206 \IM{she seems to have an invisible tag}{appendix} Invisible tags
207 and/or appendices