gettalong-webgen 0.5.7.20090227 → 0.5.8.20090507

data/doc/index.page

@@ -7,7 +7,9 @@ This documentation is for the *repository version*{: style='color: red; font-wei
 webgen and therefore may state features that are not available in the latest released version.
 
 * The documentation for the *latest released 0.5.x*{: style='color: red; font-weight: bold'} version
-  can be found [here](http://webgen.rubyforge.org/documentation/0.5.x/index.html)
+  can be found [here](http://webgen.rubyforge.org/documentation/0.5.x/index.html). This
+  documentation can also be generated locally by running `rake htmldoc` in the root directory of the
+  weben distribution.
 
 * If you are looking for the documentation of the *0.4.x*{: style='color: red; font-weight: bold'}
   series, it can be found [here](http://webgen.rubyforge.org/documentation/0.4.x/index.html).
@@ -58,6 +60,10 @@ Following is a list of all the reference documentation of webgen:
 * [**Configuration Options Reference**]({relocatable: reference_configuration.html}): Overview of all
   configuration options.
 
+* [**Website Styles Reference**]({relocatable: reference_website_styles.html}): Previews of all
+  website styles that ship with webgen.
+
+
 # Developer Documentation
 
 webgen makes it easy to extend its functionality by writing simple extension classes. All

data/doc/manual.page

@@ -12,7 +12,7 @@ webgen website is structured and how content can be added and so on.
 
 
 
-# The `webgen` command
+# The `webgen` command {#cli}
 
 The executable for webgen is called... webgen ;-) It uses a command style syntax (like Subversion's
 `svn` or Rubygem's `gem` commands) through the [cmdparse] library. To get an overview of the
@@ -20,7 +20,8 @@ possible commands run `webgen help`.
 
 The main command is the `render` command which does the actual website generation. This command uses
 either the environment variable `WEBGEN_WEBSITE` (if it is set and non-empty) or the current working
-directory as website directory if none was specified via the gloabl `-d` option.
+directory as website directory if none was specified via the gloabl `-d` option. All other commands
+that need a valid webgen website directory specified work in the same way.
 
 You can invoke a command by specifying its name after the executable name. Also counting the
 executable `webgen` as a command, the options for a command are specified directly after the command
@@ -35,10 +36,29 @@ valid:
 
 Following is a short overview of the available commands:
 
-*   `create [-t TEMPLATE] [-s STYLE] SITE_DIR`
+*   `apply [-f] (BUNDLE_NAME|BUNDLE_URL)`
 
-    Creates a basic webgen website in `SITE_DIR` using the optional template and styles. All
-    available templates and styles are listed in the help output for the command.
+    The argument may either be a valid bundle name or an URL to a bundle archive (a (gzipped) tar
+    archive). The command applies the bundle to the given webgen website. The files that will be
+    written to website directory are shown and the user is asked to confirm that the shown files
+    should indeed be written (and sometimes overwritten). If the `-f` option is used, the files are
+    always written.
+
+    You can get the full list of available bundle names by running `webgen help apply`!
+
+*   `create [-b BUNDLE] SITE_DIR`
+
+    Creates a basic webgen website in `SITE_DIR` using the optionally specified bundles. The option
+    `-b` can be used more than once to specify more than one bundle - the bundles are applied in the
+    order they are specified. As with the `apply` command, `BUNDLE` may either be a valid bundle
+    name or a bundle URL.
+
+    > If you don't specify the `-b` option, the default value is used which applies the `default`
+    > and the `style-andreas07` bundles. The former only creates a simple `src/index.page` sothat
+    > some output can be seen and the latter applies a nice layout.
+    {.information}
+
+    All available bundles are listed in the help output for the command.
 
 *   `help`
 
@@ -74,11 +94,11 @@ files and directories under this directory:
 
 * `src`: The source directory in which all the source files for the website are. If this directory
   should not be called `src` or you want to include additional source directories, you need to
-  change the `sources` configuration option.
+  change the [`sources` configuration option]({relocatable: reference_configuration.html#sources}).
 
 * `out`: This directory is created, if it does not exist, when webgen generates the HTML files. All
   the output files are put into this directory. The name of this directory can be changed by setting
-  the `output` configuration option.
+  the [`output` configuration option]({relocatable: reference_configuration.html#output}).
 
 * `ext`: The extension directory (optional). You can put self-written extensions into this directory
   so that they are used by webgen. See the [extension directory]({relocatable: '#website-ext'})
@@ -224,9 +244,10 @@ SourceHandler::Template as they are responsible for handling these page and temp
 You can naturally use any other type of file. However, be aware that some files may not be processed
 by webgen when no source handler class for them exists. For example, there is currently no source
 handler class for `.svg` files, so those files would be ignored. If you just want to have files
-copied from a source to the output directory (like images or CSS files), the SourceHandler::Copy
-class is what you need! Look through the documentation of the [availabe source handler
-classes]({relocatable: extensions.html}) to get a feeling of what files are handled by webgen.
+copied from a source to the output directory (like images or CSS files), the
+[SourceHandler::Copy]({relocatable: sourcehandler/copy.html}) class is what you need! Look through
+the documentation of the [availabe source handler classes]({relocatable: extensions.html}) to get a
+feeling of what files are handled by webgen.
 
 
 ## Source Paths Naming Convention {#source-naming}
@@ -289,25 +310,50 @@ the same canonical name.
 ## Canonical Name of a File ### {#source-cn}
 
 webgen provides the functionality to define the same content in more than one language, ie. to
-localize content. This is achieved with the _canonical name_ of a path.
+localize content. This is achieved with the _canonical name_ of a path, short CN.
 
 When multiple paths share the same canonical name, webgen assumes that they have the same content
-but in different languages. It is also possible to specify a _language independent_ path which is
-used as a fallback. Therefore when a path should be resolved using a canonical name and a given
-language, it is first tried to get the path in the requested language. If this is not possible
-(ie. no such localization exists), the unlocalized path is returned if it exists.
+but in different languages. It is also possible to specify a _language independent_ path (i.e. one
+without a language) which is used as a fallback. Therefore when a path should be resolved using a
+canonical name and a given language, it is first tried to get the path in the requested language. If
+this is not possible (ie. no such localization exists), the unlocalized path is returned if it
+exists.
+
+For example, assume that we have the following `src` directory:
+
+    /test.jpg
+    /images/my.jpg
+    /images/my.de.jpg
+    /index.page
+    /index.fr.page
+    /index.de.page
+
+Since the path `images/my.jpg` has no language part, it is assumed to be unlocalized. In contrast,
+`images/my.de.jpg` has the "same" picture but in a German version. So, when specifying
+`images/my.jpg` in `index.de.page`, the correct localized version will be returned, i.e.
+`images/my.de.jpg`. When specifying `images/my.jpg` in `index.page` or in `index.fr.page`, the
+unlocalized version will be returned since no localized version exists.
 
 > Directories and fragments are never localized, only files are!
 {.important}
 
-It is also possible to use the _localized canonical name_ of a path to resolve it. The localized
-canonical name is the same as the canonical name but with a language code inserted before the
-extension. If the localized canonical name is used to resolve a path, a possibly additionally
+It is also possible to use the _localized canonical name_ of a path (short: LCN) to resolve it. The
+localized canonical name is the same as the canonical name but with a language code inserted before
+the extension. If the localized canonical name is used to resolve a path, a possibly additionally
 specified language is ignored as it is assumed that the user really only wants the path in the
 specified language!
 
-This also means that all paths are not resolved using their real source or output names but using
-the (localized) canonical name! This is different from previous webgen versions!
+Continuing the above example, this means that `images/my.de.jpg` is always returned when one
+specifies `images/my.de.jpg` in any of the index page files, e.g. in `index.fr.page`.
+
+Both canonical and localized canonical names can be absolute (ACN and ALCN) which is done by using
+the full path starting with a slash. This is especially useful when you don't exactly know in which
+hierarchy level a certain canoncial name gets evaluated.
+
+Everything said above also means that all paths are not resolved using their real source or output
+names but using the (localized) canonical name! So when specifying paths for extensions, for example
+when using the [relocatable tag]({relocatable: tag/relocatable.html}), you always have to use the
+(absolute) (localized) canonical names. This is different from previous webgen versions!
 
 
 ## Output Path Name Construction ### {#source-output}
@@ -417,14 +463,17 @@ Here are some example path patterns:
 
 Following is the list of rules how source files are handled by webgen:
 
-* All path names of all sources specified in the configuration option `sources` are fetched. Prior
-  listed sources have priority over later listed sources if both specify the same path.
+* All path names of all sources specified in the configuration option [`sources`]({relocatable:
+  reference_configuration.html#sources}) are fetched. Prior listed sources have priority over later
+  listed sources if both specify the same path.
 
-* Those paths which match a pattern of the configuration option `sourcehandler.ignore` are excluded.
+* Those paths which match a pattern of the configuration option
+  [`sourcehandler.ignore`]({relocatable: reference_configuration.html#sourcehandlerignore}) are excluded.
 
 * The source handler classes are invoked according to the invocation order specified in
-  `sourcehandler.invoke` and they use only those paths that match one of their path patterns
-  specified in `sourcehandler.patterns`.
+  [`sourcehandler.invoke`]({relocatable: reference_configuration.html#sourcehandlerinvoke}) and
+  they use only those paths that match one of their path patterns specified in
+  [`sourcehandler.patterns`]({relocatable: reference_configuration.html#sourcehandlerpatterns}).
 
 As you might have deduced from the processing list above, it is possible that one path is handled by
 multiple source handlers. This can be used, for example, to render an XML file as HTML and copy it
@@ -438,13 +487,15 @@ example the title of the path, if it should appear in a menu and so on. This met
 specified in several ways, including:
 
 * Source handlers can provide default meta information for their handled paths (set using the
-  configuration option `sourcehandler.default_meta_info`)
+  configuration option [`sourcehandler.default_meta_info`]({relocatable:
+  reference_configuration.html#sourcehandlerdefault_meta_info}).
 
 * Some file types allow meta information to be specified directly in the file, for example page
   files in [Webgen Page Format]({relocatable: webgen_page_format.html}).
 
 * Meta information can also be specified in special meta information backing files. These files are
-  handled by the source handler SourceHandler::Metainfo.
+  handled by the source handler [SourceHandler::Metainfo]({relocatable:
+  sourcehandler/metainfo.html}).
 
 There is clearly defined order in which meta information is applied to a node for a path:
 

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}