C.3. 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

Warning

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]

Warning

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