# Configuration summary

## General options

These are set in the books or brands configuration files.

arch

  Arch to filter output on.

audience

  audience to filter output on.

books

  A space-separated list of books used in this remote set.

brand

  The brand to use when building this package.

  The default value for this parameter is: common

brew_dist

  The brew dist to use for building the standalone desktop rpm.

  The default value for this parameter is: docs-5E

  This field is deprecated and will be removed from Publican in the future.

bridgehead_in_toc

  Display bridge head elements in the TOCs?

  The default value for this parameter is: 0

chunk_first

  For HTML, should the first section be on the same page as its parent?

  The default value for this parameter is: 0

chunk_section_depth

  For HTML, what is the deepest level of nesting at which a section should be split onto its own page?

  The default value for this parameter is: 4

classpath

  Path to jar files for FOP.

  The default value for this parameter is: /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

  Path to publican content.

  The default value for this parameter is: /usr/share/publican

common_content

  Path to publican common content.

  The default value for this parameter is: /usr/share/publican/Common_Content

condition

  Conditions on which to prune XML before transformation.

confidential

  Is the content confidential?

  The default value for this parameter is: 0

confidential_text

  The text used to indicate content is confidential.

  The default value for this parameter is: CONFIDENTIAL

conformance

  conformance to filter output on.

debug

  Print out extra messages?

  The default value for this parameter is: 0

doc_url

  URL for the documentation team for this package. Used for top right URL on HTML.

  The default value for this parameter is: https://fedorahosted.org/publican

docname

  Name of this document. Fetched from title tag in xml_lang/TYPE_Info.xml if not set in cfg file.

  This parameter is constrained with the following regular expression: ^[0-9a-zA-Z_\-\.\+]+$

  This field is not supported for: brand.

drupal_author

  The author name to be shown in drupal book page. It must be a valid drupal username.

  The default value for this parameter is: Publican

drupal_image_path

  The directory where the image should be stored in drupal server.

  The default value for this parameter is: /sites/default/files/documentation/

drupal_menu_block

  The menu where we can find the book.

  The default value for this parameter is: user-guide

drupal_menu_title

  Override the bookname that will be shown in the drupal menu.

dt_format

  The format to use for the desktop output.

  The default value for this parameter is: html-desktop

dt_obsoletes

  Space-separated list of packages the desktop RPM obsoletes.

dt_requires

  Space-separated list of packages the desktop RPM requires.

dtdver

  Version of the DocBook DTD on which this project is based.

  The default value for this parameter is: 4.5

ec_id

  Eclipse plugin ID. Defaults to "$product.$docname"

ec_name

  Eclipse plugin name. Defaults to "$product $docname"

ec_provider

  Eclipse plugin provider. Defaults to "Publican-v4.2.2"

extras_dir

  Directory where images are located.

  The default value for this parameter is: extras

generate_section_toc_level

  Generate table of contents down to the given section depth.

  The default value for this parameter is: 0

ignored_translations

  Languages to replace with xml_lang regardless of translation status.

img_dir

  Directory where images are located.

  The default value for this parameter is: images

info_file

  Override the default Info file.

lang

  lang to filter output on.

license

  License this package uses.

  The default value for this parameter is: GFDL

mainfile

  The name of the main xml and ent files for this book, sans file extension and language. Fetched from docname if not set.

menu_category

  Semicolon-separated list of menu categories for the desktop package.

os

  os to filter output on.

os_ver

  The OS for which to build packages.

pdf_body_font

  The font to use for body text in PDFs.

  The default value for this parameter is: Liberation Sans

pdf_mono_font

  The font to use for mono text in PDFs.

  The default value for this parameter is: Liberation Mono

prod_url

  URL for the product. Used in top left URL in HTML.

  The default value for this parameter is: https://fedorahosted.org/publican

product

  Product this package covers. Fetched from productname tag in xml_lang/TYPE_Info.xml

  This parameter is constrained with the following regular expression: ^[0-9a-zA-Z_\-\.\+]+$

  This field is not supported for: brand.

repo

  Repository from which to fetch remote set books.

rev_dir

  By default Revision History is sorted in descending order. Set this to 'asc' or 'ascending' to reverse the sort.

rev_file

  Override the default Revision History file.

revision

  revision to filter output on.

revisionflag

  revisionflag to filter output on.

role

  role to filter output on.

scm

  Type of repository in which books that form part of a remote set are stored. Supported types: SVN, GIT.

security

  security to filter output on.

show_remarks

  Display remarks in transformed output.

  The default value for this parameter is: 0

sort_order

  Override the default sort weighting. Defaults to 50.

src_url

  URL to find tar of source files. Used in RPM Spec files.

status

  status to filter output on.

tmp_dir

  Directory to use for building.

  The default value for this parameter is: tmp

toc_section_depth

  Depth of sections to include in the main table of contents.

  The default value for this parameter is: 2

txt_formater

  Choose the formatter to use when creating txt output.

  The default value for this parameter is: default

  This parameter is constrained with the following regular expression: ^(links{1}|tables{1}|default)$

type

  Type of content this package contains. Supported: set, book, article, brand

  The default value for this parameter is: Book

userlevel

  userlevel to filter output on.

vendor

  vendor to filter output on.

version

  Version of this package. Fetched from productnumber tag in xml_lang/TYPE_Info.xml

  This parameter is constrained with the following regular expression: ^[0-9][^\p{IsSpace}]*$

web_brew_dist

  The brew dist to use for building the web rpm.

  The default value for this parameter is: docs-5E

web_formats

  A comma-separated list of the formats to use for the web packages.

  The default value for this parameter is: html,html-single,pdf,epub

web_home

  This is a home page for a Publican-generated website, not a standard book.

  web_home is deprecated and will be removed from Publican in the future. Use "web_type: home" instead.

web_host

  This is a host name for a Publican-generated website, used for searches and the Sitemap. Be sure to include the full path to your document tree. E.g. if your documents are in the docs directory: http://www.example.com/docs

  web_host is deprecated and will be removed from Publican in the future. Use "host" in the web site configuration file instead.

web_name_label

  Override the book name, bottom level, menu label on a Publican website.

web_obsoletes

  Packages to obsolete in web RPM.

web_product_label

  Override the product, top level, menu label on a Publican website.

web_search

  Override the default search form for a Publican website. By default this will use Google search and do a site search if web_host is set.

  web_search is deprecated and will be removed from Publican in the future. Use "search" in the web site configuration file instead.

web_type

  This is a special page for a Publican-generated website, not a standard book. Valid types are home, product, and version.

  This parameter is constrained with the following regular expression: ^(home|product|version)$

web_version_label

  Override the version, middle level, menu label on a Publican website. To hide this menu item set this to: UNUSED

wkhtmltopdf_opts

  Extra options to pass to wkhtmltopdf. e.g. wkhtmltopdf_opts: "-O landscape -s A3"

wordsize

  wordsize to filter output on.

xml_lang

  Language in which XML is authored.

  The default value for this parameter is: en-US

## Brand options

These are set in the brands configuration files.

banned_attrs

  A comma-separated list of XML attributes that are not permitted in the source.

banned_tags

  A comma-separated list of XML tags that are not permitted in the source.

base_brand

  The base brand to use for this brand.

  The default value for this parameter is: common

dtd_type

  Override Type for DocType. Must be a complete string.

dtd_uri

  Override URI for DocType. Must be a complete string.

no_embedtoc

  Brand option to disable embedding the navigational toc in web packages

web_cfg

  Full path for the publican site configuration file for non standard RPM websites.

web_dir

  Install path for non standard RPM websites.

web_req

  Name of site package for non standard RPM websites. Required to ensure the site is installed.

## Site options

These are set in the sites configuration file.

db_file

  The name of the SQLite database file for your site, with the filename extension .db

debug

  Output extra messages when running publican.

  The default value for this parameter is: 0

def_lang

  The default language for this website. Tables of contents for languages other than the default language will link to documents in the default language when translations are not available.

  The default value for this parameter is: en-US

dump

  Dump the publican database to an XML file.

dump_file

  The name of the file to dump the publican database to.

  The default value for this parameter is: /var/www/html/DUMP.xml

footer

  HTML to inject in to the footer of every page on the website.

  The default value for this parameter is:

host

  The web host, may be a full URI or a relative path.

  The default value for this parameter is: /docs

manual_toc_update

  Stop publican from automatically rebuilding teh web site everytime a book is installed, updated or removed.

  The default value for this parameter is: 0

search

  The HTML to inject in as the site serach.

  The default value for this parameter is: Google site search

title

  Title used for all site navigation pages.

  The default value for this parameter is: Documentation

tmpl_path

  Full path to the template directory.

  The default value for this parameter is: /usr/share/publican/templates

toc_js

  The source file to use for JavaScript functionality.

  The default value for this parameter is: default.js

toc_path

  The path to the directory in which to create the top-level index.html file.

toc_type

  Template to use for generagting the web style 1 toc file.

  The default value for this parameter is: toc

  This field is deprecated and will be removed from Publican in the future.

web_style

  Publican supports mutliple base styles for websites, this picks one.

  The default value for this parameter is: 1

  This parameter is constrained with the following regular expression: [1-2]

  This field is deprecated and will be removed from Publican in the future.

zip_dump

  Zip up the dump file after dumping it

  The default value for this parameter is: 0