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