|
Packit |
e4b6da |
.\" -*- coding: us-ascii -*-
|
|
Packit |
e4b6da |
.if \n(.g .ds T< \\FC
|
|
Packit |
e4b6da |
.if \n(.g .ds T> \\F[\n[.fam]]
|
|
Packit |
e4b6da |
.de URL
|
|
Packit |
e4b6da |
\\$2 \(la\\$1\(ra\\$3
|
|
Packit |
e4b6da |
..
|
|
Packit |
e4b6da |
.if \n(.g .mso www.tmac
|
|
Packit |
e4b6da |
.TH docbook2texi 1 "3 March 2007" "docbook2X 0.8.8" docbook2X
|
|
Packit |
e4b6da |
.SH NAME
|
|
Packit |
e4b6da |
docbook2texi \- Convert DocBook to Texinfo
|
|
Packit |
e4b6da |
.SH SYNOPSIS
|
|
Packit |
e4b6da |
'nh
|
|
Packit |
e4b6da |
.fi
|
|
Packit |
e4b6da |
.ad l
|
|
Packit |
e4b6da |
\fBdocbook2texi\fR \kx
|
|
Packit |
e4b6da |
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
|
|
Packit |
e4b6da |
'in \n(.iu+\nxu
|
|
Packit |
e4b6da |
[\fIoptions\fR] \fIxml-document\fR
|
|
Packit |
e4b6da |
'in \n(.iu-\nxu
|
|
Packit |
e4b6da |
.ad b
|
|
Packit |
e4b6da |
'hy
|
|
Packit |
e4b6da |
.SH DESCRIPTION
|
|
Packit |
e4b6da |
\fBdocbook2texi\fR converts the given
|
|
Packit |
e4b6da |
DocBook XML document into one or more Texinfo documents.
|
|
Packit |
e4b6da |
By default, these Texinfo documents will be output to the current
|
|
Packit |
e4b6da |
directory.
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
The \fBdocbook2texi\fR command is a wrapper script
|
|
Packit |
e4b6da |
for a two-step conversion process.
|
|
Packit |
e4b6da |
See the section \(lqCONVERSION PROCESS\(rq below
|
|
Packit |
e4b6da |
for details.
|
|
Packit |
e4b6da |
.SH OPTIONS
|
|
Packit |
e4b6da |
The available options are essentially the union of the options
|
|
Packit |
e4b6da |
for \fBdb2x_xsltproc\fR(1) and \fBdb2x_texixml\fR(1).
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
Some commonly-used options are listed below:
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<\fB\-\-encoding=\fR\*(T>\fIencoding\fR
|
|
Packit |
e4b6da |
Sets the character encoding of the output.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<\fB\-\-string\-param \fR\*(T>\fIparameter\fR\*(T<\fB=\fR\*(T>\fIvalue\fR
|
|
Packit |
e4b6da |
Sets a stylesheet parameter (options that affect how the output looks).
|
|
Packit |
e4b6da |
See \(lqStylesheet parameters\(rq below for the parameters that
|
|
Packit |
e4b6da |
can be set.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<\fB\-\-sgml\fR\*(T>
|
|
Packit |
e4b6da |
Accept an SGML source document as input instead of XML.
|
|
Packit |
e4b6da |
.SS "STYLESHEET PARAMETERS"
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<captions\-display\-as\-headings\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Use heading markup for minor captions?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<0\*(T> (boolean false)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, \*(T<title\*(T>
|
|
Packit |
e4b6da |
content in some (formal) objects are rendered with the Texinfo
|
|
Packit |
e4b6da |
\*(T<@\fIheading\fR\*(T> commands.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If false, captions are rendered as an emphasized paragraph.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<links\-use\-pxref\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Translate \*(T<link\*(T> using
|
|
Packit |
e4b6da |
\*(T<@pxref\*(T>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, \*(T<link\*(T> is translated
|
|
Packit |
e4b6da |
with the hypertext followed by the cross reference in parentheses.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Otherwise, the hypertext content serves as the cross-reference name
|
|
Packit |
e4b6da |
marked up using \*(T<@ref\*(T>. Typically info displays this
|
|
Packit |
e4b6da |
contruct badly.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<explicit\-node\-names\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Insist on manually constructed Texinfo node
|
|
Packit |
e4b6da |
names
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<0\*(T> (boolean false)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Elements in the source document can influence the Texinfo node name
|
|
Packit |
e4b6da |
generation specifying either a \*(T<xreflabel\*(T>, or for the sectioning elements,
|
|
Packit |
e4b6da |
a \*(T<title\*(T> with \*(T<role='texinfo\-node'\*(T> in the
|
|
Packit |
e4b6da |
\*(T<\fI*\fRinfo\*(T> container.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
However, for the majority of source documents, explicit Texinfo node
|
|
Packit |
e4b6da |
names are not available, and the stylesheet tries to generate a
|
|
Packit |
e4b6da |
reasonable one instead, e.g. from the normal title of an element.
|
|
Packit |
e4b6da |
The generated name may not be optimal. If this option is set and the
|
|
Packit |
e4b6da |
stylesheet needs to generate a name, a warning is emitted and
|
|
Packit |
e4b6da |
\*(T<\fBgenerate\-id\fR\*(T> is always used for the name.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
When the hashtable extension is not available, the stylesheet cannot
|
|
Packit |
e4b6da |
check for node name collisions, and in this case, setting this option
|
|
Packit |
e4b6da |
and using explicit node names are recommended.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This option is not set (i.e. false) by default.
|
|
Packit |
e4b6da |
.RS
|
|
Packit |
e4b6da |
\fBNote\fR
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The absolute fallback for generating node names is using the XSLT
|
|
Packit |
e4b6da |
function \*(T<\fBgenerate\-id\fR\*(T>, and the stylesheet always
|
|
Packit |
e4b6da |
emits a warning in this case regardless of the setting of
|
|
Packit |
e4b6da |
\*(T<explicit\-node\-names\*(T>.
|
|
Packit |
e4b6da |
.RE
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<show\-comments\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Display \*(T<comment\*(T> elements?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, comments will be displayed, otherwise they are suppressed.
|
|
Packit |
e4b6da |
Comments here refers to the \*(T<comment\*(T> element,
|
|
Packit |
e4b6da |
which will be renamed \*(T<remark\*(T> in DocBook V4.0,
|
|
Packit |
e4b6da |
not XML comments (<-- like this -->) which are unavailable.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<funcsynopsis\-decoration\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Decorate elements of a FuncSynopsis?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, elements of the FuncSynopsis will be decorated (e.g. bold or
|
|
Packit |
e4b6da |
italic). The decoration is controlled by functions that can be redefined
|
|
Packit |
e4b6da |
in a customization layer.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<function\-parens\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Generate parentheses after a function?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<0\*(T> (boolean false)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, the formatting of
|
|
Packit |
e4b6da |
a \*(T<<function>\*(T> element will include
|
|
Packit |
e4b6da |
generated parenthesis.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<refentry\-display\-name\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Output NAME header before 'RefName'(s)?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, a "NAME" section title is output before the list
|
|
Packit |
e4b6da |
of 'RefName's.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<manvolnum\-in\-xref\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Output \*(T<manvolnum\*(T> as part of
|
|
Packit |
e4b6da |
\*(T<refentry\*(T> cross-reference?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
if true, the \*(T<manvolnum\*(T> is used when cross-referencing
|
|
Packit |
e4b6da |
\*(T<refentry\*(T>s, either with \*(T<xref\*(T>
|
|
Packit |
e4b6da |
or \*(T<citerefentry\*(T>.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<prefer\-textobjects\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Prefer \*(T<textobject\*(T>
|
|
Packit |
e4b6da |
over \*(T<imageobject\*(T>?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, the
|
|
Packit |
e4b6da |
\*(T<textobject\*(T>
|
|
Packit |
e4b6da |
in a \*(T<mediaobject\*(T>
|
|
Packit |
e4b6da |
is preferred over any
|
|
Packit |
e4b6da |
\*(T<imageobject\*(T>.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
(Of course, for output formats other than Texinfo, you usually
|
|
Packit |
e4b6da |
want to prefer the \*(T<imageobject\*(T>,
|
|
Packit |
e4b6da |
but Info is a text-only format.)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
In addition to the values true and false, this parameter
|
|
Packit |
e4b6da |
may be set to \*(T<2\*(T> to indicate that
|
|
Packit |
e4b6da |
both the text and the images should be output.
|
|
Packit |
e4b6da |
You may want to do this because some Texinfo viewers
|
|
Packit |
e4b6da |
can read images. Note that the Texinfo \*(T<@image\*(T>
|
|
Packit |
e4b6da |
command has its own mechanism for switching between text
|
|
Packit |
e4b6da |
and image output \(em but we do not use this here.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The default is true.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<semantic\-decorations\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Use Texinfo semantic inline markup?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T> (boolean true)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, the semantic inline markup of DocBook is translated into
|
|
Packit |
e4b6da |
(the closest) Texinfo equivalent. This is the default.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
However, because the Info format is limited to plain text,
|
|
Packit |
e4b6da |
the semantic inline markup is often distinguished by using
|
|
Packit |
e4b6da |
explicit quotes, which may not look good.
|
|
Packit |
e4b6da |
You can set this option to false to suppress these.
|
|
Packit |
e4b6da |
(For finer control over the inline formatting, you can
|
|
Packit |
e4b6da |
use your own stylesheet.)
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<custom\-localization\-file\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. URI of XML document containing custom localization data
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. (blank)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This parameter specifies the URI of a XML document
|
|
Packit |
e4b6da |
that describes text translations (and other locale-specific information)
|
|
Packit |
e4b6da |
that is needed by the stylesheet to process the DocBook document.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The text translations pointed to by this parameter always
|
|
Packit |
e4b6da |
override the default text translations
|
|
Packit |
e4b6da |
(from the internal parameter \*(T<localization\-file\*(T>).
|
|
Packit |
e4b6da |
If a particular translation is not present here,
|
|
Packit |
e4b6da |
the corresponding default translation
|
|
Packit |
e4b6da |
is used as a fallback.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This parameter is primarily for changing certain
|
|
Packit |
e4b6da |
punctuation characters used in formatting the source document.
|
|
Packit |
e4b6da |
The settings for punctuation characters are often specific
|
|
Packit |
e4b6da |
to the source document, but can also be dependent on the locale.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
To not use custom text translations, leave this parameter
|
|
Packit |
e4b6da |
as the empty string.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<custom\-l10n\-data\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. XML document containing custom localization data
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<document($custom\-localization\-file)\*(T>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This parameter specifies the XML document
|
|
Packit |
e4b6da |
that describes text translations (and other locale-specific information)
|
|
Packit |
e4b6da |
that is needed by the stylesheet to process the DocBook document.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This parameter is internal to the stylesheet.
|
|
Packit |
e4b6da |
To point to an external XML document with a URI or a file name,
|
|
Packit |
e4b6da |
you should use the \*(T<custom\-localization\-file\*(T>
|
|
Packit |
e4b6da |
parameter instead.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
However, inside a custom stylesheet
|
|
Packit |
e4b6da |
(\fInot on the command-line\fR)
|
|
Packit |
e4b6da |
this paramter can be set to the XPath expression
|
|
Packit |
e4b6da |
\*(T<document('')\*(T>,
|
|
Packit |
e4b6da |
which will cause the custom translations
|
|
Packit |
e4b6da |
directly embedded inside the custom stylesheet to be read.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<author\-othername\-in\-middle\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Is \*(T<othername\*(T> in \*(T<author\*(T> a
|
|
Packit |
e4b6da |
middle name?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<1\*(T>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, the \*(T<othername\*(T> of an \*(T<author\*(T>
|
|
Packit |
e4b6da |
appears between the \*(T<firstname\*(T> and
|
|
Packit |
e4b6da |
\*(T<surname\*(T>. Otherwise, \*(T<othername\*(T>
|
|
Packit |
e4b6da |
is suppressed.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<output\-file\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Name of the Info file
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. (blank)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This parameter specifies the name of the final Info file,
|
|
Packit |
e4b6da |
overriding the setting in the document itself and the automatic
|
|
Packit |
e4b6da |
selection in the stylesheet. If the document is a \*(T<set\*(T>, this parameter has no effect.
|
|
Packit |
e4b6da |
.RS
|
|
Packit |
e4b6da |
\fBImportant\fR
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Do \fInot\fR include the \*(T<.info\*(T>
|
|
Packit |
e4b6da |
extension in the name.
|
|
Packit |
e4b6da |
.RE
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
(Note that this parameter has nothing to do with the name of
|
|
Packit |
e4b6da |
the \fITexi-XML output\fR by the XSLT processor you
|
|
Packit |
e4b6da |
are running this stylesheet from.)
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<directory\-category\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. The categorization of the document in the Info directory
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. (blank)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This is set to the category that the document
|
|
Packit |
e4b6da |
should go under in the Info directory of installed Info files.
|
|
Packit |
e4b6da |
For example, \*(T<General Commands\*(T>.
|
|
Packit |
e4b6da |
.RS
|
|
Packit |
e4b6da |
\fBNote\fR
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Categories may also be set directly in the source document.
|
|
Packit |
e4b6da |
But if this parameter is not empty, then it always overrides the
|
|
Packit |
e4b6da |
setting in the source document.
|
|
Packit |
e4b6da |
.RE
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<directory\-description\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. The description of the document in the Info directory
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. (blank)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This is a short description of the document that appears in
|
|
Packit |
e4b6da |
the Info directory of installed Info files.
|
|
Packit |
e4b6da |
For example, \*(T<An Interactive Plotting Program.\*(T>
|
|
Packit |
e4b6da |
.RS
|
|
Packit |
e4b6da |
\fBNote\fR
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Menu descriptions may also be set directly in the source document.
|
|
Packit |
e4b6da |
But if this parameter is not empty, then it always overrides the
|
|
Packit |
e4b6da |
setting in the source document.
|
|
Packit |
e4b6da |
.RE
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<index\-category\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. The Texinfo index to use
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<cp\*(T>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The Texinfo index for \*(T<indexterm\*(T>
|
|
Packit |
e4b6da |
and \*(T<index\*(T> is specified using the
|
|
Packit |
e4b6da |
\*(T<role\*(T> attribute. If the above
|
|
Packit |
e4b6da |
elements do not have a \*(T<role\*(T>, then
|
|
Packit |
e4b6da |
the default specified by this parameter is used.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The predefined indices are:
|
|
Packit |
e4b6da |
.RS
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<c\*(T>, \*(T<cp\*(T>
|
|
Packit |
e4b6da |
Concept index
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<f\*(T>, \*(T<fn\*(T>
|
|
Packit |
e4b6da |
Function index
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<v\*(T>, \*(T<vr\*(T>
|
|
Packit |
e4b6da |
Variable index
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<k\*(T>, \*(T<ky\*(T>
|
|
Packit |
e4b6da |
Keystroke index
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<p\*(T>, \*(T<pg\*(T>
|
|
Packit |
e4b6da |
Program index
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<d\*(T>, \*(T<tp\*(T>
|
|
Packit |
e4b6da |
Data type index
|
|
Packit |
e4b6da |
.RE
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
User-defined indices are not yet supported.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<qanda\-defaultlabel\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Sets the default for defaultlabel on QandASet.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<\*(T>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If no defaultlabel attribute is specified on a QandASet, this
|
|
Packit |
e4b6da |
value is used. It must be one of the legal values for the defaultlabel
|
|
Packit |
e4b6da |
attribute.
|
|
Packit |
e4b6da |
.TP
|
|
Packit |
e4b6da |
\*(T<qandaset\-generate\-toc\*(T>
|
|
Packit |
e4b6da |
\fBBrief\fR. Is a Table of Contents created for QandASets?
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBDefault setting\fR. \*(T<\*(T>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
If true, a ToC is constructed for QandASets.
|
|
Packit |
e4b6da |
.SH EXAMPLES
|
|
Packit |
e4b6da |
.nf
|
|
Packit |
e4b6da |
\*(T<\fB$ \fRdocbook2texi tdg.xml
|
|
Packit |
e4b6da |
\fB$ \fRdocbook2texi \-\-encoding=utf\-8//TRANSLIT tdg.xml
|
|
Packit |
e4b6da |
\fB$ \fRdocbook2texi \-\-string\-param semantic\-decorations=0 tdg.xml
|
|
Packit |
e4b6da |
\*(T>.fi
|
|
Packit |
e4b6da |
.SH "CONVERSION PROCESS"
|
|
Packit |
e4b6da |
.SS "Converting to Texinfo"
|
|
Packit |
e4b6da |
DocBook documents are converted to Texinfo in two steps:
|
|
Packit |
e4b6da |
.TP 0.4i
|
|
Packit |
e4b6da |
1.
|
|
Packit |
e4b6da |
The DocBook source is converted by a XSLT stylesheet into an intermediate
|
|
Packit |
e4b6da |
XML format, Texi-XML.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Texi-XML is simpler than DocBook and closer to the Texinfo format;
|
|
Packit |
e4b6da |
it is intended to make the stylesheets\(cq job easier.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
The stylesheet for this purpose is in
|
|
Packit |
e4b6da |
\*(T<\fIxslt/texi/docbook.xsl\fR\*(T>.
|
|
Packit |
e4b6da |
For portability, it should always be referred to
|
|
Packit |
e4b6da |
by the following URI:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
.nf
|
|
Packit |
e4b6da |
http://docbook2x.sourceforge.net/latest/xslt/texi/docbook.xsl
|
|
Packit |
e4b6da |
.fi
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Run this stylesheet with \fBdb2x_xsltproc\fR(1).
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
\fBCustomizing\fR.
|
|
Packit |
e4b6da |
You can also customize the output by
|
|
Packit |
e4b6da |
creating your own XSLT stylesheet \(em
|
|
Packit |
e4b6da |
changing parameters or adding new templates \(em
|
|
Packit |
e4b6da |
and importing \*(T<\fIxslt/texi/docbook.xsl\fR\*(T>.
|
|
Packit |
e4b6da |
.TP 0.4i
|
|
Packit |
e4b6da |
2.
|
|
Packit |
e4b6da |
Texi-XML is converted to the actual Texinfo files by \fBdb2x_texixml\fR(1).
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
The \fBdocbook2texi\fR command does both steps automatically,
|
|
Packit |
e4b6da |
but if any problems occur, you can see the errors more clearly
|
|
Packit |
e4b6da |
if you do each step separately:
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
.nf
|
|
Packit |
e4b6da |
\*(T<\fB$ \fRdb2x_xsltproc \-s texi \fImydoc\fR.xml \-o \fImydoc\fR.txml
|
|
Packit |
e4b6da |
\fB$ \fRdb2x_texixml \fImydoc\fR.txml
|
|
Packit |
e4b6da |
\*(T>.fi
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
Options to the conversion stylesheet are described
|
|
Packit |
e4b6da |
in the Texinfo stylesheets
|
|
Packit |
e4b6da |
reference.
|
|
Packit |
e4b6da |
.SS "Character set conversion"
|
|
Packit |
e4b6da |
When translating XML to legacy ASCII-based formats
|
|
Packit |
e4b6da |
with poor support for Unicode, such as man pages and Texinfo,
|
|
Packit |
e4b6da |
there is always the problem that Unicode characters in
|
|
Packit |
e4b6da |
the source document also have to be translated somehow.
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
A straightforward character set conversion from Unicode
|
|
Packit |
e4b6da |
does not suffice,
|
|
Packit |
e4b6da |
because the target character set, usually US-ASCII or ISO Latin-1,
|
|
Packit |
e4b6da |
do not contain common characters such as
|
|
Packit |
e4b6da |
dashes and directional quotation marks that are widely
|
|
Packit |
e4b6da |
used in XML documents. But document formatters (man and Texinfo)
|
|
Packit |
e4b6da |
allow such characters to be entered by a markup escape:
|
|
Packit |
e4b6da |
for example, \*(T<\e(lq\*(T> for the left directional quote
|
|
Packit |
e4b6da |
\*(T<\(lq\*(T>.
|
|
Packit |
e4b6da |
And if a markup-level escape is not available,
|
|
Packit |
e4b6da |
an ASCII transliteration might be used: for example,
|
|
Packit |
e4b6da |
using the ASCII less-than sign \*(T<<\*(T> for
|
|
Packit |
e4b6da |
the angle quotation mark \*(T<\(la\*(T>.
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
So the Unicode character problem can be solved in two steps:
|
|
Packit |
e4b6da |
.TP 0.4i
|
|
Packit |
e4b6da |
1.
|
|
Packit |
e4b6da |
\fButf8trans\fR(1), a program included in docbook2X, maps
|
|
Packit |
e4b6da |
Unicode characters to markup-level escapes or transliterations.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
Since there is not necessarily a fixed, official mapping of Unicode characters,
|
|
Packit |
e4b6da |
\fButf8trans\fR can read in user-modifiable character mappings
|
|
Packit |
e4b6da |
expressed in text files and apply them. (Unlike most character
|
|
Packit |
e4b6da |
set converters.)
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
In \*(T<\fIcharmaps/man/roff.charmap\fR\*(T>
|
|
Packit |
e4b6da |
and \*(T<\fIcharmaps/man/texi.charmap\fR\*(T>
|
|
Packit |
e4b6da |
are character maps that may be used for man-page and Texinfo conversion.
|
|
Packit |
e4b6da |
The programs \fBdb2x_manxml\fR(1) and \fBdb2x_texixml\fR(1) will apply
|
|
Packit |
e4b6da |
these character maps, or another character map specified by the user,
|
|
Packit |
e4b6da |
automatically.
|
|
Packit |
e4b6da |
.TP 0.4i
|
|
Packit |
e4b6da |
2.
|
|
Packit |
e4b6da |
The rest of the Unicode text is converted to some other character set
|
|
Packit |
e4b6da |
(encoding).
|
|
Packit |
e4b6da |
For example, a French document with accented characters
|
|
Packit |
e4b6da |
(such as \*(T<\('e\*(T>) might be converted to ISO Latin 1.
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
This step is applied after \fButf8trans\fR character mapping,
|
|
Packit |
e4b6da |
using the
|
|
Packit |
e4b6da |
\fBiconv\fR(1) encoding conversion tool.
|
|
Packit |
e4b6da |
Both \fBdb2x_manxml\fR(1) and \fBdb2x_texixml\fR(1) can call
|
|
Packit |
e4b6da |
\fBiconv\fR(1) automatically when producing their output.
|
|
Packit |
e4b6da |
.SH FILES
|
|
Packit |
e4b6da |
\*(T<\fI/usr/local/share/docbook2X/xslt/texi/docbook.xsl\fR\*(T>
|
|
Packit |
e4b6da |
.br
|
|
Packit |
e4b6da |
\*(T<\fI/usr/local/share/docbook2X/xslt/backend/db2x_texixml.xsl\fR\*(T>
|
|
Packit |
e4b6da |
.br
|
|
Packit |
e4b6da |
\*(T<\fI/usr/local/share/docbook2X/xslt/catalog.xml\fR\*(T>
|
|
Packit |
e4b6da |
.br
|
|
Packit |
e4b6da |
\*(T<\fI/usr/local/share/docbook2X/charmaps/texi.charmap.xml\fR\*(T>
|
|
Packit |
e4b6da |
.br
|
|
Packit |
e4b6da |
\*(T<\fI/usr/local/share/docbook2X/charmaps/texi.charmap.xml\fR\*(T>
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
The above files are distributed and installed by the docbook2X package.
|
|
Packit |
e4b6da |
.SH NOTES
|
|
Packit |
e4b6da |
The \fBdocbook2man\fR or the \fBdocbook2texi\fR
|
|
Packit |
e4b6da |
command described in this manual page
|
|
Packit |
e4b6da |
come from the docbook2X package.
|
|
Packit |
e4b6da |
It should not be confused with the command of the same
|
|
Packit |
e4b6da |
name from the obsoleted docbook-utils package.
|
|
Packit |
e4b6da |
.SH LIMITATIONS
|
|
Packit |
e4b6da |
.TP 0.2i
|
|
Packit |
e4b6da |
\(bu
|
|
Packit |
e4b6da |
Internally there is one long pipeline of programs which your
|
|
Packit |
e4b6da |
document goes through. If any segment of the pipeline fails
|
|
Packit |
e4b6da |
(even trivially, like from mistyped program options),
|
|
Packit |
e4b6da |
the resulting errors can be difficult to decipher \(em
|
|
Packit |
e4b6da |
in this case, try running the components of docbook2X
|
|
Packit |
e4b6da |
separately.
|
|
Packit |
e4b6da |
.SH AUTHOR
|
|
Packit |
e4b6da |
Steve Cheng <\*(T<stevecheng@users.sourceforge.net\*(T>>.
|
|
Packit |
e4b6da |
.SH "SEE ALSO"
|
|
Packit |
e4b6da |
\fBdb2x_xsltproc\fR(1), \fBdb2x_texixml\fR(1), \fButf8trans\fR(1)
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
The docbook2X manual (in Texinfo or HTML format) fully describes
|
|
Packit |
e4b6da |
how to convert DocBook to man pages and Texinfo.
|
|
Packit |
e4b6da |
.PP
|
|
Packit |
e4b6da |
Up-to-date information about this program
|
|
Packit |
e4b6da |
can be found
|
|
Packit |
e4b6da |
at the
|
|
Packit |
e4b6da |
.URL http://docbook2x.sourceforge.net/ "docbook2X Web site"
|
|
Packit |
e4b6da |
\&.
|