webgen 0.3.0 → 0.3.1

data/lib/webgen/plugins/htmlvalidator/defaulthtmlvalidator.rb

@@ -0,0 +1,37 @@
+#
+#--
+#
+# $Id: defaulthtmlvalidator.rb 214 2005-02-27 13:40:27Z 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 HTMLValidators
+
+  class DefaultHTMLValidator < Webgen::Plugin
+
+    summary "Base class for all HTML validators"
+
+    define_handler 'validator'
+
+    # Should be overridden in subclass!
+    def validate_file( filename )
+    end
+
+  end
+
+end

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

@@ -0,0 +1,70 @@
+#
+#--
+#
+# $Id: xmllint.rb 216 2005-02-27 14:06:09Z 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/htmlvalidator/defaulthtmlvalidator'
+require "tempfile"
+
+# Allows one to get stdout and stderr from an executed command. Original version
+# by Karl von Laudermann in ruby-talk #113035
+class ExtendedCommand
+
+  attr_reader :ret_code, :out_text, :err_text
+
+  def initialize( command )
+    tempfile = Tempfile.new( 'xmllint' )
+    tempfile.close  # So that child process can write to it
+
+    # Execute command, redirecting stderr to temp file
+    @out_text = `#{command} 2> #{tempfile.path}`
+    @ret_code = $? >> 8
+
+    # 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'
+
+    def validate_file( filename )
+      cmd = ExtendedCommand.new( "xmllint #{get_param( 'args' )} #{filename}" )
+      case cmd.ret_code
+      when 0
+      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}" }
+      else
+        self.logger.error { "Error running xmllint:\n#{cmd.err_text}" }
+      end
+    end
+
+  end
+
+end

data/lib/webgen/plugins/tags/{lang.rb → langbar.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: lang.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: langbar.rb 223 2005-03-16 14:10:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -25,7 +25,7 @@ require 'webgen/plugins/tags/tags'
 module Tags
 
   # Generates a list with all the languages for a page.
-  class LanguageTag < DefaultTag
+  class LanguageBarTag < DefaultTag
 
     summary 'Provides links to translations of the page'
     add_param 'separator', ' | ', 'Separates the languages from each other.'
@@ -35,7 +35,7 @@ module Tags
 
     def initialize
       super
-      register_tag( 'lang' )
+      register_tag( 'langbar' )
     end
 
     def process_tag( tag, node, refNode )

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: menu.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: menu.rb 223 2005-03-16 14:10:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -79,11 +79,13 @@ module Tags
     end
 
 
-    summary 'Builds up a menu'
+    summary 'Builds a menu'
     depends_on 'Tags'
 
-    add_param 'menuTag', 'ul', 'The tag used for menus.'
+    add_param 'menuTag', 'ul', 'The tag used for submenus.'
     add_param 'itemTag', 'li', 'The tag used for menu items.'
+    add_param 'submenuClass', 'webgen-submenu', 'Specifies the class of a submenu'
+    add_param 'selectedMenuitemClass', 'webgen-menuitem-selected', 'Specifies the class of the selected menu item'
     add_param 'level', 1, \
     'Specifies how many levels the menu should have by default, ie. how deep it is. ' \
     'For example, if level = 3, then three levels are always shown at least.'
@@ -153,20 +155,14 @@ module Tags
       isDir = node.kind_of?( FileHandlers::DirHandler::DirNode )
 
       styles = []
-      styles << 'webgen-submenu' if isDir
-      styles << 'webgen-menuitem-selected' if langNode.recursive_value( 'dest' ) == srcNode.recursive_value( 'dest' )
+      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'] ) )
 
-      itemTag = get_param( 'itemTag' )
-      if isDir
-        before = "<#{itemTag}#{style}>#{link}"
-        after = "</#{itemTag}>"
-      else
-        before = "<#{itemTag}#{style}>#{link}</#{itemTag}>"
-        after = ""
-      end
+      before = "<#{get_param( 'itemTag' )}#{style}>#{link}"
+      after = "</#{get_param( 'itemTag' )}>"
 
       self.logger.debug { [before, after] }
       return before, after

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: relocatable.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: relocatable.rb 224 2005-03-16 15:26:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -47,7 +47,7 @@ module Tags
     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['processor'].get_lang_node( destNode, node['lang'] ) ) )
+        return ( destNode.nil? ? '' :  node.relpath_to_node( destNode['node:isLangNode'] ? destNode : destNode['processor'].get_lang_node( destNode, node['lang'] ) ) )
       else
         return ''
       end

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

@@ -0,0 +1,73 @@
+#
+#--
+#
+# $Id: sitemap.rb 211 2005-02-26 17:23:20Z 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/tags/tags'
+
+module Tags
+
+  # Generates a sitemap. The sitemap contains the hierarchy of all pages on the web site.
+  class SitemapTag < DefaultTag
+
+    summary 'Shows all pages of the website'
+    add_param 'levelTag', 'ul', 'The tag used for creating a new hierarchy level.'
+    add_param 'itemTag', 'li', 'The tag used for pages.'
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( 'sitemap' )
+    end
+
+    def process_tag( tag, srcNode, refNode )
+      root = Node.root( srcNode )
+      output_node( root, srcNode )
+    end
+
+    #######
+    private
+    #######
+
+    def output_node( node, srcNode )
+      return '' if not node.find {|c| c.kind_of?( FileHandlers::DirHandler::DirNode ) || c.kind_of?( FileHandlers::PageHandler::PageNode ) }
+
+      out = "<#{get_param( 'levelTag' )}>"
+      node.each do |child|
+        next unless child.kind_of?( FileHandlers::DirHandler::DirNode ) || child.kind_of?( FileHandlers::PageHandler::PageNode )
+
+        isDir = child.kind_of?( FileHandlers::DirHandler::DirNode )
+        subout = output_node( child, srcNode )
+        if subout != '' || !isDir
+          langNode = child['processor'].get_lang_node( child, srcNode['lang'] )
+          link = langNode['processor'].get_html_link( langNode, srcNode, ( isDir ? langNode['directoryName'] || child['directoryName'] : langNode['title'] ) )
+        end
+
+        out += "<#{get_param( 'itemTag' )}>#{link}" if !isDir || subout != ''
+        out += subout if isDir
+        out += "</#{get_param( 'itemTag' )}>" if !isDir || subout != ''
+      end
+
+      out += "</#{get_param( 'levelTag' )}>"
+    end
+
+  end
+
+end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: tags.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: tags.rb 223 2005-03-16 14:10:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -93,7 +93,7 @@ module Tags
             newContent += content[index + $1.length, length - $1.length]
           else
             tagHeaderLength = $1.length + tag.length + 2
-            realContent = content[index + tagHeaderLength, length - tagHeaderLength - 1]
+            realContent = content[index + tagHeaderLength, length - tagHeaderLength - 1].lstrip
             newContent += yield( tag, realContent )
           end
           content[index, length] = newContent
@@ -140,18 +140,18 @@ module Tags
     # will be assigned to the default mandatory parameter. There *should* be only one default
     # mandatory parameter.
     def self.set_mandatory( param, default = false )
-      if Webgen::Plugin.config[self.name].params.nil? || !Webgen::Plugin.config[self.name].params.has_key?( param )
+      if Webgen::Plugin.config[self].params.nil? || !Webgen::Plugin.config[self].params.has_key?( param )
         self.logger.error { "Cannot set parameter #{param} as mandatory as this parameter does not exist for #{self.name}" }
       else
-        Webgen::Plugin.config[self.name].params[param].mandatory = true
-        Webgen::Plugin.config[self.name].params[param].mandatoryDefault = default
+        Webgen::Plugin.config[self].params[param].mandatory = true
+        Webgen::Plugin.config[self].params[param].mandatoryDefault = default
       end
     end
 
     # Register +tag+ at the Tags plugin.
     def register_tag( tag )
       Webgen::Plugin['Tags'].tags[tag] = self
-      Webgen::Plugin.config[self.class.name].tag = tag
+      Webgen::Plugin.config[self.class].tag = tag
     end
 
     # Set the configuration parameters for the next #process_tag call. The configuration, if
@@ -211,7 +211,7 @@ module Tags
 
     # Set the default mandatory parameter.
     def set_default_mandatory_param( value )
-      data = Webgen::Plugin.config[self.class.name]
+      data = Webgen::Plugin.config[self.class]
       key = data.params.detect {|k,v| v.mandatoryDefault} unless data.params.nil?
       if key.nil?
         self.logger.error { "Default mandatory parameter not specified for tag '#{self.class.name}'"}
@@ -222,13 +222,13 @@ module Tags
 
     # Check if this tag has mandatory parameters.
     def has_mandatory_params?
-      data = Webgen::Plugin.config[self.class.name]
+      data = Webgen::Plugin.config[self.class]
       !data.params.nil? && data.params.any? {|k,v| v.mandatory }
     end
 
     # Check if all mandatory parameters have been set
     def all_mandatory_params_set?
-      params = Webgen::Plugin.config[self.class.name].params
+      params = Webgen::Plugin.config[self.class].params
       ( params.nil? ? true : params.all? { |k,v| !v.mandatory || @curConfig.has_key?( k ) } )
     end
 

data/lib/webgen/plugins/treewalker.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: treewalker.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: treewalker.rb 218 2005-03-11 15:41:39Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -28,7 +28,7 @@ module TreeWalkers
   # so that it is called when the main class' #execute method is called.
   class TreeWalker < Webgen::Plugin
 
-    summary "Super plugin for transforming the data tree"
+    summary "Super plugin for traversing the data tree"
 
     attr_reader :walkers
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.4
 specification_version: 1
 name: webgen
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2005-02-21
+  version: 0.3.1
+date: 2005-03-16
 summary: Webgen is a templated based static website generator.
 require_paths: 
   - lib
@@ -46,40 +46,44 @@ files:
   - lib/webgen/plugins/treewalker.rb
   - lib/webgen/plugins/tags/date.rb
   - lib/webgen/plugins/tags/executecommand.rb
-  - lib/webgen/plugins/tags/lang.rb
   - lib/webgen/plugins/tags/navbar.rb
   - lib/webgen/plugins/tags/wikilink.rb
   - lib/webgen/plugins/tags/tags.rb
   - lib/webgen/plugins/tags/menu.rb
   - lib/webgen/plugins/tags/meta.rb
   - lib/webgen/plugins/tags/includefile.rb
+  - lib/webgen/plugins/tags/sitemap.rb
+  - lib/webgen/plugins/tags/langbar.rb
   - lib/webgen/plugins/tags/relocatable.rb
+  - lib/webgen/plugins/contenthandler/rdoc.rb
+  - lib/webgen/plugins/contenthandler/textile.rb
+  - lib/webgen/plugins/contenthandler/markdown.rb
+  - lib/webgen/plugins/contenthandler/defaultcontenthandler.rb
+  - lib/webgen/plugins/contenthandler/html.rb
   - lib/webgen/plugins/filehandler/picturegallery.rb
   - lib/webgen/plugins/filehandler/backing.rb
   - lib/webgen/plugins/filehandler/template.rb
   - lib/webgen/plugins/filehandler/directory.rb
+  - lib/webgen/plugins/filehandler/page.rb
   - lib/webgen/plugins/filehandler/filecopy.rb
   - lib/webgen/plugins/filehandler/filehandler.rb
-  - lib/webgen/plugins/filehandler/pagehandler/rdoc.rb
-  - lib/webgen/plugins/filehandler/pagehandler/textile.rb
-  - lib/webgen/plugins/filehandler/pagehandler/markdown.rb
-  - lib/webgen/plugins/filehandler/pagehandler/page.rb
-  - lib/webgen/plugins/filehandler/pagehandler/html.rb
+  - lib/webgen/plugins/gallerylayouter/defaultgallerylayouter.rb
+  - lib/webgen/plugins/htmlvalidator/defaulthtmlvalidator.rb
+  - lib/webgen/plugins/htmlvalidator/xmllint.rb
   - testsite/src
   - testsite/config.yaml
   - testsite/src/bluecloth.page
   - testsite/src/news_are_so-cool.de.page
   - testsite/src/default.css
   - testsite/src/projects.es.page
+  - testsite/src/bghack.png
   - testsite/src/projects.page
   - testsite/src/rdoc.page
   - testsite/src/pictures
   - testsite/src/index.page
-  - testsite/src/images
   - testsite/src/default.template
   - testsite/src/noindex
   - testsite/src/meta.info
-  - testsite/src/test.gallery
   - testsite/src/projects
   - testsite/src/home.page
   - testsite/src/projects.de.page
@@ -87,11 +91,6 @@ files:
   - testsite/src/home.en.page
   - testsite/src/redcloth.page
   - testsite/src/pictures/index.page
-  - testsite/src/images/o.png
-  - testsite/src/images/x.png
-  - testsite/src/images/tictactoe.png
-  - testsite/src/images/bghack.png
-  - testsite/src/images/smagacor.png
   - testsite/src/noindex/noindex.page
   - testsite/src/projects/05.project3.page
   - testsite/src/projects/index.page
@@ -107,41 +106,55 @@ files:
   - doc/src/default.css
   - doc/src/features.page
   - doc/src/index.page
+  - doc/src/about.page
   - doc/src/documentation
   - doc/src/download.page
   - doc/src/design.gallery
   - doc/src/default.template
   - doc/src/meta.info
   - doc/src/logo.png
-  - doc/src/designs/default.png
+  - doc/src/designs/curdesign.png
   - doc/src/designs/nostyle.png
   - doc/src/designs/old.png
   - doc/src/documentation/tags
+  - doc/src/documentation/contenthandler
   - doc/src/documentation/extloader.page
   - doc/src/documentation/index.page
   - doc/src/documentation/filehandler
+  - doc/src/documentation/gallerylayouter
+  - doc/src/documentation/htmlvalidator
   - doc/src/documentation/tags/multilang.fr.page
   - doc/src/documentation/tags/multilang.page
   - doc/src/documentation/tags/menu.page
   - doc/src/documentation/tags/relocatable.page
-  - doc/src/documentation/tags/lang.de.page
   - doc/src/documentation/tags/date.page
   - doc/src/documentation/tags/executecommand.page
   - doc/src/documentation/tags/menu.de.page
   - doc/src/documentation/tags/index.page
+  - doc/src/documentation/tags/langbar.page
   - doc/src/documentation/tags/navbar.page
+  - doc/src/documentation/tags/sitemap.page
   - doc/src/documentation/tags/multilang.de.page
   - doc/src/documentation/tags/meta.page
+  - doc/src/documentation/tags/langbar.de.page
   - doc/src/documentation/tags/wikilink.page
-  - doc/src/documentation/tags/lang.page
   - doc/src/documentation/tags/includefile.page
+  - doc/src/documentation/contenthandler/html.page
+  - doc/src/documentation/contenthandler/rdoc.page
+  - doc/src/documentation/contenthandler/index.page
+  - doc/src/documentation/contenthandler/textile.page
+  - doc/src/documentation/contenthandler/markdown.page
   - doc/src/documentation/filehandler/template.page
   - doc/src/documentation/filehandler/directory.page
-  - doc/src/documentation/filehandler/page.page
-  - doc/src/documentation/filehandler/picturegallery.page
+  - doc/src/documentation/filehandler/galleryhandler.page
   - doc/src/documentation/filehandler/index.page
+  - doc/src/documentation/filehandler/pagehandler.page
   - doc/src/documentation/filehandler/copy.page
   - doc/src/documentation/filehandler/backing.page
+  - doc/src/documentation/gallerylayouter/defaultlayouter.page
+  - doc/src/documentation/gallerylayouter/index.page
+  - doc/src/documentation/htmlvalidator/index.page
+  - doc/src/documentation/htmlvalidator/xmllint.page
 test_files: []
 rdoc_options: 
   - "--line-numbers"