|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
Packit |
e4b6da |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
Packit |
e4b6da |
<head>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"text/html; charset=us-ascii" />
|
|
Packit |
e4b6da |
<title>docbook2X: db2x_texixml</title>
|
|
Packit |
e4b6da |
<link rel="stylesheet" href="docbook2X.css" type="text/css" />
|
|
Packit |
e4b6da |
<link rev="made" href="mailto:stevecheng@users.sourceforge.net" />
|
|
Packit |
e4b6da |
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Documentation Table of Contents" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: Converting to Texinfo" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: docbook2texi" />
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X: The XSLT stylesheets" />
|
|
Packit |
e4b6da |
</head>
|
|
Packit |
e4b6da |
<body>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"command">db2x_texixml
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2texi.html"><< Previous
|
|
Packit |
e4b6da |
Converting to Texinfo
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"xsltproc.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="db2x_texixml">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"id2531808" class="indexterm" name="id2531808">
|
|
Packit |
e4b6da |
"id2531815" class="indexterm" name="id2531815">
|
|
Packit |
e4b6da |
"id2531822" class="indexterm" name="id2531822">
|
|
Packit |
e4b6da |
"id2531829" class="indexterm" name="id2531829">
|
|
Packit |
e4b6da |
"id2531835" class="indexterm" name="id2531835">
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Name
|
|
Packit |
e4b6da |
db2x_texixml
|
|
Packit |
e4b6da |
— Make Texinfo files from Texi-XML
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Synopsis
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
db2x_texixml [options...]
|
|
Packit |
e4b6da |
[xml-document]
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2531912">
|
|
Packit |
e4b6da |
Description
|
|
Packit |
e4b6da |
db2x_texixml
|
|
Packit |
e4b6da |
converts a Texi-XML document into one or more Texinfo
|
|
Packit |
e4b6da |
documents.
|
|
Packit |
e4b6da |
If xml-document is not
|
|
Packit |
e4b6da |
given, then the document to convert comes from standard input.
|
|
Packit |
e4b6da |
The filenames of the Texinfo documents are determined by markup
|
|
Packit |
e4b6da |
in the Texi-XML source. (If the filenames are not specified in the
|
|
Packit |
e4b6da |
markup, then
|
|
Packit |
e4b6da |
"command">db2x_texixml attempts to deduce them from
|
|
Packit |
e4b6da |
the name of the input file. However, the Texi-XML source should
|
|
Packit |
e4b6da |
specify the filename, because it does not work when there are
|
|
Packit |
e4b6da |
multiple output files or when the Texi-XML source comes from
|
|
Packit |
e4b6da |
standard input.)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2531953">
|
|
Packit |
e4b6da |
Options
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--encoding=
|
|
Packit |
e4b6da |
"replaceable">encoding
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Select the character encoding used for the output files. The
|
|
Packit |
e4b6da |
available encodings are those of
|
|
Packit |
e4b6da |
"citerefentry">
|
|
Packit |
e4b6da |
"command">iconv. The default encoding
|
|
Packit |
e4b6da |
is us-ascii.
|
|
Packit |
e4b6da |
The XML source may contain characters that are not representable
|
|
Packit |
e4b6da |
in the encoding that you select; in this case the program will bomb
|
|
Packit |
e4b6da |
out during processing, and you should choose another encoding.
|
|
Packit |
e4b6da |
(This is guaranteed not to happen with any Unicode encoding such as
|
|
Packit |
e4b6da |
UTF-8, but unfortunately not everyone is able to process Unicode
|
|
Packit |
e4b6da |
texts.)
|
|
Packit |
e4b6da |
If you are using GNU’s version of
|
|
Packit |
e4b6da |
"citerefentry">
|
|
Packit |
e4b6da |
"command">iconv, you can affix
|
|
Packit |
e4b6da |
//TRANSLIT to the end of the encoding
|
|
Packit |
e4b6da |
name to attempt transliterations of any unconvertible characters in
|
|
Packit |
e4b6da |
the output. Beware, however, that the really inconvertible
|
|
Packit |
e4b6da |
characters will be turned into another of those damned question
|
|
Packit |
e4b6da |
marks. (Aren’t you sick of this?)
|
|
Packit |
e4b6da |
The suffix //TRANSLIT applied to a
|
|
Packit |
e4b6da |
Unicode encoding — in particular,
|
|
Packit |
e4b6da |
"literal">utf-8//TRANSLIT — means that the output
|
|
Packit |
e4b6da |
files are to remain in Unicode, but markup-level character
|
|
Packit |
e4b6da |
translations using
|
|
Packit |
e4b6da |
"command">utf8trans are still to be done. So in
|
|
Packit |
e4b6da |
most cases, an English-language document, converted using
|
|
Packit |
e4b6da |
--encoding=
|
|
Packit |
e4b6da |
"literal">utf-8//TRANSLIT will actually end up as a
|
|
Packit |
e4b6da |
US-ASCII document, but any untranslatable characters will remain as
|
|
Packit |
e4b6da |
UTF-8 without any warning whatsoever. (Note: strictly speaking this
|
|
Packit |
e4b6da |
is not “transliteration”.) This method of conversion is
|
|
Packit |
e4b6da |
a compromise over strict
|
|
Packit |
e4b6da |
"option">--encoding=us-ascii
|
|
Packit |
e4b6da |
processing, which aborts if any untranslatable characters are
|
|
Packit |
e4b6da |
encountered.
|
|
Packit |
e4b6da |
Note that man pages and Texinfo documents in non-ASCII encodings
|
|
Packit |
e4b6da |
(including UTF-8) may not be portable to older
|
|
Packit |
e4b6da |
(non-internationalized) systems, which is why the default value for
|
|
Packit |
e4b6da |
this option is us-ascii.
|
|
Packit |
e4b6da |
To suppress any automatic character mapping or encoding
|
|
Packit |
e4b6da |
conversion whatsoever, pass the option
|
|
Packit |
e4b6da |
"option">--encoding=utf-8.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--list-files
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Write a list of all the output files to standard output, in
|
|
Packit |
e4b6da |
addition to normal processing.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--output-dir=
|
|
Packit |
e4b6da |
"replaceable">dir
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Specify the directory where the output files are placed. The
|
|
Packit |
e4b6da |
default is the current working directory.
|
|
Packit |
e4b6da |
This option is ignored if the output is to be written to
|
|
Packit |
e4b6da |
standard output (triggered by the option
|
|
Packit |
e4b6da |
"option">--to-stdout).
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--to-stdout
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Write the output to standard output instead of to individual
|
|
Packit |
e4b6da |
files.
|
|
Packit |
e4b6da |
If this option is used even when there are supposed to be
|
|
Packit |
e4b6da |
multiple output documents, then everything is concatenated to
|
|
Packit |
e4b6da |
standard output. But beware that most other programs will not
|
|
Packit |
e4b6da |
accept this concatenated output.
|
|
Packit |
e4b6da |
This option is incompatible with
|
|
Packit |
e4b6da |
"option">--list-files, obviously.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--info
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Pipe the Texinfo output to
|
|
Packit |
e4b6da |
"citerefentry">
|
|
Packit |
e4b6da |
"command">makeinfo, creating Info
|
|
Packit |
e4b6da |
files directly instead of Texinfo files.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--plaintext
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Pipe the Texinfo output to
|
|
Packit |
e4b6da |
"command">makeinfo
|
|
Packit |
e4b6da |
"option">--no-headers, thereby creating
|
|
Packit |
e4b6da |
plain text files.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--help
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Show brief usage information and exit.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--version
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Show version and exit.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This program uses certain other programs for its operation. If
|
|
Packit |
e4b6da |
they are not in their default installed locations, then use the
|
|
Packit |
e4b6da |
following options to set their location:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--utf8trans-program=
|
|
Packit |
e4b6da |
"replaceable">path,
|
|
Packit |
e4b6da |
"term">--utf8trans-map=
|
|
Packit |
e4b6da |
"replaceable">charmap
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Use the character map
|
|
Packit |
e4b6da |
"replaceable">charmap with the
|
|
Packit |
e4b6da |
"utf8trans.html">
|
|
Packit |
e4b6da |
"command">utf8trans program, included with
|
|
Packit |
e4b6da |
docbook2X, found under
|
|
Packit |
e4b6da |
"replaceable">path.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"option">--iconv-program=
|
|
Packit |
e4b6da |
"replaceable">path
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The location of the
|
|
Packit |
e4b6da |
"refentrytitle">
|
|
Packit |
e4b6da |
"command">iconv program, used for
|
|
Packit |
e4b6da |
encoding conversions.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2532365">
|
|
Packit |
e4b6da |
Notes
|
|
Packit |
e4b6da |
Texinfo language compatibility.
|
|
Packit |
e4b6da |
class="indexterm" name="id2532378"> The Texinfo files generated
|
|
Packit |
e4b6da |
by db2x_texixml
|
|
Packit |
e4b6da |
sometimes require Texinfo version 4.7 (the latest version) to work
|
|
Packit |
e4b6da |
properly. In particular:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
db2x_texixml
|
|
Packit |
e4b6da |
relies on makeinfo to
|
|
Packit |
e4b6da |
automatically add punctuation after a
|
|
Packit |
e4b6da |
"markup">@ref if it it not already there. Otherwise the
|
|
Packit |
e4b6da |
hyperlink will not work in the Info reader (although
|
|
Packit |
e4b6da |
makeinfo will not
|
|
Packit |
e4b6da |
emit any error).
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The new @comma{} command is used for
|
|
Packit |
e4b6da |
commas (,) occurring inside argument
|
|
Packit |
e4b6da |
lists to Texinfo commands, to disambiguate it from the comma used
|
|
Packit |
e4b6da |
to separate different arguments. The only alternative otherwise
|
|
Packit |
e4b6da |
would be to translate , to
|
|
Packit |
e4b6da |
. which is obviously undesirable (but
|
|
Packit |
e4b6da |
earlier docbook2X versions did this).
|
|
Packit |
e4b6da |
If you cannot use version 4.7 of
|
|
Packit |
e4b6da |
"command">makeinfo, you can still use a
|
|
Packit |
e4b6da |
sed script to perform
|
|
Packit |
e4b6da |
manually the procedure just outlined.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Relation of Texi-XML with the XML output format of
|
|
Packit |
e4b6da |
makeinfo.
|
|
Packit |
e4b6da |
The Texi-XML format used by docbook2X is
|
|
Packit |
e4b6da |
"emphasis">different and incompatible with the XML
|
|
Packit |
e4b6da |
format generated by
|
|
Packit |
e4b6da |
"refentrytitle">
|
|
Packit |
e4b6da |
"command">makeinfo with its
|
|
Packit |
e4b6da |
--xml option. This situation arose
|
|
Packit |
e4b6da |
partly because the Texi-XML format of docbook2X was designed and
|
|
Packit |
e4b6da |
implemented independently before the appearance of
|
|
Packit |
e4b6da |
makeinfo’s XML
|
|
Packit |
e4b6da |
format. Also Texi-XML is very much geared towards being
|
|
Packit |
e4b6da |
machine-generated from other XML
|
|
Packit |
e4b6da |
formats, while there seems to be no non-trivial
|
|
Packit |
e4b6da |
applications of
|
|
Packit |
e4b6da |
"command">makeinfo’s XML format. So there is
|
|
Packit |
e4b6da |
no reason at this point for docbook2X to adopt
|
|
Packit |
e4b6da |
"command">makeinfo’s XML format in lieu of
|
|
Packit |
e4b6da |
Texi-XML.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2532545">
|
|
Packit |
e4b6da |
Bugs
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Text wrapping in menus is utterly broken for non-ASCII text. It
|
|
Packit |
e4b6da |
is probably also broken everywhere else in the output, but that
|
|
Packit |
e4b6da |
would be
|
|
Packit |
e4b6da |
"command">makeinfo’s fault.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
--list-files might not work
|
|
Packit |
e4b6da |
correctly with --info. Specifically,
|
|
Packit |
e4b6da |
when the output Info file get too big,
|
|
Packit |
e4b6da |
"command">makeinfo will decide to split it into
|
|
Packit |
e4b6da |
parts named
|
|
Packit |
e4b6da |
"replaceable">abc.info-1,
|
|
Packit |
e4b6da |
"filename">
|
|
Packit |
e4b6da |
"replaceable">abc.info-2,
|
|
Packit |
e4b6da |
"filename">
|
|
Packit |
e4b6da |
"replaceable">abc.info-3, etc.
|
|
Packit |
e4b6da |
db2x_texixml does not
|
|
Packit |
e4b6da |
know exactly how many of these files there are, though you can just
|
|
Packit |
e4b6da |
do an ls to find
|
|
Packit |
e4b6da |
out.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
name="id2532646">
|
|
Packit |
e4b6da |
See Also
|
|
Packit |
e4b6da |
The input to
|
|
Packit |
e4b6da |
"command">db2x_texixml is defined by the XML DTD
|
|
Packit |
e4b6da |
present at dtd/Texi-XML in the
|
|
Packit |
e4b6da |
docbook2X distribution.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2texi.html"><< Previous
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"texinfo.html">Up
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"xsltproc.html">Next >>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
docbook2texi
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"docbook2X.html">Table of Contents
|
|
Packit |
e4b6da |
The XSLT
|
|
Packit |
e4b6da |
stylesheets
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
"http://docbook2x.sourceforge.net/" title=
|
|
Packit |
e4b6da |
"docbook2X: Home page">docbook2X home page
|
|
Packit |
e4b6da |
</body>
|
|
Packit |
e4b6da |
</html>
|