Man-page back end for Halibut. Also, a couple of additional markup
[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
7 \cfg{xhtml-leaf-contains-contents}{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.20 2004/03/23 20:10:23 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
61 This is a list:
62
63 \b Ooh.
64
65 \b Aah.
66
67 \lcont{
68
69 This bulletted list contains a list continuation. This is an
70 additional paragraph, or more than one, indented at the same level
71 as the list items, and able to contain nested sublists and other
72 features. For example, here's a code paragraph:
73
74 \c spingle:~$ whoami
75 \c spoggler
76
77 And here's a sublist. Numbered, just for variety.
78
79 \n One.
80
81 \lcont{
82
83 \n 1a.
84
85 \n 1b.
86
87 \n 1c.
88
89 \lcont{This is an even sillier one: a continuation of a list item in
90 a continuation of a list item in a continuation of a list item!}
91
92 }
93
94 \n Two.
95
96 \n Threeeee!
97
98 }
99
100 \b Eek.
101
102 This is a horizontal rule:
103
104 \rule
105
106 This is a numbered list:
107
108 \n Ooh.
109
110 \n{keyword} Aah.
111
112 \n Eek. \q{Aah} is point \k{keyword}.
113
114 This is a description list:
115
116 \dt FISH
117
118 \dd A piscine creature, often to be found swimming aimlessly around
119 in the sea eating things and not contributing to the global economy.
120
121 \lcont{
122
123 Here's another of those funky list continuation things, just to keep
124 Halibut on its toes.
125
126 }
127
128 \dt BADGER
129
130 \dd A non-piscine creature, often to be found snuffling around on
131 land, not contributing to the global economy, and not even swimming
132 to make up for it. I don't know. These mammals. Pa-thetic.
133
134 \dt "SAUSAGE SALESMAN"
135
136 \dd An exemplary contributor to the global economy. Unless he's CMOT
137 Dibbler.
138
139 A-paragraph-full-of-hyphens-to-test-the-idea-that-word-wrapping-can-happen-somewhere-in-all-this-hyphenatory-nonsense.
140
141 A\-paragraph\-full\-of\-nonbreaking\-hyphens\-to\-test\-the\-idea\-that\-word\-wrapping\-misses\-them.
142
143 A\_paragraph\_full\_of\_nonbreaking\_spaces\_to\_test\_the\_idea\_that\_word\_wrapping\_misses\_them\_too.
144
145 Use of macros: let's talk about \coopt. And about \coopt some more.
146 And a nested macro: \metacoopt.
147
148 Oh, while I'm here: some special characters. The \\, \{ and \}
149 characters, to be precise. And their code equivalents, \c{\\},
150 \i\c{\{}, \c{\}}.
151
152 \S{subhead} First subheading
153
154 So here's a \I{subheading}\I{subsection}subsection. Just
155 incidentally, \q{this} is in quotes. \ii{Those} quotes had better work
156 in all formats.
157
158 We'll try for some Unicode here: \i{Schr\u00F6{oe}dinger}.
159
160 An index tag containing non-alternatived Unicode: \i{\u00BFChe?}
161
162 An invisible index tag: \I{she seems to have an invisible tag}yeah.
163
164 \S2{sub-sub}{Florble} Smaller heading still
165
166 A tiny section. Awww. How cute. Actually, this one's a \e{florble},
167 and here's a reference to it: \k{sub-sub}.
168
169 \A{app} Needless appendix
170
171 \# \cfg{winhelp-topic}{Y5VQEXZQVJ} (uncomment this and it clashes)
172
173 Here's an \i{appendix}, for no terribly good reason at all. See
174 __\k{book}__ (please excuse those underscores, I'm testing
175 whitespace).
176
177 It also contains a \W{http://www.tartarus.org/}{hyperlink}.
178
179 \U Bibliography
180
181 \B{book} Some text describing a book.
182
183 \B{nocite} Some text describing a book. This text should appear in
184 the document even though there is no \cw{\\k} citing it.
185
186 \BR{book} [SillyCitation]
187 \BR{uncited} Badger.
188
189 \nocite{nocite}
190
191 \B{uncited} If this text appears, there's an actual error.
192
193 \# This is a comment.
194
195 \# Now for the index section.
196
197 \IM{she seems to have an invisible tag}{appendix} Invisible tags
198 and/or appendices