webgen 0.3.3 → 0.3.4

data/ChangeLog

@@ -1,4 +1,158 @@
 ------------------------------------------------------------------------
+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
+
+* fixed bug in PageHandler where duplicate files were not recognized
+------------------------------------------------------------------------
+r276 | thomas | 2005-05-12 10:36:50 +0200 (Thu, 12 May 2005) | 4 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/default.css
+   M /trunk/webgen/doc/src/default.template
+   A /trunk/webgen/doc/src/generated_by_webgen.png
+   M /trunk/webgen/doc/src/index.page
+   A /trunk/webgen/otherdata/generated_logo.svg
+
+* added dates of releases to main page
+* added xhtml11, css logos to footer
+* added "generated by webgen" logo
+* fixed syntax errors in css file
+------------------------------------------------------------------------
+r275 | thomas | 2005-05-11 19:30:20 +0200 (Wed, 11 May 2005) | 2 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/plugin/extension.rb
+   A /trunk/webgen/doc/src/documentation/meta_info_reference.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/lib/webgen/plugin.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/lib/webgen/plugins/filehandler/template.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/menu.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/sitemap.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/wikilink.rb
+
+* added PageHandler#get_html_link, simplified use of #get_html_link in menu and sitemap tag
+* added documentation page for meta information
+------------------------------------------------------------------------
+r274 | thomas | 2005-05-11 14:52:27 +0200 (Wed, 11 May 2005) | 4 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/plugin/extension.rb
+   M /trunk/webgen/doc/src/about.page
+   M /trunk/webgen/doc/src/documentation/cli.page
+   M /trunk/webgen/doc/src/documentation/gettingstarted.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/directory.page
+   M /trunk/webgen/doc/src/documentation/plugins/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/index.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/doc/src/meta.info
+   M /trunk/webgen/lib/webgen/plugins/filehandler/directory.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
+   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/sitemap.rb
+   M /trunk/webgen/test/webgen/filehandlers/tc_page.rb
+   M /trunk/webgen/testsite/src/projects/00.index.de.page
+   M /trunk/webgen/testsite/src/projects/subproj/index.page
+
+* changed meta info menuOrder to orderInfo
+* if two items have the same order information, they are sorted using their title meta info
+* BUGs fixed for sitemap tag: order information now used, multi language pages now displayed only once
+* add some documentation
+------------------------------------------------------------------------
+r273 | thomas | 2005-05-11 12:07:38 +0200 (Wed, 11 May 2005) | 3 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/about.page
+   M /trunk/webgen/doc/src/default.template
+   M /trunk/webgen/doc/src/documentation/gettingstarted.page
+   M /trunk/webgen/doc/src/documentation/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/pagehandler.page
+   M /trunk/webgen/doc/src/documentation/plugins/index.page
+   M /trunk/webgen/doc/src/documentation/plugins/tags/index.page
+   M /trunk/webgen/doc/src/features.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/lib/webgen/plugins/tags/relocatable.rb
+
+* now only webgen with lower case letters in docu
+* fixed pagehandler.page (problem with embedded ERB code)
+* tag relocatable now accepts complex URIs (with query/fragment part)
+------------------------------------------------------------------------
+r272 | thomas | 2005-05-09 10:53:04 +0200 (Mon, 09 May 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/node.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filehandler.rb
+   M /trunk/webgen/test/util/tc_composite.rb
+   M /trunk/webgen/test/util/tc_listener.rb
+
+* changed require util/listener and util/composite to webgen/...
+------------------------------------------------------------------------
+r271 | thomas | 2005-05-09 10:50:47 +0200 (Mon, 09 May 2005) | 1 line
+Changed paths:
+   D /trunk/webgen/lib/util
+   A /trunk/webgen/lib/webgen/composite.rb (from /trunk/webgen/lib/util/composite.rb:212)
+   A /trunk/webgen/lib/webgen/listener.rb (from /trunk/webgen/lib/util/listener.rb:212)
+
+* removed util directory, moved files into webgen dir
+------------------------------------------------------------------------
+r270 | thomas | 2005-05-09 10:40:14 +0200 (Mon, 09 May 2005) | 3 lines
+Changed paths:
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/pagehandler.page
+   M /trunk/webgen/doc/src/index.page
+   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/menu.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/relocatable.rb
+   M /trunk/webgen/lib/webgen/plugins/tags/sitemap.rb
+
+* renamed #get_page_node_for_lang to #get_node_for_lang for file handlers
+* changed PageHandler: ERB is now useable within a template and with content blocks of page files
+* tag relocatable modified to allow linking to directories and other file types, not only page files
+------------------------------------------------------------------------
+r269 | thomas | 2005-05-08 18:06:40 +0200 (Sun, 08 May 2005) | 6 lines
+Changed paths:
+   M /trunk/webgen/TODO
+   M /trunk/webgen/doc/src/documentation/plugins/filehandler/index.page
+   M /trunk/webgen/doc/src/features.page
+   M /trunk/webgen/doc/src/index.page
+   M /trunk/webgen/lib/webgen/node.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/filecopy.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/filehandler.rb
+   M /trunk/webgen/lib/webgen/plugins/filehandler/picturegallery.rb
+   M /trunk/webgen/test/webgen/tc_node.rb
+
+* adapted tests for Node class
+* updated documentation and added better info on FileHandler class
+* FileHandler now processes files based on path patterns and not on extensions -> more flexible
+* updated BackingFileHandler
+* changed name of parameter FileCopyHandler:types to :paths, parameters now uses path patterns instead of extensions
+* Node#node_for_string and Node#node_for_string? accept optional second parameter now
+------------------------------------------------------------------------
+r268 | thomas | 2005-05-02 17:28:31 +0200 (Mon, 02 May 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/Rakefile
+   M /trunk/webgen/doc/src/documentation/plugins/tags/multilang.fr.page
+   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/plugins/filehandler/filehandler.rb
+
+* some small changes
+------------------------------------------------------------------------
+r267 | thomas | 2005-04-27 15:32:18 +0200 (Wed, 27 Apr 2005) | 1 line
+Changed paths:
+   M /trunk/webgen/lib/webgen/plugin.rb
+
+* Fixed bug #1828
+------------------------------------------------------------------------
 r264 | thomas | 2005-04-21 12:46:59 +0200 (Thu, 21 Apr 2005) | 1 line
 Changed paths:
    M /trunk/webgen/doc/src/index.page

data/Rakefile

@@ -181,7 +181,7 @@ else
     #### Dependencies, requirements and files
 
     s.files = PKG_FILES.to_a
-    s.add_dependency( 'cmdparse', '>= 1.0.1' )
+    s.add_dependency( 'cmdparse', '>= 1.0.2' )
 
     s.require_path = 'lib'
     s.autorequire = nil

data/TODO

@@ -1,10 +1,10 @@
 ---- 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
 * 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)
 * security concerns (setting different $SAFE level???)
@@ -13,14 +13,11 @@
 ---- 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 ----
 
 * tag 'resume', uses xmlresume2x to provide HTML version of xml resume
 * multi-lingual picture/gallery files
-* create logo "Created with webgen"
 * refactor menu: abstract menu generator+parser, concrete impls (vert. menu, horz. menu, ...)
 * include exif info for pictures
 
@@ -167,3 +164,9 @@ W do not allow two or more page files in the same language, print warn
 * create file for logging plugin
 * document the existence of the mailing list
 * webgen create -> create basic template/css + index.page
+* update FileCopyHandler
+* menu order: if order number equal, sort alphabetically
+* RF bug: sitemap displays multilingual sites more times, sitemap should respect menuOrder
+* 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"

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/doc/plugin/extension.rb

@@ -41,14 +41,17 @@ 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|
         s += row[desc, CGI::escapeHTML( data.send( name ) )] if eval( "data.#{name}" )
       end
 
+      # dependencies
       s += row['Dependencies', CGI::escapeHTML( data.dependencies.join( ', ') )] if data.dependencies
 
+      # parameters
       unless data.params.nil?
-        params = data.params.collect do |k,v|
+        params = data.params.sort.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>" \
@@ -57,6 +60,11 @@ module OtherPlugins
         end
         s += row['Parameters', params.join( "<br />\n" )]
       end
+
+      # used meta info
+      s += row['Used meta information', CGI::escapeHTML( data.used_meta_info.join( ', ') )] if data.used_meta_info
+
+      # 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
 

data/doc/src/about.page

@@ -1,11 +1,11 @@
 ---
 title: About
 inMenu: true
-menuOrder: 2
+orderInfo: 2
 ---
 h2. About _webgen_
 
-Webgen is used to generate web pages from page description and template files. You create one
+webgen is used to generate web pages from page description and template files. You create one
 template file in which you define the layout of your page and where the content should go. After
 that you can create page description files in which you only define the content.
 

data/doc/src/default.css

@@ -8,7 +8,7 @@
   body {
 	margin: 0px 2em;
 	font-size: 12px;
-	font-family: Verdana, Arial, Helvetica;
+	font-family: Verdana, Arial, Helvetica, sans-serif;
     border: 1px solid black;
     color: black;
   }
@@ -38,7 +38,7 @@
     color: white;
   }
 
-, #headerbar { border-bottom: 1px solid black; }
+  #headerbar { border-bottom: 1px solid black; }
   #footer { border-top: 1px solid black; }
 
   #body {

data/doc/src/default.template

@@ -13,7 +13,7 @@
         <table>
           <tr>
             <td><img src="{relocatable: logo.png}" alt="Logo" title="Logo" /></td>
-            <td><h1>Webgen<span style="font-size: 60%"> - template based static website generator</span></h1>
+            <td><h1>webgen<span style="font-size: 60%"> - template based static website generator</span></h1>
             <p>The solution for your static website generation needs!</p></td>
           </tr>
         </table>
@@ -35,7 +35,9 @@
       </div>
 
       <div id="footer" class="bar">
-        generated with <a href="http://webgen.rubyforge.org"><em><b>webgen</b></em></a> on <b>{date: }</b>
+        <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml11" alt="Valid XHTML 1.1!" height="31" width="88" /></a>
+        <a href="http://jigsaw.w3.org/css-validator/check/referer"><img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" /></a>
+        <a href="http://webgen.rubyforge.org"><img src="generated_by_webgen.png" alt="Generated by webgen" /></a> on <b>{date: }</b>
       </div>
     </div>
 <!-- Start of StatCounter Code -->

data/doc/src/documentation/cli.page

@@ -1,7 +1,7 @@
 ---
 title: Command Line Interface
 inMenu: true
-menuOrder: 20
+orderInfo: 20
 ---
 h2. Command Line Interface
 

data/doc/src/documentation/gettingstarted.page

@@ -1,13 +1,13 @@
 ---
 title: Getting Started
 inMenu: true
-menuOrder: 10
+orderInfo: 10
 ---
 h1. Getting Started with webgen
 
 h2. The Needed Directories
 
-Webgen utilizes the following directories. These directories are in the direcctory in which the
+webgen utilizes the following directories. These directories are in the direcctory in which the
 webgen command is issued.
 
 * @src@: The source directory in which all the source files for the website are.
@@ -32,7 +32,7 @@ First, you need to create the basic directories. You can let webgen do this:
 ~ > webgen create sample_site
 </pre>
 
-Webgen created the @sample_site@ directory which holds all directories necessary for running webgen.
+webgen created the @sample_site@ directory which holds all directories necessary for running webgen.
 So you can run webgen to create your website. Just change into the @sample_site@ directory and run
 webgen
 
@@ -41,7 +41,7 @@ webgen
 ~/sample_site > webgen
 </pre>
 
-Easy! Webgen has parsed the @src@ directory and has created the HTML output. However, as we did not
+Easy! webgen has parsed the @src@ directory and has created the HTML output. However, as we did not
 write any content yet, there is not much to see (only the default page). So let's do that now!
 
 h2. Add Content to the Website

data/doc/src/documentation/index.page

@@ -3,7 +3,7 @@ directoryName: Documentation
 ---
 h2. Information
 
-p={font-size: 150%; color: red}. *!!! This documentation is for Webgen {version: } !!!*
+p={font-size: 150%; color: red}. *!!! This documentation is for webgen {version: } !!!*
 
 The source files for this website are in the @doc/src@ directory of the webgen package. Have a look
 at them to see a real world example on how to use webgen!
@@ -13,7 +13,7 @@ h2. Philosophy
 There are some things about webgen which I think are important to mention. It's about how webgen
 works and what you can expect when you start webgen.
 
-* <b>Webgen runs till the end and does not stop on errors!</b>
+* <b>webgen runs till the end and does not stop on errors!</b>
 
   I did not like it when webgen stopped because there was an error in the configuration file or an
   error in a page description file. So if something exceptional happens it is logged so that the
@@ -26,7 +26,7 @@ works and what you can expect when you start webgen.
 
 * <b>Useful default values for everything!</b>
 
-  You _do not need_ to configure webgen if you are happy with the default values. Webgen provides
+  You _do not need_ to configure webgen if you are happy with the default values. webgen provides
   default values for every configuration option.
 
 * <b>Every important thing gets logged!</b>
@@ -38,9 +38,9 @@ works and what you can expect when you start webgen.
 
 h2. Configuration
 
-Webgen provides a default configuration out of the box. If you can live with that, you do not need
+webgen provides a default configuration out of the box. If you can live with that, you do not need
 to write any configuration files. Because most people cannot, you can use your own configuration
-file. The configuration file has to be written in YAML and is called @config.yaml@. Webgen searches
+file. The configuration file has to be written in YAML and is called @config.yaml@. webgen searches
 in the current directory for the configuration file.
 
 If you want to get the configuration values you can run webgen like this

data/doc/src/documentation/meta_info_reference.page

@@ -0,0 +1,21 @@
+---
+title: Meta Info Reference
+inMenu: true
+orderInfo: 25
+---
+h2. Meta Information Reference
+
+Following is a list of all the meta information items that are used in one way or another by a
+plugin, be it a file handler plugin, a tag plugin...
+
+table{border: 1px solid black}.
+|_. Name         |_. Type  |_. Example    |_. Valid for   |_. Description|
+|*blocks*        |Hash     |\{format: markdown, name: sidebar}|Page file|Sets the name and format of content blocks.|
+|*directoryName* |String   |Img Directory |Page file      |Only used if set on a directory index page file; specifies the title of the directory for which it is the index file. If it is not specified, the title of the directory  will be used.|
+|*indexFile*     |String   |getting.page  |Directory      |Sets the directory index file for the directory overriding the default value.|
+|*inMenu*        |Boolean  |true          |Any            |Specifies if the file/directory should appear in menus.|
+|*lang*          |String   |de            |Page file      |Sets the language for the page file. Has to be the two character code for the language.|
+|*orderInfo*     |Integer  |15            |Any            |Sets the orderering information for the file/directory.|
+|*template*      |String   |my.template   |Page file      |Sets the template for the page file overriding the default value.|
+|*title*         |String   |New Title     |Any            |Sets the title for the file/directory.|
+|*useERB*        |Boolean  |false         |Page file      |Specifies if the content blocks of the page file should be processed with ERB overriding the default value.|

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

@@ -12,3 +12,15 @@ The directory handler is used for processing directories. It creates the target
 additionally an index file for each directory can be specified. If specified, this file is used
 instead of the plain directory index for displaying purposes. For example, the menu item for the
 file handlers page is generated by the index file of the @filehandler@ directory.
+
+Normally, webgen shows a warning if it could not find the directory index file for a directory.
+However, there are most certainly directories which should not have an index file, e.g. a directory
+with pictures only. To prevent webgen from displaying warnings for such directories, you can add the
+following meta information to a backing file:
+
+<pre>
+dirWithOnlyImages:
+  indexFile: ~
+</pre>
+
+This will prevent webgen from showing warnings because you explicitly define a null index file.

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

@@ -1,13 +1,29 @@
 ---
 directoryName: File Handlers
 ---
-h2. About
+h2. Information
+
+<notextile>{describe: FileHandler}</notextile>
+
+h2. Description
 
 File handlers are used to handle different types of input files. You can see the currently exisiting
 file handlers in the menu. Choose one to get a description for it!
 
-Each file handler can handle one or more different file extensions. During the processing of the
-website, files with a registered extension are processed by the corresponding file handler.
+Each file handler specifies path patterns or extensions for the files he handles. During the
+processing of the website, the FileHandler instance calls the approriate file handler for each file
+and builds the internal representation of the source directory.
+
+h2. Path Patterns
+
+Path patterns are more like shell globs than regular expressions. One can use any path pattern that
+the @Dir.glob@ method understands. Here are some examples:
+
+table{border: 1px solid black}.
+|^. <notextile><code>*/*.html</code></notextile>|^. All files with the extension @html@ in the subdirectories of the root source directory|
+|^. <notextile><code>**/*.html</code></notextile>|^. All files with the extension @html@ in all directories|
+|^. <notextile><code>**/{foo,bar}*</code></notextile>|^. All files in all directories which start with @foo@ or @bar@|
+|^. <notextile><code>**/???</code></notextile>|^. All files in all directories whose file name is exactly three characters long|
+
+
 
-A special "file" handler is used to handle directories; this file handler registers the extension
-@:dir@.