<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Users_Guide.ent">
%BOOK_ENTITIES;
]>
<appendix id="appe-Users_Guide-publican.cfg_parameters">
	<title>publican.cfg parameters</title>
	 <para>
		Every book, article, document set, or brand has a <filename>publican.cfg</filename> file in its root directory. Parameters that can be set in the <filename>publican.cfg</filename> file are:
	</para>
	 <variablelist>
		<varlistentry>
			<term><parameter>docname</parameter></term>
			 <listitem>
				<para>
					the document name, set by the <option>--name</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>version</parameter></term>
			 <listitem>
				<para>
					the product version, set by the <option>--version</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>xml_lang</parameter></term>
			 <listitem>
				<para>
					the language of the source XML files, set by the <option>--lang</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>edition</parameter></term>
			 <listitem>
				<para>
					the edition number for this documentation, set by the <option>--edition</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>type</parameter></term>
			 <listitem>
				<para>
					the type of document — a DocBook <sgmltag>&lt;article&gt;</sgmltag>, DocBook <sgmltag>&lt;book&gt;</sgmltag>, or DocBook <sgmltag>&lt;set&gt;</sgmltag>, set by the <option>--type</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>brand</parameter></term>
			 <listitem>
				<para>
					the <firstterm>brand</firstterm> of the document, set by the <option>--brand</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>product</parameter></term>
			 <listitem>
				<para>
					the product to which this documentation applies, set by the <option>--product</option> option.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>arch</parameter></term>
			 <listitem>
				<para>
					the computer <firstterm>architecture</firstterm> for this document.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>books</parameter></term>
			 <listitem>
				<para>
					a space-separated list of books used in a remote set.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>brew_dist</parameter></term>
			 <listitem>
				<para>
					the build target to use for building the desktop RPM package in <application>Brew</application>. (Default: <literal>docs-5E</literal>)
				</para>

			</listitem>

		</varlistentry>
		<varlistentry>
			<term><parameter>bridgehead_in_toc</parameter></term>
			  <listitem>
				<para>
					whether <sgmltag>bridgehead</sgmltag>s should be included in tables of contents. (Default: <literal>0</literal> — <sgmltag>bridgehead</sgmltag>s are not included in tables of contents).
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>chunk_first</parameter></term>
			 <listitem>
				<para>
					whether the first section should appear on the same page as its parent when rendered in HTML. (Default: <literal>0</literal> — the first section starts a new HTML page).
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>chunk_section_depth</parameter></term>
			 <listitem>
				<para>
					the point at which <application>Publican</application> no longer splits sub-subsections onto a new page when rendering HTML. (Default: <literal>4</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>classpath</parameter></term>
			 <listitem>
				<para>
					the path to the jar files for <application>FOP</application>. (Default for Linux operating systems: <filename>/usr</filename><filename>/share</filename><filename>/java</filename><filename>/ant</filename><filename>/ant-trax-1.7.0.jar:</filename><filename>/usr</filename><filename>/share</filename><filename>/java</filename><filename>/xmlgraphics-commons.jar:</filename><filename>/usr</filename><filename>/share</filename><filename>/java</filename><filename>/batik-all.jar:</filename><filename>/usr</filename><filename>/share</filename><filename>/java</filename><filename>/xml-commons-apis.jar:</filename><filename>/usr</filename><filename>/share</filename><filename>/java</filename><filename>/xml-commons-apis-ext.jar</filename>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>common_config</parameter></term>
			 <listitem>
				<para>
					the path to the <application>Publican</application> installation. (Default for Linux operating systems: <filename>/usr/share/publican</filename>, default for Windows operating systems: <filename>%SystemDrive%/%ProgramFiles%/publican</filename> — most usually <filename>C:/Program Files/publican</filename>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>common_content</parameter></term>
			 <listitem>
				<para>
					the path to the <application>Publican</application>'s <firstterm>Common Content</firstterm> files. (Default for Linux operating systems: <filename>/usr/share/publican/Common_Content</filename>, default for Windows operating systems: <filename>%SystemDrive%/%ProgramFiles%/publican/Common_Content</filename> — most usually <filename>C:/Program Files/publican/Common_Content</filename>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>condition</parameter></term>
			 <listitem>
				<para>
					conditions on which to prune XML before transformation.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>confidential</parameter></term>
			 <listitem>
				<para>
					marks a document as confidential. (Default: <literal>0</literal> — not confidential).
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>confidential_text</parameter></term>
			 <listitem>
				<para>
					sets the text with which to mark a document as confidential. (Default: <literal>CONFIDENTIAL</literal>).
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>cvs_branch</parameter></term>
			 <listitem>
				<para>
					the CVS branch into which to import the SRPM.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>cvs_pkg</parameter></term>
			 <listitem>
				<para>
					the CVS package into which to import the SRPM. This parameter takes the literal string <literal>__LANG__</literal> and replaces it with the langauge supplied to the package action at run time.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>cvs_root</parameter></term>
			 <listitem>
				<para>
					the CVS root into which to import the SRPM.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>debug</parameter></term>
			 <listitem>
				<para>
					whether <application>Publican</application> should display debugging messages as it works. (Default: <literal>0</literal> — suppress messages)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>def_lang</parameter></term>
			  <listitem>
				<para>
					the default language for a <application>Publican</application>-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: <literal>en-US</literal> — American English)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>doc_url</parameter></term>
			 <listitem>
				<para>
					URL for the documentation team for this package. (Default: <literal>https://fedorahosted.org/publican</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>dt_obsoletes</parameter></term>
			 <listitem>
				<para>
					a package that a desktop package obsoletes.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>dt_requires</parameter></term>
			 <listitem>
				<para>
				  a package that the desktop package requires, for example, a documentation menu package. Refer to <xref linkend="desktop_menus"/>.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>dtdver</parameter></term>
			 <listitem>
				<para>
					the version of the DocBook XML <firstterm>Document Type Definition</firstterm> (DTD) on which this project is based. (Default: <literal>4.5</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>ec_id</parameter></term>
			 <listitem>
				<para>
					the ID for an <application>Eclipse</application> help plugin (Default: <replaceable>product</replaceable>.<replaceable>docname</replaceable>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>ec_name</parameter></term>
			 <listitem>
				<para>
					the name of an <application>Eclipse</application> help plugin (Default: <replaceable>product</replaceable> <replaceable>docname</replaceable>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>ec_provider</parameter></term>
			 <listitem>
				<para>
					the provider name for an <application>Eclipse</application> help plugin (Default: <replaceable>Publican</replaceable>-<replaceable>Publican version</replaceable>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>generate_section_toc_level</parameter></term>
			 <listitem>
				<para>
					the section depth at which <application>Publican</application> generates a table of contents. (Default: <literal>0</literal> — no tables of contents in sections)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>ignored_translations</parameter></term>
			 <listitem>
				<para>
					translations to ignore.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>license</parameter></term>
			 <listitem>
				<para>
					the license this package uses. (Default: GNU Free Documentation License).
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>mainfile</parameter></term>
			 <listitem>
				<para>
					the name of the XML file in your document that contains the root XML node <sgmltag>&lt;article&gt;</sgmltag>, <sgmltag>&lt;book&gt;</sgmltag>, or <sgmltag>&lt;set&gt;</sgmltag>, and the name of the corresponding <filename>.ent</filename> file that contains the document's entities. For example, if you set <literal>mainfile: master</literal>, <application>Publican</application> looks for the root XML node in <filename>master.xml</filename> and the document entities in <filename>master.ent</filename>.
				</para>
				<para>
					If <parameter>mainfile</parameter> is not set, <application>Publican</application> looks for the root XML node in a file that matches the <sgmltag>&lt;title&gt;</sgmltag> of the document set in the <filename>Article_Info.xml</filename>, <filename>Book_Info.xml</filename>, or <filename>Set_Info.xml</filename> file, and looks for the document entities in a file with a corresponding name.
				</para> 
			</listitem>
		</varlistentry>
		 <varlistentry>
			<term><parameter>max_image_width</parameter></term>
			 <listitem>
				<para>
					the maximum width allowable for images in the document, unless specifically overriden in the <sgmltag>&lt;imagedata&gt;</sgmltag> tag for a specific image. (Default: <literal>444</literal> — 444 pixels wide)
				</para>
				 <xi:include href="Image_width.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

			</listitem>

		</varlistentry>
		<varlistentry>
		<term><parameter>menu_category</parameter></term>
				<listitem>
					<para>
					  the desktop menu category (as defined by a corresponding <filename>.menu</filename> file) in which a document should appear when installed from a desktop RPM package. Refer to <xref linkend="desktop_menus"/>.
					</para>

				</listitem>

			</varlistentry>
		<varlistentry>

			<term><parameter>os_ver</parameter></term>
			 <listitem>
				<para>
					the operating system for which to build packages. (Default: <literal>.el5</literal> — Red Hat Enterprise Linux 5)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>prod_url</parameter></term>
			 <listitem>
				<para>
					URL for the product to which this document applies. (Default: <literal>https://fedorahosted.org/publican</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>release</parameter></term>
			 <listitem>
				<para>
					the release number of this package. Defaults to the value of <literal>xml_lang</literal>, fetched from the title tag in <filename>xml_lang/TYPE_Info.xml</filename> or <literal>Project-Id-Version</literal> in <filename>lang/TYPE_Info.po</filename>.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>repo</parameter></term>
			 <listitem>
				<para>
					the repository from which to fetch remote books that form part of a distributed set.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>scm</parameter></term>
			 <listitem>
				<para>
					the version control system used in the repository in that stores the remote books in a distributed set. (Default: <literal>SVN</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>show_remarks</parameter></term>
			 <listitem>
				<para>
					whether to display remarks in transformed output. (Default: <literal>0</literal> — hide remarks)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>show_unknown</parameter></term>
			 <listitem>
				<para>
					whether <application>Publican</application> reports unknown tags when processing XML. (Default: <literal>1</literal> — report unknown tags)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>src_url</parameter></term>
			 <listitem>
				<para>
					URL at which to find tarballs of source files.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>strict</parameter></term>
			 <listitem>
				<para>
					<emphasis role="strikethrough">use <firstterm>strict mode</firstterm> (Default: <literal>0</literal> — not strict)</emphasis> Strict mode is not currently enforced.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>tmp_dir</parameter></term>
			 <listitem>
				<para>
					the directory for <application>Publican</application> output. (Default: <literal>tmp</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>toc_section_depth</parameter></term>
			 <listitem>
				<para>
					the depth of sections that <application>Publican</application> includes in the main table of contents. (Default: <literal>2</literal>)
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>web_brew_dist</parameter></term>
			 <listitem>
				<para>
					the <application>brew</application> build target to use for the web RPM package. (Defaults to <literal>docs-5E</literal>)
				</para>

			</listitem>

		</varlistentry>
		
		<varlistentry>
			<term><parameter>web_formats</parameter></term>
			  <listitem>
				<para>
					a comma-separated list of formats to include in the web RPM package. Refer to <xref linkend="sect-Users_Guide-Packaging_a_book-The_publican_package_command" />.
				</para>

			</listitem>

		</varlistentry>
		
		<varlistentry>
			<term><parameter>web_home</parameter></term>
			  <listitem>
				<para>
					specifies that the document is the home page of a documentation website, not a standard document. 
				</para>
				<important>
						<title>Important — <literal>web_home</literal> is deprecated</title>
						<para>
							In <application>Publican</application>&nbsp;2.2, <literal>web_home</literal> is replaced by <literal>web_type: home</literal>. Support for <literal>web_home</literal> will be removed in a future version of <application>Publican</application>.
						</para>
				</important>

			</listitem>

		</varlistentry>
		  <varlistentry>
			<term><parameter>web_name_label</parameter></term>
			  <listitem>
				<para>
					overrides the book name as it appears on the menu of a <application>Publican</application>-managed website.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>web_obsoletes</parameter></term>
			 <listitem>
				<para>
					packages that the web RPM package obsoletes.
				</para>

			</listitem>

		</varlistentry>
		 <varlistentry>
			<term><parameter>web_product_label</parameter></term>
			  <listitem>
				<para>
					overrides the product name as it appears on the menu of a <application>Publican</application>-managed website.
				</para>

			</listitem>

		</varlistentry>
		
		<varlistentry>
			<term><parameter>web_type</parameter></term>
			  <listitem>
				<para>
					specifies that the document is descriptive content for a <application>Publican</application>-managed website rather than product documentation. This content includes the home page of the website (<literal>web_type:&nbsp;home</literal>), product description pages  (<literal>web_type:&nbsp;product</literal>), and version description pages  (<literal>web_type:&nbsp;version</literal>). Refer to <xref linkend="sect-Users_Guide-Website" />.
				</para>

			</listitem>

		</varlistentry>
		
		
		  <varlistentry>
			<term><parameter>web_version_label</parameter></term>
			  <listitem>
				<para>
					overrides the version number as it appears on the menu of a <application>Publican</application>-managed website. 
				</para>

			</listitem>

		</varlistentry>

	</variablelist>
</appendix>