publican.cfg
file in its root directory. Parameters that can be set in the publican.cfg
file are:
docname
--name
option.
version
--version
option.
xml_lang
--lang
option.
edition
--edition
option.
type
<article>
, DocBook <book>
, or DocBook <set>
, set by the --type
option.
brand
--brand
option.
product
--product
option.
arch
books
brew_dist
docs-5E
)
bridgehead_in_toc
bridgehead
s should be included in tables of contents. (Default: 0
— bridgehead
s are not included in tables of contents).
chunk_first
0
— the first section starts a new HTML page).
chunk_section_depth
4
)
classpath
/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
/usr/share/publican
, default for Windows operating systems: %SystemDrive%/%ProgramFiles%/publican
— most usually C:/Program Files/publican
)
common_content
/usr/share/publican/Common_Content
, default for Windows operating systems: %SystemDrive%/%ProgramFiles%/publican/Common_Content
— most usually C:/Program Files/publican/Common_Content
)
condition
confidential
0
— not confidential).
confidential_text
CONFIDENTIAL
).
debug
0
— suppress messages)
def_lang
en-US
— American English)
doc_url
https://fedorahosted.org/publican
)
dt_obsoletes
dt_requires
dtdver
4.5
)
dtd_type
Note
dtd_uri
Note
ec_id
ec_name
ec_provider
extras_dir
extras
)
generate_section_toc_level
0
— no tables of contents in sections)
ignored_translations
img_dir
images
)
info_file
license
mainfile
<article>
, <book>
, or <set>
, and the name of the corresponding .ent
file that contains the document's entities. For example, if you set mainfile: master
, Publican looks for the root XML node in master.xml
and the document entities in master.ent
.
mainfile
is not set, Publican looks for the root XML node in a file that matches the <title>
of the document set in the Article_Info.xml
, Book_Info.xml
, or Set_Info.xml
file, and looks for the document entities in a file with a corresponding name.
max_image_width
<imagedata>
tag for a specific image. (Default: 444
— 444 pixels wide)
Important — 444 pixels is the maximum safe width
max_image_width
parameter if your images contain important information. Images wider than 444 pixels presented at their full size might lead to poorly presented HTML and to PDF output that it is unusable because the images have run off the page and are incomplete.
menu_category
.menu
file) in which a document should appear when installed from a desktop RPM package. Refer to Section 4.8.1.3, “Desktop menu entries for documents”.
os_ver
prod_url
https://fedorahosted.org/publican
)
release
xml_lang
, fetched from the title tag in xml_lang/TYPE_Info.xml
or Project-Id-Version
in lang/TYPE_Info.po
.
repo
rev_file
scm
SVN
)
show_remarks
0
— hide remarks)
sort_order
src_url
tmp_dir
tmp
)
toc.html
file (mandatory).
toc_section_depth
2
)
/usr/share/publican/templates
).
web_brew_dist
docs-5E
)
web_formats
$
publican package
command”.
web_home
Important — web_home
is deprecated
web_home
is replaced by web_type: home
. Support for web_home
will be removed in a future version of Publican.
web_name_label
web_obsoletes
web_product_label
web_type
web_type: home
), product description pages (web_type: product
), and version description pages (web_type: version
). Refer to Chapter 7, Building a website with Publican.
web_version_label
wkhtmltopdf_opts
wkhtmltopdf_opts: "-O landscape -s A3"