webgen 0.5.10 → 0.5.11

data/doc/reference_website_styles.page

@@ -1,6 +1,7 @@
 ---
 title: Website Styles Reference
 ---
+# Website Styles Reference
 
 Following is a list of all website styles that are included in the webgen distribution. Each style
 can be used when creating a website by using the command
@@ -13,7 +14,10 @@ or applied later using the command
 
 When you click on the link provided for each website style, you will get a full browser preview of
 the respective website style. You can then return to this list by using the *back button* of your
-browser:
+browser.
+
+If you want to create such a style yourself, you may want to read
+[this](manual.html#create-website-style)!
 
 <%
 context.content_node.tree.node_access[:alcn].select do |name, node|

data/doc/source/filesystem.page

@@ -7,7 +7,7 @@ This is the default source extension used when creating a new webgen website. It
 match a certain glob (default value for the glob is to match all files) under a specific directory.
 
 > The default configuration for a new website uses all files under the `src` directory.
-{.information}
+{:.information}
 
 The first parameter for the file system source is the directory under which the to-be-used files are
 and the second, optional, parameter specifies a glob (see [Dir.glob]).
@@ -16,9 +16,9 @@ and the second, optional, parameter specifies a glob (see [Dir.glob]).
 
 ## Examples
 
-The used sources can be specified via the [`sources` configuration option]({relocatable:
-../reference_configuration.html#sources}), so each of the examples below can be specified in the
-`config.yaml` file.
+The used sources can be specified via the [`sources` configuration
+option](../reference_configuration.html#sources), so each of the examples below can be specified in
+the `config.yaml` file.
 
 1.  The default configuration: all files under the `src` folder of the website directory
 

data/doc/source/tararchive.page

@@ -11,7 +11,7 @@ accessible via the http(s) and ftp protcols.
 > preferred way to do this is via Rubygems:
 >
 >     gem install archive-tar-minitar
-{.warning}
+{:.warning}
 
 The first parameter for the tar archive source is the URL of the archive and the second, optional,
 parameter specifies a glob (see [File.fnmatch]) for selecting the to-be-used files/directories in the
@@ -22,9 +22,9 @@ tar archive.
 
 ## Examples
 
-The used sources can be specified via the [`sources` configuration option]({relocatable:
-../reference_configuration.html#sources}), so each of the examples below can be specified in the
-`config.yaml` file.
+The used sources can be specified via the [`sources` configuration
+option](../reference_configuration.html#sources), so each of the examples below can be specified in
+the `config.yaml` file.
 
 1.  Using all files/directories from a local tar archive in addition the default configuration:
 

data/doc/sourcehandler.template

@@ -1,11 +1,11 @@
 ---
 template: extensions.template
---- name:summary pipeline:erb,tags,maruku,blocks
+--- name:summary pipeline:erb,tags,kramdown,blocks
 <%
 patterns = context.website.config['sourcehandler.patterns'][context.content_node['title']]
 if patterns
 %>
-This source handler operates on paths that match one of the following path patterns (see the [path pattern documentation]({relocatable: manual.html#source-pathpattern}) for more information): `<%= patterns.join(', ') %>`
+This source handler operates on paths that match one of the following path patterns (see the [path pattern documentation](manual.html#source-pathpattern) for more information): `<%= patterns.join(', ') %>`
 <% end %>
 
 <%

data/doc/sourcehandler/feed.page

@@ -4,8 +4,7 @@ title: Webgen::SourceHandler::Feed
 ## Description
 
 This source handler automatically generates an atom or RSS feed for a set of files from a file in
-[Webgen Page Format]({relocatable: ../webgen_page_format.html}) (the format which is also used for
-page files).
+[Webgen Page Format](../webgen_page_format.html) (the format which is also used for page files).
 
 The following meta information keys are supported:
 
@@ -17,7 +16,7 @@ The following meta information keys are supported:
     > Be aware that if you want to include a single file or files in a specific language only you
     > need to include the language part since this is a LCN and not a CN pattern, eg. `mypage.html`
     > won't work but `mypage.en.html` will!
-    {.information}
+    {:.information}
 
 *   `number_of_entries` (OPTIONAL)
 
@@ -80,7 +79,7 @@ The following meta information keys of page files are used if they are specified
     updated.
 
     > This is the field that is used to sort the entries.
-    {.information}
+    {:.information}
 
 *   `title`
 

data/doc/sourcehandler/metainfo.page

@@ -4,7 +4,7 @@ title: Webgen::SourceHandler::Metainfo
 ## Description
 
 This source handler provides the ability to set meta information for any path. It uses files in
-[Webgen Page Format]({relocatable: ../webgen_page_format.html}) which can have two special blocks:
+[Webgen Page Format](../webgen_page_format.html) which can have two special blocks:
 
 * `paths`: This block specifies meta information for paths and therefore this meta information is
   applied before a node for a path is created. This can be used, for example, to change the output

data/doc/sourcehandler/page.page

@@ -4,9 +4,9 @@ title: Webgen::SourceHandler::Page
 ## Description
 
 This source handler uses page files which are used to specify the actual content for the website.
-These files are written using [Webgen Page Format]({relocatable: ../webgen_page_format.html}).
-Therefore they contain the content for the web page and, optionally, meta information. The extension
-`page` is changed to `html` for the output file and canonical names.
+These files are written using [Webgen Page Format](../webgen_page_format.html). Therefore they
+contain the content for the web page and, optionally, meta information. The extension `page` is
+changed to `html` for the output file and canonical names.
 
 *In contrast* to other handled files, page files can never be unlocalized! If they have no language
 set, the default language specified using the configuration option `website.lang` is used. This

data/doc/sourcehandler/sitemap.page

@@ -4,9 +4,8 @@ title: Webgen::SourceHandler::Sitemap
 ## Description
 
 This source handler automatically generates a sitemap based on the specification of
-[sitemaps.org](http://sitemaps.org) from a file in [Webgen Page Format]({relocatable:
-../webgen_page_format.html}). The output and canonical names have the extension `xml` instead of
-`sitemap`.
+[sitemaps.org](http://sitemaps.org) from a file in [Webgen Page Format](../webgen_page_format.html).
+The output and canonical names have the extension `xml` instead of `sitemap`.
 
 The following meta information keys are supported:
 

data/doc/sourcehandler/template.page

@@ -5,8 +5,8 @@ title: Webgen::SourceHandler::Template
 
 The template handler processes the templates files. Templates, as the name already implies, normally
 specify the layout and the overall "picture" of a web page that is defined using a page file. These
-files are in [Webgen Page Format]({relocatable: ../webgen_page_format.html}) (the format which is
-also used for page files).
+files are in [Webgen Page Format](../webgen_page_format.html) (the format which is also used for
+page files).
 
 The configuration option `sourcehandler.template.default_template` specifies the name of the default
 template which is used when no explicit template is set via the meta information `template`. webgen

data/doc/sourcehandler/virtual.page

@@ -3,10 +3,10 @@ title: Webgen::SourceHandler::Virtual
 ---
 ## Description
 
-This source handler uses files in [Webgen Page Format]({relocatable: ../webgen_page_format.html})
-which are used to specify virtual paths. Virtual paths don't really exist as source paths but are
-useful nonetheless. For example, they allow to include links to external content in automatically
-generated menus. They are never written out since they define no real content!
+This source handler uses files in [Webgen Page Format](../webgen_page_format.html) which are used to
+specify virtual paths. Virtual paths don't really exist as source paths but are useful nonetheless.
+For example, they allow to include links to external content in automatically generated menus. They
+are never written out since they define no real content!
 
 The `content` block of the source path is used and its content needs to be a hash in YAML
 format. The keys are relative or absolute source paths names and the values meta information for
@@ -34,7 +34,7 @@ Following is a sample virtual source files with explanations afterwards:
 
 > The example does not use a normal hash but an ordered YAML map. This ensures that the virtual
 > nodes are created in the order they appear in the file.
-{.information}
+{:.information}
 
 The first entry specifies that a directory `/documentation` should be created. The virtual file
 handler recognizes this because the given path ends in a slash!. Then a virtual index file for the

data/doc/tag.template

@@ -14,7 +14,7 @@ This tag uses the following options:
 for option in context.content_node['used_options']
   temp = 'mandatory' if !context.website.config.meta_info[option][:mandatory].nil?
   temp += ' default' if context.website.config.meta_info[option][:mandatory] == 'default'
-%>* [`<%= option %>`]({relocatable: reference_configuration.html#<%= option.tr('.', '') %>}) <%= temp ? '(' + temp + ')' : '' %>
+%>* [`<%= option %>`]({relocatable: reference_configuration.html#<%= option.tr('._', '') %>}) <%= temp ? '(' + temp + ')' : '' %>
 <%
   temp = nil
 end

data/doc/tag/coderay.page

@@ -22,13 +22,13 @@ styles, the default external stylesheet file or your own stylesheet file.
 > It is easy to include and highlight an entire file by combining this tag with the `include_file` tag:
 >
 >     \{coderay:: ruby}{include_file: test.rb}{coderay}
-{.information}
+{:.information}
 
 > This extension is only available if you have installed the [coderay][1] library. The preferred
 > way to do this is via Rubygems:
 >
 >     gem install coderay
-{.warning}
+{:.warning}
 
 [1]: http://coderay.rubychan.de/ "The Coderay homepage"
 

data/doc/tag/includefile.page

@@ -12,7 +12,7 @@ relative to the website directory or as an absolute filename.
 
 > By surrounding the include file tag with a syntax highlighting tag it is possible to highlight the
 > contents of a file.
-{.information}
+{:.information}
 
 
 ## Examples

data/doc/tag/langbar.page

@@ -24,9 +24,12 @@ display language flags. For example, you can use the following entries in `confi
     tag.langbar.process_output: true
 
 This assumes that the `langbar` tag is *only* used in `src/default.template` and the flag images are
-under `src/img/` (otherwise the `relocatable` tag can correctly find the paths). To work around
+under `src/img/` (otherwise the `relocatable` tag cannot correctly find the paths). To work around
 this, you could specify the `lang_names` directly in the `langbar` tag.
 
+The CSS class `webgen-langbar-current-lang` is assigned to the HTML tag for the currently selected
+language.
+
 ## Examples
 
 <table class="examples">

data/doc/tag/menu.page

@@ -16,7 +16,7 @@ its many options that let you decide every detail of the menu.
 > The menu is constructed using HTML lists with `ul` and `li` tags.  However, the menu normally
 > looks better if no discs are shown for the menu items (using the CSS directive `list-style-type:
 > none`).
-{.information}
+{:.information}
 
 It uses the meta information `in_menu` and `sort_info` to determine which nodes should be in the
 menu and how they should be ordered. A separate menu tree is then created from all nodes for each
@@ -30,7 +30,7 @@ generating an in-page content menu of all the header sections.
 >
 > However, when using the value `all` for `tag.menu.used_nodes`, some nodes which have `in_menu` set
 > to `false` may appear in the menu if they have fragments beneath them that are in the menu!
-{.important}
+{:.important}
 
 The rendered menu consists of `ul` and `li` tags and the links (or `span` elements) to the menu
 entries . The `li` tags have special CSS classes set for styling. These CSS class names are as
@@ -51,7 +51,7 @@ menu.
 
 > Set `tag.menu.nested` to `false` if you want to generate, for example, a horizontal menu, ie. a
 > menu that has one horizontal bar for each menu level.
-{.information}
+{:.information}
 
 ## "Static" Menus
 

data/doc/tag/relocatable.page

@@ -15,7 +15,7 @@ ensuring that the relative path to file is valid.
 
 > You can only use the `relocatable` tag with paths that are handled by webgen. If you want to
 > handle paths that are not normally handled by webgen, create a virtual path for them.
-{.important}
+{:.important}
 
 If the specified path is an absolute URL (like `http://webgen.rubyforge.org`), it will just return
 it. And if you specify an URL fragment, this fragment has to exist. If you don't want to resolve a

data/doc/upgrading.page

@@ -8,12 +8,11 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
 * **Update the configuration file `config.yaml`**
 
   The configuration file syntax as well as the names of the configuration options and some defaults
-  changed. For example, the default processing pipeline now uses Maruku (a Markdown converter) as
+  changed. For example, the default processing pipeline now uses kramdown (a Markdown converter) as
   markup language processor instead of Textile. You can find an overview over all available
-  configuration options in the [configuration option reference]({relocatable:
-  reference_configuration.html}). Also have a look at the [configuration file
-  documentation]({relocatable: manual.html#website-configfile}) for more information on the syntax
-  of this file and the available helpers.
+  configuration options in the [configuration option reference](reference_configuration.html). Also
+  have a look at the [configuration file documentation](manual.html#website-configfile) for more
+  information on the syntax of this file and the available helpers.
 
   * Name changes: All configuration options now use underscores to separate word parts instead of
     camelCase.
@@ -32,22 +31,22 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
   This file is not supported anymore since webgen 0.5.x uses a more flexible way for specifying meta
   information and virtual paths. You need to migrate its data to `metainfo` and `virtual` files in
   the source directory. Have a look at the documentation of the [metainfo source
-  handler]({relocatable: sourcehandler/metainfo.html}) and the [virtual source
-  handler]({relocatable: sourcehandler/virtual.html}).
+  handler](sourcehandler/metainfo.html) and the [virtual source
+  handler](sourcehandler/virtual.html).
 
 * **Update meta information names and values**
 
   The names of some meta information keys have been changed. Meta information names are not
-  specified in camelCase anymore but with under\_scores. You can find a complete list of supported
-  meta information names in the [meta information reference]({relocatable:
-  reference_metainfo.html}). The most notable changes are:
+  specified in camelCase anymore but with under_scores. You can find a complete list of supported
+  meta information names in the [meta information reference](reference_metainfo.html). The most
+  notable changes are:
 
-  * directoryName → routed\_title
-  * inMenu → in\_menu
-  * indexFile → index\_path
-  * omitIndexPath → omit\_index\_path
-  * outputNameStyle → output\_path\_style
-  * orderInfo → sort\_info
+  * directoryName → routed_title
+  * inMenu → in_menu
+  * indexFile → index_path
+  * omitIndexPath → omit_index_path
+  * outputNameStyle → output_path_style
+  * orderInfo → sort_info
 
   Also be aware that the syntax of some meta information keys has changed. For example, all meta
   information keys that took a source path name, e.g. `index_path`, now take an localized canonical
@@ -59,7 +58,7 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
   * `virtual` files
   * page and template files
 
-* **Files in [Webgen Page Format]({relocatable: webgen_page_format.html})**
+* **Files in [Webgen Page Format](webgen_page_format.html)**
 
   Since the format of these files changed a little bit you may need to adapt all your files that use
   it, that are primarily page and template files. The main change in the format was a different use
@@ -71,15 +70,15 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
   options. Two options are currently used by webgen: `name` and `pipeline`. So you could change the
   name and the processing pipeline of a block by using a block start line like:
 
-      --- name:other pipeline:tags,maruku,blocks
+      --- name:other pipeline:tags,kramdown,blocks
 
 * **Block inclusion in template/page files**
 
   The way how named blocks are included has changed. This feature is now provided by the content
-  processor [blocks]({relocatable: contentprocessor/blocks.html}) instead of the tag `block`. This
-  allows you to specify the point in the processing pipeline when a block should be included. So you
-  definitely need to update your `default.template` file as well as any other page/template file
-  where you used the `block` tag.
+  processor [blocks](contentprocessor/blocks.html) instead of the tag `block`. This allows you to
+  specify the point in the processing pipeline when a block should be included. So you definitely
+  need to update your `default.template` file as well as any other page/template file where you used
+  the `block` tag.
 
   So you need to look for `\{block: content}` tags (where `content` is just a place holder for the
   name of the block that should be included) and replace them with `<webgen:block name='content'
@@ -87,16 +86,16 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
 
 * **Update tag names and parameters**
 
-  Since the names of the configuration options changed (from using camelCase to using under\_scores)
+  Since the names of the configuration options changed (from using camelCase to using under_scores)
   and some tags have different options, you need to change all tag parameters. You may also need to
-  convert old tag names to new ones (same reason: camelCase to under\_score), for example,
+  convert old tag names to new ones (same reason: camelCase to under_score), for example,
   `includeFile` is now `include_file`.
 
 * **Update your ERB code**
 
   If you have any ERB code in your template or page files you will most certainly have to adapt them
-  to the new [API]({relocatable: api.html}). One thing that has been used often is the check if a
-  page file has a certain block:
+  to the new [API](api.html). One thing that has been used often is the check if a page file has a
+  certain block:
 
       <%% if node.node_info[:page_data].blocks.has_key?('NAME') %>
       ...
@@ -111,10 +110,10 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
 * **Extensions development**
 
   Since the complete core of webgen has changed you need to rewrite all your plugins for the 0.5.x
-  series. Howver, webgen has complete [API documentation]({relocatable: api.html}) now which
-  provides you with all needed information as well as examples on how to implement source handlers,
-  tags, content processors, ... If you still have any questions, don't hesitate to contact me or
-  write a mail to the mailing list!
+  series. Howver, webgen has complete [API documentation](api.html) now which provides you with all
+  needed information as well as examples on how to implement source handlers, tags, content
+  processors, ... If you still have any questions, don't hesitate to contact me or write a mail to
+  the mailing list!
 
 * **Running webgen on the converted website**
 
@@ -136,4 +135,4 @@ Here are step-by-step instructions on how to update your webgen website from 0.4
   * misc: smiley replacer, html validators
   * CLI commands: check, show, use
 
-  If you need any of those you have to wait till they are implemented or port them on your on.
+  If you need any of those you have to wait till they are implemented or port them on your on.

data/doc/webgen_page_format.page

@@ -73,8 +73,8 @@ Each content block needs to have a unique name and additional options can also b
 uniquely identifies a content block and is used to access it. The only option used by webgen is the
 `pipeline` option which specifies the processing pipeline for the block. The processing pipeline is
 used for rendering the block by using the specified content processors in the specified order. There
-are many different content processors available - have a look at the [extensions page]({relocatable:
-extensions.html}) for an overview.
+are many different content processors available - have a look at the [extensions
+page](extensions.html) for an overview.
 
 webgen extensions that use files in Webgen Page Format may specify defaults for the name and the
 options of a block but these defaults can be overwritten. You can use one of two ways to do this:
@@ -88,14 +88,14 @@ options of a block but these defaults can be overwritten. You can use one of two
 The following example uses the first technique to override the name and/or the `pipeline` option:
 
     1. content block of the file
-    --- name:sidebar pipeline:maruku,tags
+    --- name:sidebar pipeline:kramdown,tags
     2. content block of the file
     --- name:other
     3. content block of the file
 
 The first block has no identifieres set (there is no line with three dashes and the identifieres).
 Therefore the default value for the name is used: `content`. The second block is named `sidebar` and
-uses the processing pipeline `maruku,tags`. As you can see, the name of a block as well as
+uses the processing pipeline `kramdown,tags`. As you can see, the name of a block as well as
 additional options are specified by stating the key (e.g. `name` or `pipeline`) followed by a colon
 and the value. Multiple options are separated via one or more spaces. The value of a block option is
 parsed with YAML. For example, when specifying `use_something:true` the value `true` is
@@ -103,14 +103,14 @@ automatically converted from the string `true` to the boolean `true`.
 
 > Only the first block gets the default name of `content`. The second and following blocks have
 > numbered names like `block2`, `block3` and so on.
-{.information}
+{:.information}
 
 You can also set the name and additional options of the content blocks by using the special `blocks`
 meta information. It is a hash using the index of a block (or the special value `default`) as key
 and the options as values. The above example can therefore also be written like this:
 
     ---
-    blocks: \{2: {name: sidebar, pipeline: maruku,tags}, 3: {name: other}}
+    blocks: \{2: {name: sidebar, pipeline: kramdown,tags}, 3: {name: other}}
     ---
     1. content block of the file
     ---

data/lib/webgen/cache.rb

@@ -1,7 +1,6 @@
 # -*- encoding: utf-8 -*-
 
 require 'set'
-require 'facets/kernel/constant'
 
 module Webgen
 
@@ -74,12 +73,12 @@ module Webgen
       @volatile = {:classes => @volatile[:classes]}
     end
 
-    # Return the unique instance of the class +name+. This method should be used when it is
-    # essential that webgen uses only one object of a class or when an object should automatically
-    # be recreated upon cache restoration (see #restore).
+    # Return the unique instance of the class +name+ (a String). This method should be used when it
+    # is essential that webgen uses only one object of a class or when an object should
+    # automatically be recreated upon cache restoration (see #restore).
     def instance(name)
       @permanent[:classes] << name unless @permanent[:classes].include?(name)
-      (@volatile[:classes] ||= {})[name] ||= constant(name).new
+      (@volatile[:classes] ||= {})[name] ||= Common.const_for_name(name).new
     end
 
   end