webgen 0.5.5 → 0.5.6

data/doc/reference_metainfo.page

@@ -60,6 +60,10 @@ never`.
 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}
+
 ### draft
 
 {:miref}
@@ -127,8 +131,13 @@ path.
 * Any
 
 Sets the time when the path was last modified. This information is automatically set for paths
-provided by Webgen::Source::FileSystem but can be overridden by setting it manually. If not set to a
-valid time, the time when webgen is executed is used for this meta information.
+provided by Webgen::Source::FileSystem (the file modification is used) but can be overridden by
+setting it manually. If not set to a valid time, the time when webgen is executed is used for this
+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}
 
 ### no\_output
 

data/doc/sourcehandler/feed.page

@@ -14,6 +14,11 @@ The following meta information keys are supported:
     A LCN pattern (or an array of LCN patterns) which specify the page files that should be
     used. Other matched files are excluded from the list.
 
+    > 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}
+
 *   `number_of_entries` (OPTIONAL)
 
     The number of entries that should be included in the feed. Defaults to 10.
@@ -26,6 +31,10 @@ The following meta information keys are supported:
 
     A RSS feed is generated if this key is set to `true`. Defaults to `true`.
 
+*   `rss_version` (OPTIONAL)
+
+    The RSS version that should be used for generating the RSS feed. Defaults to `2.0`.
+
 *   `site_url` (MANDATORY)
 
     The base url of the website for which the feed is generated.
@@ -48,11 +57,14 @@ The following meta information keys are supported:
 
 *   `created_at` (OPTIONAL)
 
-    The time at which this feed was created. Defaults to the current time if not set.
+    The time at which this feed was created. Defaults to the current time if not set. Has the same
+    format as the meta information `created_at`.
 
-*   `icon` (OPTIONAL)
+*   `content_block_name` (OPTIONAL)
 
-    The absolute localized canonical name of the feed's icon image.
+    The name of the block that should be used for the content of the feed entries. If not specified
+    the name `content` is used. Be aware that each page file that can appear in the feed needs to
+    have such a block!
 
 The following meta information keys of page files are used if they are specified:
 
@@ -65,6 +77,9 @@ The following meta information keys of page files are used if they are specified
     The time at which the page file was last modified, used as the time at which this feed entry was
     updated.
 
+    > This is the field that is used to sort the entries.
+    {.information}
+
 *   `title`
 
     The title of the page file, used as title of the feed entry.
@@ -79,4 +94,4 @@ The following meta information keys of page files are used if they are specified
 
 The default implementation supports the generation of atom and RSS feeds. You can override the
 default generation mechanism by adding an `atom_template` and/or `rss_template` block in the feed
-file which are then used to generate the atom or the RSS feed respectively.
+file which are then used to generate the atom or the RSS feed respectively.

data/doc/sourcehandler/page.page

@@ -12,19 +12,3 @@ meta information.
 set, the default language specified using the configuration option `website.lang` is used. This
 means that for the default language set to English and a source path named `index.page`, the
 language meta information is automatically set to English.
-
-## Fragment nodes
-
-The page handler automatically generates fragment nodes for all found header tags in the block named
-`content` (i.e. `h1`, `h2`, ...) that have an `id` attribute set. The default markup language Maruku
-automatically generates an `id` attribute for all headers. If you use another markup language or
-plain old HTML, you might need to set the `id` attributes by hand.
-
-> The reason why only header tags with an `id` attribute are used is that only those can be
-> referenced and linked to later.
-{.information}
-
-The generated fragment nodes can be used like any other node. So you can link to them and use them
-in a menu. Concerning the menu, there is a setting for the `tag.menu.used_nodes` option called
-`fragments` which only uses the fragment node of the current page to generate a menu. This allows to
-generate a nice overview of the page.

data/doc/tag/langbar.page

@@ -4,10 +4,13 @@ used_options:
   - tag.langbar.separator
   - tag.langbar.show_own_lang
   - tag.langbar.show_single_lang
+  - tag.langbar.lang_names
 ---
 ## Description
 
-This tag is used to display a list of links to translations of the page.
+This tag is used to display a list of links to translations of the page. The text that is displayed
+can be set via the configuration option `tag.langbar.lang_names` (if not set, the language code is
+shown).
 
 ## Examples
 
@@ -19,4 +22,8 @@ This tag is used to display a list of links to translations of the page.
   <td>\{langbar:}</td>
   <td>{langbar:}</td>
 </tr>
+<tr>
+  <td>\{langbar: {lang_names: {en: Englisch}}}</td>
+  <td>{langbar: {lang_names: {en: Englisch}}}</td>
+</tr>
 </table>

data/doc/tag/link.page

@@ -0,0 +1,44 @@
+---
+title: Webgen::Tag::Link
+used_options:
+  - tag.link.path
+  - tag.link.attr
+---
+## Description
+
+This tag can be used to generate a link to an (absolute) (localized) canonical path. The generated
+link will behave exactly like the ones generated by, for example, the breadcrumb trail tag or the
+menu tag. So it respects the setting of the configuration option `website.link_to_current_page`
+which means that if this option is set to `false` only a `span` element and not an `a` element is
+created.
+
+The configuration option `tag.link.attr` lets you specify additional HTML options that should be set
+on the generated link. It can also be used to set the link text via the special `:link_text` key!
+
+## Examples
+
+<table class="examples">
+<tr>
+  <th>Usage</th><th>Output</th>
+</tr>
+<tr>
+  <td>\{link: /default.css}</td>
+  <td>{link: /default.css}</td>
+</tr>
+<tr>
+  <td>\{link: link.html}</td>
+  <td>{link: link.html}</td>
+</tr>
+<tr>
+  <td>\{link: link.html#description}</td>
+  <td>{link: link.html#description}</td>
+</tr>
+<tr>
+  <td>\{link: ../}</td>
+  <td>{link: ../}</td>
+</tr>
+<tr>
+  <td>\{link: {path: relocatable.html, attr: {:link_text: A nicer link text, title: Just a title}}}</td>
+  <td>{link: {path: relocatable.html, attr: {:link_text: A nicer link text, title: Just a title}}}</td>
+</tr>
+</table>

data/doc/tag/tikz.page

@@ -0,0 +1,158 @@
+---
+title: Webgen::Tag::TikZ
+used_options:
+  - tag.tikz.path
+  - tag.tikz.libraries
+  - tag.tikz.opts
+  - tag.tikz.resolution
+  - tag.tikz.transparent
+  - tag.tikz.img_attr
+---
+## Description
+
+This tag provides support for automatically generating graphics with the fantastic PGF/TikZ library
+for LaTeX. You will need to have a current LaTeX distribution with the PGF/TikZ library installed
+and ImageMagick for this to work. You will also need Ghostscript if you want support for transparent
+PNG images. More exactly, you will need to have the programs `pdflatex` (usually included in the
+LaTeX distribution - for generating a PDF from the LaTeX document that describes the PGF/TikZ
+graphic), `pdfcrop` (usually included in the LaTeX distribution - to crop the generated PDF and
+throw away useless borders), `convert` (provided by ImageMagick - to convert the generated PDF
+document to an image file format and to optionally resize them) and `gs` (provided by the
+Ghostscript package - to generate transparent PNG images).
+
+When using this tag, you need to set at least the default mandatory parameter `tag.tikz.path`. This
+path specifies the source path that should be used for generating the image and should not
+exist. The output path is dervied from this path the usual way. The extension used for this
+parameter specifies the final image format that is used (a good choice is PNG). All other parameters
+are optional. The commands for creating the PGF/TikZ picture are specified in the body of the
+tag. Have a look at some of the examples below to set the power of PGF/TikZ.
+
+If you want to generate transparent images, you will need to set `tag.tikz.transparent` to `true`
+and specify a `tag.tikz.path` with a `.png` extension.
+
+## Examples
+
+These examples are taken (sometimes a little bit altered) from the great PGF Manual included in the
+PGF/TikZ distribution.
+
+<table class="examples">
+<tr>
+  <th>Usage</th><th>Output</th>
+</tr>
+
+<tr>
+  <td>
+  <pre>
+  \{tikz:: house.png}
+  \tikz \draw[thick,rounded corners=8pt]
+  (0,0) -- (0,2) -- (1,3.25) -- (2,2) -- (2,0) -- (0,2) -- (2,2) -- (0,0) -- (2,0);
+  {tikz}
+  </pre>
+  </td>
+  <td>
+  {tikz:: house.png}
+  \tikz \draw[thick,rounded corners=8pt]
+  (0,0) -- (0,2) -- (1,3.25) -- (2,2) -- (2,0) -- (0,2) -- (2,2) -- (0,0) -- (2,0);
+  {tikz}
+  </td>
+</tr>
+
+<tr>
+  <td>
+  <pre>
+  \{tikz:: {path: chain.png, libraries: [arrows,automata,shadows,positioning],
+    opts: "->,>=stealth,shorten >=1pt,auto,node distance=2.8cm,on grid,semithick,
+    every state/.style={fill=red,draw=none,circular drop shadow,text=white}",
+    resolution: 300 72}}
+\node[initial,state] (A) {$q_a$};
+\node[state] (B) [above right=of A] {$q_b$};
+\node[state] (D) [below right=of A] {$q_d$};
+\node[state] (C) [below right=of B] {$q_c$};
+\node[state] (E) [below=of D] {$q_e$};
+\path (A) edge node {0,1,L} (B)
+edge node {1,1,R} (C)
+(B) edge [loop above] node {1,1,L} (B)
+edge node {0,1,L} (C)
+(C) edge node {0,1,L} (D)
+edge [bend left] node {1,0,R} (E)
+(D) edge [loop below] node {1,1,R} (D)
+edge node {0,1,R} (A)
+(E) edge [bend left] node {1,0,R} (A);
+  {tikz}
+  </pre>
+  </td>
+  <td>
+  {tikz:: {path: chain.png, libraries: [arrows,automata,shadows,positioning],
+    opts: "->,>=stealth,shorten >=1pt,auto,node distance=2.8cm,on grid,semithick,
+    every state/.style={fill=red,draw=none,circular drop shadow,text=white}"}}
+\node[initial,state] (A) {$q_a$};
+\node[state] (B) [above right=of A] {$q_b$};
+\node[state] (D) [below right=of A] {$q_d$};
+\node[state] (C) [below right=of B] {$q_c$};
+\node[state] (E) [below=of D] {$q_e$};
+\path (A) edge node {0,1,L} (B)
+edge node {1,1,R} (C)
+(B) edge [loop above] node {1,1,L} (B)
+edge node {0,1,L} (C)
+(C) edge node {0,1,L} (D)
+edge [bend left] node {1,0,R} (E)
+(D) edge [loop below] node {1,1,R} (D)
+edge node {0,1,R} (A)
+(E) edge [bend left] node {1,0,R} (A);
+  {tikz}
+  </td>
+</tr>
+
+<tr>
+  <td>
+  Not transparent and standard res
+  <pre>
+  \{tikz:: {path: mindmap.png, libraries: [mindmap]}}
+  \path[mindmap,concept color=black,text=white]
+    node[concept] {Computer Science}
+    [clockwise from=0]
+    child[concept color=red] { node[concept] {technical} }
+    child[concept color=orange] { node[concept] {theoretical} };
+  {tikz}
+  </pre>
+  </td>
+  <td>
+  {tikz:: {path: mindmap.png, libraries: [mindmap]}}
+  \path[mindmap,concept color=black,text=white]
+    node[concept] {Computer Science}
+    [clockwise from=0]
+    child[concept color=red] { node[concept] {technical} }
+    child[concept color=orange] { node[concept] {theoretical} };
+  {tikz}
+  </td>
+</tr>
+
+<tr>
+  <td>
+  Transparent and high res
+  <pre>
+  \{tikz:: {path: mindmap-low.png, libraries: [mindmap],
+     img_attr: {style: 'background:transparent'},
+     transparent: true, resolution: 300 72}}
+  \path[mindmap,concept color=black,text=white]
+    node[concept] {Computer Science}
+    [clockwise from=0]
+    child[concept color=red] { node[concept] {technical} }
+    child[concept color=orange] { node[concept] {theoretical} };
+  {tikz}
+  </pre>
+  </td>
+  <td>
+  {tikz:: {path: mindmap-high.png, libraries: [mindmap],
+    img_attr: {style: 'background:transparent'},
+    transparent: true, resolution: 300 72}}
+  \path[mindmap,concept color=black,text=white]
+    node[concept] {Computer Science}
+    [clockwise from=0]
+    child[concept color=red] { node[concept] {technical} }
+    child[concept color=orange] { node[concept] {theoretical} };
+  {tikz}
+  </td>
+</tr>
+
+</table>

data/lib/webgen/cli.rb

@@ -88,16 +88,16 @@ module Webgen
         self.program_version = Webgen::VERSION
         self.options = CmdParse::OptionParserWrapper.new do |opts|
           opts.separator "Global options:"
-          opts.on("--directory DIR", "-d", String, "The website directory (default: the current directory)") {|@directory|}
+          opts.on("--directory DIR", "-d", String, "The website directory (default: the current directory)") {|p| @directory = p}
           opts.on("--verbose", "-v", "Print more output") { @verbosity = :verbose }
           opts.on("--quiet", "-q", "No output") { @verbosity = :quiet }
-          opts.on("--log-level LEVEL", "-l", Integer, "The logging level (0..debug, 3..error)") {|@log_level|}
-          opts.on("--log-filter", "-f", Regexp, 'Filter for logging events') {|@log_filter|}
+          opts.on("--log-level LEVEL", "-l", Integer, "The logging level (0..debug, 3..error)") {|p| @log_level = p}
+          opts.on("--log-filter", "-f", Regexp, 'Filter for logging events') {|p| @log_filter = p}
         end
         self.add_command(CmdParse::HelpCommand.new)
         self.add_command(CmdParse::VersionCommand.new)
         Webgen::CLI.constants.select {|c| c =~ /.+Command$/ }.each do |c|
-          self.add_command(Webgen::CLI.const_get(c).new, (c == 'RunCommand' ? true : false))
+          self.add_command(Webgen::CLI.const_get(c).new, (c.to_s == 'RunCommand' ? true : false))
         end
       end
 

data/lib/webgen/common/sitemap.rb

@@ -1,4 +1,4 @@
-require 'webgen/tag/menu'
+require 'webgen/tag'
 require 'webgen/websiteaccess'
 
 module Webgen::Common
@@ -64,13 +64,12 @@ module Webgen::Common
             (tree.flatten.any? do |alcn|
                (n = node.tree[alcn]) && (r = n.routing_node(lang)) && r.meta_info_changed?
              end)
-          node.dirty = true
+          node.flag(:dirty)
           break
         end
       end
     end
 
-
   end
 
 end

data/lib/webgen/configuration.rb

@@ -1,3 +1,5 @@
+require 'facets/symbol/to_proc'
+
 module Webgen
 
   # Stores the configuration for a webgen website.
@@ -99,7 +101,7 @@ module Webgen
       # Complete +sh_name+ by checking if a source handler called
       # <tt>Webgen::SourceHandler::SH_NAME</tt> exists.
       def complete_source_handler_name(sh_name)
-        (Webgen::SourceHandler.constants.include?(sh_name) ? 'Webgen::SourceHandler::' + sh_name : sh_name)
+        (Webgen::SourceHandler.constants.map(&:to_s).include?(sh_name) ? 'Webgen::SourceHandler::' + sh_name : sh_name)
       end
       private :complete_source_handler_name
 

data/lib/webgen/contentprocessor.rb

@@ -65,6 +65,7 @@ module Webgen
     autoload :Builder, 'webgen/contentprocessor/builder'
     autoload :Erubis, 'webgen/contentprocessor/erubis'
     autoload :RDiscount, 'webgen/contentprocessor/rdiscount'
+    autoload :Fragments, 'webgen/contentprocessor/fragments'
 
     # Return the list of all available content processors.
     def self.list

data/lib/webgen/contentprocessor/blocks.rb

@@ -1,5 +1,3 @@
-require 'webgen/loggable'
-
 module Webgen::ContentProcessor
 
   # Replaces special xml tags with the rendered content of a node.

data/lib/webgen/contentprocessor/context.rb

@@ -1,6 +1,3 @@
-require 'webgen/contentprocessor'
-require 'webgen/websiteaccess'
-
 module Webgen::ContentProcessor
 
   # The context object that is passed to the +call+ method of a content processor.

data/lib/webgen/contentprocessor/erubis.rb

@@ -1,5 +1,3 @@
-require 'webgen/websiteaccess'
-
 module Webgen::ContentProcessor
 
   # Processes embedded Ruby statements with the +erubis+ library.

data/lib/webgen/contentprocessor/fragments.rb

@@ -0,0 +1,23 @@
+module Webgen::ContentProcessor
+
+  # Uses the HTML headers h1, h2, ..., h6 to generate nested fragment nodes.
+  class Fragments
+
+    include Webgen::WebsiteAccess
+
+    # Generate the nested fragment nodes from <tt>context.content</tt> under
+    # <tt>content.content_node</tt> but only if there is no associated <tt>:block</tt> data in
+    # +context+ or the block is named +content+.
+    def call(context)
+      if !context[:block] || context[:block].name == 'content'
+        sections = website.blackboard.invoke(:parse_html_headers, context.content)
+        website.blackboard.invoke(:create_fragment_nodes, sections, context.content_node,
+                                  website.blackboard.invoke(:source_paths)[context.content_node.node_info[:src]],
+                                  context.content_node.meta_info['fragments_in_menu'])
+      end
+      context
+    end
+
+  end
+
+end

data/lib/webgen/default_config.rb

@@ -54,7 +54,7 @@ config.sourcehandler.patterns({
                                 'Webgen::SourceHandler::Sitemap' => ['**/*.sitemap']
                               }, :doc => 'Source handler to path pattern map')
 config.sourcehandler.invoke({
-                              1 => ['Webgen::SourceHandler::Directory', 'Webgen::SourceHandler::Metainfo', 'Webgen::SourceHandler::Directory'],
+                              1 => ['Webgen::SourceHandler::Directory', 'Webgen::SourceHandler::Metainfo'],
                               5 => ['Webgen::SourceHandler::Copy', 'Webgen::SourceHandler::Template',
                                     'Webgen::SourceHandler::Page', 'Webgen::SourceHandler::Feed',
                                     'Webgen::SourceHandler::Sitemap'],
@@ -80,7 +80,7 @@ config.sourcehandler.default_meta_info({
                                          'Webgen::SourceHandler::Page' => {
                                            'kind' => 'page',
                                            'fragments_in_menu' => true,
-                                           'blocks' => {'default' => {'pipeline' => 'erb,tags,maruku,blocks'}}
+                                           'blocks' => {'default' => {'pipeline' => 'erb,tags,maruku,blocks,fragments'}}
                                          },
                                          'Webgen::SourceHandler::Fragment' => {
                                            'kind' => 'fragment'
@@ -131,6 +131,7 @@ config.contentprocessor.map({
                               'builder' => 'Webgen::ContentProcessor::Builder',
                               'erubis' => 'Webgen::ContentProcessor::Erubis',
                               'rdiscount' => 'Webgen::ContentProcessor::RDiscount',
+                              'fragments' => 'Webgen::ContentProcessor::Fragments',
                             }, :doc => 'Content processor name to class map')
 
 Webgen::WebsiteAccess.website.blackboard.add_service(:content_processor_names, Webgen::ContentProcessor.method(:list))
@@ -148,6 +149,8 @@ config.contentprocessor.tags.map({
                                    'coderay' => 'Webgen::Tag::Coderay',
                                    'date' => 'Webgen::Tag::Date',
                                    'sitemap' => 'Webgen::Tag::Sitemap',
+                                   'tikz' => 'Webgen::Tag::TikZ',
+                                   'link' => 'Webgen::Tag::Link',
                                    :default => 'Webgen::Tag::Metainfo'
                                  }, :doc => 'Tag processor name to class map')
 
@@ -171,6 +174,7 @@ config.tag.breadcrumbtrail.end_level(-1, :doc => 'The level at which the breadcr
 config.tag.langbar.separator(' | ', :doc => 'Separates the languages from each other.')
 config.tag.langbar.show_single_lang(true, :doc => 'Should the link be shown although the page is only available in one language?')
 config.tag.langbar.show_own_lang(true, :doc => 'Should the link to the currently displayed language page be shown?')
+config.tag.langbar.lang_names({}, :doc => 'A map from language code to language names')
 
 config.tag.includefile.filename(nil, :doc => 'The name of the file which should be included (relative to the website).', :mandatory => 'default')
 config.tag.includefile.process_output(true, :doc => 'The file content will be scanned for tags if true.')
@@ -190,6 +194,15 @@ config.tag.coderay.tab_width(8, :doc => 'Number of spaces used for a tabulator')
 
 config.tag.date.format('%Y-%m-%d %H:%M:%S', :doc => 'The format of the date (same options as Ruby\'s Time#strftime)')
 
+config.tag.tikz.path(nil, :doc => 'The source path of the created image', :mandatory => 'default')
+config.tag.tikz.libraries(nil, :doc => 'An array of additional TikZ library names')
+config.tag.tikz.opts(nil, :doc => 'A string with global options for the tikzpicture environment')
+config.tag.tikz.resolution('72 72', :doc => 'A string specifying the render and output resolutions')
+config.tag.tikz.transparent(false, :doc => 'Specifies whether the generated image should be transparent (only png)')
+config.tag.tikz.img_attr({}, :doc => 'A hash of additional HTML attributes for the created img tag')
+
+config.tag.link.path(nil, :doc => 'The (A)LCN path to which a link should be generated', :mandatory => 'default')
+config.tag.link.attr({}, :doc => 'A hash of additional HTML attributes that should be set on the link')
 
 # All things regarding common functionality
 website.autoload_service(:create_sitemap, 'Webgen::Common::Sitemap')