It would probably help to add a test of the INFO-DIR-ENTRY mechanism
[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{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 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: test.but,v 1.26 2004/04/09 18:47:33 simon Exp $
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. And \k{head} contains some other stuff.
47 \K{subhead} does too.
48
49 To test the man page back end:
50
51 .Directive
52
53 'Directive
54
55 \\Sping\\Spong\\Spoing
56
57 \H{head} First section title (very long again, no prizes for
58 guessing the reason why this time, and here's yet more text to pad
59 it out to three lines of output)
60
61 \cfg{winhelp-topic}{M359HPEHGW}
62
63 Here's a code paragraph:
64
65 \c No leading spaces
66 \c One leading space
67 \c Two blank lines follow this one.
68 \c
69 \c
70 \c Two blank lines precede this one.
71 \c Two leading spaces
72 \c We can use \ { and } with impunity here.
73 \c We can use discretionary bold and italic in code paragraphs!
74 \e bbbb iiiiii
75 \c Isn't that ludicrous?
76
77 This is a list:
78
79 \b Ooh.
80
81 \b Aah.
82
83 \lcont{
84
85 This bulletted list contains a list continuation. This is an
86 additional paragraph, or more than one, indented at the same level
87 as the list items, and able to contain nested sublists and other
88 features. For example, here's a code paragraph:
89
90 \c spingle:~$ whoami
91 \c spoggler
92
93 And here's a sublist. Numbered, just for variety.
94
95 \n One.
96
97 \lcont{
98
99 \n 1a.
100
101 \n 1b.
102
103 \lcont{
104 \c Code
105 \c Paragraph
106 }
107
108 \n 1c.
109
110 \lcont{This is an even sillier one: a continuation of a list item in
111 a continuation of a list item in a continuation of a list item!}
112
113 }
114
115 \n Two.
116
117 \n Threeeee!
118
119 }
120
121 \b Eek.
122
123 This is a horizontal rule:
124
125 \rule
126
127 This is a numbered list:
128
129 \n Ooh.
130
131 \n{keyword} Aah.
132
133 \n Eek. \q{Aah} is point \k{keyword}.
134
135 This is a description list:
136
137 \dt FISH
138
139 \dd A piscine creature, often to be found swimming aimlessly around
140 in the sea eating things and not contributing to the global economy.
141
142 \lcont{
143
144 Here's another of those funky list continuation things, just to keep
145 Halibut on its toes.
146
147 }
148
149 \dt BADGER
150
151 \dd A non-piscine creature, often to be found snuffling around on
152 land, not contributing to the global economy, and not even swimming
153 to make up for it. I don't know. These mammals. Pa-thetic.
154
155 \dt "SAUSAGE SALESMAN"
156
157 \dd An exemplary contributor to the global economy. Unless he's CMOT
158 Dibbler.
159
160 A-paragraph-full-of-hyphens-to-test-the-idea-that-word-wrapping-can-happen-somewhere-in-all-this-hyphenatory-nonsense.
161
162 A\-paragraph\-full\-of\-nonbreaking\-hyphens\-to\-test\-the\-idea\-that\-word\-wrapping\-misses\-them.
163
164 A\_paragraph\_full\_of\_nonbreaking\_spaces\_to\_test\_the\_idea\_that\_word\_wrapping\_misses\_them\_too.
165
166 Use of macros: let's talk about \coopt. And about \coopt some more.
167 And a nested macro: \metacoopt.
168
169 A slightly more difficult macro: \eur\.2500.
170
171 Oh, while I'm here: some special characters. The \\, \{ and \}
172 characters, to be precise. And their code equivalents, \c{\\},
173 \i\c{\{}, \c{\}}.
174
175 \S{subhead} First subheading
176
177 So here's a \I{subheading}\I{subsection}subsection. Just
178 incidentally, \q{this} is in quotes. \ii{Those} quotes had better work
179 in all formats.
180
181 We'll try for some Unicode here: \i{Schr\u00F6{oe}dinger}.
182
183 An index tag containing non-alternatived Unicode: \i{\u00BFChe?}
184
185 An invisible index tag: \I{she seems to have an invisible tag}yeah.
186
187 \S2{sub-sub}{Florble} Smaller heading still
188
189 A tiny section. Awww. How cute. Actually, this one's a \e{florble},
190 and here's a reference to it: \k{sub-sub}.
191
192 \A{app} Needless appendix
193
194 \# \cfg{winhelp-topic}{Y5VQEXZQVJ} (uncomment this and it clashes)
195
196 Here's an \i{appendix}, for no terribly good reason at all. See
197 __\k{book}__ (please excuse those underscores, I'm testing
198 whitespace).
199
200 It also contains a \W{http://www.tartarus.org/}{hyperlink}.
201
202 \U Bibliography
203
204 \B{book} Some text describing a book.
205
206 \B{nocite} Some text describing a book. This text should appear in
207 the document even though there is no \cw{\\k} citing it.
208
209 \BR{book} [SillyCitation]
210 \BR{uncited} Badger.
211
212 \nocite{nocite}
213
214 \B{uncited} If this text appears, there's an actual error.
215
216 \# This is a comment.
217
218 \# Now for the index section.
219
220 \IM{she seems to have an invisible tag}{appendix} Invisible tags
221 and/or appendices