docname
the document name, set by the --name
option.
version
the product version, set by the --version
option.
xml_lang
the language of the source XML files, set by the --lang
option.
edition
the edition number for this documentation, set by the --edition
option.
type
the type of document — a DocBook <article>
, DocBook <book>
, or DocBook <set>
, set by the --type
option.
brand
the brand of the document, set by the --brand
option.
product
the product to which this documentation applies, set by the --product
option.
arch
the computer architecture for this document.
books
a space-separated list of books used in a remote set.
brew_dist
the build target to use for building the desktop RPM package in Brew. (Default: docs-5E
)
catalogs
the path to the DocBook catalog files. (Default for Linux operating systems: /usr/share/publican/xsl
, default for Windows operating systems: %SystemDrive%/%ProgramFiles%/publican/DocBook_DTD
— most usually C:/Program Files/publican/DocBook_DTD
).
chunk_first
whether the first section should appear on the same page as its parent when rendered in HTML. (Default: 0
— the first section starts a new HTML page).
chunk_section_depth
the point at which Publican no longer splits sub-subsections onto a new page when rendering HTML. (Default: 4
)
classpath
the path to the jar files for FOP. (Default for Linux operating systems: /usr
/share
/java
/ant
/ant-trax-1.7.0.jar:
/usr
/share
/java
/xmlgraphics-commons.jar:
/usr
/share
/java
/batik-all.jar:
/usr
/share
/java
/xml-commons-apis.jar:
/usr
/share
/java
/xml-commons-apis-ext.jar
)
common_config
the path to the Publican installation. (Default for Linux operating systems: /usr/share/publican
, default for Windows operating systems: %SystemDrive%/%ProgramFiles%/publican
— most usually C:/Program Files/publican
)
common_content
the path to the Publican's Common Content files. (Default for Linux operating systems: /usr/share/publican/Common_Content
, default for Windows operating systems: %SystemDrive%/%ProgramFiles%/publican/Common_Content
— most usually C:/Program Files/publican/Common_Content
)
condition
conditions on which to prune XML before transformation.
confidential
marks a document as confidential. (Default: 0
— not confidential).
debug
whether Publican should display debugging messages as it works. (Default: 0
— suppress messages)
doc_url
URL for the documentation team for this package. (Default: https://fedorahosted.org/publican
)
dt_obsoletes
the desktop packages that this package obsoletes.
dtdver
the version of the DocBook XML Document Type Definition (DTD) on which this project is based. (Default: 4.5)
generate_section_toc_level
the section depth at which Publican generates a table of contents. (Default: 0
— no tables of contents in sections)
ignored_translations
translations to ignore.
license
the license this package uses. (Default: GNU Free Documentation License).
os_ver
the operating system for which to build packages. (Default: .el5
— Red Hat Enterprise Linux 5)
prod_url
URL for the product to which this document applies. (Default: https://fedorahosted.org/publican
)
release
the release number of this package. Defaults to the value of xml_lang
, fetched from the title tag in xml_lang/TYPE_Info.xml
or Project-Id-Version
in lang/TYPE_Info.po
.
repo
the repository from which to fetch remote books that form part of a distributed set.
scm
the version control system used in the repository in that stores the remote books in a distributed set. (Default: SVN
)
show_remarks
whether to display remarks in transformed output. (Default: 0
— hide remarks)
show_unknown
whether Publican reports unknown tags when processing XML. (Default: 1
— report unknown tags)
src_url
URL at which to find to find tarballs of source files.
strict
use strict mode (Default: 0
— not strict) Strict mode is no longer enforced.
tmp_dir
the directory for Publican output. (Default: tmp
)
toc_section_depth
the depth of sections that Publican includes in the main table of contents. (Default: 2
)
web_brew_dist
the brew build target to use for the web RPM package. (Defaults to docs-5E
)
web_obsoletes
packages that the web RPM package obsoletes.