webgen 0.3.6 → 0.3.7

data/doc/plugin/emoticon.rb

@@ -0,0 +1,29 @@
+module WebgenDocuPlugins
+
+  class ShowEmoticonsTag < Tags::DefaultTag
+
+    summary "Creates a table of the existing emoticon packs"
+
+    tag 'showEmoticonPacks'
+
+    def process_tag( tag, node, refNode )
+      res = Webgen::Plugin.config[CorePlugins::ResourceManager].resources
+      packs = Dir[File.join( CorePlugins::Configuration.data_dir, 'resources', 'emoticons', '*/')].collect {|p| File.basename( p )}.sort
+
+      map = MiscPlugins::SmileyReplacer::SMILEY_MAP
+      output = '<table style="width: 100%; border: 1px solid black" summary="List of emoticon packs" rules="groups" frame="border">'
+      header = map.sort {|a,b| a[1] <=> b[1]}.collect {|s, name| "<th><code>#{s}</code><br />(#{name})</th>" }.join('')
+      output << "<thead><tr><th>Smiley/Pack</th>#{header}</tr></thead><tbody>"
+      packs.each do |pack|
+        output << "<tr><th>#{pack}</th>"
+        output << map.values.sort.collect do |v|
+          "<td align=\"center\"><img src=\"{resource: webgen-emoticons-#{pack}-#{v}}\" alt=\"smiley\"/></td>"
+        end.join('')
+        output << "</tr>"
+      end
+      output << "</tbody></table>"
+    end
+
+  end
+
+end

data/doc/plugin/extension.rb

@@ -1,14 +1,10 @@
-module OtherPlugins
+module WebgenDocuPlugins
 
   class VersionTag < Tags::DefaultTag
 
     summary "Shows the version number of webgen"
-    depends_on 'Tags'
 
-    def initialize
-      super
-      register_tag( 'version' )
-    end
+    tag 'version'
 
     def process_tag( tag, node, refNode )
       Webgen::VERSION.join( '.' )
@@ -21,12 +17,12 @@ module OtherPlugins
     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'
+
+    tag 'describe'
 
     def initialize
       super
       @processOutput = false
-      register_tag( 'describe' )
     end
 
     def process_tag( tag, node, refNode )
@@ -55,14 +51,7 @@ module OtherPlugins
 
       # parameters
       unless data.params.nil?
-        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>" \
-            : " (=" + ( v.mandatoryDefault ? "default " : "" ) + "mandatory parameter)" ) + \
-          ": #{CGI::escapeHTML( v.description )}"
-        end
-        s += row['Parameters', params.join( "<br />\n" )]
+        s += row['Parameters', format_params( data.params )]
       end
 
       # used meta info
@@ -80,6 +69,16 @@ module OtherPlugins
       s += "</table>"
     end
 
+    def format_params( params )
+      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>" \
+          : " (=" + ( v.mandatoryDefault ? "default " : "" ) + "mandatory parameter)" ) + \
+        ": #{CGI::escapeHTML( v.description )}"
+      end.join( "<br />\n" )
+    end
+
   end
 
 end

data/doc/plugin/listpluginparameters.rb

@@ -0,0 +1,39 @@
+require 'set'
+
+module WebgenDocuPlugins
+
+  class ListPluginParametersTag < Tags::DefaultTag
+
+    summary "Lists all available plugin parameters"
+
+    tag 'listPluginParameters'
+
+    def initialize
+      super
+      @processOutput = false
+    end
+
+    def process_tag( tag, node, refNode )
+      plugins = Webgen::Plugin.config.select {|k,v| k.name !~ /^WebgenDocuPlugins::/ }
+
+      mydata = {}
+      plugins.each do |klass, data|
+        next if data.params.nil?
+        (mydata[klass.name[/^.*?(?=::)/].gsub(/([A-Z][a-z])/, ' \1').strip] ||= []) << data
+      end
+
+      output = "<dl>\n"
+      mydata.sort.each do |cat, plugins|
+        output << "<dt>#{cat}</dt><dd><dl>"
+        plugins.sort {|a,b| a.plugin <=> b.plugin}.each do |data|
+          output << "<dt>#{data.plugin}</dt>\n"
+          output << "<dd>#{Webgen::Plugin['DescribeTag'].format_params( data.params )}</dd>\n"
+        end
+        output << "</dl></dd>"
+      end
+      output << "</dl>\n"
+    end
+
+  end
+
+end

data/doc/plugin/resources.rb

@@ -1,18 +1,18 @@
-module OtherPlugins
+module WebgenDocuPlugins
 
   class PredefinedResourcesTag < Tags::DefaultTag
 
     summary "Creates a table of all predefined resources"
-    depends_on 'Tags'
+
+    tag 'predefinedResources'
 
     def initialize
       super
       @processOutput = false
-      register_tag( 'predefinedResources' )
     end
 
     def process_tag( tag, node, refNode )
-      res = Webgen::Plugin.config[Webgen::ResourceManager].resources
+      res = Webgen::Plugin.config[CorePlugins::ResourceManager].resources
       output = '<table style="width: 100%; border: 1px solid black" summary="List of predefined resources" rules="cols" frame="border">'
       output << '<thead><tr><th>Name</th><th>Type</th><th>Output path</th><th>Description</th></tr></thead>'
       output << '<tbody>'

data/doc/plugin/source.rb

@@ -0,0 +1,21 @@
+module WebgenDocuPlugins
+
+  class ShowSourceTag < Tags::DefaultTag
+
+    summary "Copy the page source and link to it"
+
+    tag 'source'
+
+    def process_tag( tag, node, refNode )
+      outpath = node.recursive_value( 'src' ).sub( /^#{Webgen::Plugin['Configuration']['srcDirectory']}/, Webgen::Plugin['Configuration']['outDirectory'] )
+      if File.exists?( node.recursive_value('src') )
+        FileUtils.cp( node.recursive_value( 'src' ), outpath )
+        "Source: <a href=\"#{node['src']}\">page source</a>"
+      else
+        ""
+      end
+    end
+
+  end
+
+end

data/doc/src/default.css

@@ -7,6 +7,7 @@
 
 body {
   margin: 0px 2em;
+  padding: 0px;
   font-size: 12px;
   font-family: Verdana, Arial, Helvetica, sans-serif;
   border: 1px solid black;
@@ -84,8 +85,6 @@ a { color: #5C73B8; }
   clear: both;
 }
 
-#quickmenu > div > a { border-bottom: 3px double black; }
-
 /** styling the sample menus **/
 
 /* horizontal menu */
@@ -143,6 +142,10 @@ a { color: #5C73B8; }
   font-weight: bold;
 }
 
+.partial-menu .webgen-menu-submenu {
+  background: #405080;
+}
+
 .partial-menu a {
   color: white;
   display: block;
@@ -230,11 +233,11 @@ dt {
   font-weight: bold;
 }
 
-.webgen-picture {
+.webgen-image {
   text-align: center;
 }
 
-.webgen-picture img {
+.webgen-image img {
   border: 1px solid black;
 }
 

data/doc/src/default.template

@@ -2,10 +2,11 @@
 <!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>webgen - {title: }</title>
+    <title>webgen - static website generator - {title: }</title>
     <link href="{resource: webgen-css}" rel="stylesheet" />
     <link href="{relocatable: default.css}" rel="stylesheet" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="Keywords" content="webgen, static web site generator, ruby, HTML, dynamic tags, plugin based, static web, web generator, site generator" />
   </head>
   <body>
     <div id="all">
@@ -21,9 +22,10 @@
       </div>
 
       <div id="headerbar" class="bar">
-        <span class="left">Navbar: {navbar: }</span>
+        <span class="left">Location: {breadcrumbTrail: }</span>
         <span class="right">Language: {langbar: }</span>
         <span class="right">Feedback: {wikilink: {rootURL: http://webgen.rubyforge.org/wiki/wiki.pl?, title: Click here}}</span>
+        <span class="right">{source: }</span>
         <div style="clear:both"></div>
       </div>
 

data/doc/src/documentation/cli.page

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

data/doc/src/documentation/extending_webgen.page

@@ -0,0 +1,102 @@
+---
+title: Extending webgen
+inMenu: true
+orderInfo: 21
+---
+h2. Extending webgen
+
+h3. General
+
+There is a logging mechanism available for informational and debugging purposes. Four different log
+levels are available:
+
+* debug
+* info
+* warn
+* error
+
+The methods are named after the log levels and can be invoked by using
+@logger.{debug|info|warn|error}@. You need to provide a string as argument or a block which returns
+a string.
+
+h3. Normal plugins (new tags, file handlers, etc)
+
+As webgen is plugin-based, it can be extended very easily. A simple example is shown in the
+<a href="{relocatable: gettingstarted.page#simple-plugin}">Getting Started</a> guide.
+
+If you want more sophisticated examples of plugins, have a look at webgen itself and the plugins
+that get shipped with it. They can be found in the directory @lib/webgen/plugins/@!
+
+h3. CLI Command Plugins
+
+For this you need to write a new command class and put its file into the @plugin@ folder of the
+website. Have a look at the "cmdparse API reference":http://cmdparse.rubyforge.org/rdoc/index.html
+for information about how to write a command class.
+
+There are basically two ways for a command plugin:
+
+* Easiest one
+
+  You just declare a new class derived from @CmdParse::Command@ and include the
+  @Webgen::CommandPlugin@ module. After you have included this module, you can use all standard
+  plugin directives, like @summary@ or @add_param@. Also, this command gets automatically added to
+  the main @CommandParser@ class. Thus, the @initialize@ method must not take any arguments!
+
+  <pre>
+  class SimpleCommand < CmdParse::Command
+
+  include Webgen::CommandPlugin
+
+  summary "Describe simple command"
+  add_param 'firstParam', 45, 'Description of firstParam'
+
+  def initialize
+    super( 'simple', false )
+    self.short_desc = "This is a sample for a simple command."
+  end
+
+  def usage; "Usage: #{@options.program_name} [global options] simple"; end
+
+  def execute( args )
+    # do something useful
+  end
+
+  end
+  </pre>
+
+* Easy one
+
+  You only need to go this way when the @initialize@ method of your command class needs to
+  arguments!!
+
+  Like before, you declare your new command class. This time however, you need include the
+  @Webgen::PluginDefs@ module and set the constant @VIRTUAL@ to true. This prevents the plugin
+  system from automatically instantiating an object. You then need to instantiate an object and add
+  it to the main @CommandParser@ class. This can be done by calling the @add_cmdparser_command@ of
+  the configuration plugin.
+
+  <pre>
+  class OtherCommand < CmdParse::Command
+
+  include Webgen::PluginDefs
+
+  VIRTUAL = true
+
+  summary "Describe other simple command"
+
+  def initialize( arg )
+    super( 'otherSimple', false )
+    @arg = arg
+    self.short_desc = "This is a second sample for a simple command."
+  end
+
+  def usage; "Usage: #{@options.program_name} [global options] otherSimple"; end
+
+  def execute( args )
+    # do something useful
+  end
+
+  end
+
+  Webgen::Plugin['Configuration'].add_cmdparser_command( OtherCommand.new( 5 ) )
+  </pre>

data/doc/src/documentation/gettingstarted.page

@@ -73,7 +73,7 @@ Just add page files and other content to your website and let it grow!
 h2. Using Meta Information in Pages
 
 Meta information is specified at the beginning of a page file. Have a look at the
-<a href="{relocatable: plugins/filehandler/pagehandler.page}">documentation</a> to see how that is done
+<a href="{relocatable: plugins/filehandlers/page.page}">documentation</a> to see how that is done
 in detail!
 
 We are now going to use meta information to customize our website! Open the file @default.template@
@@ -112,7 +112,7 @@ Run webgen and view the output! The tag @\{filemdate: }@ got substituted by the
 the meta information. As we have not put any meta information in the @index.page@ file, a warning is
 issued when webgen is run and no date is shown on the page!
 
-h2. Write a Simple Plugin
+h2(#simple-plugin). Write a Simple Plugin
 
 Because we are not quite happy with our basic file modification time tag, we are going to write a
 simple tag plugin.
@@ -129,10 +129,7 @@ module Tags
     summary "Puts the modification time of the file on the page"
     depends_on 'Tags'
 
-    def initialize
-      super
-      register_tag( 'filemdate' )
-    end
+    tag 'filemdate'
 
     def process_tag( tag, node, refNode )
       return File.mtime( node.recursive_value( 'src' ) ).to_s

data/doc/src/documentation/index.page

@@ -56,5 +56,5 @@ parameter. Each parameter can be overridden in the configuration file by specifi
 plugin name as top level key and each parameter and value as a key/value pair. A configuration file
 looks like this:
 
-<pre class="webgen-file">{includeFile: /../../../testsite/config.yaml}</pre>
+<pre class="webgen-file">{includeFile: ../../config.yaml}</pre>
 

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

@@ -0,0 +1,7 @@
+---
+title: Core Plugins
+directoryName: Core Plugins
+---
+h2. About
+
+The core plugins provide core functionality for webgen.

data/doc/src/documentation/plugins/{resourcemanager.page → coreplugins/resourcemanager.page}

@@ -20,11 +20,15 @@ There are two different types of resources: file resources and memory resources.
     additional information, such as CSS formatting rules or Javascript.
 
 Resources are only written to the output path if they are referenced (i.e. their output path is
-included in a page file) at least once by the <a href="{relocatable: tags/resource.page}">resource
+included in a page file) at least once by the <a href="{relocatable: ../tags/resource.page}">resource
 tag</a>.
 
 h2. Predefined Resources
 
 webgen provides some predefined resources which can be used by any website created with it.
 
+Credits: The icons were taken from the "CrystalClear" package from
+"http://www.kde-look.org/content/show.php?content=25668":http://www.kde-look.org/content/show.php?content=25668
+.
+
 <notextile>{predefinedResources:}</notextile>

data/doc/src/documentation/plugins/{filehandler → filehandlers}/backing.page

@@ -35,7 +35,7 @@ information you want. You can use relative and absolute paths in the filenames.
 specify meta information for files which are in one of the parent directories of the backing file.
 
 If you want to set meta information for an existing page description file, you have to use the
-<a href="{relocatable: pagehandler.page#naming}">standardified name</a> of that page description
+<a href="{relocatable: page.page#naming}">standardified name</a> of that page description
 file (e.g. @filename1.page@ or @filename1.de.page@).
 
 Using backing files you can add virtual files and directories. If the file specified in the entry