Configuration
Configuration happens either via Command line options or with the configuration file (described below). All configurations are subject to Configuration inheritance. You can also overwrite any of them on a per-directory and/or per-file basis.
Config file formatÂ
Webber expects file named "webber.conf" file in the root directory.
It could look like this:
template: "default"
date_format: "%d.%m.%Y"
plugins: [
"skeleton",
"hierarchy",
"link",
"read_rst",
"read_html",
"read_copyonly",
"read_markdown",
"template_mako",
"my_plugin",
]
plugin_dirs: [
"my_plugins"
]
Options for the Command line options can also be specified in the config file:
in_dir: "in"
out_dir: "out"
style_dir: "in/style"
verbose: 5
Webber's configurationÂ
in_dirÂ
Directory, where the source files (in markdown, rst or html format) reside.
Default: "in".
See Command line options.
out_dirÂ
Directory where webber creates the output files.
Default: "out".
See Command line options.
style_dirÂ
Directory where webber reads the Mako templates.
Default: "in/style".
See Command line options and "template".
templateÂ
Used by Mako templates to select the template.
Default: "template"
input_encodingÂ
Encoding (e.g. 'utf-8', 'iso-8859-1' etc) used when reading source pages.
Default: "iso-8859-1"
output_encodingÂ
Encoding (e.g. 'utf-8', 'iso-8859-1' etc) used when writing the final HTML pages.
Default: "iso-8859-1"
pluginsÂ
List of Plugins to load.
plugin_dirsÂ
List of directories that should be search for Plugins. Can be empty or completely omitted.
exclude_dirsÂ
List of directories below "in_dir" to skip.
Default: "[]"
exclude_filesÂ
List of files below "in_dir" to skip.
Default: "['webber.conf', 'directory.conf', '*.tmpl']"
date_formatÂ
Used in format_date(). The format is the same as in "man 2 strftime".
verboseÂ
How verbose webber should be.
See Command line options.
keep_goingÂ
If webber should continue after an error.
See Command line options.
Plugin's configurationÂ
Many Plugins can use custom options. Read more about them in their documentation.
User defined configurationÂ
Beside those entries, you can specify any additional entries that will then be available in user-defined Plugins, Functions, Macros or Mako templates. For example, after adding:
category: "Webber"
you can access in Mako templates with:
Category: ${page.category}
Recently changed in this area:
- Changed 2010-07-06 in Webber: Configuration - enhanced, fixed and clarified (english)
- Changed 2010-07-06 in Webber: Configuration inheritance - various clarifications, a better example (english)
- Changed 2009-06-26 in Webber: Command line options (english)
Â
