webgen 0.5.10 → 0.5.11

data/doc/reference_configuration.page

@@ -60,7 +60,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           website.lang: de
 
 
-*   ### 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.
@@ -92,7 +92,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
 
 ## Commonly Used Options
 
-*   ### common.sitemap.honor\_in\_menu
+*   ### common.sitemap.honor_in_menu
 
     Specifies whether the sitemap should only include nodes that have the meta information `in_menu`
     set.
@@ -110,7 +110,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           Sitemap with in-menu nodes: \{sitemap: {honor_in_menu: true}}
 
 
-*   ### common.sitemap.any\_lang
+*   ### 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.
@@ -128,7 +128,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           Sitemap with nodes in any language: \{sitemap: {any_lang: true}}
 
 
-*   ### common.sitemap.used\_kinds
+*   ### 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.
@@ -169,7 +169,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
       source/filesystem.html}) for more examples!
 
 
-*   ### passive\_sources
+*   ### passive_sources
 
     Specifies one or more sources which are not actively used during the node creation time, ie. no
     nodes are created from these sources by default. Instead, they lie dormant until later and are
@@ -205,7 +205,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           output: [Webgen::Output::FileSystem, custom_out]
 
 
-*   ### output.do\_deletion
+*   ### output.do_deletion
 
     Specifies whether the output class should delete generated paths once the source paths are not
     available anymore.
@@ -274,7 +274,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           sourcehandler.casefold: true
 
 
-*   ### sourcehandler.use\_hidden\_files
+*   ### sourcehandler.use_hidden_files
 
     Specifies whether hidden files (those starting with a dot) should be used.
 
@@ -301,7 +301,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           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.
@@ -315,7 +315,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           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
@@ -335,7 +335,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
               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.
@@ -372,7 +372,7 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           config['contentprocessor.map']['newcp'] = ['Extension::MyNewContentProcessor', :binary]
 
 
-*   ### contentprocessor.erubis.use\_pi
+*   ### contentprocessor.erubis.use_pi
 
     Specifies whether Erubis should look for XML processing instructions or the standard ERB tags
     when processing content.
@@ -401,7 +401,37 @@ configuration options) and/or how to use it in a webgen tag (for tag configurati
           contentprocessor.erubis.options: {:trim: true}
 
 
-*   ### contentprocessor.redcloth.hard\_breaks
+*   ### contentprocessor.kramdown.handle_links
+
+    This configuration option can be used to specify whether all links generated via kramdown syntax
+    should be automatically run through the [relocatable tag]({relocatable: tag/relocatable.html}).
+    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: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
+
+    <%= show_default['contentprocessor.kramdown.handle_links'] %>
+
+    * Example for setting the option in the configuration file:
+
+          contentprocessor.kramdown.handle_links: false
+
+
+*   ### contentprocessor.kramdown.options
+
+    This configuration option can be used to specify processing and converting options for
+    kramdown.
+
+    * Syntax: `\{KEY: VALUE, ...}` where `KEY` and `VALUE` are key-value pairs of kramdown options
+
+    <%= show_default['contentprocessor.kramdown.options'] %>
+
+    * Example for setting the option in the configuration file:
+
+          contentprocessor.kramdown.options: {:auto_ids: false}
+
+
+*   ### contentprocessor.redcloth.hard_breaks
 
     Specifies whether hard breaks (i.e. single newlines) in paragraphs are converted to HTML break
     tags.
@@ -500,7 +530,7 @@ shows how to set the option in the configuration file.
           Breadcrumb trail with different separator: \{breadcrumb_trail: {separator: ' --- '}}
 
 
-*   ### tag.breadcrumbtrail.omit\_index\_path
+*   ### tag.breadcrumbtrail.omit_index_path
 
     Specifies that the last part of the breadcrumb trail should be omitted if it is an index path.
 
@@ -517,7 +547,7 @@ shows how to set the option in the configuration file.
           Breadcrumb trail with index path omitted: \{breadcrumb_trail: {omit_index_path: true}}
 
 
-*   ### tag.breadcrumbtrail.start\_level
+*   ### tag.breadcrumbtrail.start_level
 
     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
@@ -544,7 +574,7 @@ shows how to set the option in the configuration file.
           Breadcrumb trail starting at level 2: \{breadcrumb_trail: {start_level: 2}}
 
 
-*   ### tag.breadcrumbtrail.end\_level
+*   ### 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.
@@ -579,7 +609,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -613,7 +643,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -630,7 +660,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -647,7 +677,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -664,7 +694,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -740,7 +770,7 @@ shows how to set the option in the configuration file.
           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.
@@ -758,7 +788,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -790,7 +820,7 @@ shows how to set the option in the configuration file.
           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.
@@ -808,7 +838,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -843,7 +873,7 @@ shows how to set the option in the configuration file.
           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.
 
@@ -860,7 +890,7 @@ shows how to set the option in the configuration file.
           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).
@@ -878,7 +908,7 @@ shows how to set the option in the configuration file.
           Langbar with single language not shown: \{langbar: {show_single_lang: false}}
 
 
-*   ### tag.langbar.lang\_names
+*   ### tag.langbar.lang_names
 
     This configuration option can be used to specify the language names that should be displayed
     instead of the language codes.
@@ -929,7 +959,7 @@ shows how to set the option in the configuration file.
           You will find more info on the \{link: {path: docu.html, attr: {title: DocuPage}}} page!
 
 
-*   ### 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
@@ -949,7 +979,7 @@ shows how to set the option in the configuration file.
           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.
@@ -967,7 +997,7 @@ shows how to set the option in the configuration file.
           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.
@@ -985,7 +1015,7 @@ shows how to set the option in the configuration file.
           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.
@@ -1003,7 +1033,7 @@ shows how to set the option in the configuration file.
           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
@@ -1173,7 +1203,7 @@ shows how to set the option in the configuration file.
           {tikz}
 
 
-*   ### tag.tikz.img\_attr
+*   ### tag.tikz.img_attr
 
     Specifies additional HTML attributes that should be set on the generated `img` tag.
 
@@ -1205,8 +1235,3 @@ shows how to set the option in the configuration file.
 
 # All things regarding logging
 config.logger.mask(nil, :doc => 'Only show logging events which match the regexp mask')
-
-
-
-
-

data/doc/reference_metainfo.page

@@ -16,129 +16,152 @@ follows the same pattern:
 
 ### author
 
-{:miref}
 * String: `Thomas Leitner`
 * Any
+{:miref}
 
 Sets the author of the path. This information is used, for example, by Webgen::SourceHandler::Feed.
 
-### author\_url
+### author_url
 
-{:miref}
 * String: `http://webgen.rubyforge.org`
 * Any where `author` is also set
+{:miref}
 
 Sets the homepage of the author of the path. This information is used, for example, by
 Webgen::SourceHandler::Feed and normally only when `author` is also set.
 
 ### blocks
 
-{:miref}
 * Hash of Hashes: `\{default: {pipeline:textile}, 1: {name: content, pipeline:maruku,erb,tags}}`
 * Files in Webgen Page Format
+{:miref}
 
 Specifies the default names and additional options for the blocks. The special key `default` is used
 to set default options for all blocks. Specific options for (or the name of) a block can be set by
 using the block index as key (numbering starts from one).
 
-### change\_freq
+### change_freq
 
-{:miref}
 * String: `hourly`
 * Any
+{:miref}
 
 Sets the change frequency of the page. This information is used, for example, by the sitemap source
 handler. You can use the following values for this key: `hourly, daily, weekly, monthly, yearly,
 never`.
 
-### created\_at
+### created_at
 
-{:miref}
 * Time: `2008-08-14 10:25:34 +02:00`
 * Any
+{:miref}
 
 Sets the time when the path was created. This information cannot automatically be derived for paths
 provided by Webgen::Source::FileSystem, so this has to be set manually.
 
 > Note that the value needs to be a valid [YAML timestamp](http://yaml.org/type/timestamp.html) and
 > needs to include the time part.
-{.information}
+{:.information}
 
 ### draft
 
-{:miref}
 * Boolean: `true`
 * Any
+{:miref}
 
 If this meta information is set on a path, no node will be created from it. This is useful to add
 content to a website which should only be used later on.
 
-### fragments\_in\_menu
+### fragments_in_menu
 
-{:miref}
 * Boolean: `false`
 * Page files
+{:miref}
 
 Specifies if the fragment nodes of the page file should be in the menu.
 
-### index\_path
+### index_path
 
-{:miref}
 * String: `myindex.html`
 * Directories
+{:miref}
 
 Sets the directory index path for the directory overriding the default value.
 
-### in\_menu
+### in_menu
 
-{:miref}
 * Boolean: `true`
 * Any
+{:miref}
 
 Specifies if the path should appear in menus.
 
 ### kind
 
-{:miref}
 * String: `page`
 * Any
+{:miref}
 
 Specifies the kind of the path. Some source handlers define a default value for this meta
 information for nodes created by them.
 
 ### lang
 
-{:miref}
 * String: `de`
 * Any
+{:miref}
 
 Sets the language for the path. Has to be a valid ISO-639-1/2 character code for the language. This
 meta information needs to be set before a node gets created.
 
-### link\_attrs
+### link
+
+* Hash: `\{next: next_doc.html, prev: prev_doc.html}`
+* Page files
+
+Specifies additional information, for example, about the position of the page file regarding other
+files. A sample usage would be to express that the page file is logically followed or preceded by
+certain page file.
+
+The value needs to be hash and its keys need to be [link types] except for the special `javascript`
+and `css` keys (which will be discussed below). The link type is used to specify the relation of the
+page to the linked file. The value can either be a string which is interpreted as a path to the
+internal or external file; or a hash with arbitrary key-value pairs (use lower case key names) but
+it should include at least a `href` key to specify the path to the internal or external file; or an
+array containing strings or hashes to specify more than one linked file for a given link type.
+
+The special keys `javascript` and `css` may have an array of strings or a string as value which are
+interpreted as path to javascript/CSS files that should be included.
+
+This information is used by [`ContentProcessor::Head`](contentprocessor/head.html) to insert the
+approriate tags in the head section of an HTML document.
+
+[link types]: http://www.w3.org/TR/html401/types.html#type-links
+
+### link_attrs
 
-{:miref}
 * Hash: `\{title: Hallo, class: extra}`
 * Any
+{:miref}
 
 Specifies additional attribute-value pairs (in form of a Hash) that should be added to a link to the
 path.
 
 ### meta
 
-{:miref}
 * Hash: `\{author: Thomas Leitner, generator: My program}`
 * Page files
+{:miref}
 
 Specifies names and values for `<meta>` HTML tags. These key-value pairs are then properly escaped
-and inserted into the output file by [`ContentProcessor::Head`]({relocatable:
-contentprocessor/head.html}).
+and inserted into the output file by [`ContentProcessor::Head`](contentprocessor/head.html).
 
-### modified\_at
+### modified_at
 
-{:miref}
 * Time: `2008-08-14 10:25:34 +02:00`
 * Any
+{:miref}
 
 Sets the time when the path was last modified. This information is automatically set for paths
 provided by Webgen::Source::FileSystem (the file modification is used) but can be overridden by
@@ -147,66 +170,66 @@ meta information.
 
 > Note that the value needs to be a valid [YAML timestamp](http://yaml.org/type/timestamp.html) and
 > needs to include the time part.
-{.information}
+{:.information}
 
-### no\_output
+### no_output
 
-{:miref}
 * Boolean: `true`
 * Any
+{:miref}
 
 Specifies whether an output path for the node should be written or not. This differs from `draft`
 that a node for the path gets created nonetheless.
 
-### omit\_index\_path
+### omit_index_path
 
-{:miref}
 * Boolean: `false`
 * Index paths
+{:miref}
 
 Controls whether the index path should appear in a breadcrumb trail despite the setting of the
 `tag.breadcrumbtrail.omit_index_path` option.
 
-### output\_path\_style
+### output_path_style
 
-{:miref}
 * Array: `[:parent, :basename, [., :lang], .html]`
 * Any
+{:miref}
 
 Sets a custom output path style for the specified path. The basename is substituted for the value
-`:basename` and the language for the value `:lang`. Strings are used verbatim. If `:lang` is specified
-in a sub-array, the whole sub-array is omitted, if the configuration option
+`:basename` and the language for the value `:lang`. Strings are used verbatim. If `:lang` is
+specified in a sub-array, the whole sub-array is omitted, if the configuration option
 `sourcehandler.default_lang_in_output_path` is false. For more and detailed information, have look
-at the [output path creation section]({relocatable: manual.html#source-output}) of the manual!
+at the [output path creation section](manual.html#source-output) of the manual!
 
 > This meta information has to be set BEFORE a node gets created. Setting this value is therefore
 > only useful, for example, in the `paths` block of a meta information backing file.
-{.important}
+{:.important}
 
 ### priority
 
-{:miref}
 * Float: `0.5`
 * Any
+{:miref}
 
 Specifies the priority of this file in respect to all the other files of the website. This
 information is used, for example, by the sitemap source handler.
 
-### routed\_title
+### routed_title
 
-{:miref}
 * String: `Image Directory`
 * Any
+{:miref}
 
 Only used if set on a directory index path; specifies the title of the directory for which it is the
 index path. If this meta information is not specified, the title of the directory will be used
 instead.
 
-### sort\_info
+### sort_info
 
-{:miref}
 * Integer or String: `15`
 * Any
+{:miref}
 
 Sets the sort information for the path. Any String or Integer value can be used here. When two nodes
 are compared using this information and both have Integers, then an Integer comparision is
@@ -216,26 +239,26 @@ Setting a String value is useful, for example, for specifying dates as sort info
 
 ### template
 
-{:miref}
 * String or null: `my.template` or `~`
 * Page/Template files
+{:miref}
 
 Sets the template for the page/template file overriding the default value. If set to null
 (i.e. `~`), no template is used for the page/template file!
 
 ### title
 
-{:miref}
 * String: `New Title`
 * Any
+{:miref}
 
 Sets the title for the path.
 
-### used\_nodes
+### used_nodes
 
-{:miref}
 * Array: `[*.en.html, test.de.html]`
 * Any
+{:miref}
 
 The value of this meta information needs to be an array of alcn patterns. All nodes that match at
 least one of the patterns are considered to be dependencies of the node. Therefore if any of these