diff --git a/LDP/texi2db/README b/LDP/texi2db/README index 289406f8..e765ea61 100644 --- a/LDP/texi2db/README +++ b/LDP/texi2db/README @@ -1,2 +1,30 @@ This is a utility to generate DocBook from Texinfo source. Type "texi2db -h" for all the command line options. It's pretty self-explanatory. + +texi2db has to make some best guesses about how to structure your document, +because neither the html nor the info structures are optimized for DocBook. +However, by looking at a bit of both, it manages to build a pretty good +tree most of the time. + +Your DocBook file will be structured just like your original Texinfo file was. +Each node becomes one of the DocBook hierarchical structures. If your nodes +include chapter, heading, section and appendix commands, those nodes will be +placed in the corresponding DocBook section. If you don't have those structures +defined, however, it looks to see who the "parent" node is, and places the node +on the next lower type of section. Also, if your structures in Texinfo are not +legal in DocBook (having a third-level under a first-level, for example), +they will be adjusted to conform to DocBook rules. + +Almost none of the layout information in Texinfo carries over into DocBook. +DocBook is a semantic language, not a layout or display language. You do your +display in xsl. So, all of that information is just ignored. + +texi2db has full support for macros, aliases, and custom highlighting with +@defenclosure commands. + +This software is still in development and has many bugs. Please feel free to +send bug reports to , but odds are I already know about +it because of its stage of development. + +David Merrill +