Options
There are several booklet options that affect the result. From the user point of view the options is a map of key -> value pairs. These pairs are held by Properties. There are few sources of options:
- file booklet.properties in markdown catalog (the lowest priority)
- properties that is emmedded into a markdown
- user specified properties (the highest priority)
While processing all options are merged and converted to Scalate attributes.
You may add your own options as well.
List of the booklet options.
Key | Description | Example Values | Notes |
---|---|---|---|
Flag indicating whether the line numbers in code should be visible. | Y/N | changed by user |
|
A name of the default language. | en | changed by user |
|
An exclude regexp that applied to booklet markdowns. | changed by user |
||
An exclude regexp that applied to booklet markdowns. | changed by user |
||
A name of the file with an index content. | Y/N | changed by user |
|
Flag indicating whether the HTML content should be processed as markdown. | Y/N | changed by user |
|
A list of the booklet languages. | en, ja, ru | changed by user |
|
A name of the file with site manifest for offline usage. | booklet.manifest | changed by user |
|
Flag indicating whether the generated content should support offline mode. | Y/N | changed by user |
|
Full path to user container with booklet template. | changed by user |
||
A name of the template directory. | template | changed by user |
|
A name of the PageContent template. | pageContent.scaml | changed by user |
|
Full path to PageContent template. | /full/path/to/pageContent.scaml | ||
A name of the PageDeepContents template. | pageDeepContents.scaml | changed by user |
|
Full path to PageDeepContents template. | /full/path/to/pageDeepContents.scaml | ||
A name of the PageScroll template. | pageScroll.scaml | changed by user |
|
Full path to PageScroll template. | /full/path/to/pageScroll.scaml | ||
A name of the file with template properties. | booklet.properties | changed by user |
|
title | Page title. | changed by user |
|
Title pattern that applied to each page title (not to the content title). | changed by user |
||
Flag indicating whether page title should be generated from the file name. | Y/N | changed by user |
|
Flag with toc sort order. | Y/N | changed by user |
|
Flag indicating whether the library should be verbose. | Y/N |