webgen 0.3.8 → 0.4.0

data/lib/webgen/plugins/htmlvalidators/default.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: default.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: default.rb 531 2006-11-17 17:56:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,16 +20,18 @@
 #++
 #
 
-module HTMLValidators
+module HtmlValidators
 
-  class DefaultHTMLValidator < Webgen::Plugin
+  class DefaultHtmlValidator < Webgen::HandlerPlugin
 
-    summary "Base class for all HTML validators"
+    infos( :name => 'HtmlValidator/Default',
+           :author => Webgen::AUTHOR,
+           :summary => "Base class for all HTML validators"
+           )
 
-    define_handler 'validator'
-
-    # Should be overridden in subclass!
+    # Validates the file +filename+. Has to be overridden in subclasses!
     def validate_file( filename )
+      raise NotImplementedError
     end
 
   end

data/lib/webgen/plugins/htmlvalidators/xmllint.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: xmllint.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: xmllint.rb 531 2006-11-17 17:56:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,48 +20,32 @@
 #++
 #
 
-require 'webgen/plugins/htmlvalidators/default'
-require "tempfile"
+load_plugin 'webgen/plugins/htmlvalidators/default'
+require 'webgen/extcommand'
 
-# Allows one to get stdout and stderr from an executed command. Original version
-# by Karl von Laudermann in ruby-talk #113035
-class ExtendedCommand
+module HtmlValidators
 
-  attr_reader :ret_code, :out_text, :err_text
+  class XmllintHtmlValidator < DefaultHtmlValidator
 
-  def initialize( command )
-    tempfile = Tempfile.new( 'xmllint' )
-    tempfile.close  # So that child process can write to it
+    infos( :name => 'HtmlValidator/xmllint',
+           :author => Webgen::AUTHOR,
+           :summary => "Uses xmllint to check if a file is valid HTML and well-formed"
+           )
 
-    # Execute command, redirecting stderr to temp file
-    @out_text = `#{command} 2> #{tempfile.path}`
-    @ret_code = $? >> 8
+    param "args", '--catalogs --noout --valid', 'Arguments passed to the xmllint command'
 
-    # Read temp file
-    tempfile.open
-    @err_text = tempfile.readlines.join
-    tempfile.close
-  end
-end
-
-
-module HTMLValidators
-
-  class XmllintHTMLValidator < DefaultHTMLValidator
-
-    summary "Uses xmllint to check if a file is valid and well-formed"
-
-    add_param "args", '--catalogs --noout --valid', 'Arguments passed to the xmllint command'
-    register_validator 'xmllint'
+    register_handler 'xmllint'
 
     def validate_file( filename )
-      cmd = ExtendedCommand.new( "xmllint #{get_param( 'args' )} #{filename}" )
+      cmd = ExtendedCommand.new( "xmllint #{param( 'args' )} #{filename}" )
       case cmd.ret_code
-      when 0
+      when 0 then true
       when 1..10
-        self.logger.warn { "xmllint was run on <#{filename}>, exited with the return code #{cmd.ret_code} and the error message: \n#{cmd.err_text}" }
+        log(:warn) { "xmllint was run on <#{filename}>, but exited with return code #{cmd.ret_code} and the error message: #{cmd.err_text}" }
+        false
       else
-        self.logger.error { "Error running xmllint:\n#{cmd.err_text}" }
+        log(:error) { "Error running xmllint:#{cmd.err_text}" }
+        false
       end
     end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: default.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: default.rb 555 2006-12-27 15:40:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,49 +22,51 @@
 
 module MenuStyles
 
-  class DefaultMenuStyle < Webgen::Plugin
+  class DefaultMenuStyle < Webgen::HandlerPlugin
 
-    summary "Base class for all menu styles"
+    infos( :name => 'MenuStyle/Default',
+           :author => Webgen::AUTHOR,
+           :summary => "Base plugin 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 ' \
+    param 'divClass', 'webgen-menu', 'Additional CSS class for the div-tag surrounding the menu.'
+    param 'submenuClass', 'webgen-menu-submenu', 'Specifies the class of a submenu.'
+    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.'
+    param 'selectedMenuitemClass', 'webgen-menu-item-selected', 'Specifies the class of the selected menu item.'
 
-    def build_menu( srcNode, menuTree, options )
+    def build_menu( src_node, menu_tree, options )
       @options = options
-      internal_build_menu( srcNode, menuTree )
+      internal_build_menu( src_node, menu_tree )
     end
 
-    def internal_build_menu( srcNode, menuTree )
-      ""
+    def internal_build_menu( src_node, menu_tree )
+      raise NotImplementedErorr
     end
 
-    def get_param( name )
-      ( !@options.nil? && @options.kind_of?( Hash ) && @options.has_key?( name ) ? @options[name] : super )
+    def param( name, plugin = nil )
+      if defined?( @options ) && !@options.nil? && @options.kind_of?( Hash ) && @options.has_key?( name ) &&
+          self.class.ancestor_classes.any? {|klass| klass.config.params.has_key?( name )}
+        @options[name]
+      else
+        super
+      end
     end
 
     #########
     protected
     #########
 
-    # Returns style information (node is selected, ...) and link for +node+ relative to +srcNode+.
-    def menu_item_details( srcNode, node )
-      langNode = node['processor'].get_node_for_lang( node, srcNode['lang'] )
-      isDir = node['int:directory?']
-
+    # Returns style information (node is selected, ...) and a link from +src_node+ to +node+.
+    def menu_item_details( src_node, node )
       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' )
+      styles << param( 'submenuClass' ) if node.is_directory?
+      styles << param( 'submenuInHierarchyClass' ) if node.is_directory? && src_node.in_subtree_of?( node )
+      styles << param( 'selectedMenuitemClass' ) if node == src_node
 
       style = "class=\"#{styles.join(' ')}\"" if styles.length > 0
-      link = node['processor'].get_html_link( node, srcNode )
+      link = node.link_from( src_node )
 
-      self.logger.debug { [style, link] }
       return style, link
     end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: horizontal.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: horizontal.rb 531 2006-11-17 17:56:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,66 +20,47 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/default'
+load_plugin 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 
-  class HorizontalMenuStyle < MenuStyles::DefaultMenuStyle
+  class HorizontalMenuStyle < DefaultMenuStyle
 
-    summary "Builds a horizontal menu"
+    infos( :name => 'MenuStyle/Horizontal',
+           :author => Webgen::AUTHOR,
+           :summary => "Builds a horizontal menu"
+           )
 
-    register_menu_style 'horizontal'
+    register_handler '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 )
+    def internal_build_menu( src_node, menu_tree )
       unless defined?( @css_added )
-        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @plugin_manager['Core/ResourceManager'].append_data( 'webgen-css', "
+/* START webgen horizontal menu style */
+.webgen-menu-horiz ul { display: block; }
+.webgen-menu-horiz li { display: inline; }
+/* STOP webgen horizontal menu style */
+" )
         @css_added = true
       end
-      "<div class=\"webgen-menu-horiz #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+      "<div class=\"webgen-menu-horiz #{param('divClass')}\">#{submenu( src_node, menu_tree, 1 )}</div>"
     end
 
     #######
     private
     #######
 
-    def submenu( srcNode, node, level )
-      if node.nil? || node['node'].level > srcNode.level || !srcNode.in_subtree?( node['node'] )
+    def submenu( src_node, menu_node, level )
+      if menu_node.nil? || menu_node.level > src_node.level \
+        || !src_node.in_subtree_of?( menu_node.node_info[: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'] )
+      menu_node.each do |child|
+        submenu << (child.has_children? ? submenu( src_node, child, level + 1 ) : '')
+        style, link = menu_item_details( src_node, child.node_info[:node] )
         out << "<li #{style}>#{link}</li>"
       end
       out << "</ul>"

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: horizontal_dropdown.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: horizontal_dropdown.rb 531 2006-11-17 17:56:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,82 +20,68 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/default'
+load_plugin 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 
   class HorizontalDropdownMenuStyle < MenuStyles::DefaultMenuStyle
 
-    summary "Builds a horizontal menu with CSS drop down submenus"
+    infos( :name => 'MenuStyle/HorizontalDropdown',
+           :author => Webgen::AUTHOR,
+           :summary => "Builds a horizontal menu with CSS drop down submenus"
+           )
 
-    register_menu_style 'horizontal-dropdown'
+    register_handler 'horizontal-dropdown'
 
-    CSS = "
-/* START Webgen horizontal dropdown menu style */
+    def initialize( plugin_manager )
+      super
+      @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 */
+.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 */
 "
+    end
 
-    def internal_build_menu( srcNode, menuTree )
+    def internal_build_menu( src_node, menu_tree )
       unless defined?( @css_added )
-        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @plugin_manager['Core/ResourceManager'].append_data( 'webgen-css', @css )
         @css_added = true
       end
-      "<div class=\"webgen-menu-horiz-dd #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+      "<div class=\"webgen-menu-horiz-dd #{param('divClass')}\">#{submenu( src_node, menu_tree, 1 )}</div>"
     end
 
     #######
     private
     #######
 
-    def submenu( srcNode, node, level )
+    def submenu( src_node, menu_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'] )
+      menu_node.each do |child|
+        menu = (child.has_children? ? submenu( src_node, child, level + 1 ) : '')
+        style, link = menu_item_details( src_node, child.node_info[:node] )
 
         out << "<ul>" if level == 1
         out << "<li #{style}>#{link}"

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

@@ -0,0 +1,68 @@
+#
+#--
+#
+# $Id: section.rb 531 2006-11-17 17:56:14Z 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
+#
+#++
+#
+
+load_plugin 'webgen/plugins/menustyles/default'
+
+module MenuStyles
+
+  class SectionMenuStyle < MenuStyles::DefaultMenuStyle
+
+    infos( :name => 'MenuStyle/Section',
+           :author => Webgen::AUTHOR,
+           :summary => "Builds a menu out of the HTML sections (h1, h2, ...)"
+           )
+
+    register_handler 'section'
+
+    param 'maxLevels', 3, 'Specifies the maximum number of levels that should be shown.'
+    param 'numberSections', true, 'Specifies whether the section titles should be numbered'
+
+    def internal_build_menu( src_node, menu_tree )
+      "<div class=\"webgen-menu-section #{param('divClass')}\">#{submenu( src_node.node_info[:pagesections], 1, '' )}</div>"
+    end
+
+    #######
+    private
+    #######
+
+    def submenu( sections, level, number )
+      return '' if sections.empty? || level > param( 'maxLevels' )
+
+      out = ''
+      out << "<ul>"
+      sections.each_with_index do |child, index|
+        index += 1
+        child_number = number + index.to_s + '.'
+        menu = (!child.subsections.empty? ? submenu( child.subsections, level + 1, child_number ) : '')
+
+        out << "<li><a href=\"##{child.id}\">#{param('numberSections') ? child_number + ' ': ''}#{child.title}</a>"
+        out << menu
+        out << "</li>"
+      end
+      out << "</ul>"
+
+      out
+    end
+
+  end
+
+end