webgen 0.5.2 → 0.5.3

data/data/webgen/website_styles/andreas09/src/default.css

@@ -159,13 +159,13 @@ padding:0;
 
 /*** Sidebar menu ***/
 
-.webgen-menu-section ul {
+#pagemenu ul {
   margin: 0 0 16px 10px;
   padding: 0px;
   list-style: none;
 }
 
-.nav, .webgen-menu-section a {
+.nav, #pagemenu a {
 background:#e8e9ea;
 border:1px solid #b0b0b0;
 color:#606060;
@@ -177,7 +177,7 @@ text-transform:uppercase;
 width:140px;
 }
 
-.nav:hover, .webgen-menu-section a:hover, .webgen-menu-section li.webgen-menu-item-selected a, .webgen-menu-section li.webgen-menu-submenu-inhierarchy a, .active {
+.nav:hover, #pagemenu a:hover, #pagemenu li.webgen-menu-item-selected a, #pagemenu li.webgen-menu-submenu-inhierarchy a, .active {
 background:#f8f9fa;
 border:1px solid #909090;
 color:#303030;

data/data/webgen/website_styles/andreas09/src/default.template

@@ -27,7 +27,7 @@
 
         <div id="leftside">
           <h1>Page Menu</h1>
-          {menu: {used_nodes: fragments}}
+          <div id="pagemenu">{menu: {used_nodes: fragments}}</div>
 
 	  <h1>Color</h1>
 	  <p>This website style is available in many different colors. Just copy one of the <code>menuhover-COLOR.jpg</code> and <code>bodybg-COLOR.jpg</code> over <code>menuhover.jpg</code> and <code>bodybg.jpg</code> and your are done. You can then delete the other menuhover-* and bodybg-* images.</p>

data/data/webgen/website_styles/simple/src/default.css

@@ -1,84 +1,84 @@
-
-  #all { background-color: #CCCCCC; }
-
-  #header {
-    border-bottom: 1px solid black;
-    padding: 1ex;
-    background-color: #888888;
-  }
-  #header h1 {
-    margin: 0ex;
-	font-size: 300%;
-	font-style: italic;
-	font-weight: normal;
-  }
-
-, #headerbar { border-bottom: 1px solid black; }
-  #footer { border-top: 1px solid black; }
-
-  #body {
-    margin-left: 250px;
-    margin-right: 20px;
-    padding: 10px;
-  }
-
-  #menu {
-	float: left;
-	width: 230px;
-    padding: 20px 0px 0px 2px;
-  }
-
-  .bar {
-	clear: both;
-	padding: 3px;
-	text-align: center;
-	font-size: 90%;
-    background-color: #AAAAAA;
-  }
-
-  .left, .right {
-    padding: 0px 1em;
-  }
-
-  .left {
-	float: left;
-	text-align: left;
-  }
-
-  .right {
-	float: right;
-	text-align: right;
-  }
-
-  /* styling the menu */
-
-  #menu a, #menu span {
-	text-decoration: none;
-	font-weight: bold;
-	font-size: 130%;
-  }
-
-  #menu a:hover {
-	text-decoration: underline;
-  }
-
-  #menu .webgen-menu-item-selected {
-	border-left: 3px solid black;
-  }
-
-  #menu ul {
-	list-style-type: none;
-	padding: 0px;
-	margin-left: 10px;
-  }
-
-  #menu li > ul {
-	font-size: 95%;
-  }
-
-  #menu li {
-    margin: 0.0em 0px;
-    padding: 2px 0px;
-    padding-left: 5px;
-    border-left: 3px solid #CCCCCC;
-  }
+#all { background-color: #CCCCCC; }
+
+#header {
+  border-bottom: 1px solid black;
+  padding: 1ex;
+  background-color: #888888;
+}
+
+#header h1 {
+  margin: 0ex;
+  font-size: 300%;
+  font-style: italic;
+  font-weight: normal;
+}
+
+#headerbar { border-bottom: 1px solid black; }
+#footer { border-top: 1px solid black; }
+
+#body {
+  margin-left: 250px;
+  margin-right: 20px;
+  padding: 10px;
+}
+
+#menu {
+  float: left;
+  width: 230px;
+  padding: 20px 0px 0px 2px;
+}
+
+.bar {
+  clear: both;
+  padding: 3px;
+  text-align: center;
+  font-size: 90%;
+  background-color: #AAAAAA;
+}
+
+.left, .right {
+  padding: 0px 1em;
+}
+
+.left {
+  float: left;
+  text-align: left;
+}
+
+.right {
+  float: right;
+  text-align: right;
+}
+
+/* styling the menu */
+
+#menu a, #menu span {
+  text-decoration: none;
+  font-weight: bold;
+  font-size: 130%;
+}
+
+#menu a:hover {
+  text-decoration: underline;
+}
+
+#menu .webgen-menu-item-selected {
+  border-left: 3px solid black;
+}
+
+#menu ul {
+  list-style-type: none;
+  padding: 0px;
+  margin-left: 10px;
+}
+
+#menu li > ul {
+  font-size: 95%;
+}
+
+#menu li {
+  margin: 0.0em 0px;
+  padding: 2px 0px;
+  padding-left: 5px;
+  border-left: 3px solid #CCCCCC;
+}

data/data/webgen/website_styles/simple/src/default.template

@@ -30,7 +30,7 @@
     </div>
 
     <div id="footer" class="bar">
-      <a href="http://webgen.rubyforge.org"><img src="{resource: webgen-generated}" alt="Generated by webgen"/></a> on <b>{date: }</b>
+      Generated by <a href="http://webgen.rubyforge.org">webgen</a> on <b>{date: }</b>
     </div>
   </body>
 </html>

data/doc/index.page

@@ -12,36 +12,51 @@ are not available in the latest released version.
 * If you are looking for the documentation of the 0.4.x series, it can be found
   [here](http://webgen.rubyforge.org/documentation/0.4.x/index.html).
 
+If you don't find an answer to your questions in the documentation, there are also:
+
+* [forums][forum] hosted on Rubyforge
+* [mailing lists][ml] hosted on Rubyforge (the `webgen-users` mailing list is mirrored to the
+  [webgen-users google group][google-group])
+* the IRC channel `#webgen` on Freenode where I can be found whenever I'm online.
+
+[forum]: http://rubyforge.org/forum/?group_id=296
+[ml]: http://rubyforge.org/mail/?group_id=296
+[google-group]: http://groups.google.com/group/webgen-users/
+
 # User Documentation
 
 Depending on whether you are new to webgen, you want more information about a specific topic or read
 a reference, go to one of the following pages:
 
-* [Getting Started Guide]({relocatable: getting_started.html}): If you are new to webgen, this
+* [**Getting Started Guide**]({relocatable: getting_started.html}): If you are new to webgen, this
   should be your first read. It explains the usage of the CLI command and how to create your first
   website with webgen.
 
-* [Manual]({relocatable: manual.html}): Detailed information about how webgen works can be found
+* [**Manual**]({relocatable: manual.html}): Detailed information about how webgen works can be found
   here. After reading the Getting Started Guide, this should be the next read. Have a look at the
   section headers to get a quick overview of what can be found here.
 
-* [FAQ]({relocatable: faq.html}): If you want to do something with webgen, but you don't know how,
+* [**FAQ**]({relocatable: faq.html}): If you want to do something with webgen, but you don't know how,
   this page is exactly for you. It provides answers to frequently asked questions. If you have a
   question which you think should be added, just mail me.
 
-* Reference Documentation:
+* [**Upgrade information**]({relocatable: upgrading.html}): This document provides some information
+  on upgrading a website from the 0.4.x to the 0.5.x series.
+
+
+Following is a list of all the reference documentation of webgen:
 
-  * [Extensions Documentation]({relocatable: extensions.html}): Detailed information on every usage
-    related extension class (source handlers, tags, content processors, ...)
+* [**Extensions Documentation**]({relocatable: extensions.html}): Detailed information on every usage
+  related extension class (**source handlers, tags, content processors**, ...)
 
-  * [Webgen Page Format]({relocatable: webgen_page_format.html}): Information about/Specification of
-    the format used, for example, by page and template files
+* [**Webgen Page Format**]({relocatable: webgen_page_format.html}): Information about/Specification of
+  the format used, for example, by page and template files
 
-  * [Meta Information Reference]({relocatable: reference_metainfo.html}): Descriptions for every
-    meta information key that is used by webgen.
+* [**Meta Information Reference**]({relocatable: reference_metainfo.html}): Descriptions for every
+  meta information key that is used by webgen.
 
-  * [Configuration Options Reference]({relocatable: reference_configuration.html}): Overview of all
-    configuration options.
+* [**Configuration Options Reference**]({relocatable: reference_configuration.html}): Overview of all
+  configuration options.
 
 # Developer Documentation
 

data/doc/manual.page

@@ -96,16 +96,56 @@ name and the new value as a key/value pair. A sample configuration file looks li
     website.lang: de
     website.link_to_current_page: true
 
-There is one special key called `default_meta_info` which behaves a little different. It does not
-map to any configuration option but is used to update the meta information hashes of the
-configuration option `sourcehandler.default_meta_info`. For example, the following configuration
-file updates the default meta information for all source handlers by setting a new value for
-`output_path_style` and setting `in_menu` to `true`:
+Since some configuration options have a complex structure, there exist several special configuration
+keys to help setting these configuration options:
+
+*   `default_meta_info`: Set the default meta information for one or more source handlers.
+
+    This key needs needs a Hash as value which should be of the following form:
+
+        SOURCE_HANDLER_NAME:
+          mi_key: mi_value
+          other_key: other_value
+          :action: replace
+
+    So each entry has to specify the name of a source handler (or the special value `:all` which
+    sets the default meta information for all source handlers) and the meta information items that
+    should be set or modified. If you don't want to update the meta information hash but want to
+    replace it, you need to add `:action: replace` as meta information entry.
+
+    If a source handler called `Webgen::SourceHandler::SOURCE_HANDLER_NAME` exists, the meta
+    information is set for this source handler instead.
+
+    For example, the following snippet of a configuration file sets the meta information item
+    `in_menu` to `true` for `Webgen::SourceHandler::Page`:
+
+        default_meta_info:
+          Page:
+            in_menu: true
+
+*   `patterns`: Set the used path patterns for one or more source handlers.
+
+    This key needs a Hash value and provides two different ways of setting the path patterns:
+
+        SOURCE_HANDLER_NAME: [**/*.jpg, **/*.css]
+
+        SOURCE_HANDLER_NAME:
+          add: [**/*.jpg]
+          del: [**/*.js]
+
+    The first form replaces the path patterns for the source handler with the given patterns. The
+    second form allows to add or delete individual patterns.
+
+    If a source handler called `Webgen::SourceHandler::SOURCE_HANDLER_NAME` exists, the meta
+    information is set for this source handler instead.
+
+    For example, the following snippet of a configuration file adds the pattern `**/*.pdf` to the
+    patterns of `Webgen::SourceHandler::Copy`:
+
+        patterns:
+          Copy:
+            add: [**/*.pdf]
 
-    default_meta_info:
-      :all:
-        output_path_style: [:parent, :cnbase, :ext, [., :lang]]
-        in_menu: true
 
 
 ## Rakefile {#website-rakefile}
@@ -115,7 +155,9 @@ recurring task for your website, for example, for deploying the website to a ser
 some useful tasks out of the box:
 
 * `webgen`: Renders the webgen website once.
-* `auto_webgen`: Automatically renders the website when a source file has changed.
+* `auto_webgen`: Automatically renders the website when a source file has changed. This is very
+  useful when developing a website because you don't need to change back and forth between your
+  website code and the command line to rebuild the site.
 * `clobber_webgen`: Removes all webgen generated products (the output files and the cache file).
 
 

data/doc/reference_configuration.page

@@ -10,7 +10,7 @@ This reference describes all available configurations that can be set via the co
 
 ## General Options
 
-*   ### `website.lang`
+*   ### website.lang
 
     Specifies the default language of the website. The default language is assigned, for example, to
     page files for which a language is not explicitly specified.
@@ -23,7 +23,7 @@ This reference describes all available configurations that can be set via the co
           website.lang: fr
 
 
-*   ### `website.link_to_current_page`
+*   ### website.link\_to\_current\_page
 
     If this option is set to `true`, automatically generated links from a page to itself are
     used. Otherwise, only the title of the page is shown.
@@ -35,7 +35,7 @@ This reference describes all available configurations that can be set via the co
           website.link_to_current_page: false
 
 
-*   ### `website.cache`
+*   ### website.cache
 
     Specifies 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 directory. The
@@ -49,9 +49,47 @@ This reference describes all available configurations that can be set via the co
           website.cache: [:file, my.cache]
 
 
+## Commonly Used Options
+
+*   ### common.sitemap.honor\_in\_menu
+
+    Specifies whether the sitemap should only include nodes that have the meta information `in_menu`
+    set.
+
+    * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
+
+    * Examples:
+
+          Sitemap with in-menu nodes: \{sitemap: {honor_in_menu: true}}
+
+
+*   ### common.sitemap.any\_lang
+
+    Specifies whether the sitemap should include nodes in any language or only those without a
+    language or with the language of the node in which the sitemap tag is used.
+
+    * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
+
+    * Examples:
+
+          Sitemap with nodes in any language: \{sitemap: {any_lang: true}}
+
+
+*   ### common.sitemap.used\_kinds
+
+    Specifies the kind of nodes that should be used in the sitemap. This defaults to all nodes with
+    the kind `page`. If this is set to an empty array, any kind of node is used.
+
+    * Syntax: `[KIND, ...]` where `KIND` is the kind of node that should be used.
+
+    * Examples:
+
+          Sitemap with only asset nodes: \{sitemap: {used_kinds: [asset]}}
+
+
 ## Source and Output Specific Options
 
-*   ### `sources`
+*   ### sources
 
     Specifies one or more sources from which paths are read. This can also be used, for example, to
     additionally add other directories as source directories that may or may not be located in the
@@ -67,7 +105,7 @@ This reference describes all available configurations that can be set via the co
           sources: [[/, Webgen::Source::FileSystem, src], [/, Webgen::Source::FileSystem, /mnt/pictures, **/*.jpg]
 
 
-*   ### `output`
+*   ### output
 
     Specifies the output class that should be used for writing out the generated paths.
 
@@ -80,7 +118,7 @@ This reference describes all available configurations that can be set via the co
           output: [Webgen::Output::FileSystem, custom_out]
 
 
-*   ### `sourcehandler.patterns`
+*   ### sourcehandler.patterns
 
     Specifies the path patterns that are used by the individual source handlers. This configuration
     option is not normally set in the configuration file but in an extension file
@@ -94,7 +132,7 @@ This reference describes all available configurations that can be set via the co
           config.sourcehandler.patterns['Webgen::SourceHandler::Copy'] << '**/*.swf'
 
 
-*   ### `sourcehandler.invoke`
+*   ### sourcehandler.invoke
 
     Specifies the invocation order of the various source handlers. This configuration option should
     normally only be used by extensions to register their source handlers!
@@ -108,7 +146,7 @@ This reference describes all available configurations that can be set via the co
           config.sourcehandler.invoke[5] << 'Extension::MyNewSourceHandler'
 
 
-*   ### `sourcehandler.casefold`
+*   ### sourcehandler.casefold
 
     Specifies whether path names should be considered case-sensitive (set to `false`) or
     case-insensitive (set to `true`).
@@ -120,7 +158,7 @@ This reference describes all available configurations that can be set via the co
           sourcehandler.casefold: true
 
 
-*   ### `sourcehandler.use_hidden_files`
+*   ### sourcehandler.use\_hidden\_files
 
     Specifies whether hidden files (those starting with a dot) should be used.
 
@@ -131,7 +169,7 @@ This reference describes all available configurations that can be set via the co
           sourcehandler.use_hidden_files: true
 
 
-*   ### `sourcehandler.ignore`
+*   ### sourcehandler.ignore
 
     Specifies path patterns that should be ignored. All paths that match at least one of the
     patterns are never used.
@@ -143,7 +181,7 @@ This reference describes all available configurations that can be set via the co
           sourcehandler.ignore: [**/*~, **/CVS/**]
 
 
-*   ### `sourcehandler.default_lang_in_output_path`
+*   ### sourcehandler.default\_lang\_in\_output\_path
 
     Specifies whether output paths in the default language should have the language code in their
     name.
@@ -155,7 +193,7 @@ This reference describes all available configurations that can be set via the co
           sourcehandler.default_lang_in_output_path: true
 
 
-*   ### `sourcehandler.default_meta_info`
+*   ### sourcehandler.default\_meta\_info
 
     Specifies default meta information for all source handlers or for specific ones. The
     configuration file provides a shortcut for setting meta information items using the special
@@ -173,7 +211,7 @@ This reference describes all available configurations that can be set via the co
               in_menu: true
 
 
-*   ### `sourcehandler.template.default_template`
+*   ### sourcehandler.template.default\_template
 
     Specifies the name of the default template file of a directory. This template is used as
     fallback when no specific template is specified.
@@ -187,7 +225,7 @@ This reference describes all available configurations that can be set via the co
 
 ## Content Processor Specific Options
 
-*   ### `contentprocessor.map`
+*   ### contentprocessor.map
 
     This configuration option maps short names for content processor to their class names. The short
     names are used, for example, in the procesing pipeline of a content block of a file in Webgen
@@ -202,7 +240,7 @@ This reference describes all available configurations that can be set via the co
           config['contentprocessor.map']['newcp'] = 'Extension::MyNewContentProcessor'
 
 
-*   ### `contentprocessor.tags.prefix`
+*   ### contentprocessor.tags.prefix
 
     Specifies the optional prefix that is used for tag names to avoid name clashes when another
     content processor uses similar markup.
@@ -215,7 +253,7 @@ This reference describes all available configurations that can be set via the co
           contentprocessor.tags.prefix: tag
 
 
-*   ### `contentprocessor.tags.map`
+*   ### contentprocessor.tags.map
 
     This configuration option maps short names for tag classes to tag class names. The short names
     are used in page and template files to specify the tag. This configuration option is normally
@@ -234,7 +272,7 @@ These options are not normally set in the configuration file but given directly
 respective tag classes. Therefore, all examples in this section show the use of these options in
 files in Webgen Page Format.
 
-*   ### `tag.breadcrumbtrail.separator`
+*   ### tag.breadcrumbtrail.separator
 
     Specifies the string that should be used as separator between indivdual parts of the breadcrumb
     trail.
@@ -247,31 +285,51 @@ files in Webgen Page Format.
           Breadcrumb trail with different separator: \{breadcrumb_trail: {separator: ' --- '}}
 
 
-*   ### `tag.breadcrumbtrail.omit_last`
+*   ### tag.breadcrumbtrail.omit\_index\_path
 
-    Specifies that the last part of the breadcrumb trail should be omitted. If
-    `tag.breadcrumbtrail.omit_index_path` is also set to `true` and the last part is an index path,
-    only the index path is omitted (and not the parent of the index node too)!
+    Specifies that the last part of the breadcrumb trail should be omitted if it is an index path.
 
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
 
     * Examples:
 
-          Breadcrumb trail with last part omitted: \{breadcrumb_trail: {omit_last: true}}
+          Breadcrumb trail with index path omitted: \{breadcrumb_trail: {omit_index_path: true}}
 
 
-*   ### `tag.breadcrumbtrail.omit_index_path`
+*   ### tag.breadcrumbtrail.start\_level
 
-    Specifies that the last part of the breadcrumb trail should be omitted if it is an index path.
+    Specifies 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:
 
-    * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
+         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` option into
+    account when specifying the level number.
+
+    * Syntax: `INTEGER` where `INTEGER` is any integer number
 
     * Examples:
 
-          Breadcrumb trail with index path omitted: \{breadcrumb_trail: {omit_index_path: true}}
+          Breadcrumb trail starting at level 2: \{breadcrumb_trail: {start_level: 2}}
+
+
+*   ### tag.breadcrumbtrail.end\_level
+
+    Specifies the level at which the breadcrumb trail ends. Have a look at the documentation for
+    `tag.breadcrumbtrail.start_level` for more information on the useable level numbers.
+
+    * Syntax: `INTEGER` where `INTEGER` is any integer number
+
+    * Examples:
+
+          Breadcrumb trail ending at level 2: \{breadcrumb_trail: {end_level: 2}}
 
 
-*   ### `tag.coderay.lang`
+*   ### tag.coderay.lang
 
     Specifies the language that should be used for syntax highlighting.
 
@@ -282,7 +340,7 @@ files in Webgen Page Format.
           highlighting some ruby code \{coderay:: ruby}puts 5 + 5{coderay}
 
 
-*   ### `tag.coderay.process_body`
+*   ### tag.coderay.process\_body
 
     Specifies whether the body of the tag should be processed by the tags content processor first.
 
@@ -293,7 +351,7 @@ files in Webgen Page Format.
           wrapping in a span: \{coderay:: {lang: ruby, process_body: false}}puts 5 + 5{coderay}
 
 
-*   ### `tag.coderay.wrap`
+*   ### tag.coderay.wrap
 
     Specifies in which HTML element the highlighted code should be wrapped.
 
@@ -304,7 +362,7 @@ files in Webgen Page Format.
           wrapping in a span: \{coderay:: {lang: ruby, wrap: span}}puts 5 + 5{coderay}
 
 
-*   ### `tag.coderay.line_numbers`
+*   ### tag.coderay.line\_numbers
 
     Specifies whether line numbers should be shown.
 
@@ -315,7 +373,7 @@ files in Webgen Page Format.
           not showing line numbers: \{coderay:: {lang: ruby, line_numbers: false}}puts 5 + 5{coderay}
 
 
-*   ### `tag.coderay.line_number_start`
+*   ### tag.coderay.line\_number\_start
 
     Specifies the line number that should be used for the first line.
 
@@ -326,7 +384,7 @@ files in Webgen Page Format.
           starting with line 4: \{coderay:: {lang: ruby, line_number_start: 4}}puts 5 + 5{coderay}
 
 
-*   ### `tag.coderay.bold_every`
+*   ### tag.coderay.bold\_every
 
     Specifies the interval at which the line numbers should appear bold.
 
@@ -337,7 +395,7 @@ files in Webgen Page Format.
           every other line bold: \{coderay:: {lang: ruby, bold_every: 2}}puts 5 + 5{coderay}
 
 
-*   ### `tag.coderay.tab_width`
+*   ### tag.coderay.tab\_width
 
     Specifies the number of spaces that should be used to replace tabulator characters.
 
@@ -348,7 +406,7 @@ files in Webgen Page Format.
           tabulator == 4 spaces: \{coderay:: {lang: ruby, tab_width: 4}}puts 5 + 5{coderay}
 
 
-*   ### `tag.date.format`
+*   ### tag.date.format
 
     Specifies the format that should be used for formatting the current date. The format string
     needs to be in a format supported by Ruby's method
@@ -361,7 +419,7 @@ files in Webgen Page Format.
           very short date format: \{date: {format: '%Y-%m-%d'}}
 
 
-*   ### `tag.executecommand.command`
+*   ### tag.executecommand.command
 
     Specifies the command that should be executed. This option is the default mandatory option for
     Webgen::Tag::ExecuteCommand.
@@ -373,7 +431,7 @@ files in Webgen Page Format.
           executing a simple command \{exeucte_cmd: echo hallo}
 
 
-*   ### `tag.executecommand.process_output`
+*   ### tag.executecommand.process\_output
 
     Specifies whether the output of the executed command should be further processed by the tags
     content processor.
@@ -385,7 +443,7 @@ files in Webgen Page Format.
           executing command without further processing \{execute_cmd: {command: 'echo hallo', process_output: false}}
 
 
-*   ### `tag.executecommand.escape_html`
+*   ### tag.executecommand.escape\_html
 
     Specifies whether special HTML characters in the output of the executed command should be escaped.
 
@@ -396,7 +454,7 @@ files in Webgen Page Format.
           executing command, output not escaped \{execute_cmd: {command: 'echo hallo', escape_html: false}}
 
 
-*   ### `tag.includefile.filename`
+*   ### tag.includefile.filename
 
     Specifies the name of the file that should be included. The filename needs to be relative to the
     website directory or an absolute path. This option is the default mandatory option for
@@ -409,7 +467,7 @@ files in Webgen Page Format.
           including a file \{include_file: my_file.txt}
 
 
-*   ### `tag.includefile.process_output`
+*   ### tag.includefile.process\_output
 
     Specifies whether the content of the file should be further processed by the tags content
     processor.
@@ -421,7 +479,7 @@ files in Webgen Page Format.
           including a file without further processing \{include_file: {filename: my_file.txt, process_output: false}}
 
 
-*   ### `tag.includefile.escape_html`
+*   ### tag.includefile.escape\_html
 
     Specifies whether special HTML characters in the content of the file should be escaped.
 
@@ -432,7 +490,7 @@ files in Webgen Page Format.
           including a file without escaping \{include_file: {filename: my_file.txt, escape_html: false}}
 
 
-*   ### `tag.langbar.separator`
+*   ### tag.langbar.separator
 
     Specifies the string that should be used as separator between the individual language parts.
 
@@ -444,7 +502,7 @@ files in Webgen Page Format.
           Langbar with another separator: \{langbar: {separator: ' --- '}}
 
 
-*   ### `tag.langbar.show_own_lang`
+*   ### tag.langbar.show\_own\_lang
 
     Specifies whether the link to the language of the current page should be displayed.
 
@@ -455,7 +513,7 @@ files in Webgen Page Format.
           Langbar with current page's lang not shown: \{langbar: {show_own_lang: false}}
 
 
-*   ### `tag.langbar.show_single_lang`
+*   ### tag.langbar.show\_single\_lang
 
     Specifies whether the list should be displayed even if there are no translations of the page
     (i.e. when there is only one page).
@@ -467,7 +525,7 @@ files in Webgen Page Format.
           Langbar with single language not shown: \{langbar: {show_single_lang: false}}
 
 
-*   ### `tag.menu.used_nodes`
+*   ### tag.menu.used\_nodes
 
     Specifies the type of nodes that should be used for menu generation. If `all` is specified then
     all available menu nodes are used, if `files` is specified then only menu nodes that represent
@@ -481,7 +539,7 @@ files in Webgen Page Format.
           Show the fragment node menu: \{menu: {used_nodes: fragments}}
 
 
-*   ### `tag.menu.start_level`
+*   ### tag.menu.start\_level
 
     Specifies the start level for the menu. All nodes with a lower level than this number are not
     shown in the menu.
@@ -493,7 +551,7 @@ files in Webgen Page Format.
           Menu starting at level 2: \{menu: {start_level: 2}}
 
 
-*   ### `tag.menu.min_levels`
+*   ### tag.menu.min\_levels
 
     Specifies the minimum number of levels that should always be shown. For example, if this is set
     to `2` then two menu levels are always shown.
@@ -505,7 +563,7 @@ files in Webgen Page Format.
           Menu that always shows at least 2 levels : \{menu: {min_levels: 2}}
 
 
-*   ### `tag.menu.max_levels`
+*   ### tag.menu.max\_levels
 
     Specifies the maximum number of levels that should be shown even if there would be more. For
     example, if this is set to `2` then there are only shown at most two menu levels.
@@ -517,7 +575,7 @@ files in Webgen Page Format.
           Menu that always shows at most 2 levels : \{menu: {max_levels: 2}}
 
 
-*   ### `tag.menu.show_current_subtree_only`
+*   ### tag.menu.show\_current\_subtree\_only
 
     Specifies whether only the current subtree (ie. the subtree in which the node is that is
     displayed) should be shown in the menu or all subtrees. This option takes effect when there are
@@ -530,7 +588,7 @@ files in Webgen Page Format.
           Showing all subtrees: \{menu: {show_current_subtree_only: false}}
 
 
-*   ### `tag.relocatable.path`
+*   ### tag.relocatable.path
 
     The default mandatory configuration option for Tag::Relocatable that specifies the path that
     should be made relocatable. This option is the default mandatory option for
@@ -543,13 +601,11 @@ files in Webgen Page Format.
           <a href="\{relocatable: ../features.html}">Some Path</a>
 
 
-
-
 ---
 
 ## Miscelleanous Configuration Options
 
-*   ### `resources`
+*   ### resources
 
     A map from resource names to resource identifiers. Should only be used by extensions and not be
     set in the configuration file.