gettalong-webgen 0.5.4.20080929 → 0.5.5.20081001

data/Rakefile

@@ -135,6 +135,7 @@ EOF
       s.summary = SUMMARY
       s.description = DESCRIPTION
       s.post_install_message = <<EOF
+
 Thanks for choosing webgen! Here are some places to get you started:
 * The webgen User Documentation at <http://webgen.rubyforge.org/documentation/index.html>
 * The mailing list archive at <http://rubyforge.org/pipermail/webgen-users/>
@@ -142,28 +143,29 @@ Thanks for choosing webgen! Here are some places to get you started:
 Have a look at <http://webgen.rubyforge.org/news/index.html> for a list of changes!
 
 Have fun!
+
 EOF
 
       #### Dependencies, requirements and files
 
       s.files = PKG_FILES.to_a
-      s.add_dependency('cmdparse', '~> 2.0.0')
-      s.add_dependency('maruku', '>= 0.5.6')
-      s.add_dependency('facets', '>= 2.4.3')
-      s.add_dependency('rake', '>= 0.8.0')
+      s.add_dependency('cmdparse', '2.0.2')
+      s.add_dependency('maruku', '0.5.9')
+      s.add_dependency('facets', '2.4.3')
+      s.add_dependency('rake', '0.8.3')
       s.add_dependency('ramaze', '2008.06')
-      s.add_dependency('launchy', '>= 0.3.2')
-      s.add_development_dependency('rcov', '>= 0.8.0')
-      s.add_development_dependency('dcov', '>= 0.2.2')
-      s.add_development_dependency('rubyforge', '>= 1.0.0')
-      s.add_development_dependency('RedCloth', '>= 3.0.0')
-      s.add_development_dependency('haml', '>= 2.0.1')
-      s.add_development_dependency('builder', '>= 2.1.0')
-      s.add_development_dependency('rdoc', '>= 2.0.0')
-      s.add_development_dependency('coderay', '>= 0.7.4.215')
-      s.add_development_dependency('feedtools', '>= 0.2.29')
-      s.add_development_dependency('erubis', '>= 2.6.2')
-      s.add_development_dependency('rdiscount', '>= 1.2.9')
+      s.add_dependency('launchy', '0.3.2')
+      s.add_development_dependency('rcov', '0.8.1.2.0')
+      s.add_development_dependency('dcov', '0.2.2')
+      s.add_development_dependency('rubyforge', '1.0.0')
+      s.add_development_dependency('RedCloth', '3.0.0')
+      s.add_development_dependency('haml', '2.0.1')
+      s.add_development_dependency('builder', '2.1.2')
+      s.add_development_dependency('rdoc', '2.0.0')
+      s.add_development_dependency('coderay', '0.7.4.215')
+      s.add_development_dependency('feedtools', '0.2.29')
+      s.add_development_dependency('erubis', '2.6.2')
+      s.add_development_dependency('rdiscount', '1.2.9')
 
       s.require_path = 'lib'
 
@@ -193,6 +195,19 @@ EOF
       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.post_install_message = "
+
+
+WARNING: This is an unsupported BETA version of webgen which may
+still contain bugs!
+
+The official version is called 'webgen' and can be installed via
+
+    gem install webgen
+
+
+
+"
       File.open('webgen.gemspec', 'w+') {|f| f.write(spec.to_yaml)}
     end
 

data/doc/reference_configuration.page

@@ -613,6 +613,39 @@ files in Webgen Page Format.
           Showing all subtrees: \{menu: {show_current_subtree_only: false}}
 
 
+*   ### tag.menu.nested
+
+    Specifies whether the generated menu should contain nested lists, ie. whether sub menus are
+    put inline
+
+        ul           1
+          li         2
+            ul       3
+              li     4
+              li     5
+          li         6
+
+    or separately following the previous menu level
+
+        ul           1
+          li         2
+          li         6
+        ul           3
+          li         4
+          li         5
+
+    > When this option is enabled you should enable the option
+    > `tag.menu.show_current_subtree_only`. Otherwise the generated menu will look a little bit
+    > confusing.
+    {.information}
+
+    * Syntax: `BOOLEAN` where `BOOLEAN` is either `true` or `false`.
+
+    * Examples:
+
+          Don't use nested lists: \{menu: {nested: false}}
+
+
 *   ### tag.relocatable.path
 
     The default mandatory configuration option for Tag::Relocatable that specifies the path that

data/doc/tag/menu.page

@@ -6,6 +6,7 @@ used_options:
   - tag.menu.min_levels
   - tag.menu.max_levels
   - tag.menu.show_current_subtree_only
+  - tag.menu.nested
 ---
 ## Description
 
@@ -40,6 +41,15 @@ follows:
   sub tree of the rendered node.
 * `webgen-menu-item-selected`: Set if the menu item corresponds to the rendered node.
 
+The option `tag.menu.nested` decides whether a nested menu or a non-nested is generated. When
+setting this option to `false` you need to ensure that `tag.menu.show_current_subtree_only` is set
+to `true` and `tag.menu.min_levels` is set to `1`. Both ensure that no other subtree obfuscates the
+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}
+
 ## "Static" Menus
 
 It is also possible to define a "static" menu or to augment the dynamic menu with static entries by
@@ -89,4 +99,8 @@ setting `in_menu` for any other node.
   <td>\{menu: {used_nodes: fragments}}</td>
   <td>{menu: {used_nodes: fragments}}</td>
 </tr>
+<tr>
+  <td>\{menu: {used_nodes: all, nested: false}}</td>
+  <td>{menu: {used_nodes: all, nested: false}}</td>
+</tr>
 </table>

data/lib/webgen/default_config.rb

@@ -161,6 +161,7 @@ config.tag.menu.min_levels(1, :doc => 'The minimum number of menu levels that sh
 config.tag.menu.max_levels(3, :doc => 'The maximum number of menu levels that should be shown.')
 config.tag.menu.show_current_subtree_only(true, :doc => 'Specifies whether only the current subtree should be shown.')
 config.tag.menu.used_nodes('all', :doc => 'Specifies the kind of nodes that should be used: all, files, or fragments')
+config.tag.menu.nested(true, :doc => 'Specifies whether a nested menu list should be generated.')
 
 config.tag.breadcrumbtrail.separator(' / ', :doc => 'Separates the hierachy entries from each other.')
 config.tag.breadcrumbtrail.omit_index_path(false, :doc => 'Omits the last path component if it is an index path.')

data/lib/webgen/tag/menu.rb

@@ -59,7 +59,14 @@ module Webgen::Tag
       tree = specific_menu_tree_for(context.content_node)
 
       (context.dest_node.node_info[:tag_menu_menus] ||= {})[[@params.to_a.sort, context.content_node.absolute_lcn]] = (tree ? tree.to_lcn_list : nil)
-      (tree && !tree.children.empty? ? create_output(context, tree) : '')
+
+      if !tree || tree.children.empty?
+        ''
+      elsif param('tag.menu.nested')
+        create_output_nested(context, tree)
+      else
+        create_output_not_nested(context, tree)
+      end
     end
 
     #########
@@ -127,11 +134,11 @@ module Webgen::Tag
       end
     end
 
-    # Create the HTML menu of the +tree+ using the provided +context+.
-    def create_output(context, tree, level = 1)
+    # Create the nested HTML menu of the +tree+ using the provided +context+.
+    def create_output_nested(context, tree, level = 1)
       out = "<ul>"
       tree.children.each do |child|
-        menu = child.children.length > 0 ? create_output(context, child, level + 1) : ''
+        menu = child.children.length > 0 ? create_output_nested(context, child, level + 1) : ''
         style, link = menu_item_details(context.dest_node, child.node, context.content_node.lang, level)
 
         out << "<li #{style}>#{link}"
@@ -142,6 +149,21 @@ module Webgen::Tag
       out
     end
 
+    # Create the not nested HTML menu of the +tree+ using the provided +context+.
+    def create_output_not_nested(context, tree, level = 1)
+      submenu = ''
+      out = "<ul>"
+      tree.children.each do |child|
+        submenu << (child.children.length > 0 ? create_output_not_nested(context, child, level + 1) : '')
+        style, link = menu_item_details(context.dest_node, child.node, context.content_node.lang, level)
+
+        out << "<li #{style}>#{link}</li>"
+      end
+      out << "</ul>"
+      out << submenu
+      out
+    end
+
     # Return style information (node is selected, ...) and a link from +dest_node+ to +node+.
     def menu_item_details(dest_node, node, lang, level)
       styles = ['webgen-menu-level' + level.to_s]

data/lib/webgen/version.rb

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

data/test/test_tag_menu.rb

@@ -66,6 +66,16 @@ class TestTagMenu < Test::Unit::TestCase
                  "<li class=\"webgen-menu-level1 webgen-menu-submenu\"><a href=\"../../dir2/\"></a></li>" +
                  "<li class=\"webgen-menu-level1 webgen-menu-submenu\"><a href=\"../../dir3/\"></a></li></ul>", output)
 
+    @obj.set_params('tag.menu.nested' => false)
+    output = @obj.call('menu', '', Webgen::ContentProcessor::Context.new(:chain => [nodes[:index11_en]]))
+    @obj.set_params({})
+    assert_equal("<ul><li class=\"webgen-menu-level1 webgen-menu-submenu webgen-menu-submenu-inhierarchy\"><a href=\"../\"></a></li>" +
+                 "<li class=\"webgen-menu-level1 webgen-menu-submenu\"><a href=\"../../dir2/\"></a></li>" +
+                 "<li class=\"webgen-menu-level1 webgen-menu-submenu\"><a href=\"../../dir3/\"></a></li></ul>" +
+                 "<ul><li class=\"webgen-menu-level2 webgen-menu-submenu webgen-menu-submenu-inhierarchy\"><span></span></li>" +
+                 "<li class=\"webgen-menu-level2\"><a href=\"../file11.en.html\"></a></li></ul>" +
+                 "<ul><li class=\"webgen-menu-level3\"><a href=\"file111.en.html\"></a></li>" +
+                 "<li class=\"webgen-menu-level3 webgen-menu-item-selected\"><span></span></li></ul>", output)
 
     @obj.set_params('tag.menu.used_nodes' => 'fragments')
     output = @obj.call('menu', '', Webgen::ContentProcessor::Context.new(:chain => [nodes[:file11_en]]))
@@ -189,7 +199,7 @@ class TestTagMenu < Test::Unit::TestCase
                  "<ul><li class=\"webgen-menu-level2\"><a href=\"../../dir2/file21.en.html\"></a></li></ul></li>" +
                  "<li class=\"webgen-menu-level1 webgen-menu-submenu\"><a href=\"../../dir3/\"></a>" +
                  "<ul><li class=\"webgen-menu-level2\"><a href=\"../../dir3/file31.en.html\"></a></li></ul></li></ul>",
-                 @obj.send(:create_output, context, tree))
+                 @obj.send(:create_output_nested, context, tree))
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gettalong-webgen
 version: !ruby/object:Gem::Version 
-  version: 0.5.4.20080929
+  version: 0.5.5.20081001
 platform: ruby
 authors: 
 - Thomas Leitner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-28 15:00:00 -07:00
+date: 2008-09-30 15:00:00 -07:00
 default_executable: webgen
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: 2.0.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: maruku
@@ -28,9 +28,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 0.5.6
+        version: 0.5.9
     version: 
 - !ruby/object:Gem::Dependency 
   name: facets
@@ -38,7 +38,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 2.4.3
     version: 
@@ -48,9 +48,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 0.8.0
+        version: 0.8.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: ramaze
@@ -68,7 +68,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 0.3.2
     version: 
@@ -78,9 +78,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 0.8.0
+        version: 0.8.1.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: dcov
@@ -88,7 +88,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 0.2.2
     version: 
@@ -98,7 +98,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
@@ -108,7 +108,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 3.0.0
     version: 
@@ -118,7 +118,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 2.0.1
     version: 
@@ -128,9 +128,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 2.1.0
+        version: 2.1.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: rdoc
@@ -138,7 +138,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 2.0.0
     version: 
@@ -148,7 +148,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 0.7.4.215
     version: 
@@ -158,7 +158,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 0.2.29
     version: 
@@ -168,7 +168,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 2.6.2
     version: 
@@ -178,7 +178,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
@@ -535,15 +535,19 @@ files:
 - test/helper.rb
 has_rdoc: true
 homepage: http://webgen.rubyforge.org
-post_install_message: |
-  Thanks for choosing webgen! Here are some places to get you started:
-  * The webgen User Documentation at <http://webgen.rubyforge.org/documentation/index.html>
-  * The mailing list archive at <http://rubyforge.org/pipermail/webgen-users/>
+post_install_message: |+
+  
+  
+  
+  WARNING: This is an unsupported BETA version of webgen which may
+  still contain bugs!
+  
+  The official version is called 'webgen' and can be installed via
+  
+      gem install webgen
+  
   
-  Have a look at <http://webgen.rubyforge.org/news/index.html> for a list of changes!
   
-  Have fun!
-
 rdoc_options: 
 - --line-numbers
 - --inline-source