webgen 0.5.7 → 0.5.8

data/doc/reference_configuration.page

@@ -2,6 +2,36 @@
 title: Configuration Option Reference
 in_menu: false
 ---
+<%
+def convert_proc(data, indent)
+  res = if data.kind_of?(Array)
+    data.inspect
+  elsif data.kind_of?(String)
+    (data.empty? ? '""' : data)
+  elsif data.kind_of?(Hash)
+    res = data.collect do |k,v|
+      if v.kind_of?(Hash)
+        k.to_s + ":\n" + convert_proc(v, 2)
+      else
+        k.to_s + ": " + convert_proc(v, 0)
+      end
+    end.join("\n")
+    (res.empty? ? "{}" : res)
+  elsif data.kind_of?(NilClass)
+    "~"
+  else
+    data.inspect
+  end
+  res.split("\n").collect {|l| ' '*indent + l}.join("\n")
+end
+
+require 'tmpdir'
+ws = Webgen::Website.new(File.join(Dir.tmpdir, 'webgen' + Process.pid.to_s))
+ws.init
+show_default = lambda do |option|
+  "* Default value:\n\n#{convert_proc(ws.config[option], 10)}\n"
+end
+%>
 
 # Configuration Option Reference
 
@@ -23,6 +53,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `LANGUAGE` where `LANGUAGE` is a ISO-639-1/2 two or three letter language code
 
+    <%= show_default['website.lang'] %>
+
     * Example for setting the option in the configuration file:
 
           website.lang: de
@@ -35,6 +67,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is `true` or `false`
 
+    <%= show_default['website.link_to_current_page'] %>
+
     * Example for setting the option in the configuration file:
 
           website.link_to_current_page: false
@@ -49,6 +83,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `[TYPE, LOCATION]` where `TYPE` is one of `:file` or `:string`
 
+    <%= show_default['website.cache'] %>
+
     * Example for setting the option in the configuration file:
 
           website.cache: [:file, my.cache]
@@ -63,6 +99,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['common.sitemap.honor_in_menu'] %>
+
     * Example for setting the option in the configuration file:
 
           common.sitemap.honor_in_menu: true
@@ -79,6 +117,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['common.sitemap.any_lang'] %>
+
     * Example for setting the option in the configuration file:
 
           common.sitemap.any_lang: true
@@ -95,6 +135,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `[KIND, ...]` where `KIND` is the kind of node that should be used.
 
+    <%= show_default['common.sitemap.used_kinds'] %>
+
     * Example for setting the option in the configuration file:
 
           common.sitemap.used_kinds: [asset]
@@ -117,10 +159,15 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
       `Webgen::Source::FileSystem`) and `ARG1`, `ARG2` and so on are the parameters for the source
       class. The supported parameters can be found in the documentation for each source class.
 
+    <%= show_default['sources'] %>
+
     * Example for setting the option in the configuration file:
 
           sources: [[/, Webgen::Source::FileSystem, src], [/, Webgen::Source::FileSystem, /mnt/pictures, **/*.jpg]
 
+      Also have a look at the [file system source documentation]({relocatable:
+      source/filesystem.html}) for more examples!
+
 
 *   ### output
 
@@ -130,6 +177,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
       `Webgen::Output::FileSystem`) and `ARG1`, `ARG2` and so on are the parameters for the output
       class. The supported parameters can be found in the documentation for each output class.
 
+    <%= show_default['output'] %>
+
     * Example for setting the option in the configuration file:
 
           output: [Webgen::Output::FileSystem, custom_out]
@@ -145,6 +194,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
     * Syntax: `\{NAME: [PATTERN, PATTERN, ...], ...}` where `NAME` is the
       name the name of a source handler and `PATTERN` are one or more path patterns.
 
+    <%= show_default['sourcehandler.patterns'] %>
+
     * Example for setting the option in `ext/init.rb`:
 
           config = Webgen::WebsiteAccess.website.config
@@ -166,6 +217,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
       invocation (source handlers with a lower `ORDER` setting are executed earlier than ones with a
       higher `ORDER` setting) and `NAME` is the name of a source handler.
 
+    <%= show_default['sourcehandler.invoke'] %>
+
     * Example for setting the option in `ext/init.rb`:
 
           config = Webgen::WebsiteAccess.website.config
@@ -179,6 +232,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['sourcehandler.casefold'] %>
+
     * Example for setting the option in the configuration file:
 
           sourcehandler.casefold: true
@@ -190,6 +245,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['sourcehandler.use_hidden_files'] %>
+
     * Example for setting the option in the configuration file:
 
           sourcehandler.use_hidden_files: true
@@ -202,6 +259,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `[PATTERN, ...]` where `PATTERN` is a valid path pattern.
 
+    <%= show_default['sourcehandler.ignore'] %>
+
     * Example for setting the option in the configuration file:
 
           sourcehandler.ignore: [**/*~, **/CVS/**]
@@ -214,6 +273,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['sourcehandler.default_lang_in_output_path'] %>
+
     * Example for setting the option in the configuration file:
 
           sourcehandler.default_lang_in_output_path: true
@@ -228,6 +289,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
     * Syntax: `\{NAME: {MI_KEY: MI_VALUE, ...}, ...}` where `NAME` is either the name of a source
       handler or the special key `:all` which sets default meta info for all source handlers.
 
+    <%= show_default['sourcehandler.default_meta_info'] %>
+
     * Example for setting the option in the configuration file:
 
           default_meta_info:
@@ -242,7 +305,9 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
     Specifies the name of the default template file of a directory. This template is used as
     fallback when no specific template is specified.
 
-    * Syntax: `PATH` where `PATH` is the absolute localized canonical name of the default template.
+    * Syntax: `PATH` where `PATH` is the (absolute) localized canonical name of the default template.
+
+    <%= show_default['sourcehandler.template.default_template'] %>
 
     * Example for setting the option in the configuration file:
 
@@ -261,6 +326,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
     * Syntax: `\{SHORT: NAME, ...}` where `SHORT` is the short name of the content processor class
       `NAME`.
 
+    <%= show_default['contentprocessor.map'] %>
+
     * Examples for setting the option in `ext/init.rb`:
 
           config = Webgen::WebsiteAccess.website.config
@@ -274,6 +341,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['contentprocessor.erubis.use_pi'] %>
+
     * Example for setting the option in the configuration file:
 
           contentprocessor.erubis.use_pi: true
@@ -287,11 +356,27 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
     * Syntax: `\{KEY: VALUE, ...}` where `KEY` and `VALUE` are key-value pairs of options where
       `KEY` needs to be a Symbol and not a String.
 
+    <%= show_default['contentprocessor.erubis.options'] %>
+
     * Example for setting the option in the configuration file:
 
           contentprocessor.erubis.options: {:trim: true}
 
 
+*   ### contentprocessor.redcloth.hard\_breaks
+
+    Specifies whether hard breaks (i.e. single newlines) in paragraphs are converted to HTML break
+    tags.
+
+    * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
+
+    <%= show_default['contentprocessor.redcloth.hard_breaks'] %>
+
+    * Example for setting the option in the configuration file:
+
+          contentprocessor.redcloth.hard_breaks: true
+
+
 *   ### contentprocessor.tags.prefix
 
     Specifies the optional prefix that is used for tag names to avoid name clashes when another
@@ -299,6 +384,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `PREFIX` where `PREFIX` is the prefix name.
 
+    <%= show_default['contentprocessor.tags.prefix'] %>
+
     * Example for setting the option in the configuration file:
 
           contentprocessor.tags.prefix: webgen
@@ -312,6 +399,8 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
     * Syntax: `\{SHORT: NAME, ...}` where `SHORT` is the short name of the tag class `NAME`.
 
+    <%= show_default['contentprocessor.tags.map'] %>
+
     * Example for setting the option in `ext/init.rb`:
 
           config = Webgen::WebsiteAccess.website.config
@@ -333,6 +422,8 @@ shows how to set the option in the configuration file.
     * Syntax: `SEPARATOR` where `SEPARATOR` is a string (special HTML characters need to be properly
       escaped)
 
+    <%= show_default['tag.breadcrumbtrail.separator'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.breadcrumbtrail.separator: '---'
@@ -348,6 +439,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.breadcrumbtrail.omit_index_path'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.breadcrumbtrail.omit_index_path: true
@@ -373,6 +466,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `INTEGER` where `INTEGER` is any integer number
 
+    <%= show_default['tag.breadcrumbtrail.start_level'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.breadcrumbtrail.start_level: 2
@@ -389,6 +484,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `INTEGER` where `INTEGER` is any integer number
 
+    <%= show_default['tag.breadcrumbtrail.end_level'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.breadcrumbtrail.end_level: 2
@@ -404,6 +501,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `LANG` where `LANG` is one of <%= (require 'coderay'; CodeRay::Scanners.list.map {|n| '`' + n + '`'}.join(', ')) %>.
 
+    <%= show_default['tag.coderay.lang'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.coderay.lang: ruby
@@ -419,6 +518,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.coderay.process_body'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.coderay.process_body: false
@@ -432,7 +533,9 @@ shows how to set the option in the configuration file.
 
     Specifies in which HTML element the highlighted code should be wrapped.
 
-    * Syntax: `WRAP` where `WRAP` is either `div` or `span`
+    * Syntax: `WRAP` where `WRAP` is either `:div` or `:span`
+
+    <%= show_default['tag.coderay.wrap'] %>
 
     * Example for setting the option in the configuration file:
 
@@ -449,6 +552,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.coderay.line_numbers'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.coderay.line_numbers: false
@@ -464,6 +569,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `NUMBER` where `NUMBER` is an integer value.
 
+    <%= show_default['tag.coderay.line_number_start'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.coderay.line_number_start: 4
@@ -479,6 +586,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `NUMBER` where `NUMBER` is an integer value.
 
+    <%= show_default['tag.coderay.bold_every'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.coderay.bold_every: 2
@@ -494,6 +603,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `NUMBER` where `NUMBER` is an integer value.
 
+    <%= show_default['tag.coderay.tab_width'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.coderay.tab_width: 4
@@ -511,6 +622,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `FORMAT` where `FORMAT` is a string.
 
+    <%= show_default['tag.date.format'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.date.format: '%Y-%m-%d'
@@ -527,6 +640,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `COMMAND` where `COMMAND` is the to-be-executed command.
 
+    <%= show_default['tag.executecommand.command'] %>
+
     * Example for setting the option directly in a tag:
 
           executing a simple command \{exeucte_cmd: echo hallo}
@@ -539,6 +654,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.executecommand.process_output'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.executecommand.process_output: false
@@ -554,6 +671,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.executecommand.escape_html'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.executecommand.escape_html: false
@@ -571,6 +690,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `FILENAME` where `FILENAME` is the name of a file
 
+    <%= show_default['tag.includefile.filename'] %>
+
     * Example for setting the option directly in a tag:
 
           including a file \{include_file: my_file.txt}
@@ -583,6 +704,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.includefile.process_output'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.includefile.process_output: false
@@ -598,6 +721,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.includefile.escape_html'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.includefile.escape_html: false
@@ -614,6 +739,8 @@ shows how to set the option in the configuration file.
     * Syntax: `SEPARATOR` where `SEPARATOR` is a string (special HTML characters need to be properly
       escaped)
 
+    <%= show_default['tag.langbar.separator'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.langbar.separator: ' --- '
@@ -629,6 +756,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.langbar.show_own_lang'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.langbar.show_own_lang: false
@@ -645,6 +774,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.langbar.show_single_lang'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.langbar.show_single_lang: false
@@ -662,6 +793,8 @@ shows how to set the option in the configuration file.
     * Syntax: `\{CODE: NAME, ...}` where `CODE` is a language code and `NAME` the associated language
       name of the code.
 
+    <%= show_default['tag.langbar.lang_names'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.langbar.lang_names: \{de: Deutsch, en: English}
@@ -678,6 +811,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `PATH` where `PATH` is an (absolute) (localized) canonical name.
 
+    <%= show_default['tag.link.path'] %>
+
     * Example for setting the option directly in a tag:
 
           You will find more information on the \{link: docu.html} page!
@@ -690,6 +825,8 @@ shows how to set the option in the configuration file.
     * Syntax: `\{NAME: VALUE, ...}` where `NAME` is a valid HTML attribute name and `VALUE` its
       value.
 
+    <%= show_default['tag.link.attr'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.link.attr: \{title: DocuPage}
@@ -708,6 +845,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `TYPE` where `TYPE` is one of `all`, `files` or `fragments`
 
+    <%= show_default['tag.menu.used_nodes'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.menu.used_nodes: fragments
@@ -724,6 +863,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `LEVEL` where `LEVEL` is a number that is greater or equal to one.
 
+    <%= show_default['tag.menu.start_level'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.menu.start_level: 2
@@ -740,6 +881,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `LEVEL` where `LEVEL` is a number that is greater or equal to one.
 
+    <%= show_default['tag.menu.min_levels'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.menu.min_levels: 2
@@ -756,6 +899,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `LEVEL` where `LEVEL` is a number that is greater or equal to one.
 
+    <%= show_default['tag.menu.max_levels'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.menu.max_levels: 2
@@ -773,6 +918,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.menu.show_current_subtree_only'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.menu.show_current_subtree_only: false
@@ -810,6 +957,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.menu.nested'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.menu.nested: false
@@ -826,6 +975,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `PATH` where `PATH` is a (localized) canonical name.
 
+    <%= show_default['tag.relocatable.path'] %>
+
     * Example for setting the option directly in a tag:
 
           <a href="\{relocatable: ../features.html}">Some Path</a>
@@ -839,6 +990,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `PATH` where `PATH` is a relative or absolute source path.
 
+    <%= show_default['tag.tikz.path'] %>
+
     * Example for setting the option directly in a tag:
 
           \{tikz:: images/tikz.png}\tikz \draw (0,0) -- (0,2);{tikz}
@@ -851,6 +1004,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `[NAME, ...]` where `NAME` is the name of a TikZ library.
 
+    <%= show_default['tag.tikz.libraries'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.tikz.libraries: [mindmap, arrows]
@@ -868,6 +1023,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `OPTS` where `OPTS` is the string with the global options.
 
+    <%= show_default['tag.tikz.opts'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.tikz.opts: 'scale=3, line cap=round'
@@ -884,11 +1041,13 @@ shows how to set the option in the configuration file.
     Specifies the render and output resolutions that should be used to convert the TikZ image in PDF
     format to the chosen image format. The first number specifies the render resolution and the
     second one the output resolution. If the render resolution is higher than the output resolution,
-    the final image quality is better but the image needs to scaled down to the output resolution.
+    the final image quality is better but the image needs to be scaled down to the output resolution.
 
     * Syntax: `RENDER_RES OUTPUT_RES` where `RENDER_RES` is the integer specifying the render
       resolution and `OUTPUT_RES` is the integer specifying the output resolution.
 
+    <%= show_default['tag.tikz.resolution'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.tikz.resolution: 300 72
@@ -908,6 +1067,8 @@ shows how to set the option in the configuration file.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
+    <%= show_default['tag.tikz.transparent'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.tikz.transparent: true
@@ -926,6 +1087,8 @@ shows how to set the option in the configuration file.
     * Syntax: `\{KEY:VALUE, ...}` where `KEY` is a valid HTML `img` tag attribute name and `VALUE`
       the to-be-set value.
 
+    <%= show_default['tag.tikz.img_attr'] %>
+
     * Example for setting the option in the configuration file:
 
           tag.tikz.img_attr: \{alt: Some TikZ picture}