webgen 0.3.4 → 0.3.5

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: page.rb 277 2005-05-12 08:43:54Z thomas $
+# $Id: page.rb 301 2005-06-14 10:25:49Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -43,7 +43,7 @@ module FileHandlers
     add_param 'outputNameStyle', [:name, ['.', :lang], '.html'], 'Defines how the output name should be built. The correct name will be used for ' \
     'the :name part and the file language will be used for the :lang part. If <defaultLangInFilename> is true, the :lang part or the subarray in which '\
     'the :lang part was defined, will be omitted.'
-    add_param 'validator', 'xmllint', 'The validator for checking HTML files on their validness. Set to "" or nil to prevent checking.'
+    add_param 'validator', nil, 'The validator for checking HTML files on their validness. Set to "" or nil to prevent checking.'
     add_param 'useERB', true, 'Specifies if the content blocks of the page file should be processed with ERB before they are formatted.'
 
     used_meta_info 'title', 'orderInfo', 'lang', 'blocks', 'useERB'
@@ -56,26 +56,39 @@ module FileHandlers
       create_node_internally( parse_data( data, srcName ), analyse_file_name( File.basename( srcName ) ), parent )
     end
 
-    def write_node( node )
-      templateNode = Webgen::Plugin['TemplateFileHandler'].get_template_for_node( node )
+    def render_node( node, with_template = true, block_name = 'content' )
+      unless node['int:content-formatted']
+        useERB = node['useERB'] || ( node['useERB'].nil? && get_param( 'useERB' ) )
+        node['blocks'].each do |blockdata|
+          begin
+            content = ( useERB ? ERB.new( blockdata['data'] ).result( binding ) : blockdata['data'] )
+          rescue Exception => e
+            logger.error { "ERB threw an error while processing an ERB template (<#{node.recursive_value('src')}>, block #{blockdata['name']}): #{e.message}" }
+            content = blockdata['data']
+          end
+          node[blockdata['name']] = Webgen::Plugin['DefaultContentHandler'].get_format( blockdata['format'] ).format_content( content )
+        end
+        node['int:content-formatted'] = true
+      end
 
-      useERB = node['useERB'] || ( node['useERB'].nil? && get_param( 'useERB' ) )
-      node['blocks'].each do |blockdata|
+      if with_template
+        templateNode = Webgen::Plugin['TemplateFileHandler'].get_template_for_node( node )
         begin
-          content = ( useERB ? ERB.new( blockdata['data'] ).result( binding ) : blockdata['data'] )
+          outstring = ERB.new( templateNode['content'] ).result( binding )
         rescue Exception => e
-          logger.error { "ERB threw an error while processing an ERB template (<#{node.recursive_value('src')}>, block #{blockdata['name']}): #{e.message}" }
-          content = blockdata['data']
+          logger.error { "ERB threw an error while processing an ERB template (<#{templateNode.recursive_value('src')}>: #{e.message}" }
+          outstring = templateNode['content'].dup
         end
-        node[blockdata['name']] = Webgen::Plugin['DefaultContentHandler'].get_format( blockdata['format'] ).format_content( content )
-      end
-      begin
-        outstring = ERB.new( templateNode['content'] ).result( binding )
-      rescue Exception => e
-        logger.error { "ERB threw an error while processing an ERB template (<#{templateNode.recursive_value('src')}>: #{e.message}" }
-        outstring = templateNode['content'].dup
+      else
+        templateNode = node
+        outstring = node[block_name].to_s.dup
       end
-      outstring = Webgen::Plugin['Tags'].substitute_tags( outstring, node, templateNode )
+
+      Webgen::Plugin['Tags'].substitute_tags( outstring, node, templateNode )
+    end
+
+    def write_node( node )
+      outstring = render_node( node )
 
       File.open( node.recursive_value( 'dest' ), File::CREAT|File::TRUNC|File::RDWR ) do |file|
         file.write( outstring )
@@ -125,7 +138,8 @@ module FileHandlers
     def create_node_internally( data, analysed, parent )
       lang = data['lang'] || analysed.lang
 
-      pagename = create_output_name( analysed, data['outputNameStyle'] || get_param( 'outputNameStyle' ), true )
+      pagename = analysed.name + '.page'
+      localizedPagename = analysed.name + '.' + lang + '.page'
 
       if node = parent.find {|node| node['int:pagename'] == pagename && node['lang'] == lang }
         logger.warn do
@@ -141,6 +155,7 @@ module FileHandlers
         node['src'] = analysed.srcName
         node['dest'] = create_output_name( analysed, node['outputNameStyle'] || get_param( 'outputNameStyle' ) )
         node['int:pagename'] = pagename
+        node['int:local-pagename'] = localizedPagename
         node['processor'] = self
       end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: picturegallery.rb 274 2005-05-11 12:52:27Z thomas $
+# $Id: picturegallery.rb 303 2005-06-24 13:44:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -154,6 +154,7 @@ module FileHandlers
         imageData['imageFilename'] = image
         imageData['srcName'] = File.basename( image ).tr( ' .', '_' ) + '.html'
         imageData['thumbnail'] ||= get_thumbnail( imageData, parent )
+        imageData['thumbnailSize'] ||= @filedata['thumbnailSize']
 
         imageList << imageData
       end
@@ -175,7 +176,7 @@ module FileHandlers
       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 )
+        node = Webgen::Plugin['ThumbnailWriter'].create_node( File.join( @path, imageData['imageFilename'] ), p_node, imageData['thumbnailSize'] )
         p_node.add_child( node )
 
         File.dirname( imageData['imageFilename'] ) + '/' + node['dest']
@@ -188,19 +189,20 @@ module FileHandlers
       summary "Writes out thumbnails with RMagick"
       add_param "thumbnailSize", "100x100", "The size of the thumbnails"
 
-      def create_node( file, parent )
+      def create_node( file, parent, thumbnailSize = nil )
         node = Node.new( parent )
         node['title'] = node['src'] = node['dest'] = 'tn_' + File.basename( file )
-        node['tn:imageFile'] = file
+        node['int:thumbnailFile'] = file
+        node['int:thumbnailSize'] = thumbnailSize
         node['processor'] = self
         node
       end
 
       def write_node( node )
-        if Webgen::Plugin['FileHandler'].file_modified?( node['tn:imageFile'], node.recursive_value( 'dest' ) )
-          self.logger.info {"Creating thumbnail <#{node.recursive_value('dest')}> from <#{node['tn:imageFile']}>"}
-          image = Magick::ImageList.new( node['tn:imageFile'] )
-          image.change_geometry( get_param( 'thumbnailSize' ) ) {|c,r,i| i.resize!( c, r )}
+        if Webgen::Plugin['FileHandler'].file_modified?( node['int:thumbnailFile'], node.recursive_value( 'dest' ) )
+          self.logger.info {"Creating thumbnail <#{node.recursive_value('dest')}> from <#{node['int:thumbnailFile']}>"}
+          image = Magick::ImageList.new( node['int:thumbnailFile'] )
+          image.change_geometry( node['int:thumbnailSize'] || get_param( 'thumbnailSize' ) ) {|c,r,i| i.resize!( c, r )}
           image.write( node.recursive_value( 'dest' ) )
         end
       end

data/lib/webgen/plugins/menustyles/defaultmenustyle.rb

@@ -0,0 +1,73 @@
+#
+#--
+#
+# $Id: defaultmenustyle.rb 293 2005-06-11 08:37:51Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+#
+
+
+module MenuStyles
+
+  class DefaultMenuStyle < Webgen::Plugin
+
+    summary "Base class for all menu styles"
+
+    define_handler 'menu_style'
+
+    add_param 'divClass', '', 'Additional CSS class for the div-tag surrounding the menu'
+    add_param 'submenuClass', 'webgen-menu-submenu', 'Specifies the class of a submenu.'
+    add_param 'submenuInHierarchyClass', 'webgen-menu-submenu-inhierarchy', 'Specifies the class of the submenus which are ' \
+    'in the hierarchy of the selected menu item.'
+    add_param 'selectedMenuitemClass', 'webgen-menu-item-selected', 'Specifies the class of the selected menu item.'
+
+    def build_menu( srcNode, menuTree, options )
+      @options = options
+      internal_build_menu( srcNode, menuTree )
+    end
+
+    def internal_build_menu( srcNode, menuTree )
+      ""
+    end
+
+    def get_param( name )
+      ( !@options.nil? && @options.kind_of?( Hash ) && @options.has_key?( name ) ? @options[name] : super )
+    end
+
+    #########
+    protected
+    #########
+
+    def menu_item_details( srcNode, node )
+      langNode = node['processor'].get_node_for_lang( node, srcNode['lang'] )
+      isDir = node['int:directory?']
+
+      styles = []
+      styles << get_param( 'submenuClass' ) if isDir
+      styles << get_param( 'submenuInHierarchyClass' ) if isDir && srcNode.in_subtree?( node )
+      styles << get_param( 'selectedMenuitemClass' ) if langNode.recursive_value( 'dest' ) == srcNode.recursive_value( 'dest' )
+
+      style = "class=\"#{styles.join(' ')}\"" if styles.length > 0
+      link = node['processor'].get_html_link( node, srcNode )
+
+      self.logger.debug { [style, link] }
+      return style, link
+    end
+
+  end
+
+end

data/lib/webgen/plugins/menustyles/horizontal.rb

@@ -0,0 +1,93 @@
+#
+#--
+#
+# $Id: horizontal.rb 293 2005-06-11 08:37:51Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+#
+
+require 'webgen/plugins/menustyles/defaultmenustyle'
+
+module MenuStyles
+
+  class HorizontalMenuStyle < MenuStyles::DefaultMenuStyle
+
+    summary "Builds a horizontal menu"
+
+    register_menu_style 'horizontal'
+
+    CSS = "
+/* START Webgen horizontal menu style */
+.webgen-menu-horiz {
+  text-align: center;
+}
+
+.webgen-menu-horiz ul {
+  display: block;
+  margin: 0px;
+  padding-bottom: 3px;
+  margin-bottom: 3px;
+}
+
+.webgen-menu-horiz li {
+  display: inline;
+  padding: 0px 5px;
+}
+
+.webgen-menu-horiz .webgen-menu-submenu-inhierarchy {
+  font-weight: bold;
+}
+
+.webgen-menu-horiz .webgen-menu-item-selected {
+  font-weight: bold;
+}
+/* STOP Webgen horizontal menu style */
+"
+
+    def internal_build_menu( srcNode, menuTree )
+      unless defined?( @css_added )
+        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @css_added = true
+      end
+      "<div class=\"webgen-menu-horiz #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+    end
+
+    #######
+    private
+    #######
+
+    def submenu( srcNode, node, level )
+      if node.nil? || node['node'].level > srcNode.level || !srcNode.in_subtree?( node['node'] )
+        return ''
+      end
+
+      submenu = ''
+      out = "<ul>"
+      node.each do |child|
+        submenu << (child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : '')
+        style, link = menu_item_details( srcNode, child['node'] )
+        out << "<li #{style}>#{link}</li>"
+      end
+      out << "</ul>"
+      out << submenu
+
+      return out
+    end
+
+  end
+
+end

data/lib/webgen/plugins/menustyles/horizontal_dropdown.rb

@@ -0,0 +1,113 @@
+#
+#--
+#
+# $Id: horizontal_dropdown.rb 300 2005-06-14 10:04:17Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+#
+
+require 'webgen/plugins/menustyles/defaultmenustyle'
+
+module MenuStyles
+
+  class HorizontalDropdownMenuStyle < MenuStyles::DefaultMenuStyle
+
+    summary "Builds a horizontal menu with CSS drop down submenus"
+
+    register_menu_style 'horizontal-dropdown'
+
+    CSS = "
+/* START Webgen horizontal dropdown menu style */
+.webgen-menu-horiz-dd ul {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+  float: left;
+}
+
+.webgen-menu-horiz-dd ul ul {
+  width: 15em;
+  border: 1px solid black;
+  position: absolute;
+  z-index: 500;
+}
+
+
+.webgen-menu-horiz-dd a {
+  display: block;
+  margin: 0px;
+  padding: 3px 3px;
+  background-color: white;
+}
+
+.webgen-menu-horiz-dd li {
+  position: relative;
+}
+
+.webgen-menu-horiz-dd ul ul ul {
+position: absolute;
+top: 0;
+left: 100%;
+}
+
+.webgen-menu-horiz-dd ul ul {
+  display: none;
+}
+
+.webgen-menu-horiz-dd ul li:hover > ul > ul {
+  display: none;
+}
+
+.webgen-menu-horiz-dd ul li:hover > ul {
+  display: block;
+}
+/* STOP Webgen horizontal dropdown menu style */
+"
+
+    def internal_build_menu( srcNode, menuTree )
+      unless defined?( @css_added )
+        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @css_added = true
+      end
+      "<div class=\"webgen-menu-horiz-dd #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+    end
+
+    #######
+    private
+    #######
+
+    def submenu( srcNode, node, level )
+      out = ''
+      out = "<ul>" if level > 1
+      node.each do |child|
+        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
+        style, link = menu_item_details( srcNode, child['node'] )
+
+        out << "<ul>" if level == 1
+        out << "<li #{style}>#{link}"
+        out << menu
+        out << "</li>"
+        out << "</ul>" if level == 1
+      end
+      out << "</ul>" if level > 1
+
+      return out
+    end
+
+  end
+
+end

data/lib/webgen/plugins/menustyles/partial.rb

@@ -0,0 +1,95 @@
+#
+#--
+#
+# $Id: partial.rb 293 2005-06-11 08:37:51Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+#
+
+require 'webgen/plugins/menustyles/defaultmenustyle'
+
+module MenuStyles
+
+  class PartialMenuStyle < MenuStyles::DefaultMenuStyle
+
+    summary "Builds a partial menu"
+    description "Creates a menu that only shows the menu levels under the current page"
+
+    register_menu_style 'partial'
+
+    add_param 'subtreeLevel', 1, \
+    'Specifies how many levels should be shown. The number specifies ' \
+    'the maximum depth the menu will have.'
+    add_param 'dropdown', false, 'Specifies if the menu should be a drop-down menu'
+
+    CSS = "
+/* START Webgen partial menu style */
+.webgen-menu-partial-dropdown > ul {
+  display: none;
+}
+
+.webgen-menu-partial-dropdown:hover > ul {
+  display: block;
+}
+/* STOP Webgen partial menu style */
+"
+
+    def internal_build_menu( srcNode, menuTree )
+      unless defined?( @css_added )
+        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @css_added = true
+      end
+      styles = ['webgen-menu-partial',
+                (get_param( 'dropdown' ) ? 'webgen-menu-partial-dropdown' : ''),
+                get_param( 'divClass' )]
+
+      "<div class=\"#{styles.join(' ')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+    end
+
+    #######
+    private
+    #######
+
+    def submenu( srcNode, node, level )
+      if node.nil? || level - srcNode.level >= get_param( 'subtreeLevel' ) || \
+        (level >= srcNode.level && !node['node'].in_subtree?( srcNode ))
+        return ''
+      end
+
+      out = ''
+      if get_param( 'dropdown' ) && level == srcNode.level
+        style, link = menu_item_details( srcNode, node['node'] )
+        out << "#{link}"
+      end
+
+      out << "<ul>" if level >= srcNode.level
+      node.each do |child|
+        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
+        style, link = menu_item_details( srcNode, child['node'] )
+
+        out << "<li #{style}>#{link}" if level >= srcNode.level
+        out << menu
+        out << "</li>" if level >= srcNode.level
+      end
+      out << "</ul>" if level >= srcNode.level
+
+      return out
+    end
+
+  end
+
+end