Blame doc/docbook2texi.html

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: docbook2texi</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: Converting to Texinfo" />
Packit e4b6da
Packit e4b6da
"docbook2X: db2x_texixml" />
Packit e4b6da
</head>
Packit e4b6da
<body>
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
docbook2texi
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
"texinfo.html"><< Previous 
Packit e4b6da
Converting to Texinfo
Packit e4b6da
 
Packit e4b6da
"db2x_texixml.html">Next >>
Packit e4b6da
Packit e4b6da
Packit e4b6da

Packit e4b6da
Packit e4b6da
name="docbook2texi">
Packit e4b6da
Packit e4b6da
Packit e4b6da
"id2529014" class="indexterm" name="id2529014">
Packit e4b6da
"id2529021" class="indexterm" name="id2529021">
Packit e4b6da
"id2529027" class="indexterm" name="id2529027">
Packit e4b6da
Packit e4b6da

Name

Packit e4b6da

docbook2texi

Packit e4b6da
— Convert DocBook to Texinfo

Packit e4b6da
Packit e4b6da
Packit e4b6da

Synopsis

Packit e4b6da
Packit e4b6da

docbook2texi [

Packit e4b6da
"replaceable">options] 
Packit e4b6da
"replaceable">xml-document

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
name="id2529110">
Packit e4b6da

Description

Packit e4b6da

docbook2texi

Packit e4b6da
converts the given DocBook XML document into one or more Texinfo
Packit e4b6da
documents. By default, these Texinfo documents will be output to
Packit e4b6da
the current directory.

Packit e4b6da

The docbook2texi

Packit e4b6da
command is a wrapper script for a two-step conversion process.

Packit e4b6da
Packit e4b6da
Packit e4b6da
name="id2529146">
Packit e4b6da

Options

Packit e4b6da

The available options are essentially the union of the options

Packit e4b6da
for 
Packit e4b6da
"command">db2x_xsltproc and 
Packit e4b6da
"db2x_texixml.html">
Packit e4b6da
"command">db2x_texixml.

Packit e4b6da

Some commonly-used options are listed below:

Packit e4b6da
Packit e4b6da
Packit e4b6da
--encoding=
Packit e4b6da
"replaceable">encoding
Packit e4b6da
Packit e4b6da

Sets the character encoding of the output.

Packit e4b6da
Packit e4b6da
--string-param
Packit e4b6da
parameter=
Packit e4b6da
"replaceable">value
Packit e4b6da
Packit e4b6da

Sets a stylesheet parameter (options that affect how the output

Packit e4b6da
looks). See “Stylesheet parameters” below for the
Packit e4b6da
parameters that can be set.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"option">--sgml
Packit e4b6da
Packit e4b6da

Accept an SGML source document as input instead of XML.

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
name="id2529242">
Packit e4b6da

Stylesheet parameters

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">captions-display-as-headings
Packit e4b6da
Packit e4b6da

Brief. Use heading markup for minor captions?

Packit e4b6da

Default setting. 0

Packit e4b6da
(boolean false)

Packit e4b6da

If true, title content in

Packit e4b6da
some (formal) objects are rendered with the Texinfo 
Packit e4b6da
"markup">@heading
Packit e4b6da
commands.

Packit e4b6da

If false, captions are rendered as an emphasized paragraph.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">links-use-pxref
Packit e4b6da
Packit e4b6da

Brief. Translate

Packit e4b6da
"sgmltag-element">link using 
Packit e4b6da
"markup">@pxref

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

If true, link is translated

Packit e4b6da
with the hypertext followed by the cross reference in
Packit e4b6da
parentheses.

Packit e4b6da

Otherwise, the hypertext content serves as the cross-reference

Packit e4b6da
name marked up using @ref. Typically
Packit e4b6da
info displays this contruct badly.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">explicit-node-names
Packit e4b6da
Packit e4b6da

Brief. Insist on manually constructed Texinfo node

Packit e4b6da
names

Packit e4b6da

Default setting. 0

Packit e4b6da
(boolean false)

Packit e4b6da

Elements in the source document can influence the Texinfo node

Packit e4b6da
name generation specifying either a 
Packit e4b6da
"sgmltag-attribute">xreflabel, or for the sectioning
Packit e4b6da
elements, a title with
Packit e4b6da
role='texinfo-node' in the
Packit e4b6da
Packit e4b6da
"replaceable">*info container.

Packit e4b6da

However, for the majority of source documents, explicit Texinfo

Packit e4b6da
node names are not available, and the stylesheet tries to generate
Packit e4b6da
a 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
Packit e4b6da
the stylesheet needs to generate a name, a warning is emitted and
Packit e4b6da
generate-id is always used for the
Packit e4b6da
name.

Packit e4b6da

When the hashtable extension is not available, the stylesheet

Packit e4b6da
cannot check for node name collisions, and in this case, setting
Packit e4b6da
this option and using explicit node names are recommended.

Packit e4b6da

This option is not set (i.e. false) by default.

Packit e4b6da
Packit e4b6da

Note

Packit e4b6da

The absolute fallback for generating node names is using the

Packit e4b6da
XSLT function generate-id, and the
Packit e4b6da
stylesheet always emits a warning in this case regardless of the
Packit e4b6da
setting of 
Packit e4b6da
"parameter">explicit-node-names.

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">show-comments
Packit e4b6da
Packit e4b6da

Brief. Display

Packit e4b6da
"sgmltag-element">comment elements?

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

If true, comments will be displayed, otherwise they are

Packit e4b6da
suppressed. Comments here refers to the 
Packit e4b6da
"sgmltag-element">comment element, which will be renamed
Packit e4b6da
remark in DocBook V4.0, not
Packit e4b6da
XML comments (<-- like this -->) which are unavailable.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">funcsynopsis-decoration
Packit e4b6da
Packit e4b6da

Brief. Decorate elements of a FuncSynopsis?

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

If true, elements of the FuncSynopsis will be decorated (e.g.

Packit e4b6da
bold or italic). The decoration is controlled by functions that can
Packit e4b6da
be redefined in a customization layer.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">function-parens
Packit e4b6da
Packit e4b6da

Brief. Generate parentheses after a function?

Packit e4b6da

Default setting. 0

Packit e4b6da
(boolean false)

Packit e4b6da

If true, the formatting of a

Packit e4b6da
"sgmltag-starttag"><function> element will include
Packit e4b6da
generated parenthesis.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">refentry-display-name
Packit e4b6da
Packit e4b6da

Brief. Output NAME header before 'RefName'(s)?

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

If true, a "NAME" section title is output before the list of

Packit e4b6da
'RefName's.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">manvolnum-in-xref
Packit e4b6da
Packit e4b6da

Brief. Output

Packit e4b6da
"sgmltag-element">manvolnum as part of 
Packit e4b6da
"sgmltag-element">refentry cross-reference?

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

if true, the manvolnum is

Packit e4b6da
used when cross-referencing 
Packit e4b6da
"sgmltag-element">refentrys, either with 
Packit e4b6da
"sgmltag-element">xref or 
Packit e4b6da
"sgmltag-element">citerefentry.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">prefer-textobjects
Packit e4b6da
Packit e4b6da

Brief. Prefer

Packit e4b6da
"sgmltag-element">textobject over 
Packit e4b6da
"sgmltag-element">imageobject?

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

If true, the textobject in

Packit e4b6da
a mediaobject is preferred
Packit e4b6da
over any imageobject.

Packit e4b6da

(Of course, for output formats other than Texinfo, you usually

Packit e4b6da
want to prefer the 
Packit e4b6da
"sgmltag-element">imageobject, but Info is a text-only
Packit e4b6da
format.)

Packit e4b6da

In addition to the values true and false, this parameter may be

Packit e4b6da
set to 2 to indicate that both the
Packit e4b6da
text and the images should be output. You may want to do this
Packit e4b6da
because some Texinfo viewers can read images. Note that the Texinfo
Packit e4b6da
@image command has its own mechanism
Packit e4b6da
for switching between text and image output — but we do not
Packit e4b6da
use this here.

Packit e4b6da

The default is true.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">semantic-decorations
Packit e4b6da
Packit e4b6da

Brief. Use Texinfo semantic inline markup?

Packit e4b6da

Default setting. 1

Packit e4b6da
(boolean true)

Packit e4b6da

If true, the semantic inline markup of DocBook is translated

Packit e4b6da
into (the closest) Texinfo equivalent. This is the default.

Packit e4b6da

However, because the Info format is limited to plain text, the

Packit e4b6da
semantic inline markup is often distinguished by using explicit
Packit e4b6da
quotes, which may not look good. You can set this option to false
Packit e4b6da
to suppress these. (For finer control over the inline formatting,
Packit e4b6da
you can use your own stylesheet.)

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">custom-localization-file
Packit e4b6da
Packit e4b6da

Brief. URI of XML document containing custom

Packit e4b6da
localization data

Packit e4b6da

Default setting. (blank)

Packit e4b6da

This parameter specifies the URI of a XML document that

Packit e4b6da
describes text translations (and other locale-specific information)
Packit e4b6da
that is needed by the stylesheet to process the DocBook
Packit e4b6da
document.

Packit e4b6da

The text translations pointed to by this parameter always

Packit e4b6da
override the default text translations (from the internal parameter
Packit e4b6da
localization-file). If a
Packit e4b6da
particular translation is not present here, the corresponding
Packit e4b6da
default translation is used as a fallback.

Packit e4b6da

This parameter is primarily for changing certain punctuation

Packit e4b6da
characters used in formatting the source document. The settings for
Packit e4b6da
punctuation characters are often specific to the source document,
Packit e4b6da
but can also be dependent on the locale.

Packit e4b6da

To not use custom text translations, leave this parameter as the

Packit e4b6da
empty string.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">custom-l10n-data
Packit e4b6da
Packit e4b6da

Brief. XML document containing custom localization

Packit e4b6da
data

Packit e4b6da

Default setting. 

Packit e4b6da
"literal">document($custom-localization-file)

Packit e4b6da

This parameter specifies the XML document that describes text

Packit e4b6da
translations (and other locale-specific information) that is needed
Packit e4b6da
by the stylesheet to process the DocBook document.

Packit e4b6da

This parameter is internal to the stylesheet. To point to an

Packit e4b6da
external XML document with a URI or a file name, you should use the
Packit e4b6da
custom-localization-file
Packit e4b6da
parameter instead.

Packit e4b6da

However, inside a custom stylesheet (

Packit e4b6da
"emphasis">not on the command-line) this paramter
Packit e4b6da
can be set to the XPath expression 
Packit e4b6da
"literal">document(''), which will cause the custom
Packit e4b6da
translations directly embedded inside the custom stylesheet to be
Packit e4b6da
read.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">author-othername-in-middle
Packit e4b6da
Packit e4b6da

Brief. Is

Packit e4b6da
"sgmltag-element">othername in 
Packit e4b6da
"sgmltag-element">author a middle name?

Packit e4b6da

Default setting. 1

Packit e4b6da

If true, the othername of

Packit e4b6da
an author appears between the
Packit e4b6da
firstname and 
Packit e4b6da
"sgmltag-element">surname. Otherwise, 
Packit e4b6da
"sgmltag-element">othername is suppressed.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">output-file
Packit e4b6da
Packit e4b6da

Brief. Name of the Info file

Packit e4b6da

Default setting. (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 
Packit e4b6da
"sgmltag-element">set, this parameter has no effect.

Packit e4b6da
Packit e4b6da
"margin-left: 0.5in; margin-right: 0.5in;">
Packit e4b6da

Important

Packit e4b6da

Do not include the

Packit e4b6da
.info extension in the name.

Packit e4b6da
Packit e4b6da

(Note that this parameter has nothing to do with the name of the

Packit e4b6da
Texi-XML output by the XSLT
Packit e4b6da
processor you are running this stylesheet from.)

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">directory-category
Packit e4b6da
Packit e4b6da

Brief. The categorization of the document in the

Packit e4b6da
Info directory

Packit e4b6da

Default setting. (blank)

Packit e4b6da
Packit e4b6da

This is set to the category that the document should go under in

Packit e4b6da
the Info directory of installed Info files. For example,
Packit e4b6da
General Commands.

Packit e4b6da
Packit e4b6da

Note

Packit e4b6da

Categories may also be set directly in the source document. But

Packit e4b6da
if this parameter is not empty, then it always overrides the
Packit e4b6da
setting in the source document.

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">directory-description
Packit e4b6da
Packit e4b6da

Brief. The description of the document in the Info

Packit e4b6da
directory

Packit e4b6da

Default setting. (blank)

Packit e4b6da
Packit e4b6da

This is a short description of the document that appears in the

Packit e4b6da
Info directory of installed Info files. For example, 
Packit e4b6da
"literal">An Interactive Plotting Program.

Packit e4b6da
Packit e4b6da

Note

Packit e4b6da

Menu descriptions may also be set directly in the source

Packit e4b6da
document. But if this parameter is not empty, then it always
Packit e4b6da
overrides the setting in the source document.

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">index-category
Packit e4b6da
Packit e4b6da

Brief. The Texinfo index to use

Packit e4b6da

Default setting. cp

Packit e4b6da

The Texinfo index for

Packit e4b6da
"sgmltag-element">indexterm and 
Packit e4b6da
"sgmltag-element">index is specified using the 
Packit e4b6da
"sgmltag-attribute">role attribute. If the above elements do
Packit e4b6da
not have a role, then the
Packit e4b6da
default specified by this parameter is used.

Packit e4b6da

The predefined indices are:

Packit e4b6da
Packit e4b6da
Packit e4b6da
c,
Packit e4b6da
cp
Packit e4b6da
Packit e4b6da

Concept index

Packit e4b6da
Packit e4b6da
f,
Packit e4b6da
fn
Packit e4b6da
Packit e4b6da

Function index

Packit e4b6da
Packit e4b6da
v,
Packit e4b6da
vr
Packit e4b6da
Packit e4b6da

Variable index

Packit e4b6da
Packit e4b6da
k,
Packit e4b6da
ky
Packit e4b6da
Packit e4b6da

Keystroke index

Packit e4b6da
Packit e4b6da
p,
Packit e4b6da
pg
Packit e4b6da
Packit e4b6da

Program index

Packit e4b6da
Packit e4b6da
d,
Packit e4b6da
tp
Packit e4b6da
Packit e4b6da

Data type index

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da

User-defined indices are not yet supported.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">qanda-defaultlabel
Packit e4b6da
Packit e4b6da

Brief. Sets the default for defaultlabel on

Packit e4b6da
QandASet.

Packit e4b6da

Default setting. 

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
Packit e4b6da
defaultlabel attribute.

Packit e4b6da
Packit e4b6da
Packit e4b6da
"parameter">qandaset-generate-toc
Packit e4b6da
Packit e4b6da

Brief. Is a Table of Contents created for

Packit e4b6da
QandASets?

Packit e4b6da

Default setting. 

Packit e4b6da

If true, a ToC is constructed for QandASets.

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
name="id2531519">
Packit e4b6da

Examples

Packit e4b6da
Packit e4b6da
Packit e4b6da
Packit e4b6da
$ 
Packit e4b6da
"userinput">docbook2texi tdg.xml
Packit e4b6da
$ 
Packit e4b6da
"userinput">docbook2texi --encoding=utf-8//TRANSLIT tdg.xml
Packit e4b6da
$ 
Packit e4b6da
"userinput">docbook2texi --string-param semantic-decorations=0 tdg.xml