Product SiteDocumentation Site

publican.cfg parameters

Every book, article, document set, or brand has a publican.cfg file in its root directory. Parameters that can be set in the publican.cfg file are:
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)
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).
confidential_text
sets the text with which to mark a document as confidential. (Default: CONFIDENTIAL).
cvs_branch
the CVS branch into which to import the SRPM.
cvs_pkg
the CVS package into which to import the SRPM. This parameter takes the literal string __LANG__ and replaces it with the langauge supplied to the package action at run time.
cvs_root
the CVS root into which to import the SRPM.
debug
whether Publican should display debugging messages as it works. (Default: 0 — suppress messages)
def_lang
the default language for a Publican-managed website. Tables of contents for languages other than the default language will link to documents in the default language when translations are not available. (Default: en-US — American English)
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)
ec_id
the ID for an Eclipse help plugin (Default: product.docname)
ec_name
the name of an Eclipse help plugin (Default: product docname)
ec_provider
the provider name for an Eclipse help plugin (Default: Publican-Publican version)
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).
max_image_width
the maximum width allowable for images in the document. (Default: 444 — 444 pixels wide)

Important — 444 pixels is the maximum safe width

Do not use the max_image_width parameter if your images contain important information. Images wider than 444 pixels might lead to poorly presented HTML and to PDF output that it is unusable because images have run off the page and are presented incomplete to the reader.
Conversely, images lose quality when scaled down in HTML and PDF.
To safeguard the quality of your images, crop or scale them so that they are no wider than 444 pixels before including them in a document.
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 not currently 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_home
specifies that the document is the home page of a documentation website, not a standard document.
web_host
specifies the host name of a documentation website.
web_name_label
overrides the book name as it appears on the menu of a Publican-managed website.
web_obsoletes
packages that the web RPM package obsoletes.
web_product_label
overrides the product name as it appears on the menu of a Publican-managed website.
web_search
overrides the default search form for a Publican-managed website. (Defaults: Google search; limited to a site search if web_host is set.)
web_version_label
overrides the version number as it appears on the menu of a Publican-managed website.