Support the \W{...}\i\c{...} combination used in the NASM manual.
[sgt/halibut] / doc / intro.but
CommitLineData
11f2edfa 1\C{intro} Introduction to Halibut
2
3Halibut is a multi-format documentation processing system.
4
5What that means is that you write your document once, in Halibut's
6input format, and then the Halibut program processes it into several
7output formats which all contain the same text. So, for example, if
8you want your application to have a Windows help file, and you also
9want the same documentation available in HTML on your web site,
10Halibut can do that for you.
11
12\H{intro-formats} Output formats supported by Halibut
13
14Currently Halibut supports the following output formats:
15
16\b Plain ASCII text.
17
18\b HTML.
19
20\b Windows Help.
21
43f61c25 22\b Unix \cw{man} page format.
11f2edfa 23
43f61c25 24\b GNU \c{info} format.
25
0287083a 26\b PostScript.
27
28\b PDF.
11f2edfa 29
30\H{intro-features} Features supported by Halibut
31
32Here's a list of Halibut's notable features.
33
34\b Halibut automatically assigns sequential numbers to your
35chapters, sections and subsections, and keeps track of them for you.
36You supply a \e{keyword} for each section, and then you can generate
37cross-references to that section using the keyword, and Halibut will
38substitute the correct section number. Also, in any output format
39where it makes sense, the cross-references will be hyperlinks to
40that section of the document.
41
42\b Halibut has some support for Unicode: you can include arbitrary
43Unicode characters in your document, and specify fallback text in
44case any output format doesn't support that character.
45
46\b Halibut's indexing support is comprehensive and carefully
47designed. It's easy to use in the simple case, but has powerful
48features that should make it possible to maintain a high-quality and
49useful index.