webgen 0.3.4 → 0.3.5

data/ChangeLog

@@ -1,4 +1,205 @@
 ------------------------------------------------------------------------
+r303 | thomas | 2005-06-24 15:44:14 +0200 (Fri, 24 Jun 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/Rakefile
+   M /trunk/webgen/TODO
+   M /trunk/webgen/lib/webgen/configuration.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/picturegallery.rb
+   A /trunk/webgen/otherdata/webgen-gallery-creator.rb
+
+* added thumbnailSize option to gallery file
+------------------------------------------------------------------------
+r301 | thomas | 2005-06-14 12:25:49 +0200 (Tue, 14 Jun 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugins/filehandler/page.rb
+
+* separated rendering of page nodes from writing
+------------------------------------------------------------------------
+r300 | thomas | 2005-06-14 12:04:17 +0200 (Tue, 14 Jun 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/documentation/plugins/menustyles/horizontal-dropdown.page
+   M /trunk/webgen/lib/webgen/plugins/menustyles/horizontal_dropdown.rb
+   M /trunk/webgen/lib/webgen/plugins/menustyles/vertical_dropdown.rb
+   M /trunk/webgen/lib/webgen/plugins/resourcemanager.rb
+
+* fixed ResourceManager plugin to work in Windows
+* updated CSS styles for dropdown menus to look "nice" in IE because they do not work in IE
+------------------------------------------------------------------------
+r296 | thomas | 2005-06-14 08:42:31 +0200 (Tue, 14 Jun 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/backing.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/pagehandler.page
+   M /trunk/webgen/doc/src/documentation/plugins/resourcemanager.page
+   M /trunk/webgen/doc/src/index.page
+
+* updated documentation of backing file handler
+* updated some other pages
+------------------------------------------------------------------------
+r295 | thomas | 2005-06-14 08:41:37 +0200 (Tue, 14 Jun 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/doc/src/default.css
+   M /trunk/webgen/doc/src/default.template
+
+* now using vertical dropdown menu and quick menu on the left side
+------------------------------------------------------------------------
+r294 | thomas | 2005-06-14 08:37:56 +0200 (Tue, 14 Jun 2005) | 3 lines
+Changed paths:
+   M /trunk/webgen/lib/webgen/node.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/backing.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/page.rb
+   M /trunk/webgen/test/webgen/tc_node.rb
+
+* fixed Node#get_node_for_string and tests so that page files with standardified names are found
+* fixed bug in backing file handler where meta info files in subdirs were not processed
+* updated PageHandler to provided a localized standardified page name to page nodes
+------------------------------------------------------------------------
+r293 | thomas | 2005-06-11 10:37:51 +0200 (Sat, 11 Jun 2005) | 17 lines
+Changed paths:
+   M /trunk/webgen/Rakefile
+   M /trunk/webgen/TODO
+   A /trunk/webgen/data
+   A /trunk/webgen/data/webgen
+   A /trunk/webgen/data/webgen/example
+   A /trunk/webgen/data/webgen/example/config.yaml
+   A /trunk/webgen/data/webgen/example/log
+   A /trunk/webgen/data/webgen/example/output
+   A /trunk/webgen/data/webgen/example/plugin
+   A /trunk/webgen/data/webgen/example/src
+   A /trunk/webgen/data/webgen/example/src/default.css
+   A /trunk/webgen/data/webgen/example/src/default.template
+   A /trunk/webgen/data/webgen/example/src/index.page
+   A /trunk/webgen/data/webgen/images
+   A /trunk/webgen/data/webgen/images/generated_by_webgen.png
+   A /trunk/webgen/data/webgen/images/valid-css.gif
+   A /trunk/webgen/data/webgen/images/valid-xhtml11.png
+   A /trunk/webgen/data/webgen/images/webgen_logo.png
+   M /trunk/webgen/doc/plugin/extension.rb
+   A /trunk/webgen/doc/plugin/resources.rb
+   M /trunk/webgen/doc/src/default.css
+   M /trunk/webgen/doc/src/default.template
+   M /trunk/webgen/doc/src/documentation/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/index.page
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles/horizontal-dropdown.page
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles/horizontal.page
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles/index.page
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles/partial.page
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles/vertical-dropdown.page
+   A /trunk/webgen/doc/src/documentation/plugins/menustyles/vertical.page
+   A /trunk/webgen/doc/src/documentation/plugins/resourcemanager.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/langbar.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/menu.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/navbar.page
+   A /trunk/webgen/doc/src/documentation/plugins/tags/resource.page
+   M /trunk/webgen/doc/src/download.page
+   M /trunk/webgen/doc/src/features.page
+   D /trunk/webgen/doc/src/generated_by_webgen.png
+   M /trunk/webgen/doc/src/index.page
+   D /trunk/webgen/doc/src/logo.png
+   M /trunk/webgen/doc/src/meta.info
+   M /trunk/webgen/lib/webgen/configuration.rb
+   M /trunk/webgen/lib/webgen/node.rb
+   M /trunk/webgen/lib/webgen/plugin.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filehandler.rb
+   A /trunk/webgen/lib/webgen/plugins/menustyles
+   A /trunk/webgen/lib/webgen/plugins/menustyles/defaultmenustyle.rb
+   A /trunk/webgen/lib/webgen/plugins/menustyles/horizontal.rb
+   A /trunk/webgen/lib/webgen/plugins/menustyles/horizontal_dropdown.rb
+   A /trunk/webgen/lib/webgen/plugins/menustyles/partial.rb
+   A /trunk/webgen/lib/webgen/plugins/menustyles/vertical.rb
+   A /trunk/webgen/lib/webgen/plugins/menustyles/vertical_dropdown.rb
+   A /trunk/webgen/lib/webgen/plugins/resourcemanager.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/langbar.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/menu.rb
+   M /trunk/webgen/lib/webgen/webgen.rb
+   M /trunk/webgen/otherdata/logo.svg
+   M /trunk/webgen/test/webgen/tc_node.rb
+
+* added method Node#relpath_to_string and tests for it
+* updated to cmdparse version 1.0.3
+* extensively updated documentation (esp. features)
+* updated default.template to use webgen image resources
+* added webgen doc site specific plugin for showing the predefined resources
+* the ancestors of plugins are now shown in the information section
+* added new plugin ResourceManager for handling file and memory resources
+* added new tag resource for accessing resources
+* restructured menu tag to allow different menu styles
+* added five menu styles: horizontal, vertical, partial, horizontal-dropdown, vertical-dropdown
+* added documentation pages for menu styles, Resource Manager and resource tag
+* added new listener message to FileHandler: AFTER_ALL_WRITTEN
+* updated relpath_to_node to better handle absolute destinations (http, ftp, ...)
+* Configuration.data_dir returns webgen specific data directory now
+* webgen sample site moved to data directory
+* added some images to data directory
+* created new logo for webgen
+------------------------------------------------------------------------
+r289 | thomas | 2005-06-05 10:49:15 +0200 (Sun, 05 Jun 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugins/tags/langbar.rb
+
+* incorporated change (option showOwnLang) from Thomas Werschlein
+------------------------------------------------------------------------
+r288 | thomas | 2005-05-29 14:25:47 +0200 (Sun, 29 May 2005) | 4 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   A /trunk/webgen/doc/config.yaml
+   M /trunk/webgen/doc/src/documentation/gettingstarted.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/galleryhandler.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/pagehandler.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/langbar.page
+   M /trunk/webgen/doc/src/features.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/doc/src/meta.info
+   M /trunk/webgen/lib/webgen/node.rb
+   M /trunk/webgen/lib/webgen/plugins/contenthandler/textile.rb
+   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/page.rb
+   M /trunk/webgen/test/webgen/tc_node.rb
+
+* BUG fixed in Node#get_node_for_string: invalid name resolution if node is directory node
+* metainfo int:pagename now set to <name of page>.page
+* changed PageHandler:validator to default to nil
+* added some doku
+------------------------------------------------------------------------
+r287 | thomas | 2005-05-26 11:33:38 +0200 (Thu, 26 May 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/default.template
+   M /trunk/webgen/lib/webgen/plugins/filehandler/backing.rb
+   M /trunk/webgen/lib/webgen/plugins/treewalker.rb
+   M /trunk/webgen/lib/webgen/webgen.rb
+
+* added clean command to CLI
+* added parameter to TreeWalker#execute for specifying the order in which #handle_node is called
+------------------------------------------------------------------------
+r283 | thomas | 2005-05-21 13:15:59 +0200 (Sat, 21 May 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filehandler.rb
+
+* BUG fixed where invokation of webgen without src dir produced error
+------------------------------------------------------------------------
+r280 | thomas | 2005-05-16 08:51:18 +0200 (Mon, 16 May 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/default.template
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/lib/webgen/configuration.rb
+
+* bumped version number
+* small change to docu
+------------------------------------------------------------------------
+r278 | thomas | 2005-05-12 12:22:51 +0200 (Thu, 12 May 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/doc/src/default.template
+
+* made webgen logo relocatable
+------------------------------------------------------------------------
 r277 | thomas | 2005-05-12 10:43:54 +0200 (Thu, 12 May 2005) | 1 line
 Changed paths:
    M /trunk/webgen/lib/webgen/plugins/filehandler/page.rb

data/Rakefile

@@ -106,6 +106,7 @@ PKG_FILES = FileList.new( [
                             'install.rb',
                             'bin/**/*',
                             'lib/**/*.rb',
+                            'data/**/*',
                             'testsite/**/*',
                             'tests/**/*',
                             'doc/**/*'
@@ -181,7 +182,7 @@ else
     #### Dependencies, requirements and files
 
     s.files = PKG_FILES.to_a
-    s.add_dependency( 'cmdparse', '>= 1.0.2' )
+    s.add_dependency( 'cmdparse', '>= 1.0.3' )
 
     s.require_path = 'lib'
     s.autorequire = nil
@@ -199,7 +200,7 @@ else
 
     s.author = "Thomas Leitner"
     s.email = "t_leitner@gmx.at"
-    s.homepage = "webgen.rubyforge.org"
+    s.homepage = "http://webgen.rubyforge.org"
     s.rubyforge_project = "webgen"
   end
 

data/TODO

@@ -1,24 +1,30 @@
 ---- CURRENT ----
 
-* implement command "webgen clean" (options -f (force) -a (all files in dir, not only generated ones)
-* implement plugin which creates nodes for fragment identifiers (#info) in html
+* simplify menu style plugins
+* make menu generation faster (for webgen: 5.2s without menus in template, 9.2s with menus!)
 * 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
 * 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)
-* 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
+* add keywords to default.template
+* document which meta info can be used in gallery file for gallery itself, gallery pages and picture pages
 
 ---- FUTURE ----
 
+* parameter for setting the orderInfo of index pages so that they always appear as first entry
+* custom commands provided by plugins
+* implement plugin which creates nodes for fragment identifiers (#info) in html
+* convert smiley characters to smileys
+* include spell checker (ispell, aspell, MS Word OLE on Win32,...)
+* tag 'download' which links to a download file and appends its size and ev. an image (PDF, ...)
 * tag 'resume', uses xmlresume2x to provide HTML version of xml resume
 * multi-lingual picture/gallery files
-* refactor menu: abstract menu generator+parser, concrete impls (vert. menu, horz. menu, ...)
 * include exif info for pictures
 
 ---- DONE ----
@@ -170,3 +176,24 @@ W do not allow two or more page files in the same language, print warn
 * reloctable tag: correct output for complex URLS???
 * document the various meta info entries that the plugins use (inMenu, menuOrdering, ...) --> define: Plugin.used_meta_info( name, desc )
 * create logo "Created with webgen"
+* implement command "webgen clean" (options -f (force) -a (all files in dir, not only generated ones)
+* BUG: relocatable should work if defaultLangInFilename is true (eg. copy.html -> not found because of copy.en.html)
+* refactor menu: abstract menu generator+parser, concrete impls (vert. menu, horz. menu, ...)
+* change langbar like in mail from Thomas Werschleinvn
+* mention which extension the file handlers work on (backing file handler, template file handler, ...)
+* add doku for new menu builder plugins, adjust menu.page
+* test Node#relpath_to_string
+* add possibility to add user-defined resources via config.yaml
+* MAYBE: ONE page node for all pages, metainfo 'en' => all info about english, 'de' => same, ...??? --> better not
+* add style advices for menu styles
+* resources should be saved in Webgen::Plugin.config
+* make tag plugin for predefinedResources work
+* document ResourceManager
+* specify on menu style pages in which browsers the menus work
+* document super classes of plugins because plugins can use parameters of super classes
+* create partialMenu style which only shows a partial menu
+* security concerns (setting different $SAFE level???) --> No
+* create vertical-dropdown menu
+* better docu for backing file handler
+* make dropdown menus "look" nice in IE
+* make dropdown menus work in IE -> rather hard to do in a general way

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/data/webgen/example/config.yaml

@@ -0,0 +1,2 @@
+# Configuration file for webgen
+# Used to set the parameters of the plugins

data/data/webgen/example/src/default.css

@@ -0,0 +1,84 @@
+
+  #all { background-color: #CCCCCC; }
+
+  #header {
+    border-bottom: 1px solid black;
+    padding: 1ex;
+    background-color: #888888;
+  }
+  #header h1 {
+    margin: 0ex;
+	font-size: 300%;
+	font-style: italic;
+	font-weight: normal;
+  }
+
+, #headerbar { border-bottom: 1px solid black; }
+  #footer { border-top: 1px solid black; }
+
+  #body {
+    margin-left: 250px;
+    margin-right: 20px;
+    padding: 10px;
+  }
+
+  #menu {
+	float: left;
+	width: 230px;
+    padding: 20px 0px 0px 2px;
+  }
+
+  .bar {
+	clear: both;
+	padding: 3px;
+	text-align: center;
+	font-size: 90%;
+    background-color: #AAAAAA;
+  }
+
+  .left, .right {
+    padding: 0px 1em;
+  }
+
+  .left {
+	float: left;
+	text-align: left;
+  }
+
+  .right {
+	float: right;
+	text-align: right;
+  }
+
+  /* styling the menu */
+
+  #menu a {
+	text-decoration: none;
+	font-weight: bold;
+	font-size: 130%;
+  }
+
+  #menu a:hover {
+	text-decoration: underline;
+  }
+
+  #menu .webgen-menuitem-selected {
+	border-left: 3px solid black;
+  }
+
+  #menu ul {
+	list-style-type: none;
+	padding: 0px;
+	margin-left: 10px;
+  }
+
+  #menu li > ul {
+	font-size: 95%;
+  }
+
+  #menu li {
+    margin: 0.0em 0px;
+    padding: 2px 0px;
+    padding-left: 5px;
+    border-left: 3px solid #CCCCCC;
+  }

data/data/webgen/example/src/default.template

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
+  <head>
+    <title>{title: }</title>
+    <link href="{relocatable: default.css}" rel="stylesheet" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  </head>
+  <body>
+    <div id="header">
+      <h1>{title: }</h1>
+    </div>
+
+    <div id="headerbar" class="bar">
+      <span class="left">Navbar: {navbar: }</span>
+      <span class="right">Language: {langbar: }</span>
+      <div style="clear:both"></div>
+    </div>
+
+    <div id="menu">
+      {menu: }
+    </div>
+
+    <div id="body">
+      {content: }
+    </div>
+
+    <div id="footer" class="bar">
+      generated with <a href="http://webgen.rubyforge.org"><img src="{resource: webgen-generated}" /></a> on <b>{date: }</b>
+    </div>
+  </body>
+</html>

data/data/webgen/example/src/index.page

@@ -0,0 +1,8 @@
+---
+title: Empty index page
+inMenu: true
+directoryName: New Website
+---
+h2. Empty index file
+
+Fill this file with your own data!!!

data/doc/config.yaml

@@ -0,0 +1,2 @@
+PageHandler:
+  validator: xmllint

data/doc/plugin/extension.rb

@@ -41,8 +41,12 @@ module OtherPlugins
       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, summary, description
-      [['Plugin Name', 'plugin'], ['Summary', 'summary'], ['Description', 'description']].each do |desc, name|
+      # Plugin and ancestors
+      ancestors = data.klass.ancestor_classes[1..-1].collect {|k| Webgen::Plugin.config[k].plugin}.join(', ')
+      s += row['Plugin name', CGI::escapeHTML( data.plugin + (ancestors.empty? ? '' : " (#{ancestors})" ) )]
+
+      # summary, description
+      [['Summary', 'summary'], ['Description', 'description']].each do |desc, name|
         s += row[desc, CGI::escapeHTML( data.send( name ) )] if eval( "data.#{name}" )
       end
 
@@ -66,11 +70,11 @@ module OtherPlugins
 
       # tag name, file ext
       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
+      s += row['Handled paths', data.path.collect {|p| CGI::escapeHTML( p )}.join('<br />')] if data.path
 
       # 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 )]
+        s += row[k.to_s.sub( /^registered_/, '' ).tr('_', ' ').capitalize + " name", data.send( k )]
       end
 
       s += "</table>"