webgen 0.3.3 → 0.3.4

data/doc/src/documentation/plugins/filehandler/pagehandler.page

@@ -73,8 +73,36 @@ named @sidebar@ and formatted using @markdown@.
 
 h2. Content format
 
-The content of page description can be written in different formats. Have a look at the sub menu
-entries to get an overview of the existing formats.
+h3. Embedded Ruby (ERB)
+
+Before the content is converted to HTML with a specific content handler, ERB is run over the
+content. This allows one to add dynamic content to the web pages without using tags. Following is an
+example of a page file which uses ERB:
+
+<notextile>
+<pre>
+\---
+title: Test page with ERB
+\---
+This page has the following meta info items:
+&lt;% node.metainfo.each do |key, value| %&gt;
+    * &lt;%=key %&gt;: &lt;%=value %&gt;
+&lt;% end %&gt;
+</pre>
+</notextile>
+
+This would output all meta information for the current page. As one can see in the example, the node
+for the current page can be accessed by using @node@. The parameter @useERB@ specifies if ERB should
+be used. To provide more control, one can enable or disable ERB for a page file by setting the meta
+information @useERB@ to @true@ or @false@.
+
+The template will always be processed with ERB!
+
+h3. Format
+
+The content of page description can be written in different formats. Have a look at the
+<a href="{relocatable: ../contenthandler}">Content Handlers</a> to get an overview of the existing
+formats.
 
 h2. Default settings
 
@@ -85,7 +113,7 @@ The following defaults are used:
 
 * Content format
 
-  If there is only content in a page description file, its formatting defaults to the parameter
+  If there is only one content in a page description file, its formatting defaults to the parameter
   value @defaultContentFormat@.
 
 * Title, ordering and language

data/doc/src/documentation/plugins/index.page

@@ -1,6 +1,6 @@
 ---
 title: Plugins
-menuOrder: 30
+orderInfo: 30
 directoryName: Plugins
 ---
 h2. About
@@ -10,7 +10,7 @@ to get more information!
 
 h2. Plugins
 
-Webgen is written with extensibility in mind; therefore most of its features are implemented with
+webgen is written with extensibility in mind; therefore most of its features are implemented with
 plugins, only the core functions are not plugins.
 
 Writing your own plugins is not difficult, too! If you need a specific functionality, implement a

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

@@ -8,14 +8,14 @@ are substituted. For example, the menu you see to left was generated. This makes
 remove menu items. If the menu was not generated, you would have to change every file which uses the
 menu.
 
-Webgen comes bundled with some default tag plugins. All currently available tags are exercised in
+webgen comes bundled with some default tag plugins. All currently available tags are exercised in
 this online demo. Choose a tag from the menu to get a detailed description of the tag.
 
 h2. Usage
 
 Tags are defined by a special markup code. A tag has the following structure:
 
-<pre class="webgen-file">\{tagname: {parameters}}</pre>
+<pre>\{tagname: {parameters}}</pre>
 
 Every time a tag is found in a source file, the registered plugin for the tag is called. The plugin
 returns a string which is put into the output file instead of the tag. The output a tag plugin can
@@ -24,6 +24,11 @@ Meta Tag</a> plugin copies any additional info specified in the source file verb
 into the correct place in the output file. And in contrast, the <a href="{relocatable: menu.html}">
 Menu Tag</a> plugin generates a whole menu tree.
 
+If you want to use the markup code used for tags, you need to escape the tag, like this:
+
+<pre>\\\{tagname: {parameters}}</pre>
+
+
 h2. Tag Parameters
 
 A tag can have zero or more parameters some of which are mandatory. You can see the supported

data/doc/src/documentation/plugins/tags/multilang.fr.page

@@ -1,4 +1,4 @@
 ---
 title: Francais
 ---
-Parle vouz francais?
+Ceci est la version française de cette page.

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.1 or higher
+* "cmdparse":http://cmdparse.rubyforge.org version 1.0.2 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

@@ -5,10 +5,11 @@ 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
+* 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}

data/doc/src/index.page

@@ -1,7 +1,7 @@
 ---
 title: HomePage
 inMenu: true
-directoryName: Webgen
+directoryName: webgen
 ---
 h2. Welcome
 
@@ -18,7 +18,20 @@ list":http://rubyforge.org/mail/?group_id=296 available if you have any question
 
 h2. News
 
-*Webgen 0.3.3 released!!!*
+<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>)!
+* 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 page describing meta information items used by plugins
+* Fixed bugs
+
+<b>21.04.2005 - webgen 0.3.3 released!!!</b>
 
 Major changes:
 
@@ -32,12 +45,12 @@ Major changes:
 * Fixed bugs
 
 
-<b>Webgen 0.3.2 released!!!</b>
+<b>17.03.2005 - webgen 0.3.2 released!!!</b>
 
 Bug fix release for bug #1637 and other bugs
 
 
-*Webgen 0.3.1 released!!!*
+<b>16.03.2005 - webgen 0.3.1 released!!!</b>
 
 Major changes:
 
@@ -51,7 +64,7 @@ Major changes:
 * Fixed bugs
 
 
-*Webgen 0.3.0 released!!!*
+<b>21.02.2005 - webgen 0.3.0 released!!!</b>
 
 Major changes:
 

data/doc/src/meta.info

@@ -1,17 +1,20 @@
 index.html:
-  menuOrder: 1
+  orderInfo: 1
 
 download.html:
-  menuOrder: 3
+  orderInfo: 3
 
 features.html:
-  menuOrder: 5
+  orderInfo: 5
 
 api.html:
   dest: rdoc/index.html
   title: API Reference
-  menuOrder: 7
+  orderInfo: 7
   inMenu: true
 
 documentation/index.html:
-  menuOrder: 9
+  orderInfo: 9
+
+designs:
+  indexFile: ~

data/install.rb

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

data/lib/{util → webgen}/composite.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: composite.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: composite.rb 271 2005-05-09 08:50:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner

data/lib/webgen/configuration.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: configuration.rb 259 2005-04-21 10:37:47Z thomas $
+# $Id: configuration.rb 268 2005-05-02 15:28:31Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -37,7 +37,7 @@ end
 
 module Webgen
 
-  VERSION = [0, 3, 3]
+  VERSION = [0, 3, 4]
   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 " \

data/lib/{util → webgen}/listener.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: listener.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: listener.rb 271 2005-05-09 08:50:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner

data/lib/webgen/node.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: node.rb 258 2005-04-21 10:35:28Z thomas $
+# $Id: node.rb 272 2005-05-09 08:53:04Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'util/composite'
+require 'webgen/composite'
 
 class Node
 
@@ -82,8 +82,8 @@ class Node
 
 
   # Return the node identified by +destString+ relative to the current node.
-  def node_for_string( destString )
-    node = get_node_for_string( destString )
+  def node_for_string( destString, metainfo='dest' )
+    node = get_node_for_string( destString, metainfo )
     if node.nil?
       self.logger.warn { "Could not get destination node '#{destString}' for <#{recursive_value( 'src' )}>" }
     end
@@ -91,8 +91,8 @@ class Node
   end
 
   # Check if there is a node for +destString+.
-  def node_for_string?( destString )
-    get_node_for_string( destString ) != nil
+  def node_for_string?( destString, metainfo='dest' )
+    get_node_for_string( destString, metainfo )
   end
 
   # Return the level of the node. The level specifies how deep the node is in the hierarchy.
@@ -130,7 +130,7 @@ class Node
   private
   #######
 
-  def get_node_for_string( destString )
+  def get_node_for_string( destString, metainfo='dest' )
     if /^\// =~ destString
       node = Node.root( self )
       destString = destString[1..-1]
@@ -145,7 +145,7 @@ class Node
       break if node.nil?
       case element
       when '..' then node = node.parent
-      else node = node.find {|child| /^#{element}\/?$/ =~ child['dest'] }
+      else node = node.find {|child| /^#{element}\/?$/ =~ child[metainfo] }
       end
     end
 
@@ -154,11 +154,11 @@ class Node
       node = startElement
       elements.each_with_index do |element, index|
         break if node.nil?
-        temp = node.find {|child| /^#{elements[index..-1].join( '/' )}\/?$/ =~ child['dest']}
+        temp = node.find {|child| /^#{elements[index..-1].join( '/' )}\/?$/ =~ child[metainfo]}
         if temp.nil?
           case element
           when '..' then node = node.parent
-          else node = node.find {|child| /^#{element}\/?$/ =~ child['dest'] }
+          else node = node.find {|child| /^#{element}\/?$/ =~ child[metainfo] }
           end
         else
           node = temp

data/lib/webgen/plugin.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: plugin.rb 259 2005-04-21 10:37:47Z thomas $
+# $Id: plugin.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -36,6 +36,19 @@ module Webgen
     @@config = {}
     @@configFileData = ( File.exists?( 'config.yaml' ) ? YAML::load( File.new( 'config.yaml' ) ) : {} )
 
+    # Return plugin data
+    def self.config
+      @@config
+    end
+
+    # Shortcut for getting the plugin with the name +name+.
+    def self.[]( name )
+      pair = @@config.find {|k,v| v.plugin == name }
+      self.logger.warn { "Could not retrieve plugin '#{name}' as such a plugin does not exist!" } if pair.nil?
+      pair[1].obj unless pair.nil?
+    end
+
+    # Add subclass to plugin data.
     def self.inherited( klass )
       (@@config[klass] = OpenStruct.new).klass = klass
       @@config[klass].plugin = klass.name.split( /::/ ).last
@@ -45,22 +58,15 @@ module Webgen
       self.module_eval "def self.#{name}( obj ); @@config[self].#{name} = obj; end"
     end
 
-    # Return plugin data
-    def self.config
-      @@config
-    end
-
     # Add a dependency to the plugin. Dependencies are instantiated before the plugin gets
     # instantiated.
     def self.depends_on( *dep )
       dep.each {|d| (@@config[self].dependencies ||= []) << d}
     end
 
-    # Shortcut for getting the plugin with the name +name+.
-    def self.[]( name )
-      pair = @@config.find {|k,v| v.plugin == name }
-      self.logger.warn { "Could not retrieve plugin '#{name}' as such a plugin does not exist!" } if pair.nil?
-      pair[1].obj unless pair.nil?
+    # Specify which meta information entries are used by the plugin.
+    def self.used_meta_info( *names )
+      names.each {|n| (@@config[self].used_meta_info ||= []) << n }
     end
 
     # Add a parameter for the current class. Has to be used by subclasses to define their parameters!
@@ -74,8 +80,9 @@ module Webgen
     def self.add_param( name, default, description, changeHandler = nil )
       self.logger.debug { "Adding parameter '#{name}' for plugin class '#{self.name}'" }
       if @@configFileData.kind_of?( Hash ) && @@configFileData.has_key?( @@config[self].plugin ) \
-        && @@configFileData[@@config[self].plugin].has_key?( name )
+        && @@configFileData[@@config[self].plugin].kind_of?( Hash ) && @@configFileData[@@config[self].plugin].has_key?( name )
         curval = @@configFileData[@@config[self].plugin][name]
+        self.logger.debug { "Using configured value for parameter #{@@config[self].plugin} -> #{name}" }
       else
         curval = default
       end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: backing.rb 256 2005-04-14 01:13:57Z thomas $
+# $Id: backing.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -34,12 +34,13 @@ module FileHandlers
 
     def initialize
       super
-      Webgen::Plugin['FileHandler'].add_msg_listener( :AFTER_DIR_READ, method( :process_backing_file ) )
+      Webgen::Plugin['FileHandler'].add_msg_listener( :AFTER_ALL_READ, method( :process_backing_files ) )
     end
 
     def create_node( path, parent )
       node = Node.new( parent )
       node['src'] = node['dest'] = node['title'] = File.basename( path )
+      node['int:backingFile?'] = true
       begin
         node['content'] = YAML::load( File.new( path ) )
         if !valid_content( node['content'] )
@@ -68,8 +69,8 @@ module FileHandlers
       && data.all? {|k,v| v.kind_of?( Hash ) }
     end
 
-    def process_backing_file( dirNode )
-      backingFiles = dirNode.find_all {|child| /\.#{Webgen::Plugin.config[self.class].extension}$/ =~ child['src'] }
+    def process_backing_files( dirNode )
+      backingFiles = dirNode.find_all {|child| child['int:backingFile?'] }
 
       backingFiles.each do |backingFile|
         backingFile['content'].each do |filename, data|
@@ -82,6 +83,8 @@ module FileHandlers
           end
         end
       end
+
+      dirNode.each {|child| process_backing_files( child ) if child['directory']}
     end
 
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: directory.rb 256 2005-04-14 01:13:57Z thomas $
+# $Id: directory.rb 275 2005-05-11 17:30:20Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -32,13 +32,14 @@ module FileHandlers
 
       def initialize( parent, name )
         super( parent )
-        self['title'] = self['directoryName'] = name
+        self['title'] = name
         self['src'] = self['dest'] = name + '/'
         self['processor'] = Webgen::Plugin['DirHandler']
+        self['int:directory?'] = true
       end
 
       def []( name )
-        process_dir_index if super('indexFile').nil? && name == 'indexFile'
+        process_dir_index if !self.metainfo.has_key?( 'indexFile' ) && name == 'indexFile'
         super
       end
 
@@ -57,10 +58,10 @@ module FileHandlers
 
 
     summary "Handles directories"
-    extension :dir
+    handle_path '**/'
     add_param 'indexFile', 'index.html', 'The default file name for the directory index file.'
     depends_on 'FileHandler'
-
+    used_meta_info 'indexFile', 'directoryName'
 
     # Return a new DirNode.
     def create_node( path, parent )
@@ -79,9 +80,9 @@ module FileHandlers
     # Return the page node for the directory +node+ using the specified language +lang+. If an
     # index file is specified, then the its correct language node is returned, else +node+ is
     # returned.
-    def get_page_node_for_lang( node, lang )
+    def get_node_for_lang( node, lang )
       if node['indexFile']
-        node['indexFile']['processor'].get_page_node_for_lang( node['indexFile'], lang )
+        node['indexFile']['processor'].get_node_for_lang( node['indexFile'], lang )
       else
         node
       end
@@ -89,8 +90,8 @@ module FileHandlers
 
     # Get the HTML link for the directory +node+.
     def get_html_link( node, refNode, title = nil )
-      lang_node = get_page_node_for_lang( node, refNode['lang'] )
-      title ||=  lang_node['directoryName'] || node['directoryName']
+      lang_node = get_node_for_lang( node, refNode['lang'] )
+      title ||=  lang_node['directoryName'] || node['title']
       super( lang_node, refNode, title )
     end