webgen 0.3.3 → 0.3.4

data/lib/webgen/plugins/filehandler/picturegallery.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: picturegallery.rb 249 2005-04-13 19:23:51Z thomas $
+# $Id: picturegallery.rb 274 2005-05-11 12:52:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -33,7 +33,7 @@ module FileHandlers
     add_param "picturesPerPage", 20, 'Number of picture per gallery page'
     add_param "picturePageInMenu", false, 'True if the picture pages should be in the menu'
     add_param "galleryPageInMenu", false, 'True if the gallery pages should be in the menu'
-    add_param "galleryMenuOrder", 50, 'The <menuOrder> metainfo for the first gallery page. The second gallery page gets this value plus one, and so on.'
+    add_param "galleryOrderInfo", 50, 'The <orderInfo> metainfo for the first gallery page. The second gallery page gets this value plus one, and so on.'
     add_param "mainPageInMenu", true, 'True if the main page of the picture gallery should be in the menu'
     add_param "galleryPageTemplate", nil, 'The template for gallery pages. If nil or a not existing file is specified, the default template is used.'
     add_param "picturePageTemplate", nil, 'The template for picture pages. If nil or a not existing file is specified, the default template is used.'
@@ -123,7 +123,7 @@ module FileHandlers
         data['template'] ||= get_param( 'galleryPageTemplate' )
         data['inMenu'] ||= get_param( 'galleryPageInMenu' )
         data['number'] = i/picsPerPage + 1
-        data['menuOrder'] = get_param( 'galleryMenuOrder' ) + data['number']
+        data['orderInfo'] = get_param( 'galleryOrderInfo' ) + data['number']
         data['title'] = gallery_title( data['number'] )
         data['srcName'] = gallery_file_name( data['title'] )
         data['imageList'] = create_picture_pages( images[i..(i + picsPerPage - 1)], parent )
@@ -172,6 +172,7 @@ module FileHandlers
 
     class PictureGalleryFileHandler
 
+      remove_method :get_thumbnail
       def get_thumbnail( imageData, parent )
         p_node = Webgen::Plugin['DirHandler'].recursive_create_path( File.dirname( imageData['imageFilename'] ), parent )
         node = Webgen::Plugin['ThumbnailWriter'].create_node( File.join( @path, imageData['imageFilename'] ), p_node )

data/lib/webgen/plugins/filehandler/template.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: template.rb 249 2005-04-13 19:23:51Z thomas $
+# $Id: template.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -32,6 +32,8 @@ module FileHandlers
     add_param 'defaultTemplate', 'default.template', 'The default file name for the template file.'
     depends_on 'FileHandler'
 
+    used_meta_info 'template'
+
     def create_node( srcName, parent )
       node = Node.new( parent )
       node['title'] = 'Template'
@@ -68,7 +70,7 @@ module FileHandlers
     # Return the default template for +node+. If the template node is not found in the directory of
     # the node, the parent directories are searched.
     def get_default_template( node )
-      node = node.parent until node.kind_of?( FileHandlers::DirHandler::DirNode )
+      node = node.parent until node['int:directory?']
       templateNode = node.find { |child| child['src'] == get_param( 'defaultTemplate' ) }
       if templateNode.nil?
         if node.parent.nil?

data/lib/webgen/plugins/tags/langbar.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: langbar.rb 256 2005-04-14 01:13:57Z thomas $
+# $Id: langbar.rb 274 2005-05-11 12:52:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -39,7 +39,7 @@ module Tags
     end
 
     def process_tag( tag, node, refNode )
-      output = node.parent.find_all {|a| a['page:name'] == node['page:name']}.sort {|a, b| a['lang'] <=> b['lang']}.collect do |n|
+      output = node.parent.find_all {|a| a['int:pagename'] == node['int:pagename']}.sort {|a, b| a['lang'] <=> b['lang']}.collect do |n|
         n['processor'].get_html_link( n, n, n['lang'] )
       end.join( get_param( 'separator' ) )
       return ( get_param( 'showSingleLang' ) || node.parent.children.length > 1 ? output : "" )

data/lib/webgen/plugins/tags/menu.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: menu.rb 256 2005-04-14 01:13:57Z thomas $
+# $Id: menu.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -30,7 +30,7 @@ module Tags
   # one page file.
   #
   # The order in which the menu items are listed can be controlled via the meta information
-  # +menuOrder+. By default the menu items are sorted by the file names.
+  # +orderInfo+. By default the menu items are sorted by the file names.
   #
   # Tag parameters:
   # [<b>level</b>]
@@ -38,6 +38,39 @@ module Tags
   #   also displays the menu files in the direct subdirectories and so on.
   class MenuTag < DefaultTag
 
+    class ::Node
+
+      # Retrieves the meta information +orderInfo+.
+      def order_info
+        # be optimistic and try metainfo field first
+        node = self
+        value = node['orderInfo'].to_s.to_i unless node['orderInfo'].nil?
+
+        # get index file for directory
+        if node['int:directory?']
+          node = node['indexFile']
+          value ||= node['orderInfo'].to_s.to_i unless node.nil? || node['orderInfo'].nil?
+        end
+
+        # find the first orderInfo entry in the page files if node is a page file
+        if !node.nil? && node['int:pagename']
+          node = node.parent.find {|child| child['int:pagename'] == node['int:pagename'] && child['orderInfo'].to_s.to_i != 0}
+          value ||= node['orderInfo'].to_s.to_i unless node.nil?
+        end
+
+        # fallback value
+        value ||= 0
+
+        value
+      end
+
+      SORT_PROC = Proc.new do |a,b|
+        aoi = a.order_info
+        boi = b.order_info
+        (aoi == boi ? a['title'] <=> b['title'] : aoi <=> boi)
+      end
+
+    end
 
     # Specialised node class for the menu.
     class MenuNode < Node
@@ -52,28 +85,11 @@ module Tags
       end
 
 
-      # Sorts recursively all children of the node depending on their order value.
+      # Sorts recursively all children of the node depending on their order value. If two order
+      # values are equal, sort the items using their title.
       def sort!
-        self.children.sort! {|a,b| get_order_value( a ) <=> get_order_value( b )}
-        self.children.each {|child| child.sort! if child.kind_of?( MenuNode ) && child['node'].kind_of?( FileHandlers::DirHandler::DirNode )}
-      end
-
-
-      # Retrieves the order value for the specific node.
-      def get_order_value( node )
-        # be optimistic and try metainfo field first
-        node = node['node'] if node.kind_of?( MenuNode )
-        value = node['menuOrder'].to_s.to_i unless node['menuOrder'].nil?
-
-        # find the first menuOrder entry in the page files
-        node = node['indexFile'] if node.kind_of?( FileHandlers::DirHandler::DirNode )
-        node = node.parent.find {|child| child['page:name'] == node['page:name'] && child['menuOrder'].to_s.to_i != 0} if !node.nil? && node['page:name']
-        value ||= node['menuOrder'].to_s.to_i unless node.nil?
-
-        # fallback value
-        value ||= 0
-
-        value
+        self.children.sort! {|a,b| SORT_PROC.call( a['node'], b['node'] ) }
+        self.children.each {|child| child.sort! if child['node']['int:directory?'] }
       end
 
     end
@@ -96,6 +112,8 @@ module Tags
     'True if only the current subtree should be shown in the menu. If set to false, ' \
     'each subtree will be shown.'
 
+    used_meta_info 'orderInfo', 'inMenu'
+
     def initialize
       super
       register_tag( 'menu' )
@@ -132,13 +150,8 @@ module Tags
 
       out = "<#{get_param( 'menuTag' )}>"
       node.each do |child|
-        if child.kind_of?( MenuNode )
-          menu = child['node'].kind_of?( FileHandlers::DirHandler::DirNode ) ? build_menu( srcNode, child, level + 1 ) : ''
-          before, after = menu_entry( srcNode, child['node'] )
-        else
-          menu = ''
-          before, after = menu_entry( srcNode, child )
-        end
+        menu = child['node']['int:directory?'] ? build_menu( srcNode, child, level + 1 ) : ''
+        before, after = menu_entry( srcNode, child['node'] )
 
         out << before
         out << menu
@@ -151,15 +164,15 @@ module Tags
 
 
     def menu_entry( srcNode, node )
-      langNode = node['processor'].get_page_node_for_lang( node, srcNode['lang'] )
-      isDir = node.kind_of?( FileHandlers::DirHandler::DirNode )
+      langNode = node['processor'].get_node_for_lang( node, srcNode['lang'] )
+      isDir = node['int:directory?']
 
       styles = []
       styles << get_param( 'submenuClass' ) if isDir
       styles << get_param( 'selectedMenuitemClass' ) if langNode.recursive_value( 'dest' ) == srcNode.recursive_value( 'dest' )
 
       style = " class=\"#{styles.join(' ')}\"" if styles.length > 0
-      link = langNode['processor'].get_html_link( langNode, srcNode, ( isDir ? langNode['directoryName'] || node['directoryName'] : langNode['title'] ) )
+      link = node['processor'].get_html_link( node, srcNode )
 
       before = "<#{get_param( 'itemTag' )}#{style}>#{link}"
       after = "</#{get_param( 'itemTag' )}>"
@@ -173,12 +186,12 @@ module Tags
       menuNode = MenuNode.new( parent, node )
 
       node.each do |child|
-        next if menuNode.find {|n| n['page:name'] == child['page:name'] && !n['page:name'].nil? }
+        next if menuNode.find {|n| n['node']['int:pagename'] == child['int:pagename'] && !n['node']['int:pagename'].nil? }
         menu = create_menu_tree( child, menuNode )
         menuNode.add_child( menu ) unless menu.nil?
       end
 
-      return menuNode.has_children? ? menuNode : ( node['inMenu'] && !node['virtual'] ? node : nil )
+      return menuNode.has_children? ? menuNode : ( node['inMenu'] && !node['virtual'] ? menuNode : nil )
     end
 
   end

data/lib/webgen/plugins/tags/relocatable.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: relocatable.rb 256 2005-04-14 01:13:57Z thomas $
+# $Id: relocatable.rb 273 2005-05-11 10:07:38Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -21,6 +21,7 @@
 #
 
 require 'webgen/plugins/tags/tags'
+require 'uri'
 
 module Tags
 
@@ -45,12 +46,23 @@ module Tags
     end
 
     def process_tag( tag, node, refNode )
-      unless get_param( 'item' ).nil?
-        destNode = refNode.node_for_string( get_param( 'item' ) )
-        return ( destNode.nil? ? '' :  node.relpath_to_node( destNode['page:name'] ? destNode['processor'].get_page_node_for_lang( destNode, node['lang'] ) : destNode ) )
-      else
-        return ''
+      uri_string = get_param( 'item' )
+      result = ''
+      unless uri_string.nil?
+        begin
+          uri = URI.parse( uri_string )
+          if uri.absolute?
+            result = uri_string
+          else
+            destNode = refNode.node_for_string( uri.path )
+            qf = (uri.query.nil? ? '' : '?'+ uri.query ) + (uri.fragment.nil? ? '' : '#' + uri.fragment)
+            result = ( destNode.nil? ? '' :  node.relpath_to_node( destNode['processor'].get_node_for_lang( destNode, node['lang'] ) ) + qf )
+          end
+        rescue URI::InvalidURIError => e
+          logger.error { "Error while parsing URI for relocatable tag: #{e.message}" }
+        end
       end
+      return result
     end
 
   end

data/lib/webgen/plugins/tags/sitemap.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: sitemap.rb 256 2005-04-14 01:13:57Z thomas $
+# $Id: sitemap.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -32,6 +32,8 @@ module Tags
     add_param 'itemTag', 'li', 'The tag used for pages.'
     depends_on 'Tags'
 
+    used_meta_info 'orderInfo'
+
     def initialize
       super
       register_tag( 'sitemap' )
@@ -47,18 +49,17 @@ module Tags
     #######
 
     def output_node( node, srcNode )
-      return '' if not node.find {|c| c.kind_of?( FileHandlers::DirHandler::DirNode ) || c.kind_of?( FileHandlers::PageHandler::PageNode ) }
+      return '' if not node.find {|c| c['int:directory?'] || c['int:pagename'] }
 
+      processed_pagenodes = []
       out = "<#{get_param( 'levelTag' )}>"
-      node.each do |child|
-        next unless child.kind_of?( FileHandlers::DirHandler::DirNode ) || child.kind_of?( FileHandlers::PageHandler::PageNode )
+      node.sort( &Node::SORT_PROC ).each do |child|
+        next unless (child['int:directory?'] || child['int:pagename']) && !processed_pagenodes.include?( child['int:pagename'] )
+        processed_pagenodes << child['int:pagename'] if child['int:pagename']
 
-        isDir = child.kind_of?( FileHandlers::DirHandler::DirNode )
+        isDir = child['int:directory?']
         subout = output_node( child, srcNode )
-        if subout != '' || !isDir
-          langNode = child['processor'].get_page_node_for_lang( child, srcNode['lang'] )
-          link = langNode['processor'].get_html_link( langNode, srcNode, ( isDir ? langNode['directoryName'] || child['directoryName'] : langNode['title'] ) )
-        end
+        link = child['processor'].get_html_link( child, srcNode ) if subout != '' || !isDir
 
         out += "<#{get_param( 'itemTag' )}>#{link}" if !isDir || subout != ''
         out += subout if isDir

data/lib/webgen/plugins/tags/wikilink.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: wikilink.rb 252 2005-04-13 20:21:12Z thomas $
+# $Id: wikilink.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -35,6 +35,8 @@ module Tags
     add_param 'invalidChars', ' &;', 'The characters which are invalid as wiki URLs.'
     add_param 'replacementChar', '_', 'The character(s) which should be used instead of the invalid characters.'
 
+    used_meta_info 'title'
+
     def initialize
       super
       register_tag( 'wikilink' )

data/testsite/src/projects/00.index.de.page

@@ -1,7 +1,7 @@
 ---
 title: Projekte Seite
 inMenu: true
-menuOrder: 3
+orderInfo: 3
 directoryName: Projekte
 blocks:
   - {name: content, format: html}

data/testsite/src/projects/subproj/index.page

@@ -2,7 +2,7 @@
 title: Project index
 directoryName: Projects
 inMenu: true
-menuOrder: 4
+orderInfo: 4
 blocks:
   - {name: content, format: html}
 ---

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.6
 specification_version: 1
 name: webgen
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
-date: 2005-04-21
+  version: 0.3.4
+date: 2005-05-12
 summary: Webgen is a templated based static website generator.
 require_paths: 
   - lib
@@ -36,11 +36,11 @@ files:
   - VERSION
   - install.rb
   - bin/webgen
-  - lib/util/composite.rb
-  - lib/util/listener.rb
+  - lib/webgen/composite.rb
   - lib/webgen/configuration.rb
   - lib/webgen/node.rb
   - lib/webgen/logging.rb
+  - lib/webgen/listener.rb
   - lib/webgen/plugin.rb
   - lib/webgen/webgen.rb
   - lib/webgen/plugins/treewalker.rb
@@ -114,12 +114,14 @@ files:
   - doc/src/design.gallery
   - doc/src/default.template
   - doc/src/meta.info
+  - doc/src/generated_by_webgen.png
   - doc/src/logo.png
   - doc/src/designs/curdesign.png
   - doc/src/designs/nostyle.png
   - doc/src/designs/old.png
   - doc/src/documentation/gettingstarted.page
   - doc/src/documentation/index.page
+  - doc/src/documentation/meta_info_reference.page
   - doc/src/documentation/cli.page
   - doc/src/documentation/plugins
   - doc/src/documentation/plugins/tags
@@ -185,5 +187,5 @@ dependencies:
         - 
           - ">="
           - !ruby/object:Gem::Version 
-            version: 1.0.1
+            version: 1.0.2
       version: