1DOCBOOK2TEXI-SPEC.PL(1)                                DOCBOOK2TEXI-SPEC.PL(1)
2
3
4

NAME

6       docbook2texi-spec.pl - convert DocBook Booksto Texinfo documents
7

SYNOPSIS

9       sgmlspl docbook2man-spec.pl
10
11
12       nsgmls [ sgml document ]| sgmlspl docbook2texi-spec.pl [ basename ]
13
14

DESCRIPTION

16       docbook2texi is a sgmlspl spec file that produces GNU Texinfo documents
17       from DocBook documents.
18
19       The program reads ESIS produced by nsgmls (or other SGML parsers)  from
20       standard input.  Currently the document element must be Book, otherwise
21       the results are undefined.
22
23       Its output, the converted Texinfo document, is written to standard out‐
24       put.
25
26       The  file  basename.refs  will  also be created, which contains all the
27       nodes in the document and their immediate 'child' nodes.  As node  pro‐
28       cessing  always  require  forward  references, docbook2texi must be run
29       twice for each document: the first time to build  the  references,  and
30       the second to actually generate a valid document.
31

REQUIREMENTS

33       The  SGMLSpm  package  from  CPAN.   This  package includes the sgmlspl
34       script that is also needed.
35

LIMITATIONS

37       Trying docbook2man on non-DocBook or  non-conformant  SGML  results  in
38       undefined behavior. :-)
39
40       This program is a slow, dodgy Perl script.
41
42       This  program does not come close to supporting all the possible markup
43       in DocBook, and may produce wrong output in some cases  with  supported
44       markup.
45

TO DO

47       · How  the  hell  do you represent a backslash (\) in Texinfo!!@?  I've
48         tried \\ but TeX complains about it.
49
50       · Fix breakages found in the test documents.
51
52       · Add new element handling and fix existing handling.  Be robust.
53
54       · Make it faster. I think most of the speed problems  so  far  is  with
55         parsing ESIS.  Rewrite SGMLS.pm with C and/or get input directly from
56         SP.
57
58       · There are some dependencies on elements occurring when they are actu‐
59         ally  optional  (according to the DTD).  We need to fix that (prefer‐
60         ably) or prominently state the requirements.
61
62       · Allow other more common document elements.
63
64       · Separate out node referencing to a separate script.  Not  only  would
65         it  make  it faster/easier to maintain because it's separate from the
66         main code, but also I would like it to evolve into an automatic  Doc‐
67         Book ToC generator.
68

70       Copyright (C) 1998-1999 Steve Cheng <steve@ggi-project.org>
71
72       This program is free software; you can redistribute it and/or modify it
73       under the terms of the GNU General Public License as published  by  the
74       Free  Software  Foundation;  either  version 2, or (at your option) any
75       later version.
76
77       You should have received a copy of the GNU General Public License along
78       with  this  program; see the file COPYING.  If not, please write to the
79       Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
80
81
82
83                               11 February 2004        DOCBOOK2TEXI-SPEC.PL(1)
Impressum