RubyGems - gettalong-webgen - Versions diffs - 0.5.5.20081012 → 0.5.6.20081020 - Mend

gettalong-webgen 0.5.5.20081012 → 0.5.6.20081020

Files changed (27) hide show

data/Rakefile +8 -1
data/data/webgen/website_styles/1024px/src/default.template +1 -1
data/data/webgen/website_styles/andreas00/src/default.template +1 -1
data/data/webgen/website_styles/andreas01/src/default.template +2 -1
data/data/webgen/website_styles/andreas03/src/default.template +1 -1
data/data/webgen/website_styles/andreas04/src/default.template +1 -1
data/data/webgen/website_styles/andreas05/src/default.template +1 -1
data/data/webgen/website_styles/andreas06/src/default.template +1 -1
data/data/webgen/website_styles/andreas07/src/default.template +1 -1
data/data/webgen/website_styles/andreas08/src/default.template +1 -1
data/data/webgen/website_styles/andreas09/src/default.template +1 -1
data/data/webgen/website_styles/simple/src/default.template +1 -1
data/doc/reference_configuration.page +248 -69
data/doc/tag/link.page +44 -0
data/lib/webgen/cli.rb +4 -4
data/lib/webgen/configuration.rb +3 -1
data/lib/webgen/default_config.rb +4 -0
data/lib/webgen/sourcehandler/base.rb +2 -1
data/lib/webgen/tag.rb +1 -0
data/lib/webgen/tag/link.rb +23 -0
data/lib/webgen/version.rb +1 -1
data/lib/webgen/website.rb +2 -1
data/test/test_cli.rb +14 -0
data/test/test_node.rb +1 -2
data/test/test_tag_link.rb +61 -0
data/test/test_tree.rb +2 -0
metadata +6 -2

data/Rakefile CHANGED Viewed

@@ -98,6 +98,7 @@ EOF
                             'Rakefile',
                             'setup.rb',
                             'VERSION',
+                            'ChangeLog',
                             'AUTHORS',
                             'THANKS',
                             'COPYING',
@@ -120,6 +121,12 @@ EOF
     File.open('VERSION', 'w+') {|file| file.write(Webgen::VERSION + "\n")}
   end
+  CLOBBER << 'ChangeLog'
+  file 'ChangeLog' do
+    puts "Generating ChangeLog file"
+    `git log --name-only > ChangeLog`
+  end
   Rake::PackageTask.new('webgen', Webgen::VERSION) do |pkg|
     pkg.need_tar = true
     pkg.need_zip = true
@@ -194,7 +201,7 @@ EOF
     task :gemspec do
       spec.version = Webgen::VERSION + '.' + Time.now.strftime('%Y%m%d')
       spec.summary = 'webgen beta build, not supported!!!'
-      spec.files = spec.files.reject {|f| f == 'VERSION'}
+      spec.files = spec.files.reject {|f| f == 'VERSION' || f == 'ChangeLog'}
       spec.post_install_message = "

data/data/webgen/website_styles/1024px/src/default.template CHANGED Viewed

@@ -35,7 +35,7 @@
         <p>Write a short presentation of yourself or the site right here!</p>
         <h2>Pages:</h2>
-        <div id="menu">{menu: {max_levels: 2}}</div>
+        <div id="menu">{menu: {max_levels: 2, used_nodes: files}}</div>
         <h2>Site news:</h2>
         <p><strong>09.09.2009</strong><br />

data/data/webgen/website_styles/andreas00/src/default.template CHANGED Viewed

@@ -20,7 +20,7 @@
       <div id="avmenu">
         <h2 class="hide">Site menu:</h2>
-        {menu: }
+        {menu: {used_nodes: files}}
         <div class="announce">
           <h2>Latest news:</h2>

data/data/webgen/website_styles/andreas01/src/default.template CHANGED Viewed

@@ -1,3 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
@@ -24,7 +25,7 @@
       <div id="leftside">
         <h2 class="hide">Menu:</h2>
-        <div id="menu">{menu: }</div>
+        <div id="menu">{menu: {used_nodes: files}}</div>
         <div class="announce">
           <h2>Latest news:</h2>

data/data/webgen/website_styles/andreas03/src/default.template CHANGED Viewed

@@ -37,7 +37,7 @@
       <div id="sidebar">
         <h2 class="sidelink menuheader"><a id="sitemenu"></a>Menu:</h2>
-        <div id="menu">{menu: {max_levels: 1}}</div>
+        <div id="menu">{menu: {max_levels: 1, used_nodes: files}}</div>
         <a class="hide" href="#top" accesskey="1">Top of page</a>
         <h3>Regular links</h3>

data/data/webgen/website_styles/andreas04/src/default.template CHANGED Viewed

@@ -19,7 +19,7 @@
       </div>
       <div id="menu">
-        {menu: {max_levels: 1}}
+        {menu: {max_levels: 1, used_nodes: files}}
       </div>
       <div id="content">

data/data/webgen/website_styles/andreas05/src/default.template CHANGED Viewed

@@ -17,7 +17,7 @@
       <div id="sidebar">
         <h2>Site menu</h2>
-        <div id="menu">{menu: {max_levels: 1}}</div>
+        <div id="menu">{menu: {max_levels: 1, used_nodes: files}}</div>
         <p class="sidenote">
           Links:<br />

data/data/webgen/website_styles/andreas06/src/default.template CHANGED Viewed

@@ -23,7 +23,7 @@
       </div>
       <div id="nav">
-        {menu: {max_levels: 1}}
+        {menu: {max_levels: 1, used_nodes: files}}
         <p class="hide"><a href="#top">Back to top</a></p>
       </div>

data/data/webgen/website_styles/andreas07/src/default.template CHANGED Viewed

@@ -20,7 +20,7 @@
       <h2>your website slogan</h2>
       <div id="menu">
-        {menu: {max_levels: 1}}
+        {menu: {max_levels: 1, used_nodes: files}}
       </div>
       <h3>Links:</h3>

data/data/webgen/website_styles/andreas08/src/default.template CHANGED Viewed

@@ -19,7 +19,7 @@
       </div>
       <div id="navigation">
-        {menu: {max_levels: 1}}
+        {menu: {max_levels: 1, used_nodes: files}}
       </div>
       <div id="content">

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

@@ -20,7 +20,7 @@
       </div>
       <div id="mainmenu">
-        {menu: {max_levels: 1}}
+        {menu: {max_levels: 1, used_nodes: files}}
       </div>
       <div id="wrap">

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

@@ -22,7 +22,7 @@
     </div>
     <div id="menu">
-      {menu: }
+      {menu: {used_nodes: files}}
     </div>
     <div id="body">

data/doc/reference_configuration.page CHANGED Viewed

@@ -5,8 +5,14 @@ in_menu: false
 # Configuration Option Reference
-This reference describes all available configurations that can be set via the configuration file
-(or, if you want to have more control, via an extension file).
+This reference describes all available configurations that can be set via the [configuration
+file]({relocatable: manual.html#website-configfile}) `config.yaml` (or, if you want to have more
+control, via an extension file).
+The reference is splitted into sections to provide better navigation. A sub header under a category
+always specifies the name of a configuration option and after that comes a description and example
+code. The example code either shows how to set this option in the configuration file (for most
+configuration options) and/or how to use it in a webgen tag (for tag configuration options).
 ## General Options
@@ -17,10 +23,9 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `LANGUAGE` where `LANGUAGE` is a ISO-639-1/2 two or three letter language code
-    * Examples:
+    * Example for setting the option in the configuration file:
-          website.lang: deu
-          website.lang: fr
+          website.lang: de
 *   ### website.link\_to\_current\_page
@@ -30,7 +35,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is `true` or `false`
-    * Examples:
+    * Example for setting the option in the configuration file:
           website.link_to_current_page: false
@@ -44,7 +49,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `[TYPE, LOCATION]` where `TYPE` is one of `:file` or `:string`
-    * Examples:
+    * Example for setting the option in the configuration file:
           website.cache: [:file, my.cache]
@@ -58,7 +63,11 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          common.sitemap.honor_in_menu: true
+      Example for setting the option directly in a tag:
           Sitemap with in-menu nodes: \{sitemap: {honor_in_menu: true}}
@@ -70,7 +79,11 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          common.sitemap.any_lang: true
+      Example for setting the option directly in a tag:
           Sitemap with nodes in any language: \{sitemap: {any_lang: true}}
@@ -82,7 +95,11 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `[KIND, ...]` where `KIND` is the kind of node that should be used.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          common.sitemap.used_kinds: [asset]
+      Example for setting the option directly in a tag:
           Sitemap with only asset nodes: \{sitemap: {used_kinds: [asset]}}
@@ -100,7 +117,7 @@ This reference describes all available configurations that can be set via the co
       `Webgen::Source::FileSystem`) and `ARG1`, `ARG2` and so on are the parameters for the source
       class. The supported parameters can be found in the documentation for each source class.
-    * Examples:
+    * Example for setting the option in the configuration file:
           sources: [[/, Webgen::Source::FileSystem, src], [/, Webgen::Source::FileSystem, /mnt/pictures, **/*.jpg]
@@ -113,7 +130,7 @@ This reference describes all available configurations that can be set via the co
       `Webgen::Output::FileSystem`) and `ARG1`, `ARG2` and so on are the parameters for the output
       class. The supported parameters can be found in the documentation for each output class.
-    * Examples:
+    * Example for setting the option in the configuration file:
           output: [Webgen::Output::FileSystem, custom_out]
@@ -121,15 +138,23 @@ This reference describes all available configurations that can be set via the co
 *   ### 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
-    (e.g. `ext/init.rb`) because otherwise the default entries would be overwritten.
+    option is not normally set directly in the configuration file but either in an extension file
+    (e.g. `ext/init.rb`) or using a [configuration file helper]({relocatable:
+    manual.html#website-configfile}) because otherwise the default entries would be overwritten.
     * Syntax: `\{NAME: [PATTERN, PATTERN, ...], ...}` where `NAME` is the
       name the name of a source handler and `PATTERN` are one or more path patterns.
-    * Examples (for `ext/init.rb`):
+    * Example for setting the option in `ext/init.rb`:
+          config = Webgen::WebsiteAccess.website.config
+          config['sourcehandler.patterns']['Webgen::SourceHandler::Copy'] << '**/*.swf'
+      Example for setting the option via the configuration file helper in the configuration file:
-          config.sourcehandler.patterns['Webgen::SourceHandler::Copy'] << '**/*.swf'
+          patterns:
+            Copy:
+              add: [**/*.swf]
 *   ### sourcehandler.invoke
@@ -141,9 +166,10 @@ This reference describes all available configurations that can be set via the co
       invocation (source handlers with a lower `ORDER` setting are executed earlier than ones with a
       higher `ORDER` setting) and `NAME` is the name of a source handler.
-    * Examples (for `ext/init.rb`):
+    * Example for setting the option in `ext/init.rb`:
-          config.sourcehandler.invoke[5] << 'Extension::MyNewSourceHandler'
+          config = Webgen::WebsiteAccess.website.config
+          config['sourcehandler.invoke'][5] << 'Extension::MyNewSourceHandler'
 *   ### sourcehandler.casefold
@@ -153,7 +179,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
           sourcehandler.casefold: true
@@ -164,7 +190,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
           sourcehandler.use_hidden_files: true
@@ -176,7 +202,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `[PATTERN, ...]` where `PATTERN` is a valid path pattern.
-    * Examples:
+    * Example for setting the option in the configuration file:
           sourcehandler.ignore: [**/*~, **/CVS/**]
@@ -188,7 +214,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
           sourcehandler.default_lang_in_output_path: true
@@ -202,7 +228,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `\{NAME: {MI_KEY: MI_VALUE, ...}, ...}` where `NAME` is either the name of a source
       handler or the special key `:all` which sets default meta info for all source handlers.
-    * Examples:
+    * Example for setting the option in the configuration file:
           default_meta_info:
             :all:
@@ -218,7 +244,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `PATH` where `PATH` is the absolute localized canonical name of the default template.
-    * Examples:
+    * Example for setting the option in the configuration file:
           sourcehandler.template.default_template: other.template
@@ -235,8 +261,9 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `\{SHORT: NAME, ...}` where `SHORT` is the short name of the content processor class
       `NAME`.
-    * Examples (for `ext/init.rb`):
+    * Examples for setting the option in `ext/init.rb`:
+          config = Webgen::WebsiteAccess.website.config
           config['contentprocessor.map']['newcp'] = 'Extension::MyNewContentProcessor'
@@ -247,7 +274,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
           contentprocessor.erubis.use_pi: true
@@ -260,7 +287,7 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `\{KEY: VALUE, ...}` where `KEY` and `VALUE` are key-value pairs of options where
       `KEY` needs to be a Symbol and not a String.
-    * Examples:
+    * Example for setting the option in the configuration file:
           contentprocessor.erubis.options: {:trim: true}
@@ -272,10 +299,9 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `PREFIX` where `PREFIX` is the prefix name.
-    * Examples:
+    * Example for setting the option in the configuration file:
           contentprocessor.tags.prefix: webgen
-          contentprocessor.tags.prefix: tag
 *   ### contentprocessor.tags.map
@@ -286,16 +312,18 @@ This reference describes all available configurations that can be set via the co
     * Syntax: `\{SHORT: NAME, ...}` where `SHORT` is the short name of the tag class `NAME`.
-    * Examples (for `ext/init.rb`):
+    * Example for setting the option in `ext/init.rb`:
+          config = Webgen::WebsiteAccess.website.config
           config['contentprocessor.tags.map']['highlight'] = 'Extension::MyHighlightingTag'
 ## Tag Specific Options
 These options are not normally set in the configuration file but given directly as options to the
-respective tag classes. Therefore, all examples in this section show the use of these options in
-files in Webgen Page Format.
+respective tag classes. Therefore, all options described in this section have an example which shows
+how to use the option in files in Webgen Page Format and most options also have an example which
+shows how to set the option in the configuration file.
 *   ### tag.breadcrumbtrail.separator
@@ -305,7 +333,11 @@ files in Webgen Page Format.
     * Syntax: `SEPARATOR` where `SEPARATOR` is a string (special HTML characters need to be properly
       escaped)
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.breadcrumbtrail.separator: '---'
+      Example for setting the option directly in a tag:
           Breadcrumb trail with different separator: \{breadcrumb_trail: {separator: ' --- '}}
@@ -316,7 +348,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.breadcrumbtrail.omit_index_path: true
+      Example for setting the option directly in a tag:
           Breadcrumb trail with index path omitted: \{breadcrumb_trail: {omit_index_path: true}}
@@ -337,7 +373,11 @@ files in Webgen Page Format.
     * Syntax: `INTEGER` where `INTEGER` is any integer number
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.breadcrumbtrail.start_level: 2
+      Example for setting the option directly in a tag:
           Breadcrumb trail starting at level 2: \{breadcrumb_trail: {start_level: 2}}
@@ -349,7 +389,11 @@ files in Webgen Page Format.
     * Syntax: `INTEGER` where `INTEGER` is any integer number
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.breadcrumbtrail.end_level: 2
+      Example for setting the option directly in a tag:
           Breadcrumb trail ending at level 2: \{breadcrumb_trail: {end_level: 2}}
@@ -360,7 +404,11 @@ files in Webgen Page Format.
     * Syntax: `LANG` where `LANG` is one of <%= (require 'coderay'; CodeRay::Scanners.list.map {|n| '`' + n + '`'}.join(', ')) %>.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.lang: ruby
+      Example for setting the option directly in a tag:
           highlighting some ruby code \{coderay:: ruby}puts 5 + 5{coderay}
@@ -371,7 +419,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.process_body: false
+      Example for setting the option directly in a tag:
           wrapping in a span: \{coderay:: {lang: ruby, process_body: false}}puts 5 + 5{coderay}
@@ -382,7 +434,11 @@ files in Webgen Page Format.
     * Syntax: `WRAP` where `WRAP` is either `div` or `span`
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.wrap: span
+      Example for setting the option directly in a tag:
           wrapping in a span: \{coderay:: {lang: ruby, wrap: span}}puts 5 + 5{coderay}
@@ -393,7 +449,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.line_numbers: false
+      Example for setting the option directly in a tag:
           not showing line numbers: \{coderay:: {lang: ruby, line_numbers: false}}puts 5 + 5{coderay}
@@ -404,7 +464,11 @@ files in Webgen Page Format.
     * Syntax: `NUMBER` where `NUMBER` is an integer value.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.line_number_start: 4
+      Example for setting the option directly in a tag:
           starting with line 4: \{coderay:: {lang: ruby, line_number_start: 4}}puts 5 + 5{coderay}
@@ -415,7 +479,11 @@ files in Webgen Page Format.
     * Syntax: `NUMBER` where `NUMBER` is an integer value.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.bold_every: 2
+      Example for setting the option directly in a tag:
           every other line bold: \{coderay:: {lang: ruby, bold_every: 2}}puts 5 + 5{coderay}
@@ -426,7 +494,11 @@ files in Webgen Page Format.
     * Syntax: `NUMBER` where `NUMBER` is an integer value.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.coderay.tab_width: 4
+      Example for setting the option directly in a tag:
           tabulator == 4 spaces: \{coderay:: {lang: ruby, tab_width: 4}}puts 5 + 5{coderay}
@@ -439,7 +511,11 @@ files in Webgen Page Format.
     * Syntax: `FORMAT` where `FORMAT` is a string.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.date.format: '%Y-%m-%d'
+      Example for setting the option directly in a tag:
           very short date format: \{date: {format: '%Y-%m-%d'}}
@@ -451,7 +527,7 @@ files in Webgen Page Format.
     * Syntax: `COMMAND` where `COMMAND` is the to-be-executed command.
-    * Examples:
+    * Example for setting the option directly in a tag:
           executing a simple command \{exeucte_cmd: echo hallo}
@@ -463,7 +539,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.executecommand.process_output: false
+      Example for setting the option directly in a tag:
           executing command without further processing \{execute_cmd: {command: 'echo hallo', process_output: false}}
@@ -474,7 +554,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.executecommand.escape_html: false
+      Example for setting the option directly in a tag:
           executing command, output not escaped \{execute_cmd: {command: 'echo hallo', escape_html: false}}
@@ -487,7 +571,7 @@ files in Webgen Page Format.
     * Syntax: `FILENAME` where `FILENAME` is the name of a file
-    * Examples:
+    * Example for setting the option directly in a tag:
           including a file \{include_file: my_file.txt}
@@ -499,7 +583,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.includefile.process_output: false
+      Example for setting the option directly in a tag:
           including a file without further processing \{include_file: {filename: my_file.txt, process_output: false}}
@@ -510,7 +598,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.includefile.escape_html: false
+      Example for setting the option directly in a tag:
           including a file without escaping \{include_file: {filename: my_file.txt, escape_html: false}}
@@ -522,7 +614,11 @@ files in Webgen Page Format.
     * Syntax: `SEPARATOR` where `SEPARATOR` is a string (special HTML characters need to be properly
       escaped)
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.langbar.separator: ' --- '
+      Example for setting the option directly in a tag:
           Langbar with another separator: \{langbar: {separator: ' --- '}}
@@ -533,7 +629,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.langbar.show_own_lang: false
+      Example for setting the option directly in a tag:
           Langbar with current page's lang not shown: \{langbar: {show_own_lang: false}}
@@ -545,7 +645,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.langbar.show_single_lang: false
+      Example for setting the option directly in a tag:
           Langbar with single language not shown: \{langbar: {show_single_lang: false}}
@@ -558,11 +662,43 @@ files in Webgen Page Format.
     * Syntax: `\{CODE: NAME, ...}` where `CODE` is a language code and `NAME` the associated language
       name of the code.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.langbar.lang_names: \{de: Deutsch, en: English}
+      Example for setting the option directly in a tag:
           Langbar with custom language names: \{langbar: {lang_names: {de: Deutsch, en: English}}}
+*   ### tag.link.path
+    The default mandatory configuration option for Tag::Link that specifies the (AL)CN path to which
+    should be linked.
+    * Syntax: `PATH` where `PATH` is an (absolute) (localized) canonical name.
+    * Example for setting the option directly in a tag:
+          You will find more information on the \{link: docu.html} page!
+*   ### tag.link.attr
+    Specifies additional HTML attributes that should be set on the link generated by Tag::Link.
+    * Syntax: `\{NAME: VALUE, ...}` where `NAME` is a valid HTML attribute name and `VALUE` its
+      value.
+    * Example for setting the option in the configuration file:
+          tag.link.attr: \{title: DocuPage}
+      Example for setting the option directly in a tag:
+          You will find more info on the \{link: {path: docu.html, attr: {title: DocuPage}}} page!
 *   ### tag.menu.used\_nodes
     Specifies the type of nodes that should be used for menu generation. If `all` is specified then
@@ -572,7 +708,11 @@ files in Webgen Page Format.
     * Syntax: `TYPE` where `TYPE` is one of `all`, `files` or `fragments`
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.menu.used_nodes: fragments
+      Example for setting the option directly in a tag:
           Show the fragment node menu: \{menu: {used_nodes: fragments}}
@@ -584,7 +724,11 @@ files in Webgen Page Format.
     * Syntax: `LEVEL` where `LEVEL` is a number that is greater or equal to one.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.menu.start_level: 2
+      Example for setting the option directly in a tag:
           Menu starting at level 2: \{menu: {start_level: 2}}
@@ -596,7 +740,11 @@ files in Webgen Page Format.
     * Syntax: `LEVEL` where `LEVEL` is a number that is greater or equal to one.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.menu.min_levels: 2
+      Example for setting the option directly in a tag:
           Menu that always shows at least 2 levels : \{menu: {min_levels: 2}}
@@ -608,7 +756,11 @@ files in Webgen Page Format.
     * Syntax: `LEVEL` where `LEVEL` is a number that is greater or equal to one.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.menu.max_levels: 2
+      Example for setting the option directly in a tag:
           Menu that always shows at most 2 levels : \{menu: {max_levels: 2}}
@@ -621,7 +773,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.menu.show_current_subtree_only: false
+      Example for setting the option directly in a tag:
           Showing all subtrees: \{menu: {show_current_subtree_only: false}}
@@ -654,7 +810,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.menu.nested: false
+      Example for setting the option directly in a tag:
           Don't use nested lists: \{menu: {nested: false}}
@@ -662,12 +822,11 @@ files in Webgen Page Format.
 *   ### 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
-    Webgen::Tag::Relocatable.
+    should be made relocatable.
     * Syntax: `PATH` where `PATH` is a (localized) canonical name.
-    * Examples:
+    * Example for setting the option directly in a tag:
           <a href="\{relocatable: ../features.html}">Some Path</a>
@@ -680,7 +839,7 @@ files in Webgen Page Format.
     * Syntax: `PATH` where `PATH` is a relative or absolute source path.
-    * Examples:
+    * Example for setting the option directly in a tag:
           \{tikz:: images/tikz.png}\tikz \draw (0,0) -- (0,2);{tikz}
@@ -692,7 +851,11 @@ files in Webgen Page Format.
     * Syntax: `[NAME, ...]` where `NAME` is the name of a TikZ library.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.tikz.libraries: [mindmap, arrows]
+      Example for setting the option directly in a tag:
           \{tikz:: {path: images/tikz.png, libraries: [mindmap, arrows]}}
           \tikz \draw (0,0) -- (0,2) -- (2,2);
@@ -705,7 +868,11 @@ files in Webgen Page Format.
     * Syntax: `OPTS` where `OPTS` is the string with the global options.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.tikz.opts: 'scale=3, line cap=round'
+      Example for setting the option directly in a tag:
           \{tikz:: {path: images/tikz.png, opts: 'scale=3, line cap=round'}}
           \tikz \draw (0,0) -- (0,2) -- (2,2);
@@ -722,7 +889,11 @@ files in Webgen Page Format.
     * Syntax: `RENDER_RES OUTPUT_RES` where `RENDER_RES` is the integer specifying the render
       resolution and `OUTPUT_RES` is the integer specifying the output resolution.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.tikz.resolution: 300 72
+      Example for setting the option directly in a tag:
           \{tikz:: {path: images/tikz.png, resolution: 300 72}}
           \tikz \draw (0,0) -- (0,2) -- (2,2);
@@ -737,7 +908,11 @@ files in Webgen Page Format.
     * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.tikz.transparent: true
+      Example for setting the option directly in a tag:
           \{tikz:: {path: images/tikz.png, transparent: true}}
           \tikz \draw (0,0) -- (0,2) -- (2,2);
@@ -751,7 +926,11 @@ files in Webgen Page Format.
     * Syntax: `\{KEY:VALUE, ...}` where `KEY` is a valid HTML `img` tag attribute name and `VALUE`
       the to-be-set value.
-    * Examples:
+    * Example for setting the option in the configuration file:
+          tag.tikz.img_attr: \{alt: Some TikZ picture}
+      Example for setting the option directly in a tag:
           \{tikz:: {path: images/tikz.png, img_attr: {alt: Some TikZ picture}}}
           \tikz \draw (0,0) -- (0,2) -- (2,2);

data/doc/tag/link.page ADDED Viewed

@@ -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/lib/webgen/cli.rb CHANGED Viewed

@@ -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/configuration.rb CHANGED Viewed

@@ -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/default_config.rb CHANGED Viewed

@@ -150,6 +150,7 @@ config.contentprocessor.tags.map({
                                    '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')
@@ -200,6 +201,9 @@ config.tag.tikz.resolution('72 72', :doc => 'A string specifying the render and
 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')

data/lib/webgen/sourcehandler/base.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require 'facets/symbol/to_proc'
 require 'webgen/websiteaccess'
 require 'webgen/loggable'
 require 'webgen/page'
@@ -163,7 +164,7 @@ module Webgen::SourceHandler
                         Webgen::WebsiteAccess.website.config['sourcehandler.default_lang_in_output_path'] ||
                           Webgen::WebsiteAccess.website.config['website.lang'] != path.meta_info['lang']
                       end
-      if OutputPathHelpers.public_instance_methods(false).include?(method)
+      if OutputPathHelpers.public_instance_methods(false).map(&:to_s).include?(method)
         name = send(method, parent, path, use_lang_part)
         name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
         if (node = node_exists?(parent, path, name)) && node.lang == path.meta_info['lang']

data/lib/webgen/tag.rb CHANGED Viewed

@@ -18,6 +18,7 @@ module Webgen
     autoload :Date, 'webgen/tag/date'
     autoload :Sitemap, 'webgen/tag/sitemap'
     autoload :TikZ, 'webgen/tag/tikz'
+    autoload :Link, 'webgen/tag/link'
   end

data/lib/webgen/tag/link.rb ADDED Viewed

@@ -0,0 +1,23 @@
+module Webgen::Tag
+  # Create a link to a given (A)LCN.
+  class Link
+    include Webgen::Tag::Base
+    # Return a HTML link to the given (A)LCN.
+    def call(tag, body, context)
+      if (dest_node = context.ref_node.resolve(param('tag.link.path'), context.dest_node.lang))
+        context.dest_node.link_to(dest_node, param('tag.link.attr').merge(:lang => context.content_node.lang))
+      else
+        raise ArgumentError, 'Resolving of path failed'
+      end
+    rescue ArgumentError, URI::InvalidURIError => e
+      log(:error) { "Could not link to path '#{param('tag.link.path')}' in <#{context.ref_node.absolute_lcn}>: #{e.message}" }
+      context.dest_node.flag(:dirty)
+      ''
+    end
+  end
+end

data/lib/webgen/version.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 module Webgen
   # The version of webgen.
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 end

data/lib/webgen/website.rb CHANGED Viewed

@@ -2,6 +2,7 @@
 require 'logger'
 require 'set'
 require 'fileutils'
+require 'facets/symbol/to_proc'
 # Requirements for Website
 require 'webgen/coreext'
@@ -197,7 +198,7 @@ module Webgen
           raise 'Structure of config file is not valid, has to be a Hash' if !config.kind_of?(Hash)
           config.each do |key, value|
             case key
-            when *Webgen::Configuration::Helpers.public_instance_methods(false) then @config.send(key, value)
+            when *Webgen::Configuration::Helpers.public_instance_methods(false).map(&:to_s) then @config.send(key, value)
             else @config[key] = value
             end
           end

data/test/test_cli.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'webgen/cli'
+class TestCLICommandParser < Test::Unit::TestCase
+  def test_initialize
+    cli = Webgen::CLI::CommandParser.new
+    assert_equal('render', cli.main_command.default_command)
+    assert_equal(:normal, cli.verbosity)
+    assert_equal(Logger::WARN, cli.log_level)
+    assert_equal(Dir.pwd, cli.directory)
+  end
+end

data/test/test_node.rb CHANGED Viewed

@@ -203,9 +203,8 @@ class TestNode < Test::Unit::TestCase
     node.unflag(:dirty_meta_info)
     node.node_info[:used_meta_info_nodes] << node.absolute_lcn
     node.node_info[:used_meta_info_nodes] << 'unknown alcn'
-    node.node_info[:used_meta_info_nodes] << @tree.dummy_root.absolute_lcn
     assert(node.meta_info_changed?)
-    assert_equal(2, calls)
+    assert_equal(1, calls)
   end
   def test_method_missing

data/test/test_tag_link.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require 'test/unit'
+require 'helper'
+require 'webgen/tree'
+require 'webgen/contentprocessor'
+require 'webgen/tag'
+class TestTagLink < Test::Unit::TestCase
+  include Test::WebsiteHelper
+  def setup
+    super
+    @obj = Webgen::Tag::Link.new
+  end
+  def call(context)
+    @obj.call('link', '', context)
+  end
+  def test_call
+    root = Webgen::Node.new(Webgen::Tree.new.dummy_root, '/', '/')
+    node = Webgen::Node.new(root, '/file.html', 'file.html', {'lang' => 'en'})
+    dir = Webgen::Node.new(root, '/dir/', 'dir/', 'index_path' => "index.html")
+    file = Webgen::Node.new(dir, '/dir/file.html', 'file.html', {'lang' => 'en', 'title' => 'Dir/File'})
+    Webgen::Node.new(dir, '/dir/other.de.html', 'other.html', {'lang' => 'de'})
+    Webgen::Node.new(file, '/dir/file.html#fragment', '#fragment')
+    dir2 = Webgen::Node.new(root, '/dir2/', 'dir2/', 'index_path' => "index.html")
+    Webgen::Node.new(dir2, '/dir2/index.html', 'index.html')
+    context = Webgen::ContentProcessor::Context.new(:chain => [node])
+    # no path set
+    node.unflag(:dirty)
+    @obj.set_params('tag.link.path' => nil)
+    assert_equal('', call(context))
+    assert(node.flagged(:dirty))
+    # invalid paths
+    @obj.set_params('tag.link.path' => ':/asdf=-)')
+    assert_equal('', call(context))
+    # basic node resolving
+    @obj.set_params('tag.link.path' => 'dir/file.html')
+    assert_equal('<a href="dir/file.html">Dir/File</a>', call(context))
+    @obj.set_params('tag.link.path' => 'dir/file.html', 'tag.link.attr' => {'title' => 'other'})
+    assert_equal('<a href="dir/file.html" title="other">Dir/File</a>', call(context))
+    @obj.set_params('tag.link.path' => 'dir/other.html')
+    assert_equal('', call(context))
+    # non-existing fragments
+    @obj.set_params('tag.link.path' => 'file.html#hallo')
+    assert_equal('', call(context))
+    # directory paths
+    @obj.set_params('tag.link.path' => 'dir')
+    assert_equal('<a href="dir/"></a>', call(context))
+    @obj.set_params('tag.link.path' => 'dir2')
+    assert_equal('<a href="dir2/index.html"></a>', call(context))
+  end
+end

data/test/test_tree.rb CHANGED Viewed

@@ -13,11 +13,13 @@ class TestTree < Test::Unit::TestCase
   def test_initialize
     assert_not_nil(@tree.dummy_root)
+    assert_equal('', @tree.dummy_root.absolute_lcn)
   end
   def test_root
     root = Webgen::Node.new(@tree.dummy_root, '/', '/')
     assert_equal(root, @tree.root)
+    assert_equal('/', root.absolute_lcn)
   end
   def test_register_node_and_register_path

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gettalong-webgen
 version: !ruby/object:Gem::Version
-  version: 0.5.5.20081012
+  version: 0.5.6.20081020
 platform: ruby
 authors:
 - Thomas Leitner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2008-10-11 15:00:00 -07:00
+date: 2008-10-19 15:00:00 -07:00
 default_executable: webgen
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -395,6 +395,7 @@ files:
 - doc/tag/executecommand.page
 - doc/tag/includefile.page
 - doc/tag/langbar.page
+- doc/tag/link.page
 - doc/tag/menu.page
 - doc/tag/metainfo.page
 - doc/tag/relocatable.page
@@ -460,6 +461,7 @@ files:
 - lib/webgen/tag/executecommand.rb
 - lib/webgen/tag/includefile.rb
 - lib/webgen/tag/langbar.rb
+- lib/webgen/tag/link.rb
 - lib/webgen/tag/menu.rb
 - lib/webgen/tag/metainfo.rb
 - lib/webgen/tag/relocatable.rb
@@ -486,6 +488,7 @@ files:
 - misc/images/quote.gif
 - test/test_blackboard.rb
 - test/test_cache.rb
+- test/test_cli.rb
 - test/test_common_sitemap.rb
 - test/test_configuration.rb
 - test/test_contentprocessor.rb
@@ -530,6 +533,7 @@ files:
 - test/test_tag_executecommand.rb
 - test/test_tag_includefile.rb
 - test/test_tag_langbar.rb
+- test/test_tag_link.rb
 - test/test_tag_menu.rb
 - test/test_tag_metainfo.rb
 - test/test_tag_relocatable.rb