README
1This is a utility to generate DocBook from Texinfo source. Type
2"texi2db -h" for all the command line options. It's pretty self-explanatory.
3
4texi2db has to make some best guesses about how to structure your document,
5because neither the html nor the info structures are optimized for DocBook.
6However, by looking at a bit of both, it manages to build a pretty good
7tree most of the time.
8
9Your DocBook file will be structured just like your original Texinfo file was.
10Each node becomes one of the DocBook hierarchical structures. If your nodes
11include chapter, heading, section and appendix commands, those nodes will be
12placed in the corresponding DocBook section. If you don't have those structures
13defined, however, it looks to see who the "parent" node is, and places the node
14on the next lower type of section. Also, if your structures in Texinfo are not
15legal in DocBook (having a third-level under a first-level, for example),
16they will be adjusted to conform to DocBook rules.
17
18Almost none of the layout information in Texinfo carries over into DocBook.
19DocBook is a semantic language, not a layout or display language. You do your
20display in xsl. So, all of that information is just ignored. Therefore, if you
21are doing anything fancy with linespacing and such, it will not convert very
22well.
23
24texi2db has full support for macros, aliases, and custom highlighting with
25@defenclosure commands.
26
27This software has been in active use for some time and has proven reliable.
28However, it is still in development and probably has bugs. Please feel free to
29send bug reports to <david@lupercalia.net>.
30
31David Merrill
32
33
34The following structures are not supported, at least not yet.
35
36@dircategory
37@direntry
38@end direntry
39All of the indexing commands.
40@menu and friends are ignored for now, but I'm planning to support them later.
41