Configuration Options

This reference describes all available configurations that can be set via the configuration file webgen.config.

The configuration options are listed in alphabetical order. For each configuration option a short description and example code are displayed. The example code either shows how to set the option in the configuration file (for most configuration options) and/or how to use it in a webgen tag (for tag configuration options).

content_processor.erb.trim_mode

The ERB trim mode. The string can contain any combination of ‘%’, ‘<’ and ‘<>’ – see the API documentation of ERB for more information.

Syntax

STRING where STRING is any combination of any combination of ‘%’, ‘<’ and ‘<>’

Default value

null

Example for setting the option in the configuration file

content_processor.erb.trim_mode: '%<'

content_processor.erubis.options

Additional Erubis options. Have a look at the Erubis documentation for available options.

Syntax

{KEY: VALUE, ...} where KEY and VALUE are key-value pairs of options

Default value

{}

Example for setting the option in the configuration file

content_processor.erubis.options: {trim: true}

content_processor.erubis.use_pi

Specifies whether Erubis should look for XML processing instructions or the standard ERB tags when processing content.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

content_processor.erubis.use_pi: true

content_processor.kramdown.handle_links

Specifies whether all links in a kramdown document should be processed by webgen. If this option is set, all links are automatically resolved using webgen’s built-in facilities. This saves some typing and makes the document more robust since all links are automatically checked and warnings displayed if the link target is not found.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

content_processor.kramdown.handle_links: false

content_processor.kramdown.ignore_unknown_fragments

Specifies whether unknown, non-resolvable fragment parts should be ignored. This is useful when there are links to fragments that have no internal representation.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

content_processor.kramdown.ignore_unknown_fragments: true

content_processor.kramdown.options

Additional options for the kramdown processor. Have a look at the kramdown documentation for available options.

Syntax

{KEY: VALUE, ...} where KEY and VALUE are key-value pairs of kramdown options

Default value

{"auto_ids": true}

Example for setting the option in the configuration file

content_processor.kramdown.options: {auto_ids: false, coderay_line_numbers: null}

content_processor.rainpress.options

Options for the rainpress CSS compressor. All rainpress options are enabled by default, so this can be used to disable some compression methods.

Syntax

{KEY: false, ...} where KEY are valid rainpress option keys

Default value

{}

Example for setting the option in the configuration file

content_processor.rainpress.options: {comments: false}

content_processor.redcloth.hard_breaks

Specifies whether hard breaks (i.e. single newlines) in paragraphs are converted to HTML break tags.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

content_processor.redcloth.hard_breaks: true

content_processor.sass.options

Additional Sass options (also used by the scss content processors). Have a look at the Sass documentation for available options.

Syntax

{KEY: VALUE, ...} where KEY and VALUE are key-value pairs of Sass options

Default value

{}

Example for setting the option in the configuration file

content_processor.sass.options: {line_numbers: true}

content_processor.tidy.options

Additional options passed to the tidy command (-q is always used).

Syntax

STRING where STRING is the string with the command line options

Default value

"-raw"

Example for setting the option in the configuration file

content_processor.tidy.options: "-utf8"

content_processor.tikz.engine

Specifies which LaTeX engine should be used. Default is pdflatex, but you may want to use xelatex or lualatex if needed.

Syntax

pdflatex or lualatex or xelatex

Default value

"pdflatex"

Example for setting the option in the configuration file

content_processor.tikz.engine: lualatex

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, content_processor.tikz.engine: xelatex}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

content_processor.tikz.libraries

Array of additional TikZ library names.

Syntax

[NAME, ...] where NAME is the name of a TikZ library

Default value

[]

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, content_processor.tikz.libraries: [mindmap, arrows]}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

content_processor.tikz.opts

A string with global options for the tikzpicture environment

Syntax

OPTS where OPTS is the string with the global options

Default value

""

Example for setting the option in the configuration file

content_processor.tikz.opts: 'scale=3, line cap=round'

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, content_processor.tikz.opts: 'scale=3, line cap=round'}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

content_processor.tikz.resolution

The render and output resolutions that should be used for converting the TikZ image in PDF format to the chosen image format. The first number specifies the render resolution and the second the output resolution. If the render resolution is higher than the output resolution, the final image quality is better by scaling the image down to the output resolution.

Syntax

RENDER OUTPUT where RENDER is the integer specifying the render resolution and OUTPUT is the integer specifying the output resolution.

Default value

"72 72"

Example for setting the option in the configuration file

content_processor.tikz.resolution: 300 72

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, content_processor.tikz.resolution: 300 72}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

content_processor.tikz.template

The template node containing the LaTeX framework that should be used for creating the TikZ image.

Syntax

PATH where PATH is the (a)(l)cn of a template node

Default value

"/templates/tikz.template"

Example for setting the option in the configuration file

content_processor.tikz.template: /tmpl/my_tikz.template

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, content_processor.tikz.template: /my_tikz.template}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

content_processor.tikz.transparent

Specifies whether the generated image should be transparent. This configuration option is only used when the destination path of the TikZ image has the extension “.png”!

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

content_processor.tikz.transparent: true

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, content_processor.tikz.transparent: true}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

content_processor.xmllint.options

Options passed to the xmllint command.

Syntax

STRING where STRING is the string with the command line options.

Default value

"--catalogs --noout --valid"

Example for setting the option in the configuration file

content_processor.xmllint.options: "--catalogs --noout"

destination

The destination extension that should be used for writing out the generated paths.

Syntax

[NAME, ARG1, ARG2, ...] where NAME is the short name of the destination extension (for example “file_system”) and ARG1, ARG2 and so on are the parameters for the destination extension. The supported parameters can be found in the documentation for each destination extension.

Default value

["file_system", "out"]

Example for setting the option in the configuration file

destination: [file_system, custom_out_dir]

destination.show_changes

Specifies whether changes to the content of destination paths should be shown in a diff-like manner. This option combined with the website.dry_run configuration option allows one to preview the changes that the invocation of webgen would do.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

destination.show_changes: true

misc.dummy_index.directory_indexes

A list of directory index names that should be recognized. These index names are used to determine whether a directory already has a valid directory index. The first entry is also used as the name for the dummy directory index that is created if needed.

Syntax

[INDEX NAME, ...] where INDEX NAME is a directory index name

Default value

["index.html"]

Example for setting the option in the configuration file

misc.dummy_index.directory_indexes: [index.html, index.htm, default.htm]

misc.dummy_index.enabled

Specifies whether dummy index paths should automatically be created.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

misc.dummy_index.enabled: false

node_finder.option_sets

Predefined node finder option sets. This option allows one to define common node finder option sets beforehand and then use them for any node finder operation.

Syntax

{NAME: OPTION SET, ...} where NAME is the name of the to-be-defined option set and

OPTION
SET

is a hash with node finder options

Default value

{}

Example for setting the option in the configuration file

node_finder.option_sets:
  menu: {in_menu: true, sort: sort_info, levels: [1,3]}
  sub_menu: {descendants: true, levels: [2,10]}

path_handler.default_template

The name of the default template of a directory. This template is used as fallback when no specific template is specified.

Syntax

PATH where PATH is the (a)(l)cn of the default template

Default value

"default.template"

Example for setting the option in the configuration file

path_handler.default_template: other.template

path_handler.lang_code_in_dest_path

Specifies whether destination paths should have the language part in their name. This option can either be set to true (all paths get the language part), false (no path gets a language part) or except_default (all paths except those in the default language – see the website.lang configuration option – get the language part).

Syntax

true, false or except_default

Default value

"except_default"

Example for setting the option in the configuration file

path_handler.lang_code_in_dest_path: true

path_handler.patterns.case_sensitive

Specifies whether path names should be considered case-sensitive (value true) or case-insensitive (value false).

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

path_handler.patterns.case_sensitive: true

path_handler.patterns.match_leading_dot

Specifies whether paths with a leading dot, i.e. hidden files, should be used.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

path_handler.patterns.match_leading_dot: true

path_handler.version_in_dest_path

Specifies whether destination paths should use the version name in their name. This option can either be set to true (all paths get the version part), false (no path gets a version part) or except_default (all paths except those with the default version name get the version part).

Syntax

true, false or except_default

Default value

"except_default"

Example for setting the option in the configuration file

path_handler.version_in_dest_path: true

sources

One or more source extensions from which paths are read. This can be used, for example, to additionally add source directories that may or may not be located in the website directory.

Syntax

[[MOUNT POINT, NAME, ARG1, ARG2, ...], ...] where MOUNT POINT is the absolute path under which the source should be mounted, NAME is the short name of the source extension (for example, “file_system”) and ARG1, ARG2 and so on are the parameters for the source extension. The supported parameters can be found in the documentation for each source extension.

Default value

[["/", "file_system", "src"]]

Example for setting the option in the configuration file

sources: [[/, file_system, src], [/, file_system, /mnt/pictures, '**/*.jpg']]

sources.ignore_paths

The path patterns that should be ignored. All paths that match at least one of the patterns are ignored.

Syntax

[PATTERN, ...] where PATTERN is a valid path pattern

Default value

["**/*~", "**/.svn/**", "**/.gitignore"]

Example for setting the option in the configuration file

sources.ignore_paths: [**/*~, **/CVS/**]

tag.breadcrumb_trail.end_level

The level at which the breadcrumb trail ends. Have a look at the documentation for tag.breadcrumb_trail.start_level for more information on the useable level numbers.

Syntax

INTEGER where INTEGER is an integer

Default value

-1

Example for setting the option in the configuration file

tag.breadcrumb_trail.end_level: 2

Example for setting the option directly in a tag

{breadcrumb_trail: {end_level: 2}}

tag.breadcrumb_trail.omit_dir_index

Specifies whether the last path component should be omitted if it is an index path.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

tag.breadcrumb_trail.omit_dir_index: true

Example for setting the option directly in a tag

{breadcrumb_trail: {omit_dir_index: true}}

tag.breadcrumb_trail.separator

The string that should be used as separator between indivdual parts of the breadcrumb trail.

Syntax

SEPARATOR where SEPARATOR is a string (special HTML characters like < need to be properly escaped)

Default value

" / "

Example for setting the option in the configuration file

tag.breadcrumb_trail.separator: '---'

Example for setting the option directly in a tag

{breadcrumb_trail: {separator: ' --- '}}

tag.breadcrumb_trail.start_level

The level at which the breadcrumb trail starts. The default of 0 means to start a the root directory. Setting this option to 1 starts the breadcrumb trail at the first level. If you specify negative numbers, then everything is calculated from the end of the trail. Following is a diagram showing the level numbers for a sample path:

0   1        2           3
/  dir1  /  dir2  /  myfile.html
-4  -3       -2          -1

Be aware that the you need to take the tag.breadcrumbtrail.omit_index_path configuration option into account when specifying the level number.

Syntax

INTEGER where INTEGER is an integer

Default value

Example for setting the option in the configuration file

tag.breadcrumb_trail.start_level: 2

Example for setting the option directly in a tag

{breadcrumb_trail: {start_level: 2}}

tag.breadcrumb_trail.template

The template node used for rendering the tag. It has to contain the block ‘tag.breadcrumb_trail’ because this block is used for rendering.

Syntax

PATH where PATH is the (a)(l)cn of the template node

Default value

"/templates/tag.template"

Example for setting the option in the configuration file

tag.breadcrumb_trail.template: /other.template

Example for setting the option directly in a tag

{breadcrumb_trail: {template: /other.template}}

tag.coderay.bold_every

The interval at which the line numbers should appear bold.

Syntax

INTEGER where INTEGER is an integer

Default value

Example for setting the option in the configuration file

tag.coderay.bold_every: 2

Example for setting the option directly in a tag

{coderay:: {lang: ruby, bold_every: 2}}puts 5 + 5{coderay}

tag.coderay.css

Specifies how the highlighted code should be styled. If set to style, the CSS style attributes are set directly on the various HTML elements. If set to class, only classes are set on the HTML elements and the default external stylesheet is used - the content processor html_head is needed for this to work. If set to other, only classes are set like with the class value but no default external stylesheet is used.

Syntax

STYLE where STYLE is either style, css or other

Default value

"style"

Example for setting the option in the configuration file

tag.coderay.css: style

Example for setting the option directly in a tag

{coderay:: {lang: ruby, css: class}}puts 5 + 5{coderay}

tag.coderay.lang

The language used for highlighting.

Syntax

LANG where LANG is one of the languages supported by coderay

Default value

"ruby"

Example for setting the option in the configuration file

tag.coderay.lang: ruby

Example for setting the option directly in a tag

{coderay:: ruby}puts 5 + 5{coderay}

tag.coderay.line_number_start

The line number that should be used for the first line.

Syntax

INTEGER where INTEGER is an integer

Default value

Example for setting the option in the configuration file

tag.coderay.line_number_start: 4

Example for setting the option directly in a tag

{coderay:: {lang: ruby, line_number_start: 4}}puts 5 + 5{coderay}

tag.coderay.line_numbers

Specifies whether line numbers should be shown.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.coderay.line_numbers: false

Example for setting the option directly in a tag

{coderay:: {lang: ruby, line_numbers: false}}puts 5 + 5{coderay}

tag.coderay.process_body

Specifies whether the body of the tag should be processed by the content processor tags first.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.coderay.process_body: false

Example for setting the option directly in a tag

{coderay:: {lang: ruby, process_body: false}}puts 5 + 5{coderay}

tag.coderay.tab_width

The number of spaces that should be used to replace tabulator characters.

Syntax

INTEGER where INTEGER is an integer

Default value

Example for setting the option in the configuration file

tag.coderay.tab_width: 4

Example for setting the option directly in a tag

{coderay:: {lang: ruby, tab_width: 4}}puts 5 + 5{coderay}

tag.coderay.wrap

The HTML element the highlighted code should be wrapped in.

Syntax

WRAP where WRAP is either :div or :span

Default value

"div"

Example for setting the option in the configuration file

tag.coderay.wrap: span

Example for setting the option directly in a tag

{coderay:: {lang: ruby, wrap: span}}puts 5 + 5{coderay}

tag.date.format

The format that should be used for formatting the current date. The format string needs to be in a format supported by Ruby’s Time#strftime method.

Syntax

FORMAT where FORMAT is the date format string

Default value

"%Y-%m-%d %H:%M:%S"

Example for setting the option in the configuration file

tag.date.format: '%Y-%m-%d'

Example for setting the option directly in a tag

{date: {format: '%Y-%m-%d'}}

tag.date.mi

The name of the meta information key (a date/time) which should be formatted.

Syntax

KEY where KEY is the name of a meta information key

Default value

null

Example for setting the option directly in a tag

{date: {mi: modified_at, format: '%Y-%m-%d'}}

tag.execute_command.command

The command that should be executed.

Syntax

COMMAND where COMMAND is a string containing the command and its arguments

Default value

null

Example for setting the option directly in a tag

{exeucte_cmd: echo hallo}

tag.execute_command.escape_html

Specifies whether special HTML characters in the output of the executed command should be escaped.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.execute_command.escape_html: false

Example for setting the option directly in a tag

{execute_cmd: {command: 'echo hallo', escape_html: false}}

tag.execute_command.process_output

Specifies whether the output of the executed command should be further processed by the content processor tags.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.execute_command.process_output: false

Example for setting the option directly in a tag

{execute_cmd: {command: 'echo hallo', process_output: false}}

tag.include_file.escape_html

Specifies whether special HTML characters in the content of the file should be escaped.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.include_file.escape_html: false

Example for setting the option directly in a tag

{include_file: {filename: my_file.txt, escape_html: false}}

tag.include_file.filename

The name of the file that should be included. The filename needs to be relative to the website directory or an absolute path.

Syntax

FILENAME where FILENAME is the name of a file

Default value

null

Example for setting the option directly in a tag

{include_file: my_file.txt}

tag.include_file.process_output

Specifies whether the content of the file should be further processed by the content processor tags.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.include_file.process_output: false

Example for setting the option directly in a tag

{include_file: {filename: my_file.txt, process_output: false}}

tag.langbar.mapping

A hash with a mapping from language codes to display strings. If there is no mapping for a language code, the language code itself is displayed.

Syntax

MAPPING where MAPPING is a hash with the mappings

Default value

{}

Example for setting the option in the configuration file

tag.langbar.mapping: {de: Deutsch, en: English}

Example for setting the option directly in a tag

{menu: {mapping: {de: Deutsch, en: English}}}

tag.langbar.separator

The string that should be used as separator between the individual language parts.

Syntax

SEPARATOR where SEPARATOR is a string (special HTML characters like < need to be properly escaped)

Default value

" | "

Example for setting the option in the configuration file

tag.langbar.separator: ' --- '

Example for setting the option directly in a tag

{langbar: {separator: ' --- '}}

tag.langbar.show_own_lang

Specifies whether the link to the language of the current page should be displayed.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.langbar.show_own_lang: false

Example for setting the option directly in a tag

{langbar: {show_own_lang: false}}

tag.langbar.show_single_lang

Specifies whether the langbar should be displayed even if there are no translations of the page (i.e. when there is only one page).

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.langbar.show_single_lang: false

Example for setting the option directly in a tag

{langbar: {show_single_lang: false}}

tag.langbar.template

The template node used for rendering the tag. It has to contain the block ‘tag.langbar’ because this block is used for rendering.

Syntax

PATH where PATH is the (a)(l)cn of the template node

Default value

"/templates/tag.template"

Example for setting the option in the configuration file

tag.langbar.template: /other.template

Example for setting the option directly in a tag

{langbar: {template: /other.template}}

tag.link.attr

Additional HTML attributes that should be set on the generated link.

Syntax

{NAME: VALUE, ...} where NAME is a valid HTML attribute name and VALUE its value

Default value

{}

Example for setting the option in the configuration file

tag.link.attr: {title: DocuPage}

Example for setting the option directly in a tag

{link: {path: docu.html, attr: {title: DocuPage}}}

tag.link.path

The (a)(l)cn or destination path to which a link should be created.

Syntax

PATH where PATH is an (a)(l)cn or a destination path

Default value

null

Example for setting the option directly in a tag

{link: docu.html}

tag.menu.css_class

The content of the class attribute of the top level list element.

Syntax

STRING where STRING is a space-separated list of CSS class names

Default value

null

Example for setting the option directly in a tag

{menu: {options: {in_menu: true}, css_class: sidebar menu}}

tag.menu.item_level_class

The CSS class that is used on list items to indicate the nesting level.

Syntax

STRING where STRING is a CSS class name

Default value

"webgen-menu-level"

Example for setting the option directly in a tag

{menu: {options: {in_menu: true}, item_level_class: mlevel}}

tag.menu.item_selected_class

The CSS class that is used on list items to indicate the current page.

Syntax

STRING where STRING is a CSS class name

Default value

"webgen-menu-item-selected"

Example for setting the option directly in a tag

{menu: {options: {in_menu: true}, item_selected_class: active}}

tag.menu.item_submenu_class

The CSS class that is used on list items to indicate an item with a sub-menu.

Syntax

STRING where STRING is a CSS class name

Default value

"webgen-menu-submenu"

Example for setting the option directly in a tag

{menu: {options: {in_menu: true}, item_submenu_class: submenu}}

tag.menu.item_submenu_inhierarchy_class

The CSS class that is used on list items to indicate an item that is in the hierarchy of the current page.

Syntax

STRING where STRING is a CSS class name

Default value

"webgen-menu-submenu-inhierarchy"

Example for setting the option directly in a tag

{menu: {options: {in_menu: true}, item_submenu_inhierarchy_class: submenu-hier}}

tag.menu.options

Node finder options that specify which nodes the menu should use.

Syntax

OPTIONS where OPTIONS is a hash with node finder options

Default value

{}

Example for setting the option directly in a tag

{menu: {options: {in_menu: true, sort: sort_info, levels: [1,3]}}}

tag.menu.style

The menu rendering style that should be used. The value can either be ‘nested’ for a nested menu or ‘flat’ for a flat menu.

For example, this would be a menu with style ‘nested’

ul           1
  li         2
    ul       3
      li     4
      li     5
  li         6

and this with style ‘flat’

ul           1
  li         2
  li         6
ul           3
  li         4
  li         5

Syntax

STYLE where STYLE is either nested or flat

Default value

"nested"

Example for setting the option in the configuration file

tag.menu.style: flat

Example for setting the option directly in a tag

{menu: {options: {mi: {menu: true}}, style: nested}}

tag.menu.template

The template node used for rendering the tag. It has to contain the block ‘tag.menu’ because this block is used for rendering.

Syntax

PATH where PATH is the (a)(l)cn of the template node

Default value

"/templates/tag.template"

Example for setting the option in the configuration file

tag.menu.template: /other.template

Example for setting the option directly in a tag

{menu: {options: {mi: {menu: true}}, template: /other.template}}

tag.menu.tracking_style

Specifies which kind of information should be tracked by the ‘nodes’ item tracker

Syntax

STYLE where STYLE is ‘meta_info’ (if only changed meta information should be tracked) or ‘content’ (if the content should be tracked)

Default value

"meta_info"

Example for setting the option directly in a tag

{menu: {options: {in_menu: true, sort: sort_info}, tracking_style: content}}

tag.meta_info.escape_html

Specifies whether special HTML characters in the meta information value should be escaped.

Syntax

true or false

Default value

true

Example for setting the option in the configuration file

tag.meta_info.escape_html: true

Example for setting the option directly in a tag

{title: {escape_html: false}}
{meta_info: {mi: title, escape_html: false}}

tag.meta_info.mi

The name of the meta information key the value of which should be output.

Syntax

KEY where KEY is the name of a meta information key

Default value

null

Example for setting the option directly in a tag

{title: }
{meta_info: {mi: title}

tag.prefix

The prefix used for tag names to avoid name clashes when another content processor uses similar markup.

Syntax

PREFIX where PREFIX is the prefix name

Default value

""

Example for setting the option in the configuration file

tag.prefix: webgen

tag.relocatable.ignore_unknown_fragment

Specifies whether an unknown, non-resolvable fragment part should be ignored.

Syntax

true or false

Default value

false

Example for setting the option in the configuration file

tag.relocatable.ignore_unknown_fragment: true

tag.relocatable.path

The path that should be made relocatable.

Syntax

PATH where PATH is an (a)(l)cn

Default value

null

Example for setting the option directly in a tag

{relocatable: default.css}

tag.tikz.img_attr

Additional HTML attributes that should be set on the generated img tag.

Syntax

{KEY:VALUE, ...} where KEY is a valid HTML img tag attribute name and VALUE its value.

Default value

{}

Example for setting the option in the configuration file

tag.tikz.img_attr: {alt: Some TikZ picture}

Example for setting the option directly in a tag

{tikz:: {path: tikz.png, img_attr: {alt: Some TikZ picture}}}
\tikz \draw (0,0) -- (0,2) -- (2,2);
{tikz}

tag.tikz.path

The source path that should be used for creating the TikZ image. The destination path is derived from this path the usual way. Don’t use a path that does already exist!

Syntax

PATH where PATH is a relative or absolute source path

Default value

null

Example for setting the option directly in a tag

{tikz:: images/tikz.png}\tikz \draw (0,0) -- (0,2);{tikz}

tag.tipue_search.entries

Node finder option set defining the search index. The nodes of the result set may only contain valid HTML content.

Syntax

OPTIONS where OPTIONS is a hash with node finder options

Default value

null

Example for setting the option directly in a tag

{tipue_search: {path: data.js, options: {mode: static}, entries: {alcn: /**/*.html}}}

tag.tipue_search.options

Options passed to the Tipue Search engine (and partially to path_handler.tipue_search). The keys ‘mode’ and ‘liveDescription’ are mapped to the meta information keys ‘mode’ and ‘content_css’ for path_handler.tipue_search.

Syntax

{KEY: VALUE, ...} where KEY and VALUE are key-value pairs of Tipue Search options

Default value

{"mode": "static"}

Example for setting the option in the configuration file

tag.tipue_search.options: {}

Example for setting the option directly in a tag

{tipue_search: {path: data.js, options: {mode: static}, entries: {alcn: /**/*.html}}}

tag.tipue_search.path

The source path that should be used for creating the Tipue Search data file. The destination path is derived from this path the usual way. Don’t use a path that does already exist!

Syntax

PATH where PATH is a relative or absolute source path

Default value

""

Example for setting the option directly in a tag

{tipue_search: {path: data.js, options: {mode: static}, entries: {alcn: /**/*.html}}}

tag.tipue_search.template

The template node used for rendering the tag. It has to contain the block ‘tag.tipue_search’ because this block is used for rendering.

Syntax

PATH where PATH is the (a)(l)cn of the template node

Default value

"/templates/tipue_search.template"

Example for setting the option in the configuration file

tag.tipue_search.template: /other.template

Example for setting the option directly in a tag

{tipue_search: {path: data.js, options: {mode: static},
                entries: {alcn: /**/*.html}, template: /my.template}}

website.base_url

The base URL of the website. It is used to create absolute URLs when relative URLs won’t work.

Syntax

URL where URL is the base URL of the website

Default value

""

Example for setting the option in the configuration file

website.base_url: http://webgen.gettalong.org

website.cache

The type and location of the cache. Two types are currently supported: file and string. The file cache type stores the cache in a file relative to the website’s temporary directory. The string cache type stores the cache directly in the second part of the configuration option (this is only useful when webgen is used as a library).

Syntax

[TYPE, LOCATION] where TYPE is one of file or string

Default value

["file", "webgen.cache"]

Example for setting the option in the configuration file

website.cache: [file, my.cache]

website.dry_run

Specifies whether anything should be written to the destination.

Syntax

true or false.

Default value

false

Example for setting the option in the configuration file

website.dry_run: false

website.lang

The default language of the website. This language is assigned, for example, to page paths for which no language has explicitly been specified.

Syntax

LANGUAGE where LANGUAGE is a ISO-639-1/2 two or three letter language code (e.g. ‘de’, ‘en’, ‘fr’, …)

Default value

"en"

Example for setting the option in the configuration file

website.lang: de

website.link_to_current_page

Specifies whether generated links to the current page should be used. If false, then a <span> element is used instead of an <a> element.

Syntax

true or false.

Default value

true

Example for setting the option in the configuration file

website.link_to_current_page: false

website.tmpdir

The directory used for temporary files. It is taken relative to website directory and used for cache and temporary files created when webgen is run. Note that this directory cannot be shared between webgen websites!

Syntax

DIRECTORY where DIRECTORY is a directory (relative to the website directory or absolute)

Default value

"tmp"

Example for setting the option in the configuration file

website.tmpdir: /tmp/webgen-tmp-dir