webgen 0.4.1 → 0.4.2

data/doc/src/documentation/references/webpage_format.page

@@ -242,6 +242,10 @@ use in your ERB code:
 * @ref_node@: the reference node, i.e. the node in which the content will be embedded (normally a
   template file)
 
+*Caveat*: you may need to ensure that the ERB start and end tags are not processed by the content
+converter. For example, with Textile you may need to surround the ERB code with <textile>
+tags!
+
 
 h3(#proc-tags). Evaluating webgen Tags
 

data/doc/src/examples/example_sites/index.page

@@ -0,0 +1,41 @@
+---
+title: Index
+directoryName: Example Websites
+---
+h2. List of example websites
+
+
+Here is a list of the available example sites:
+
+* webgen homepage: included in the webgen distribution in the @doc@ directory
+
+  The webgen homepage uses many features of webgen so it is a very good example for a webgen
+  website.
+
+* personal homepage example: {download: personal.zip}
+
+  From the README:
+
+  This is an example site for a personal homepage done with webgen.
+  Have a look at the files in the src directory to see what it
+  takes to make the homepage.
+
+  It features, among others, the following things:
+
+  * multilingual pages
+  * dynamic menu generation with some static parts
+  * an automatically generated breadcrumb trail
+  * pages in different markup languages (textile, markdown)
+
+  By running webgen in this directory, the homepage gets built and
+  you can view the output in the output directory with a browser.
+
+* photo gallery example: {download: photo_gallery.zip}
+
+  From the README:
+
+  This example shows you how to create a simple photo gallery with
+  webgen. It also shows how to use image navigation links in the main
+  template.
+
+  To create the output just run webgen in this directory!

data/doc/src/examples/index.page

@@ -2,7 +2,7 @@
 title: Index
 directoryName: Examples
 ---
-h2(#overview). Overview
+h2. Overview
 
 
 This section shows examples for various parts of webgen. Currently, there are examples for
@@ -10,6 +10,7 @@ This section shows examples for various parts of webgen. Currently, there are ex
 * website templates
 * website styles
 * gallery styles
+* whole website done with webgen
 
 Most of the website styles are from open source web design sites and have been adjusted to work with
 webgen. Detailed information and full demos of these styles are available at the homepage specified

data/doc/src/js/sipttra.js

@@ -0,0 +1,7 @@
+function toogle( element ) {
+  if (document.getElementById(element).style.display == "block") {
+    document.getElementById(element).style.display = "none";
+  } else {
+    document.getElementById(element).style.display = "block";
+  }
+}

data/doc/src/news.page

@@ -5,6 +5,31 @@ inMenu: true
 h2. News
 
 
+h3(#news-2007-02-28). 28.02.2007 - webgen 0.4.2
+
+
+Another minor release which concentrates on fixing some bugs and adding some new features:
+
+New features:
+
+* Implemented support for <a href="{relocatable:/documentation/references/sipttra_format.page}">sipttra</a> (Simple Plain Text Tracker) files and using it for the <a href="{relocatable: project.page}">project status page</a>
+* HTML is now the default content format for template files (also see "FR#7893":http://rubyforge.org/tracker/?func=detail&atid=1210&aid=7893&group_id=296)
+* New parameters for {plugin: Tag/BreadcrumbTrail}: {param: Tag/BreadcrumbTrail:omitLast} and {param: Tag/BreadcrumbTrail:omitIndexFile} (also see "Patch#7942":http://rubyforge.org/tracker/?func=detail&atid=1209&aid=7942&group_id=296)
+* New parameter {param: Core/Configuration:customVars} for storing custom global variables and a new plugin {plugin: Tag/CustomVar} for accessing them
+* Added an example websites section to the examples section (also see "FR#7827":http://rubyforge.org/tracker/?func=detail&atid=1210&aid=7827&group_id=296)!
+* Added a <a href="{relocatable: documentation/howto.page}">HowTo page</a> which answer some often asked questions!
+* Added a man page contributed by the Debian project
+
+Closed bugs:
+
+* Specifying arguments to the @run@ command to render only certain files now actually works! ;-)
+* Fixed bug when loading site specific plugins: the use of @load_plugin@ should now work correctly!
+* All website styles updated to behave correctly when {param: File/DefaultHandler:linkToCurrentPage} is false
+
+Thanks for the many comments and suggestions since the last release, especially to Bill Paxton,
+Massimiliano Filacchioni, Erhard Karger, Alejandro Sierra, Fritz Heinrichmeyer and Vincent Fourmond!
+
+
 h3(#news-2007-01-12). 12.01.2007 - webgen 0.4.1
 
 

data/doc/src/project.todo

@@ -0,0 +1,91 @@
+---
+webgen-metainfo:
+  inMenu: true
+  title: Project Status
+---
+
+The following category defines all milestones for webgen:
+
+
+###### Milestones ######
+
+
+* Feb07 (2007-02-28) Bug fixes and small enhancements
+  - include patches/requests created since 0.4.1 release
+  - add support for sipttra (Simple Plain Text Tracker) files
+
+
+* F: Ideas and todo items for future versions
+
+  This milestone holds all ideas/todo items/requests which are implemented some
+  time in the future.
+
+
+Categories for implementation issues:
+
+
+###### Implementation (open) ######
+
+
+* T002 [F] add localization support for all files
+  See also FR#7891
+
+* T003 [F] add additional tests for sipttra implementation
+
+
+## Implementation (closed) ##
+
+* T004 [Feb07] use HTML as default format for templates
+  See also FR#7893
+
+* T006 [Feb07] add parameter for not showing index files in breadcrumb trail
+  See also PATCH#7942
+
+* T007 [Feb07] implement a plugin for storing/accessing global variables
+
+* T001 [Feb07] add support for sipttra files
+
+
+###### Bugs (open) ######
+
+
+
+## Bugs (closed) ##
+
+* T005 [Feb07] check all styles for correctly selected menu items
+  style issues because of new span element when File/DefaultHandler:linkToCurrentPage is false
+
+* T009 [Feb07] PluginManager#init: log typo for "creating plugin of class..."
+
+* T012 [Feb07] update copyright notices for included website templates
+  See also Bug#8725
+
+* T008 [Feb07] PluginLoader shouldn't load plugins that are already loaded in the DEFAULT_WRAPPER_MODULE
+  When site plugins use the load_plugin command to load plugins that are shipped with webgen and loaded by
+  default, some plugins don't work correctly as plugin classes get defined twice with different oids.
+
+* T013 [Feb07] fix TreeWalker
+  Make TreeWalker work as in 0.3.8 again, name it 'Misc/TreeWalker' and call it after building and
+  before writing tree
+
+
+Category for documentation issues:
+
+
+###### Documentation (open) ######
+
+
+* T014 [F] add plugin developer documentation
+  - document how to write various plugins (file handler, tag, CLI command, ...)
+  - caveat when using classes in modules
+
+
+## Documentation (closed) ##
+
+* T010 [Feb07] add some example sites
+  It was requested that one should be able to download some zipped examples sites from the examples
+  section showing basic use cases for webgen.
+
+* T011 [Feb07] add example section for sipttra style files
+
+* T015 [Feb07] add a resource reference page with the table of resources

data/doc/src/sipttra.template

@@ -0,0 +1,105 @@
+--- content, html
+<% sipttra = node.node_info[:sipttra] %>
+
+<div class="sipttra">
+
+
+<h1>Milestones</h1>
+
+<% sipttra.milestones.each do |ms| %>
+
+<div class="milestone">
+
+<h2 class="milestone-name" id="ticket-<%= ms.name %>">Milestone: <span><%= ms.name %></span></h2>
+<p class="milestone-info">
+<% if ms.due_date %>Due on: <span class="date"><%= ms.due_date %></span><% else %>No due date<% end %>
+<% if ms.belongs_to %> | <% end %>
+<% if ms.belongs_to %>Belongs to milestone: <span class="belongs-to"><%= ms.belongs_to %></span><% end %>
+</p>
+
+
+<%
+  if ms.all_assigned_tickets.length > 0
+    closed = ms.all_assigned_tickets( :closed ).length
+    all = ms.all_assigned_tickets.length
+    percent = "%.2f" % (100 * closed.to_f / all)
+%>
+<div class="progress-info">
+<div class="progress-bar">
+  <div class="progress-indicator" style="width: <%= percent %>%"></div>
+</div>
+<p class="progress-text"><%= closed %> out of <%= all %> tickets (= <%= percent %>%) closed (including tickets in sub milestones)</p>
+</div>
+<% end %>
+
+
+<div class="milestone-summary"><%= CGI.escapeHTML(ms.summary) %></div>
+<% if !ms.description.to_s.empty? %>
+<p><b>Detailed description:</b></p>
+<div class="milestone-description"><%= sipttra.htmlize(ms.description) %></div>
+<% end %>
+
+<% if ms.assigned_tickets.length > 0 %>
+<p>Tickets directly assigned to milestone (<a href="javascript: toogle('assigned-tickets_<%= ms.name %>')">show/hide</a>):</p>
+<ul id="assigned-tickets_<%= ms.name %>" class="assigned-tickets">
+<% ms.assigned_tickets.each do |ticket| %>
+  <li>
+    <% if ticket.name.to_s.empty? %>
+    <a href='#category-<%= ticket.category.name %>'><%= CGI.escapeHTML(ticket.summary) %></a>
+    <% else %>
+    <a href='#ticket-<%= ticket.name %>'><%= ticket.name %>: <%= CGI.escapeHTML(ticket.summary) %></a>
+    <% end %>
+    <% if ticket.closed? %>(closed)<% end %>
+  </li>
+<% end %>
+</ul>
+<% end %>
+
+
+<% if ms.sub_milestones.length > 0 %>
+<p>Sub milestones (<a href="javascript: toogle('sub-milestones-<%= ms.name %>')">show/hide</a>):</p>
+<ul id="sub-milestones_<%= ms.name %>" class="sub-milestones">
+<% ms.sub_milestones.each do |sms| %>
+<li><a href='#ticket-<%= sms.name %>'><%= sms.name %></a> <% if sms.closed? %>(closed)<% end %></li>
+<% end %>
+</ul>
+<% end %>
+
+</div>
+
+<% end %>
+
+
+<h1>Tickets</h1>
+
+<% sipttra.category_names.each do |cat_name| %>
+
+<div class="ticket">
+
+<h2 id="category-<%= cat_name %>">Category: <%= cat_name %></h2>
+
+<table class='tickets'>
+  <tr class='header'><th>Name</th><th>Due&nbsp;Date</th><th>Belongs&nbsp;To</th><th>Text</th><th>Type</th></tr>
+
+<% sipttra.tickets_for_category( cat_name ).each do |ticket| %>
+  <tr class='<%= ticket.category.type %>'>
+    <td class='name'<%= ticket.name ? ' id="ticket-' + ticket.name + '"' : '' %>><%= ticket.name %></td>
+    <td class='due_date'><%= ticket.due_date %></td>
+    <td class='belongs_to'><a href='#ticket-<%= ticket.belongs_to %>'><%= ticket.belongs_to %></a></td>
+    <td class='text'>
+      <% if !ticket.description.empty? %><span style="float:right">(<a href="javascript: toogle('ticket-description-<%= ticket.hash.abs %>')">details</a>)</span><% end %>
+      <%= CGI.escapeHTML(ticket.summary) %>
+      <% if !ticket.description.empty? %><div class="ticket-description" id="ticket-description-<%= ticket.hash.abs %>"><%= BlueCloth.new(ticket.description).to_html %></div><% end %>
+    </td>
+    <td class='type'><%= ticket.category.type %></td>
+  </tr>
+<% end %>
+
+</table>
+
+</div>
+
+<% end %>
+
+
+</div>

data/lib/webgen/cli.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: cli.rb 579 2007-01-04 20:48:43Z thomas $
+# $Id: cli.rb 601 2007-02-14 21:20:44Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -200,6 +200,36 @@ module Webgen
         end
       end
       self.add_command( useGalleryStyle )
+
+      # Use sipttra style command.
+      useSipttraStyle = CmdParse::Command.new( 'sipttra_style', false )
+      useSipttraStyle.short_desc = "Changes the used sipttra style"
+      useSipttraStyle.description =
+        CliUtils.format("\nCopies the sipttra styles files for the sipttra style STYLE to the website " +
+                        "directory defined by the global directory option, overwritting existing files. " +
+                        "If the global verbosity level is set to 0 or 1, the copied files are listed.")
+      useSipttraStyle.options = CmdParse::OptionParserWrapper.new do |opts|
+        opts.separator "Available styles:"
+        opts.separator ""
+        Webgen::SipttraStyle.entries.sort.each {|name, entry| CliUtils.dirinfo_output( opts, name, entry ) }
+      end
+      def useSipttraStyle.usage
+        "Usage: #{commandparser.program_name} [global options] use sipttra_style STYLE"
+      end
+      useSipttraStyle.set_execution_block do |args|
+        if args.length == 0
+          raise OptionParser::MissingArgument.new( 'STYLE' )
+        else
+          if @force || ask_overwrite
+            files = Webgen::WebSite.use_sipttra_style( cmdparser.directory, args[0] )
+            if (0..1) === cmdparser.verbosity
+              puts "The following files were created or overwritten:"
+              puts files.collect {|f| "- " + f }.join("\n")
+            end
+          end
+        end
+      end
+      self.add_command( useSipttraStyle )
     end
 
     #######

data/lib/webgen/config.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: config.rb 586 2007-01-10 16:46:05Z thomas $
+# $Id: config.rb 621 2007-02-28 09:45:30Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -24,7 +24,7 @@ require 'rbconfig'
 
 module Webgen
 
-  VERSION = [0, 4, 1]
+  VERSION = [0, 4, 2]
   AUTHOR = 'Thomas Leitner <t_leitner@gmx.at>'
   SUMMARY = "webgen is a templated based static Web site generator."
   DESCRIPTION = "webgen is a Web site generator implemented in Ruby. " \

data/lib/webgen/plugin.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: plugin.rb 578 2007-01-04 20:35:37Z thomas $
+# $Id: plugin.rb 611 2007-02-19 15:30:54Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -191,6 +191,10 @@ module Webgen
     # The optional parts managed (loaded or not) by this PluginLoader instance.
     attr_reader :optional_parts
 
+    # The files loaded by this PluginLoader instance.
+    attr_reader :loaded_files
+
+
     # Creates a new PluginLoader instance. The +wrapper_module+ is used when loading the plugins so
     # that they do not pollute the global namespace.
     def initialize( wrapper_module = Module.new )
@@ -220,7 +224,7 @@ module Webgen
           load_plugin( file )
           nil
         end
-        do_load_file = !@loaded_files.include?( file ) unless file.nil?
+        do_load_file = !@loaded_files.include?( file ) && !DEFAULT_PLUGIN_LOADER.loaded_files.include?( file ) unless file.nil?
         @loaded_files << file unless file.nil? || @loaded_files.include?( file )
         cont.call( @wrapper_module, do_load_file ) if cont
       end
@@ -363,7 +367,7 @@ module Webgen
       dep.tsort.each do |plugin_name|
         config = plugin_class_for_name( plugin_name ).config
         unless config.infos.has_key?(:instantiate) && !config.infos[:instantiate]
-          log_msg( :debug, 'PluginManager#init') { "Creating plugin of class #{config.plugin_name}" }
+          log_msg( :debug, 'PluginManager#init') { "Creating instance of plugin #{plugin_name}" }
           @plugins[plugin_name] = config.plugin_klass.new( self )
         end
       end

data/lib/webgen/plugins/coreplugins/configuration.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: configuration.rb 531 2006-11-17 17:56:14Z thomas $
+# $Id: configuration.rb 598 2007-02-14 19:42:43Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -36,6 +36,8 @@ module CorePlugins
     param 'lang', 'en', 'The default language.'
     param 'loggerLevel', 2, 'The logging level, ranges from 0 (debug, more verbose) to 3 (error, less verbose)'
 
+    param 'customVars', {}, 'A hash with global custom variables.'
+
   end
 
 end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: filehandler.rb 577 2007-01-04 20:09:28Z thomas $
+# $Id: filehandler.rb 620 2007-02-28 09:19:15Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -73,15 +73,16 @@ module FileHandlers
     # Renders the whole website.
     def render_site
       tree = build_tree
-      #TODO
-      #transform tree???
-      write_tree( tree ) unless tree.nil?
+      unless tree.nil?
+        @plugin_manager['Misc/TreeWalker'].execute( tree )
+        write_tree( tree )
+      end
     end
 
     # Renders only the given +files+.
     def render_files( files )
       tree = build_tree
-      return unless tree.nil?
+      return if tree.nil?
       files.each do |file|
         node = tree.resolve_node( file )
         if !node.nil?