1 <RefEntry id="docbook2texi">
4 <RefEntryTitle>docbook2texi-spec.pl</RefEntryTitle>
5 <ManVolNum>1</ManVolNum>
9 <RefName>docbook2texi-spec.pl</RefName>
10 <RefPurpose>convert DocBook <SGMLTag>Book</sgmltag>s
11 to <Application>Texinfo</application> documents</RefPurpose>
16 <Command>sgmlspl</command>
17 <Arg choice=req>docbook2man-spec.pl</arg>
20 <!-- docbook2man-spec.pl BREAKAGE HERE! -->
23 <Command>nsgmls</command>
24 <Arg><Replaceable>sgml document</replaceable></Arg>
25 <Command>| sgmlspl</command>
26 <Arg choice=req>docbook2texi-spec.pl</arg>
27 <Arg><Replaceable>basename</replaceable></Arg>
32 <Title>Description</Title>
35 <Application>docbook2texi</application> is a sgmlspl spec file that produces
36 GNU Texinfo documents from DocBook documents.
40 The program reads ESIS produced by nsgmls (or other SGML parsers) from
41 standard input. Currently the document element must be <SGMLTag>Book</sgmltag>,
42 otherwise the results are undefined.
46 Its output, the converted Texinfo document, is written to standard
51 The file <Filename><Replaceable>basename.refs</replaceable></Filename> will also
52 be created, which contains all the nodes in the document and their immediate
53 'child' nodes. As node processing always require forward references,
54 <Application>docbook2texi</application> must be run twice for each document: the
55 first time to build the references, and the second to actually generate a valid
62 <Title>Requirements</Title>
66 The SGMLSpm package from CPAN. This package includes the sgmlspl script
75 <Title>Limitations</Title>
78 Trying <Application>docbook2man</application> on non-DocBook or non-conformant
79 SGML results in undefined behavior. :-)
83 This program is a slow, dodgy Perl script.
87 This program does not come close to supporting all the possible markup
88 in DocBook, and may produce wrong output in some cases with supported
100 How the hell do you represent a backslash (<Literal>\</literal>) in Texinfo!!@?
101 I've tried <Literal>\\</literal> but TeX complains about it.
106 Fix breakages found in the test documents.
111 Add new element handling and fix existing handling.
116 <Para>Make it faster. I think most of the speed problems so far is with parsing
117 ESIS. Rewrite <Filename>SGMLS.pm</filename> with C and/or get input directly
118 from <Application>SP</application>.
124 There are some dependencies on elements occurring when they are actually
125 optional (according to the DTD). We need to fix that (preferably) or
126 prominently state the requirements.
132 Allow other more common document elements.
138 Separate out node referencing to a separate script. Not only would it
139 make it faster/easier to maintain because it's separate from the main
140 code, but also I would like it to evolve into an automatic DocBook
141 <SGMLTag>ToC</sgmltag> generator.
149 <Title>Copyright</Title>
152 Copyright (C) 1998-1999 Steve Cheng <Email>steve@ggi-project.org</email>
156 This program is free software; you can redistribute it and/or modify it
157 under the terms of the GNU General Public License as published by the
158 Free Software Foundation; either version 2, or (at your option) any
163 You should have received a copy of the GNU General Public License along with
164 this program; see the file <Filename>COPYING</filename>. If not, please write
165 to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.