webgen 0.3.6 → 0.3.7

data/lib/webgen/plugins/{filehandler → filehandlers}/filehandler.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: filehandler.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: filehandler.rb 360 2005-11-02 08:24:26Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -50,7 +50,7 @@ module FileHandlers
         allFiles.subtract( get_files_for_pattern( pattern ) )
       end
 
-      handlerFiles = sort_file_handlers( Webgen::Plugin['DefaultFileHandler'].get_file_handlers ).collect do |pattern, handler|
+      handlerFiles = sort_file_handlers( FileHandlers::DefaultFileHandler.get_file_handlers ).collect do |pattern, handler|
         [get_files_for_pattern( pattern ), Webgen::Plugin.config[handler].obj]
       end
 
@@ -123,7 +123,7 @@ module FileHandlers
 
     def create_root_node( path, handler )
       root = handler.create_node( path, nil )
-      root['title'] = '/'
+      root['title'] = ''
       root['dest'] = Webgen::Plugin['Configuration']['outDirectory'] + '/'
       root['src'] = Webgen::Plugin['Configuration']['srcDirectory'] + '/'
       root
@@ -171,11 +171,13 @@ module FileHandlers
 
     summary "Base class of all file handler plugins"
 
+    VIRTUAL = true
+
     # Specify the extension which should be handled by the class.
     def self.handle_path( path )
       logger.info { "Registering class #{self.name} for handling the path pattern: #{path.inspect}" }
-      (@@config[self].path ||= []) << path
-      handlers = (@@config[DefaultFileHandler].file_handler ||= {})
+      (self.config[self].path ||= []) << path
+      handlers = (self.config[DefaultFileHandler].file_handler ||= {})
       logger.warn { "Path pattern #{path} already associated with class #{handlers[path].name}, not using class #{self.name} for it!" } if handlers[path]
       handlers[path] ||= self
     end
@@ -186,8 +188,8 @@ module FileHandlers
     end
 
     # Return the registered file handler plugins.
-    def get_file_handlers
-      @@config[self.class].file_handler
+    def self.get_file_handlers
+      self.config[self].file_handler
     end
 
     # Supplies the +path+ to a file and the +parent+ node sothat the plugin can create a node for this

data/lib/webgen/plugins/{filehandler/picturegallery.rb → filehandlers/gallery.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: picturegallery.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: gallery.rb 361 2005-11-25 14:17:13Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,29 +20,29 @@
 #++
 #
 
-require 'webgen/plugins/filehandler/filehandler'
-require 'webgen/plugins/filehandler/directory'
-require 'webgen/plugins/filehandler/page'
+require 'webgen/plugins/filehandlers/filehandler'
+require 'webgen/plugins/filehandlers/directory'
+require 'webgen/plugins/filehandlers/page'
 
 module FileHandlers
 
-  class PictureGalleryFileHandler < DefaultFileHandler
+  class GalleryFileHandler < DefaultFileHandler
 
-    summary "Handles picture gallery files for page file"
+    summary "Handles images gallery files"
     extension 'gallery'
-    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 "imagesPerPage", 20, 'Number of images per gallery page'
+    add_param "imagePageInMenu", false, 'True if the image pages should be in the menu'
     add_param "galleryPageInMenu", false, 'True if the gallery pages should be in the menu'
     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 "mainPageInMenu", true, 'True if the main page of the image 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.'
+    add_param "imagePageTemplate", nil, 'The template for image pages. If nil or a not existing file is specified, the default template is used.'
     add_param "mainPageTemplate", nil, 'The template for the main page. If nil or a not existing file is specified, the default template is used.'
-    add_param "files", 'images/**/*.jpg', 'The Dir glob for specifying the picture files'
+    add_param "files", 'images/**/*.jpg', 'The Dir glob for specifying the image files'
     add_param "title", 'Gallery', 'The title of the gallery'
     add_param "layout", 'default', 'The layout used'
 
-    depends_on 'FileHandler', 'PageHandler'
+    depends_on 'FileHandler', 'PageFileHandler'
 
     def create_node( file, parent )
       begin
@@ -53,7 +53,14 @@ module FileHandlers
       end
       @path = File.dirname( file )
       images = Dir[File.join( @path, get_param( 'files' ))].collect {|i| i.sub( /#{@path + File::SEPARATOR}/, '' ) }
-      self.logger.info { "Creating gallery for file <#{file}> with #{images.length} pictures" }
+      images.sort! do |a,b|
+        aoi = @filedata[a].nil? ? 0 : @filedata[a]['orderInfo'] || 0
+        boi = @filedata[b].nil? ? 0 : @filedata[b]['orderInfo'] || 0
+        atitle = @filedata[a].nil? ? a : @filedata[a]['title'] || a
+        btitle = @filedata[b].nil? ? b : @filedata[b]['title'] || b
+        (aoi == boi ? atitle <=> btitle : aoi <=> boi)
+      end
+      self.logger.info { "Creating gallery for file <#{file}> with #{images.length} images" }
 
       create_gallery( images, parent )
 
@@ -75,7 +82,7 @@ module FileHandlers
 
     def call_layouter( type, metainfo, *args )
       content = Webgen::Plugin['DefaultGalleryLayouter'].get_layout( get_param( 'layout' ) ).send( type.to_s, *args )
-      "#{metainfo.to_yaml}\n---\n#{content}"
+      "---\n#{metainfo.to_yaml}\n---\n#{content}"
     end
 
     def create_gallery( images, parent )
@@ -83,7 +90,7 @@ module FileHandlers
       main['galleries'] = create_gallery_pages( images, parent )
 
       if main['galleries'].length != 1
-        mainNode = Webgen::Plugin['PageHandler'].create_node_from_data( call_layouter( :main, main, main ), main['srcName'], parent )
+        mainNode = Webgen::Plugin['PageFileHandler'].create_node_from_data( call_layouter( :main, main, main ), main['srcName'], parent )
         parent.add_child( mainNode )
       else
         main['galleries'][0]['title'] = main['title']
@@ -93,10 +100,10 @@ module FileHandlers
       end
 
       main['galleries'].each_with_index do |gallery, gIndex|
-        node = Webgen::Plugin['PageHandler'].create_node_from_data( call_layouter( :gallery, gallery, main, gIndex ), gallery['srcName'], parent )
+        node = Webgen::Plugin['PageFileHandler'].create_node_from_data( call_layouter( :gallery, gallery, main, gIndex ), gallery['srcName'], parent )
         parent.add_child( node )
         gallery['imageList'].each_with_index do |image, iIndex|
-          node = Webgen::Plugin['PageHandler'].create_node_from_data( call_layouter( :picture, image, main, gIndex, iIndex ), image['srcName'], parent )
+          node = Webgen::Plugin['PageFileHandler'].create_node_from_data( call_layouter( :image, image, main, gIndex, iIndex ), image['srcName'], parent )
           parent.add_child( node )
         end
       end
@@ -115,7 +122,7 @@ module FileHandlers
 
     def create_gallery_pages( images, parent )
       galleries = []
-      picsPerPage = get_param( 'picturesPerPage' )
+      picsPerPage = get_param( 'imagesPerPage' )
       0.step( images.length - 1, picsPerPage ) do |i|
         data = (@filedata['galleryPages'] || {}).dup
 
@@ -126,7 +133,7 @@ module FileHandlers
         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 )
+        data['imageList'] = create_image_pages( images[i..(i + picsPerPage - 1)], parent )
 
         galleries << data
       end
@@ -141,20 +148,20 @@ module FileHandlers
       ( title.nil? ? nil : title.tr( ' .', '_' ) + '.html' )
     end
 
-    def create_picture_pages( images, parent )
+    def create_image_pages( images, parent )
       imageList = []
       images.each do |image|
         imageData = (@filedata[image] || {}).dup
 
         imageData['blocks'] ||= [{'name'=>'content', 'format'=>'html'}]
-        imageData['title'] ||= "Picture #{File.basename( image )}"
+        imageData['title'] ||= "Image #{File.basename( image )}"
         imageData['description'] ||= ''
-        imageData['inMenu'] ||= get_param( 'picturePageInMenu' )
-        imageData['template'] ||= get_param( 'picturePageTemplate' )
+        imageData['inMenu'] ||= get_param( 'imagePageInMenu' )
+        imageData['template'] ||= get_param( 'imagePageTemplate' )
         imageData['imageFilename'] = image
-        imageData['srcName'] = File.basename( image ).tr( ' .', '_' ) + '.html'
-        imageData['thumbnail'] ||= get_thumbnail( imageData, parent )
+        imageData['srcName'] = gallery_file_name( get_param( 'title' ) + ' ' + File.basename( image ) )
         imageData['thumbnailSize'] ||= @filedata['thumbnailSize']
+        imageData['thumbnail'] ||= get_thumbnail( imageData, parent )
 
         imageList << imageData
       end
@@ -171,11 +178,11 @@ module FileHandlers
   begin
     require 'RMagick'
 
-    class PictureGalleryFileHandler
+    class GalleryFileHandler
 
       remove_method :get_thumbnail
       def get_thumbnail( imageData, parent )
-        p_node = Webgen::Plugin['DirHandler'].recursive_create_path( File.dirname( imageData['imageFilename'] ), parent )
+        p_node = Webgen::Plugin['DirectoryHandler'].recursive_create_path( File.dirname( imageData['imageFilename'] ), parent )
         node = Webgen::Plugin['ThumbnailWriter'].create_node( File.join( @path, imageData['imageFilename'] ), p_node, imageData['thumbnailSize'] )
         p_node.add_child( node )
 
@@ -193,7 +200,7 @@ module FileHandlers
         node = Node.new( parent )
         node['title'] = node['src'] = node['dest'] = 'tn_' + File.basename( file )
         node['int:thumbnailFile'] = file
-        node['int:thumbnailSize'] = thumbnailSize
+        node['int:thumbnailSize'] = thumbnailSize unless thumbnailSize.nil? || thumbnailSize !~ /\d+x\d+/
         node['processor'] = self
         node
       end

data/lib/webgen/plugins/{filehandler → filehandlers}/page.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: page.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: page.rb 350 2005-09-02 09:44:23Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,8 @@
 #++
 #
 
-require 'webgen/plugins/filehandler/filehandler'
+require 'webgen/plugins/filehandlers/filehandler'
+require 'webgen/listener'
 require 'yaml'
 require 'erb'
 
@@ -28,7 +29,7 @@ module FileHandlers
 
   # Super class for all page description files. Provides helper methods so that writing new plugins
   # for page description files is easy.
-  class PageHandler < DefaultFileHandler
+  class PageFileHandler < DefaultFileHandler
 
     class PageNode < Node; end;
 
@@ -39,15 +40,27 @@ module FileHandlers
     add_param 'defaultLangInFilename', false, \
     'If true, the output files for the default language will have the ' \
     'language in the file name like all other page files. If false, they won''t.'
-    add_param 'defaultContentFormat', 'textile', 'The default content format used in page files.'
-    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 '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', 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.'
+
+    add_param 'defaultPageMetaData', \
+    {'useERB' => true,
+     'blocks' => [{'name'=>'content', 'format'=>'textile'}]
+    },'Specifies the default meta data for page files.'
 
     used_meta_info 'title', 'orderInfo', 'lang', 'blocks', 'useERB'
 
+
+    include Listener
+
+    def initialize
+      add_msg_name( :AFTER_CONTENT_RENDERED )
+    end
+
     def create_node( srcName, parent )
       create_node_internally( parse_data( File.read( srcName ), srcName ), analyse_file_name( File.basename( srcName ) ), parent )
     end
@@ -58,7 +71,7 @@ module FileHandlers
 
     def render_node( node, with_template = true, block_name = 'content' )
       unless node['int:content-formatted']
-        useERB = node['useERB'] || ( node['useERB'].nil? && get_param( 'useERB' ) )
+        useERB = node['useERB']
         node['blocks'].each do |blockdata|
           begin
             content = ( useERB ? ERB.new( blockdata['data'] ).result( binding ) : blockdata['data'] )
@@ -76,7 +89,7 @@ module FileHandlers
         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}" }
+          logger.error { "ERB threw an error while processing an ERB template (<#{templateNode.recursive_value('src')}>): #{e.message}" }
           outstring = templateNode['content'].dup
         end
       else
@@ -84,7 +97,9 @@ module FileHandlers
         outstring = node[block_name].to_s.dup
       end
 
-      Webgen::Plugin['Tags'].substitute_tags( outstring, node, templateNode )
+      outstring = Webgen::Plugin['Tags'].substitute_tags( outstring, node, templateNode )
+      dispatch_msg( :AFTER_CONTENT_RENDERED, outstring, node )
+      outstring
     end
 
     def write_node( node )
@@ -163,19 +178,19 @@ module FileHandlers
     end
 
     def parse_data( data, srcName )
-      options = {}
+      options = Marshal.load( Marshal.dump( get_param( 'defaultPageMetaData' ) ) )
       blocks = data.split( /^---\s*$/ )
       if blocks.length > 0
         if blocks[0] == ''
           begin
-            options = YAML::load( blocks[1] )
+            options.update( YAML::load( blocks[1] ) )
           rescue ArgumentError => x
             self.logger.error { "Error parsing options for file <#{srcName}>: #{x.message}" }
           end
           blocks[0..1] = []
         end
         blocks.each {|b| b.gsub!( /^(\\+)(---\s*)$/ ) {|m| "\\" * ($1.length / 2) + $2 } }
-        (options['blocks'] ||= [{'name'=>'content', 'format'=>get_param( 'defaultContentFormat' )}]).each do |blockdata|
+        options['blocks'].each do |blockdata|
           if !blockdata.kind_of?( Hash ) || !blockdata['name'] || !blockdata['format']
             self.logger.error { "Block meta information in <#{srcName}> invalid (#{blockdata.inspect})" }
             next
@@ -188,7 +203,7 @@ module FileHandlers
     end
 
     def analyse_file_name( srcName )
-      matchData = /^(?:(\d+)\.)?([^.]*?)(?:\.(\w\w))?\.(.*)$/.match( srcName )
+      matchData = /^(?:(\d+)\.)?([^.]*?)(?:\.(\w\w\w?))?\.(.*)$/.match( srcName )
       analysed = OpenStruct.new
 
       self.logger.info { "Using default language for file <#{srcName}>" } if matchData[3].nil?

data/lib/webgen/plugins/{filehandler → filehandlers}/template.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: template.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: template.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/filehandler/filehandler'
+require 'webgen/plugins/filehandlers/filehandler'
 
 module FileHandlers
 
@@ -57,7 +57,7 @@ module FileHandlers
     #######
 
     def get_template( node )
-      if node['template'].kind_of?( String )
+      if node['template'].kind_of?( String ) && node['template'] != ''
         templateNode = node.node_for_string( node['template'] )
         if templateNode.nil?
           self.logger.warn { "Specified template for file <#{node.recursive_value('src')}> not found, using default template!" }

data/lib/webgen/plugins/{gallerylayouter/defaultgallerylayouter.rb → gallerylayouters/default.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: defaultgallerylayouter.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: default.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,11 +20,11 @@
 #++
 #
 
-module PictureGalleryLayouter
+module GalleryLayouters
 
   class DefaultGalleryLayouter < Webgen::Plugin
 
-    summary "Base class for all Picture Gallery Layouters and, at the same time, default layouter"
+    summary "Base class for all gallery layouters and, at the same time, default layouter"
 
     define_handler 'layout'
 
@@ -49,8 +49,8 @@ module PictureGalleryLayouter
       gIndex != data['galleries'].length - 1 ? gIndex + 1 : nil
     end
 
-    # Returns the gallery and image indices of the previous picture, if it exists, or +nil+ otherwise.
-    def prev_picture( data, gIndex, iIndex )
+    # Returns the gallery and image indices of the previous image, if it exists, or +nil+ otherwise.
+    def prev_image( data, gIndex, iIndex )
       result = nil
       if gIndex != 0 || iIndex != 0
         if iIndex == 0
@@ -64,8 +64,8 @@ module PictureGalleryLayouter
       return result
     end
 
-    # Returns the gallery and image indices of the next picture, if it exists, or +nil+ otherwise.
-    def next_picture( data, gIndex, iIndex )
+    # Returns the gallery and image indices of the next image, if it exists, or +nil+ otherwise.
+    def next_image( data, gIndex, iIndex )
       result = nil
       if gIndex != data['galleries'].length - 1 || iIndex != data['galleries'][gIndex]['imageList'].length - 1
         if iIndex == data['galleries'][gIndex]['imageList'].length - 1
@@ -124,14 +124,14 @@ module PictureGalleryLayouter
     # Should be overwritten by subclasses! +data+ is the data structure which holds all information
     # about the gallery. +gIndex+ is the index of the current gallery. +iIndex+ is the index of the
     # current image.
-    def picture( data, gIndex, iIndex )
+    def image( data, gIndex, iIndex )
       s = "
 <h2>#{data['galleries'][gIndex]['imageList'][iIndex]['title']}</h2>
-<div class=\"webgen-picture\">
+<div class=\"webgen-image\">
 "
       s += "<a href=\"#{data['galleries'][gIndex]['srcName']}\">^&nbsp;#{data['galleries'][gIndex]['title']}&nbsp;^</a><br />"
-      prevGIndex, prevIIndex = prev_picture( data, gIndex, iIndex )
-      nextGIndex, nextIIndex = next_picture( data, gIndex, iIndex )
+      prevGIndex, prevIIndex = prev_image( data, gIndex, iIndex )
+      nextGIndex, nextIIndex = next_image( data, gIndex, iIndex )
       s += "<a href=\"#{data['galleries'][prevGIndex]['imageList'][prevIIndex]['srcName']}\">" \
       "&lt;&nbsp;#{data['galleries'][prevGIndex]['imageList'][prevIIndex]['title']}</a>" unless prevGIndex.nil?
       s += "&nbsp;&mdash;&nbsp;" unless prevGIndex.nil? || nextGIndex.nil?

data/lib/webgen/plugins/{htmlvalidator/defaulthtmlvalidator.rb → htmlvalidators/default.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: defaulthtmlvalidator.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: default.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner

data/lib/webgen/plugins/{htmlvalidator → htmlvalidators}/xmllint.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: xmllint.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: xmllint.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/htmlvalidator/defaulthtmlvalidator'
+require 'webgen/plugins/htmlvalidators/default'
 require "tempfile"
 
 # Allows one to get stdout and stderr from an executed command. Original version

data/lib/webgen/plugins/menustyles/{defaultmenustyle.rb → default.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: defaultmenustyle.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: default.rb 348 2005-09-02 08:43:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,6 @@
 #++
 #
 
-
 module MenuStyles
 
   class DefaultMenuStyle < Webgen::Plugin
@@ -52,6 +51,7 @@ module MenuStyles
     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?']