webgen 0.3.2 → 0.3.3

data/ChangeLog

@@ -1,3 +1,227 @@
+------------------------------------------------------------------------
+r264 | thomas | 2005-04-21 12:46:59 +0200 (Thu, 21 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/doc/src/index.page
+
+
+------------------------------------------------------------------------
+r263 | thomas | 2005-04-21 12:45:25 +0200 (Thu, 21 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/Rakefile
+
+
+------------------------------------------------------------------------
+r262 | thomas | 2005-04-21 12:44:55 +0200 (Thu, 21 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/doc/src/documentation/gettingstarted.page
+
+* changed URL to correct path
+------------------------------------------------------------------------
+r261 | thomas | 2005-04-21 12:39:25 +0200 (Thu, 21 Apr 2005) | 3 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   A /trunk/webgen/doc/plugin/clidesc.rb
+   M /trunk/webgen/doc/plugin/extension.rb
+   M /trunk/webgen/doc/src/about.page
+   M /trunk/webgen/doc/src/default.css
+   M /trunk/webgen/doc/src/design.gallery
+   A /trunk/webgen/doc/src/documentation/cli.page
+   A /trunk/webgen/doc/src/documentation/gettingstarted.page
+   M /trunk/webgen/doc/src/documentation/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/directory.page
+   A /trunk/webgen/doc/src/documentation/plugins/index.page
+   A /trunk/webgen/doc/src/documentation/plugins/system
+   A /trunk/webgen/doc/src/documentation/plugins/system/configuration.page
+   A /trunk/webgen/doc/src/documentation/plugins/system/index.page
+   A /trunk/webgen/doc/src/documentation/plugins/system/logging.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/doc/src/meta.info
+
+* added documentation for system plugins Configuration and Logging
+* added documentation for CLI
+* added a Getting Started section
+------------------------------------------------------------------------
+r260 | thomas | 2005-04-21 12:38:17 +0200 (Thu, 21 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/Rakefile
+
+* removed check for validness of output documents as this is now done by a webgen plugin
+------------------------------------------------------------------------
+r259 | thomas | 2005-04-21 12:37:47 +0200 (Thu, 21 Apr 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/lib/webgen/configuration.rb
+   M /trunk/webgen/lib/webgen/logging.rb
+   M /trunk/webgen/lib/webgen/plugin.rb
+   M /trunk/webgen/lib/webgen/webgen.rb
+
+* added generation of default.template, default.css and index.page to CLI command create
+* moved parameter verbosityLevel from Configuration to Logging
+------------------------------------------------------------------------
+r258 | thomas | 2005-04-21 12:35:28 +0200 (Thu, 21 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/node.rb
+   M /trunk/webgen/test/webgen/tc_node.rb
+
+* Node#get_node_for_string now supports dest entries with slashes
+------------------------------------------------------------------------
+r257 | thomas | 2005-04-14 10:57:04 +0200 (Thu, 14 Apr 2005) | 1 line
+Changed paths:
+   D /trunk/webgen/doc/src/documentation/contenthandler
+   D /trunk/webgen/doc/src/documentation/filehandler
+   D /trunk/webgen/doc/src/documentation/gallerylayouter
+   D /trunk/webgen/doc/src/documentation/htmlvalidator
+   M /trunk/webgen/doc/src/documentation/index.page
+   A /trunk/webgen/doc/src/documentation/plugins
+   A /trunk/webgen/doc/src/documentation/plugins/contenthandler (from /trunk/webgen/doc/src/documentation/contenthandler:217)
+   A /trunk/webgen/doc/src/documentation/plugins/contenthandler/index.page (from /trunk/webgen/doc/src/documentation/contenthandler/index.page:256)
+   R /trunk/webgen/doc/src/documentation/plugins/contenthandler/markdown.page (from /trunk/webgen/doc/src/documentation/contenthandler/markdown.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/filehandler (from /trunk/webgen/doc/src/documentation/filehandler:212)
+   R /trunk/webgen/doc/src/documentation/plugins/filehandler/backing.page (from /trunk/webgen/doc/src/documentation/filehandler/backing.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/filehandler/galleryhandler.page (from /trunk/webgen/doc/src/documentation/filehandler/galleryhandler.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/filehandler/pagehandler.page (from /trunk/webgen/doc/src/documentation/filehandler/pagehandler.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/gallerylayouter (from /trunk/webgen/doc/src/documentation/gallerylayouter:217)
+   A /trunk/webgen/doc/src/documentation/plugins/gallerylayouter/index.page (from /trunk/webgen/doc/src/documentation/gallerylayouter/index.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/htmlvalidator (from /trunk/webgen/doc/src/documentation/htmlvalidator:217)
+   A /trunk/webgen/doc/src/documentation/plugins/htmlvalidator/index.page (from /trunk/webgen/doc/src/documentation/htmlvalidator/index.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/htmlvalidator/xmllint.page (from /trunk/webgen/doc/src/documentation/htmlvalidator/xmllint.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/tags (from /trunk/webgen/doc/src/documentation/tags:212)
+   R /trunk/webgen/doc/src/documentation/plugins/tags/executecommand.page (from /trunk/webgen/doc/src/documentation/tags/executecommand.page:256)
+   R /trunk/webgen/doc/src/documentation/plugins/tags/index.page (from /trunk/webgen/doc/src/documentation/tags/index.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/tags/langbar.de.page (from /trunk/webgen/doc/src/documentation/tags/langbar.de.page:256)
+   A /trunk/webgen/doc/src/documentation/plugins/tags/langbar.page (from /trunk/webgen/doc/src/documentation/tags/langbar.page:256)
+   M /trunk/webgen/doc/src/documentation/plugins/tags/menu.de.page
+   R /trunk/webgen/doc/src/documentation/plugins/tags/menu.page (from /trunk/webgen/doc/src/documentation/tags/menu.page:256)
+   D /trunk/webgen/doc/src/documentation/tags
+
+* moved plugin docu into plugin subfolder
+------------------------------------------------------------------------
+r256 | thomas | 2005-04-14 03:13:57 +0200 (Thu, 14 Apr 2005) | 4 lines
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugins/filehandler/backing.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/directory.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filehandler.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/page.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/langbar.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/menu.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/relocatable.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/sitemap.rb
+
+* removed virtual PageNodes, now page files are internally directly stored in the directory
+* renamed some methods in PageHandler plugin, esp. #get_lang_node to #get_page_node_for_lang
+* updated plugins to work with new code
+* changed format of meta info backing files
+------------------------------------------------------------------------
+r255 | thomas | 2005-04-14 03:07:13 +0200 (Thu, 14 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/node.rb
+   M /trunk/webgen/lib/webgen/webgen.rb
+
+* fixed some minor issues
+------------------------------------------------------------------------
+r254 | thomas | 2005-04-14 03:05:44 +0200 (Thu, 14 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/test/webgen/filehandlers/tc_page.rb
+
+* fixed test files
+------------------------------------------------------------------------
+r253 | thomas | 2005-04-14 03:04:53 +0200 (Thu, 14 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/testsite/src/default.template
+   A /trunk/webgen/testsite/src/images
+   A /trunk/webgen/testsite/src/images/bghack.png (from /trunk/webgen/testsite/src/bghack.png:212)
+   M /trunk/webgen/testsite/src/meta.info
+
+* fixed some small issues with testsite files
+------------------------------------------------------------------------
+r252 | thomas | 2005-04-13 22:21:12 +0200 (Wed, 13 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugins/tags/wikilink.rb
+
+* added parameters to replace invalid chars in wikilink tag
+------------------------------------------------------------------------
+r251 | thomas | 2005-04-13 22:09:21 +0200 (Wed, 13 Apr 2005) | 1 line
+Changed paths:
+   D /trunk/webgen/doc/extension.config
+   A /trunk/webgen/doc/plugin
+   A /trunk/webgen/doc/plugin/extension.rb (from /trunk/webgen/doc/extension.config:221)
+   D /trunk/webgen/doc/src/documentation/extloader.page
+   D /trunk/webgen/lib/webgen/plugins/extloader.rb
+
+* removed extension loader plugin and docu
+------------------------------------------------------------------------
+r250 | thomas | 2005-04-13 21:49:20 +0200 (Wed, 13 Apr 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/lib/webgen/configuration.rb
+   M /trunk/webgen/lib/webgen/logging.rb
+   M /trunk/webgen/lib/webgen/node.rb
+   A /trunk/webgen/lib/webgen/plugin.rb
+   M /trunk/webgen/lib/webgen/plugins/extloader.rb
+
+* moved plugin code to file plugin.rb
+* new plugin Logging with which logging parameters can be set
+------------------------------------------------------------------------
+r249 | thomas | 2005-04-13 21:23:51 +0200 (Wed, 13 Apr 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugins/filehandler/backing.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/directory.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filecopy.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filehandler.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/page.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/picturegallery.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/template.rb
+
+* renamed DefaultHandler to DefaultFileHandler
+* moved Plugin.extension to DefaultFileHandler
+------------------------------------------------------------------------
+r248 | thomas | 2005-04-13 21:17:09 +0200 (Wed, 13 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/webgen.rb
+
+* correct initialization sequence in main method
+------------------------------------------------------------------------
+r247 | thomas | 2005-04-13 20:55:33 +0200 (Wed, 13 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/test/setup.rb
+   M /trunk/webgen/test/webgen/filehandlers/tc_page.rb
+   M /trunk/webgen/test/webgen/tc_webgen.rb
+
+* changed test files to accomodate new plugin/logging/configuration structure
+------------------------------------------------------------------------
+r245 | thomas | 2005-04-13 14:51:33 +0200 (Wed, 13 Apr 2005) | 4 lines
+Changed paths:
+   M /trunk/webgen/Rakefile
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/default.template
+   M /trunk/webgen/doc/src/design.gallery
+   M /trunk/webgen/doc/src/download.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/lib/webgen/configuration.rb
+   M /trunk/webgen/lib/webgen/webgen.rb
+
+* added command driven CLI
+* fixed rubyforge bug #1734
+* plugin parameters now can have change handlers which are invoked when the parameter is changed
+* removed parameter configfile from Configuration, the configuration is alwayws loaded from config.yaml now
+------------------------------------------------------------------------
+r244 | thomas | 2005-04-13 14:39:17 +0200 (Wed, 13 Apr 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugins/filehandler/backing.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/page.rb
+
+* removed unused lines in page.rb
+* updated backing.rb
+------------------------------------------------------------------------
+r234 | thomas | 2005-04-06 12:10:32 +0200 (Wed, 06 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/doc/src/documentation/tags/executecommand.page
+
+* fixed BUG #1739
+------------------------------------------------------------------------
+r232 | thomas | 2005-03-17 12:12:26 +0100 (Thu, 17 Mar 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/TODO
+
+
 ------------------------------------------------------------------------
 r231 | thomas | 2005-03-17 10:31:00 +0100 (Thu, 17 Mar 2005) | 1 line
 Changed paths:

data/Rakefile

@@ -73,9 +73,7 @@ desc "Builds the documentation"
 task :doc => [:rdoc] do
   chdir 'doc' do
     puts "\nGenerating online documentation..."
-    ruby %{-I../lib ../bin/webgen -V 3 }
-    puts "\nValidating all generated documentation..."
-    sh 'find output/ -name "*.html" -exec xmllint --valid {} --catalogs --noout \;'
+    ruby %{-I../lib ../bin/webgen -V 2 }
   end
 end
 
@@ -183,6 +181,7 @@ else
     #### Dependencies, requirements and files
 
     s.files = PKG_FILES.to_a
+    s.add_dependency( 'cmdparse', '>= 1.0.1' )
 
     s.require_path = 'lib'
     s.autorequire = nil

data/TODO

@@ -1,17 +1,20 @@
 ---- CURRENT ----
 
+* implement plugin which creates nodes for fragment identifiers (#info) in html
+* modify tags system sothat tags can be specified via a tag directive (like extension with file handlers)
 * create tests for methods in webgen.rb
 * webgen -c => output same info as on docu pages
 * reloctable tag: correct output for complex URLS???
 * check if duplicate nodes are created??? by using a tag in a template
 * allow a template to use another template (templates as page description files?) (template2 uses template1)
-* create webgen 0.2.0 to 0.3.0 converter
 * security concerns (setting different $SAFE level???)
 * use code generator to create test file with all tags and all tag parameter configurations
 
 ---- DOCU ----
 
 * DEV: self.logger.warn/error/info/debug can be used for messages
+* document the various meta info entries that the plugins use (inMenu, menuOrdering, ...)
+  --> define: Plugin.used_meta_info( name, desc )
 
 ---- FUTURE ----
 
@@ -150,3 +153,17 @@ W do not allow two or more page files in the same language, print warn
 * tag 'mrplot' -> generate a plot with mrplot --> tag not very useable
 * ordering of picture/gallery files for menu
 * add params to menu for style classes (webgen-submenu, webgen-menuitem-selected) -> see menu feedback on wiki
+* add parameters for controlling log files
+* implement feature request #1642
+* create webgen 0.2.0 to 0.3.0 converter -> No
+* Bug in wikilink: & not supported
+* have a look at wiki -> done
+* remove PageNode nodes from tree and put ***.page nodes directly in dir??? (see directory/backing/page handler)
+* refactor backing file structure: reference files directly, not via basename/language
+* site specific plugins in plugin directory
+* add a getting started section
+* describe new CLI on extra page (documentation/cli.page)
+* log files goto log directory
+* create file for logging plugin
+* document the existence of the mailing list
+* webgen create -> create basic template/css + index.page

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/doc/plugin/clidesc.rb

@@ -0,0 +1,35 @@
+require 'cgi'
+
+module OtherPlugins
+
+  class CliDescTag < Tags::DefaultTag
+
+    summary "Describes the CLI interface"
+    depends_on 'Tags'
+
+    def initialize
+      super
+      @processOutput = false
+      register_tag( 'clidesc' )
+    end
+
+    def process_tag( tag, node, refNode )
+      wcp = Webgen::WebgenCommandParser.new
+      output = ''
+      output << "<p><b>Global Options:</b></p>"
+      output << "<pre>#{CGI::escapeHTML(wcp.options.summarize.to_s)}</pre>"
+      output << "<p><b>Commands:</b></p>"
+      output << "<dl>"
+      wcp.commands.sort.each do |name, command|
+        output << "<dt>#{name}</dt>"
+        output << "<dd>#{CGI::escapeHTML(command.description)}<br />"
+        output << "#{CGI::escapeHTML(command.usage)}<br />"
+        output << "<pre>#{CGI::escapeHTML(command.options.summarize.to_s)}</pre>"
+        output << "</dd>"
+      end
+      output << "</dl>"
+    end
+
+  end
+
+end

data/doc/plugin/extension.rb

@@ -0,0 +1,73 @@
+module OtherPlugins
+
+  class VersionTag < Tags::DefaultTag
+
+    summary "Shows the version number of webgen"
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( 'version' )
+    end
+
+    def process_tag( tag, node, refNode )
+      Webgen::VERSION.join( '.' )
+    end
+
+  end
+
+  class DescribeTag < Tags::DefaultTag
+
+    summary "Shows options for the specified file handler"
+    add_param 'plugin', nil, 'The plugin which should be described'
+    set_mandatory 'plugin', true
+    depends_on 'Tags'
+
+    def initialize
+      super
+      @processOutput = false
+      register_tag( 'describe' )
+    end
+
+    def process_tag( tag, node, refNode )
+      filehandler = get_param( 'plugin' )
+      self.logger.debug { "Describing tag #{filehandler}" }
+      plugin = Webgen::Plugin.config.find {|k,v| v.plugin == filehandler }
+      self.logger.warn { "Could not describe plugin '#{filehandler}' as it does not exist" } if plugin.nil?
+      ( plugin.nil? ? '' : format_data( plugin[1] ) )
+    end
+
+    def format_data( data )
+      s = "<table>"
+      row = lambda {|desc, value| "<tr style='vertical-align: top'><td style='font-weight:bold'>#{CGI::escapeHTML( desc )}:</td><td>#{value}</td></tr>" }
+
+      [['Plugin Name', 'plugin'], ['Summary', 'summary'], ['Description', 'description']].each do |desc, name|
+        s += row[desc, CGI::escapeHTML( data.send( name ) )] if eval( "data.#{name}" )
+      end
+
+      s += row['Dependencies', CGI::escapeHTML( data.dependencies.join( ', ') )] if data.dependencies
+
+      unless data.params.nil?
+        params = data.params.collect do |k,v|
+          "<span style='color: red'>#{v.name}</span>" + \
+          ( v.mandatory.nil? \
+            ? "&nbsp;=&nbsp;<span style='color: blue'>#{CGI::escapeHTML( v.default.inspect )}</span>" \
+            : " (=" + ( v.mandatoryDefault ? "default " : "" ) + "mandatory parameter)" ) + \
+          ": #{CGI::escapeHTML( v.description )}"
+        end
+        s += row['Parameters', params.join( "<br />\n" )]
+      end
+      s += row['Name of tag', (data.tag == :default ? "Default tag" : data.tag)] if data.tag
+      s += row['File extension', data.extension.inspect.gsub(/"/, '')] if data.extension
+
+      # Show all registered handlers
+      data.table.keys.find_all {|k| /^registered_/ =~ k.to_s }.each do |k|
+        s += row[k.to_s.sub( /^registered_/, '' ).capitalize + " name", data.send( k )]
+      end
+
+      s += "</table>"
+    end
+
+  end
+
+end

data/doc/src/about.page

@@ -11,7 +11,8 @@ that you can create page description files in which you only define the content.
 
 When webgen is run it combines the template with each of the page description files and generates
 the HTML output files. During this process special tags are substituted so that, for example, a menu
-is generated.
+is generated. Actually, this page was generated with webgen and, for example, the menu that you can
+see was created dynamically. For more information look at the documentation!
 
 h2. Author
 

data/doc/src/default.css

@@ -118,12 +118,16 @@
     border-bottom: 1px solid #405080;
   }
 
-  .webgen-file {
+  pre {
     padding-left: 10px;
     margin: 0px 10px;
     border-left: 3px solid #5C73B8;
   }
 
+  dt {
+    font-weight: bold;
+  }
+
   .webgen-picture {
     text-align: center;
   }

data/doc/src/default.template

@@ -38,6 +38,15 @@
         generated with <a href="http://webgen.rubyforge.org"><em><b>webgen</b></em></a> on <b>{date: }</b>
       </div>
     </div>
+<!-- Start of StatCounter Code -->
+<script type="text/javascript">
+var sc_project=648325; 
+var sc_partition=5; 
+var sc_security="7d00de1e"; 
+var sc_invisible=1; 
+</script>
 
+<script type="text/javascript" src="http://www.statcounter.com/counter/counter_xhtml.js"></script><noscript><div class="statcounter"><a class="statcounter" href="http://www.statcounter.com/"><img class="statcounter" src="http://c6.statcounter.com/counter.php?sc_project=648325&amp;java=0&amp;security=7d00de1e&amp;invisible=1" alt="free geoip" /></a></div></noscript>
+<!-- End of StatCounter Code -->
   </body>
 </html>