webgen 0.3.4 → 0.3.5

data/doc/src/documentation/plugins/tags/navbar.page

@@ -15,5 +15,6 @@ h2. Examples
 
 table{border:1px solid black}.
 |_.Command|_.Output|
-|<notextile>\{navbar: {separator: " HALLO "}}</notextile>|<notextile>{navbar: {separator: " HALLO "}}</notextile>|
 |\{navbar:}|{navbar:}|
+|<notextile>\{navbar: {separator: " HALLO "}}</notextile>|<notextile>{navbar: {separator: " HALLO "}}</notextile>|
+

data/doc/src/documentation/plugins/tags/resource.page

@@ -0,0 +1,22 @@
+---
+title: Resource
+inMenu: true
+---
+h2. Information
+
+<notextile>{describe: ResourceTag}</notextile>
+
+h2. Description
+
+The resource tag is used to include a resource either verbatim (i.e. its content is copied) or by
+path. For more information about resources have a look at the
+<a href="{relocatable: ../resourcemanager.page}">Resource Manager</a>.
+
+h2. Examples
+
+table{border:1px solid black}.
+|_{width: 30%}.Command|_.Output|
+|\{resource: webgen-logo}|{resource: webgen-logo}|
+|\{resource: w3c-valid-xhtml11}|{resource: w3c-valid-xhtml11}|
+|\{resource: {name: webgen-css, insert: data}}|{resource: {name: webgen-css, insert: data}}|
+

data/doc/src/download.page

@@ -12,7 +12,7 @@ Download: "http://rubyforge.org/frs/?group_id=296":http://rubyforge.org/frs/?gro
 
 h2. Dependencies
 
-* "cmdparse":http://cmdparse.rubyforge.org version 1.0.2 or higher
+* "cmdparse":http://cmdparse.rubyforge.org version 1.0.3 or higher
 * "RedCloth":http://redcloth.rubyforge.org version 2.0.10 or higher if you want Textile support
 * "BlueCloth":http://www.deveiate.org version 1.0.0 or higher if you want Markdown support
 * "RMagick":http://rmagick.rubyforge.org/ version 1.7.1 or higher if you want automatic thumbnail

data/doc/src/features.page

@@ -4,12 +4,35 @@ inMenu: true
 ---
 h2. Feature list
 
-* Easily extendable through plugins
-* Easy to install and use
-* Uses templates for separating layout from content
-* Supports several different content formats (Textile, Markdown, RDOC, plain HTML), new ones are easy to add
-* Uses 'tags' to add generated, ie. dynamic, content to the web pages -- standard distribution provides often used tags
-* Supports 'virtual files' via meta information backing files
-* Automatically checks generated files if they are standard conform
-* Easy to configure if one needs to (no need if you are happy with the default values)
-* Relatively fast: processes ~1000 files in ~25 seconds on an {execute: uname -p}
+* <h3>webgen core</h3>
+
+  * Easily extendable through plugins
+  * Easy to install and use
+  * Uses templates for separating layout from content
+  * Easy to configure if one needs to (no need if you are happy with the default values)
+  * Command line interface uses command style syntax (like Subversion's @svn@ command)
+  * Fast
+
+* <h3>File Handler (for handling the files in the source directory)</h3>
+
+  * Powerful file copy handler for copying single files or entire directories to the output directory
+  * Support for gallery definition files -> generates entire picture gallery, automatic thumbnail creation
+
+* <h3>Page Description Files (for define web pages)</h3>
+
+  * Support for ERB (embedded Ruby) in page description files and in templates
+  * Supports several different content formats (Textile, Markdown, RDOC, plain HTML), new ones are easy to add
+  * Support for specifying meta information (e.g. title, menu ordering information, ...)
+
+* <h3>Tags (used for easily adding dynamic content to web pages)</h3>
+
+  * Standard distribution provides often used tags
+  * Menu tag can generate different types of menus (simple menus and ones with CSS drop downs)
+  * Navbar tag generates a navigation bar so that one always knows where he is in the hierarchy
+  * Relocatable tag for automatically generating correct relative paths to files
+  * ... and much more!
+
+* <h3>Other Features</h3>
+
+  * Automatically checks generated files if they are standard conform
+  * Supports 'virtual files' via meta information backing files

data/doc/src/index.page

@@ -5,7 +5,7 @@ directoryName: webgen
 ---
 h2. Welcome
 
-... to the homepage of _*webgen*_, a template based web page generator.
+... to the homepage of _*webgen*_, a template based static website generator.
 
 This whole site was generated with webgen and provides an online demonstration of its features.
 Choose from the menu what you want to see from or know about webgen!
@@ -18,16 +18,30 @@ list":http://rubyforge.org/mail/?group_id=296 available if you have any question
 
 h2. News
 
+<b>??.??.2005 - webgen 0.3.5 released!!!</b>
+
+Major changes:
+
+* Now using cmdparse version 1.0.3!
+* New CLI command "clean" for deleting the generated or all files from the output directory
+* Restructured menu tag -> five different menu styles now available (see <a href="{relocatable: documentation/plugins/menustyles}">Menu Styles</a>)
+* New plugin <a href="{relocatable: documentation/plugins/resourcemanager.page}">ResourceManager</a> for defining resources
+* New plugin <a href="{relocatable: documentation/plugins/tags/resource.page}">Resource Tag</a> for accessing resources
+* Pages files can now be referenced in @relocatable@ tag and backing files with a standardified name (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page#naming}">here</a>), despite an eventually self defined naming scheme
+* New parameters: <a href="{relocatable: documentation/plugins/tags/langbar.page}">LangbarTag:showOwnLang</a>
+* Changed paramters: <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler:validator</a> (now deactivated by default)
+* Fixed bugs
+
 <b>12.05.2005 - webgen 0.3.4 released!!!</b>
 
 Major changes:
 
 * FileHandler now uses path patterns and/or extensions for determining which files to process !
-* ERB (embedded ruby) can now be used in templates and page files (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.html}">PageHandler</a>)!
+* ERB (embedded ruby) can now be used in templates and page files (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler</a>)!
 * Relocatable tag now accepts complex URIs (URIs with query and fragment part, absolute URIs)
 * Changed meta info name *menuOrder* to *orderInfo* (e.g. used for specifying order information for menus) -- you have to adapt your page and backing files!!!
-* New parameters: <a href="{relocatable: documentation/plugins/filehandler/pagehandler.html}">PageHandler:useERB</a>
-* Changed parameters: <a href="{relocatable: documentation/plugins/filehandler}">FileHandler:ignorePaths</a>, <a href="{relocatable: documentation/plugins/filehandler/copy.html}">FileCopyHandler:paths</a>
+* New parameters: <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler:useERB</a>
+* Changed parameters: <a href="{relocatable: documentation/plugins/filehandler}">FileHandler:ignorePaths</a>, <a href="{relocatable: documentation/plugins/filehandler/copy.page}">FileCopyHandler:paths</a>
 * New page describing meta information items used by plugins
 * Fixed bugs
 
@@ -39,8 +53,8 @@ Major changes:
 * Now you can let webgen create the basic directories and files by executing @webgen create my_site@
 * New logging plugin lets you have more control over logging and log files
 * Now each website can have a plugin directory
-* New parameters for: <a href="{relocatable: documentation/plugins/tags/wikilink.html}">wikilink</a>
-* Changed format of backing files -> have a look at the <a href="{relocatable: documentation/plugins/filehandler/backing.html}">documentation</a>!
+* New parameters for: <a href="{relocatable: documentation/plugins/tags/wikilink.page}">wikilink</a>
+* Changed format of backing files -> have a look at the <a href="{relocatable: documentation/plugins/filehandler/backing.page}">documentation</a>!
 * Removed obsolete Extension Loader plugin
 * Fixed bugs
 
@@ -54,10 +68,10 @@ Bug fix release for bug #1637 and other bugs
 
 Major changes:
 
-* Better DefaultLayouter for picture galleries (<a href="{relocatable: Design_Gallery_1.html}">online demo</a>)
-* Output names for page files now customizable (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.html}">PageHandler</a>)
+* Better DefaultLayouter for picture galleries (<a href="{relocatable: Design_Gallery_1.page}">online demo</a>)
+* Output names for page files now customizable (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler</a>)
 * On-the-fly creation of thumbnails for pictures with RMagick
-* New tags: <a href="{relocatable: documentation/plugins/tags/sitemap.html}">sitemap</a>
+* New tags: <a href="{relocatable: documentation/plugins/tags/sitemap.page}">sitemap</a>
 * Tag @lang@ renamed, new name @langbar@!
 * New parameters for @menu@ tag
 * Automatic checking of HTML files on their validness
@@ -69,7 +83,7 @@ Major changes:
 Major changes:
 
 * Textile, Markdown, RDOC and HTML as content format supported!!!
-* New tags: <a href="{relocatable: documentation/plugins/tags/wikilink.html}">wikilink</a>
+* New tags: <a href="{relocatable: documentation/plugins/tags/wikilink.page}">wikilink</a>
 * Improved plugin system
 * On-the-fly creation of new tags
 * Fixed bugs

data/doc/src/meta.info

@@ -1,19 +1,29 @@
-index.html:
+index.page:
   orderInfo: 1
 
-download.html:
-  orderInfo: 3
+download.page:
+  orderInfo: 11
 
-features.html:
+features.page:
   orderInfo: 5
 
 api.html:
   dest: rdoc/index.html
   title: API Reference
-  orderInfo: 7
+
+documentation/api.html:
+  dest: ../rdoc/index.html
+  title: API Reference
+  inMenu: true
+  orderInfo: 60
+
+documentation/wiki.html:
+  dest: http://webgen.rubyforge.org/wiki/wiki.pl
+  title: Wiki Web
   inMenu: true
+  orderInfo: 50
 
-documentation/index.html:
+documentation/index.page:
   orderInfo: 9
 
 designs:

data/install.rb

@@ -3,7 +3,7 @@ require 'rpa/install'
 
 class Install_webgen < RPA::Install::FullInstaller
   name 'webgen'
-  version '0.3.4-1'
+  version '0.3.5-1'
   classification Application
   build do
     installdocs %w[COPYING ChangeLog TODO]

data/lib/webgen/configuration.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: configuration.rb 268 2005-05-02 15:28:31Z thomas $
+# $Id: configuration.rb 303 2005-06-24 13:44:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -37,7 +37,7 @@ end
 
 module Webgen
 
-  VERSION = [0, 3, 4]
+  VERSION = [0, 3, 5]
   SUMMARY = "Webgen is a templated based static website generator."
   DESCRIPTION = "Webgen is a web page generator implemented in Ruby. " \
   "It is used to generate static web pages from templates and page " \
@@ -52,6 +52,28 @@ module Webgen
     add_param 'outDirectory', 'output', 'The directory to which the output files are written.'
     add_param 'lang', 'en', 'The default language.'
 
+    # Returns the data directory of webgen.
+    def self.data_dir
+      unless defined?( @@data_dir )
+        @@data_dir = File.join( Config::CONFIG["datadir"], "webgen" )
+
+        if defined?( Gem::Cache )
+          gem = Gem::Cache.from_installed_gems.search( "webgen", "=#{Webgen::VERSION.join('.')}" ).last
+          @@data_dir = File.join( gem.full_gem_path, "data", "webgen" ) if gem
+        end
+
+        @@data_dir =  File.dirname( $0 ) + '/../data/webgen' if !File.exists?( @@data_dir )
+
+        if File.exists?( @@data_dir )
+          logger.info { "Webgen data directory found at #{@@data_dir}" }
+        else
+          logger.error { "Could not locate webgen data directory!!!" }
+          @@data_dir = ''
+        end
+      end
+      @@data_dir
+    end
+
     # Does all the initialisation stuff
     def init_all
       load_plugins( File.dirname( __FILE__) + '/plugins', File.dirname( __FILE__).sub(/webgen$/, '') )

data/lib/webgen/node.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: node.rb 272 2005-05-09 08:53:04Z thomas $
+# $Id: node.rb 294 2005-06-14 06:37:56Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,6 +20,7 @@
 #++
 #
 
+require 'uri'
 require 'webgen/composite'
 
 class Node
@@ -56,13 +57,25 @@ class Node
   end
 
 
+  # Returns the relative path from this node to +dest+.
+  def relpath_to_string( dest )
+    if dest[0] == ?/
+      from = recursive_value( 'dest' ).sub( /#{self['dest']}$/, '' ).split( '/' )[1..-1] || []
+      from.fill( '..' )
+      from.concat( dest.split( '/' )[1..-1] ).join( '/' )
+    else
+      from = recursive_value( 'dest' ).sub( /#{self['dest']}$/, '' ).split( '/' )[1..-1] || []
+      from.concat( dest.split( '/' ) ).join( '/' )
+    end
+  end
+
   # Return the relative path from this node to the destNode, virtual nodes are not used in the
   # calculation. The destNode can be any non virtual node. If +destNode+ starts with http://, the
   # relative path to it is the empty string. If +includeDestNode+ is true, then the path of the
   # destination node is appended to the calculated path.
   def relpath_to_node( destNode, includeDestNode = true)
-    if destNode['dest'] =~ /^http:\/\//
-      path = ''
+    if URI::parse( destNode['dest'] ).absolute?
+      path = destNode['dest']
     else
       from = recursive_value( 'dest' ).sub( /#{self['dest']}$/, '' ).split( '/' )[1..-1] || []
       to = destNode.recursive_value( 'dest' ).sub( /#{destNode['dest']}$/, '' ).split( '/' )[1..-1] || []
@@ -126,6 +139,11 @@ class Node
     node
   end
 
+  # Returns an informative representation of the node.
+  def to_s
+    "<##{self.class.name}: src=#{@metainfo['src']}, dest=#{@metainfo['dest']}, title=#{@metainfo['title']}>"
+  end
+
   #######
   private
   #######
@@ -135,17 +153,23 @@ class Node
       node = Node.root( self )
       destString = destString[1..-1]
     else
-      node = self.parent_dir || self
+      node = @metainfo['int:directory?'] ? self : self.parent_dir || self
     end
 
     startElement = node
     elements = destString.split( '/' )
+    pagelang = (/\.(\w\w)\.page$/ =~ destString ? $1 : Webgen::Plugin['Configuration']['lang'])
 
     elements.each do |element|
       break if node.nil?
       case element
       when '..' then node = node.parent
-      else node = node.find {|child| /^#{element}\/?$/ =~ child[metainfo] }
+      else
+        node = node.find do |child|
+          /^#{element}\/?$/ =~ child[metainfo] || \
+          (metainfo == 'dest' && (child['int:pagename'] == element || child['int:local-pagename'] == element) && \
+           child['lang'] == pagelang)
+        end
       end
     end
 

data/lib/webgen/plugin.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: plugin.rb 275 2005-05-11 17:30:20Z thomas $
+# $Id: plugin.rb 293 2005-06-11 08:37:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -156,10 +156,6 @@ module Webgen
       module_eval s
     end
 
-    #######
-    private
-    #######
-
     # Return the ancestor classes for the object's class which are sub classes from Plugin.
     def self.ancestor_classes
       self.ancestors.delete_if {|c| c.instance_of?( Module ) }[0..-3]

data/lib/webgen/plugins/contenthandler/textile.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: textile.rb 212 2005-02-27 12:02:27Z thomas $
+# $Id: textile.rb 288 2005-05-29 12:25:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -35,8 +35,8 @@ begin
 
       def format_content( txt )
         RedCloth.new( txt ).to_html
-      rescue
-        self.logger.error { "Error converting Textile text to HTML" }
+      rescue Exception => e
+        self.logger.error { "Error converting Textile text to HTML: #{e.message}" }
         ''
       end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: backing.rb 275 2005-05-11 17:30:20Z thomas $
+# $Id: backing.rb 294 2005-06-14 06:37:56Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -74,8 +74,8 @@ module FileHandlers
 
       backingFiles.each do |backingFile|
         backingFile['content'].each do |filename, data|
-          if dirNode.node_for_string?( filename )
-            backedFile = dirNode.node_for_string( filename )
+          backedFile = dirNode.node_for_string?( filename )
+          if backedFile
             self.logger.info { "Setting meta info data on file <#{backedFile.recursive_value( 'dest' )}>" }
             backedFile.metainfo.update( data )
           else
@@ -84,7 +84,7 @@ module FileHandlers
         end
       end
 
-      dirNode.each {|child| process_backing_files( child ) if child['directory']}
+      dirNode.each {|child| process_backing_files( child ) if child['int:directory?']}
     end
 
 
@@ -97,6 +97,7 @@ module FileHandlers
       pageNode = Webgen::Plugin['VirtualPageHandler'].create_node_from_data( '', filename, dirNode )
       dirNode.add_child( pageNode )
       pageNode.metainfo.update( data )
+      pageNode['int:virtualNode'] = true
       self.logger.info { "Created virtual node <#{pageNode.recursive_value( 'src' )}> (#{pageNode['lang']}) in <#{dirNode.recursive_value( 'dest' )}> " \
         "referencing '#{pageNode['dest']}'" }
     end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: directory.rb 275 2005-05-11 17:30:20Z thomas $
+# $Id: directory.rb 288 2005-05-29 12:25:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -44,7 +44,7 @@ module FileHandlers
       end
 
       def process_dir_index
-        node = Webgen::Plugin['PageHandler'].get_page_node_by_name( self, Webgen::Plugin['DirHandler']['indexFile'] )
+        node = node_for_string( Webgen::Plugin['DirHandler']['indexFile'] )
         if node
           self.logger.info { "Directory index file for <#{self.recursive_value( 'src' )}> => <#{node.recursive_value( 'src', false )}>" }
           self['indexFile'] = node
@@ -59,7 +59,7 @@ module FileHandlers
 
     summary "Handles directories"
     handle_path '**/'
-    add_param 'indexFile', 'index.html', 'The default file name for the directory index file.'
+    add_param 'indexFile', 'index.page', 'The default file name for the directory index page file.'
     depends_on 'FileHandler'
     used_meta_info 'indexFile', 'directoryName'
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: filehandler.rb 272 2005-05-09 08:53:04Z thomas $
+# $Id: filehandler.rb 293 2005-06-11 08:37:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -40,6 +40,7 @@ module FileHandlers
 
     def initialize
       add_msg_name( :AFTER_ALL_READ )
+      add_msg_name( :AFTER_ALL_WRITTEN )
     end
 
     # Builds the tree with all the nodes and returns it.
@@ -56,7 +57,7 @@ module FileHandlers
       rootPath = Webgen::Plugin['Configuration']['srcDirectory'] + File::SEPARATOR
       rootHandler = handler_for_path( rootPath, handlerFiles )
       if rootHandler.nil? || allFiles.empty?
-        logger.error { "No file handler for root directory <#{rootPath}> found" } if rootHandler.nil?
+        logger.error { "No file handler for root directory <#{rootPath}> found" } if rootHandler.nil? && !allFiles.empty?
         logger.error { "No files found in directory <#{rootPath}>" } if allFiles.empty?
         return nil
       end
@@ -90,6 +91,8 @@ module FileHandlers
       node.each do |child|
         write_tree( child )
       end
+
+      dispatch_msg( :AFTER_ALL_WRITTEN ) if node.parent.nil?
     end
 
 
@@ -153,7 +156,8 @@ module FileHandlers
     end
 
     def handler_for_path( path, handlerFiles )
-      handlerFiles.find {|p, handler| p.include?( path )}[1]
+      temp, handler = handlerFiles.find {|p, handler| p.include?( path )}
+      handler
     end
 
     def sort_file_handlers( handlers )
@@ -209,7 +213,7 @@ module FileHandlers
     # Returns a HTML link for the given +node+ relative to +refNode+. You can optionally specify the
     # title for the link. If not specified, the title of the node is used.
     def get_html_link( node, refNode, title = node['title'] )
-      "<a href=\"#{refNode.relpath_to_node( node )}\">#{title}</a>"
+      "<a href=\"#{refNode.relpath_to_node( node )}\" title=\"#{title}\">#{title}</a>"
     end
 
   end