Product SiteDocumentation Site

Makefile Parameters

Every Book, Article or Book Set has a Makefile in its root directory. Parameters that can be set in a Book's Makefile are:
BOOKS
This defines the Books a Set contains. It is only useful for Book Sets.
Default value: Undefined.
BRAND
This parameter tells Publican which Brand to apply to a book's html and pdf output. Its default value is: common.
BREW_DIST
BREW_DIST sets the Brew tag for desktop RPMs. Default: dist-5E-qu-candidate.
CHUNK_FIRST
Controls chunking of first sections. 0 or 1. Default: 0.
CHUNK_SECTION_DEPTH
Override the max section depth to chunk to. Default: 4.
COMMON_CONFIG
Sets the path to Publican's configuration and common files, including Brand files. Default: /usr/share/publican.
CONFIDENTIAL
The default value — 0 — is not confidential. To set a book to confidential, change this to 1.
Setting this parameter to 1 places a large Confidential footer on each page.
DEFAULT_LANGS
Languages that should be included in xi:include even if the translation is not complete. Used in update_includes. Default: Undefined.
DESKTOP
Use the desktop CSS (1) or not (0). Default: 0
DOC_TYPE
Sets the sort of publication being produced: Book, Article or Set. Default value is Book. This paremeter has no relationship to the DOCTYPE declaration in a publication's XML files.
DOC_URL
Sets the URL used for the link in the right-hand header of every html page. Also sets the URL entry in a publication's RPM spec file. Default: https://fedorahosted.org/publican
DT_OBSOLETES
A comma seperated list of desk top packages the package should obsolete. Default: undefined.
EMBEDTOC
Embed the web navigation TOC in the html. 0 or 1. Default: 0.
GENERATE_SECTION_TOC_LEVEL
Include a Table of Contents at the given section level. Valid values: 0 – 5. Default: 0.
IGNORED_TRANSLATIONS
When building, replace any languages in this list with the source langauge text. This allows you to work on translations without shipping incomplete translations. Default: Undefined.
OTHER_LANGS
Space seperated list of language locales. Default: Undefined.
PRODUCT
The product this book is associated with. Default: Documentation.
PROD_URL
Sets the URL used for the link in the left-hand header of every html page. Default: https://fedorahosted.org/publican
SHOW_REMARKS
Display contents of remark tags in output? Two possible values: 0 (off) or 1 (on). Off by default.
TOC_SECTION_DEPTH
How many section levels should be included in the main Table of Contents. Default: 2.
WEB_BREW_DIST
WEB_BREW_DIST sets the Brew tag for web RPMs. Default: docs-5E.
WEB_OBSOLETES
A comma seperated list of web site packages the web package should obsolete. Default: Undefined.
XML_LANG
Language of a publication's source xml. Default: en-US (US English).
USE_SAXON
Use saxon for xslt. Two possible values: 0 (off) or 1 (on). On by default.
USE_XALAN
Test xalan for xslt. 0 or 1. Default: 0.