webgen 0.3.6 → 0.3.7

data/doc/src/index.page

@@ -18,18 +18,37 @@ list":http://rubyforge.org/mail/?group_id=296 available if you have any question
 
 h2. News
 
-<b>??.??.2005 - webgen 0.3.5 released!!!</b>
+<b>27.11.2005 - webgen 0.3.7 released!!!</b>
+
+Major changes:
+
+* Now using cmdparse version 2.0.0!
+* %{color:red}Attention%: For unified naming in reference to image galleries, I have removed all occurences of the word "picture" from the code and documentation and replaced it with "image". Therefore you may need to adapt your code, especially custom gallery layouters!
+* %{color:red}Attention%: Many documentation and library files have been renamed for better consistency! Custom plugins may have to be adapted!
+* <b>New <a href="{relocatable: /documentation/webgen_gallery_editor.page}">application</a></b> for managing image galleries (only alpha quality currently!)
+* Smileys are now optionally replaced with emoticons (<notextile>:-) ;-) :'-( 8-)</notextile>, several different emoticon packs available) -> see <a href="{relocatable: documentation/plugins/miscplugins/smileyreplacer.page}">SmileyReplacer</a>
+* <a href="{relocatable: documentation/extending_webgen.page}">Site specific commands</a> (used in command line processing) can now be used
+* New plugin <a href="{relocatable: documentation/plugins/tags/download.page}">Download Tag</a> for nice download links
+* New parameters: <a href="{relocatable: documentation/plugins/filehandlers/page.page}">PageFileHandler:defaultPageMetaData</a>, <a href="{relocatable: documentation/plugins/tags/sitemap.page}">SitemapTag:honorInMenu</a>
+* Removed parameters: PageFileHandler:useERB, PageFileHandler:defaultContentFormat
+* Renamed tag <b>navbar</b> to <b>breadcrumbTrail</b>
+* Images in image galleries can now be ordered by specifying the @orderInfo@ meta information
+* The use of directory index files is now optional: by setting the parameter <a href="{relocatable: documentation/plugins/filehandlers/directoryhandler.page}">DirectoryHandler:indexFile</a> to nil directory index files are not used
+* Languages can now be specified using 2-char ISO-639-1 codes or 3-char ISO-639-2 codes
+* Now there is a link (next to the wiki link) to the source of each page unless the page was programmatically generated.
+
+<b>24.06.2005 - webgen 0.3.5 released!!!</b>
 
 Major changes:
 
 * Now using cmdparse version 1.0.3!
 * New CLI command "clean" for deleting the generated or all files from the output directory
 * Restructured menu tag -> five different menu styles now available (see <a href="{relocatable: documentation/plugins/menustyles}">Menu Styles</a>)
-* New plugin <a href="{relocatable: documentation/plugins/resourcemanager.page}">ResourceManager</a> for defining resources
+* New plugin <a href="{relocatable: documentation/plugins/coreplugins/resourcemanager.page}">ResourceManager</a> for defining resources
 * New plugin <a href="{relocatable: documentation/plugins/tags/resource.page}">Resource Tag</a> for accessing resources
-* Pages files can now be referenced in @relocatable@ tag and backing files with a standardified name (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page#naming}">here</a>), despite an eventually self defined naming scheme
+* Pages files can now be referenced in @relocatable@ tag and backing files with a standardified name (see <a href="{relocatable: documentation/plugins/filehandlers/page.page#naming}">here</a>), despite an eventually self defined naming scheme
 * New parameters: <a href="{relocatable: documentation/plugins/tags/langbar.page}">LangbarTag:showOwnLang</a>
-* Changed paramters: <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler:validator</a> (now deactivated by default)
+* Changed paramters: <a href="{relocatable: documentation/plugins/filehandlers/page.page}">PageFileHandler:validator</a> (now deactivated by default)
 * Fixed bugs
 
 <b>12.05.2005 - webgen 0.3.4 released!!!</b>
@@ -37,11 +56,11 @@ Major changes:
 Major changes:
 
 * FileHandler now uses path patterns and/or extensions for determining which files to process !
-* ERB (embedded ruby) can now be used in templates and page files (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler</a>)!
+* ERB (embedded ruby) can now be used in templates and page files (see <a href="{relocatable: documentation/plugins/filehandlers/page.page}">PageFileHandler</a>)!
 * Relocatable tag now accepts complex URIs (URIs with query and fragment part, absolute URIs)
 * Changed meta info name *menuOrder* to *orderInfo* (e.g. used for specifying order information for menus) -- you have to adapt your page and backing files!!!
-* New parameters: <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler:useERB</a>
-* Changed parameters: <a href="{relocatable: documentation/plugins/filehandler}">FileHandler:ignorePaths</a>, <a href="{relocatable: documentation/plugins/filehandler/copy.page}">FileCopyHandler:paths</a>
+* New parameters: <a href="{relocatable: documentation/plugins/filehandlers/page.page}">PageFileHandler:useERB</a>
+* Changed parameters: <a href="{relocatable: documentation/plugins/filehandlers}">FileHandler:ignorePaths</a>, <a href="{relocatable: documentation/plugins/filehandlers/copy.page}">CopyFileHandler:paths</a>
 * New page describing meta information items used by plugins
 * Fixed bugs
 
@@ -54,7 +73,7 @@ Major changes:
 * New logging plugin lets you have more control over logging and log files
 * Now each website can have a plugin directory
 * New parameters for: <a href="{relocatable: documentation/plugins/tags/wikilink.page}">wikilink</a>
-* Changed format of backing files -> have a look at the <a href="{relocatable: documentation/plugins/filehandler/backing.page}">documentation</a>!
+* Changed format of backing files -> have a look at the <a href="{relocatable: documentation/plugins/filehandlers/backing.page}">documentation</a>!
 * Removed obsolete Extension Loader plugin
 * Fixed bugs
 
@@ -68,9 +87,9 @@ Bug fix release for bug #1637 and other bugs
 
 Major changes:
 
-* Better DefaultLayouter for picture galleries (<a href="{relocatable: Design_Gallery_1.page}">online demo</a>)
-* Output names for page files now customizable (see <a href="{relocatable: documentation/plugins/filehandler/pagehandler.page}">PageHandler</a>)
-* On-the-fly creation of thumbnails for pictures with RMagick
+* Better DefaultLayouter for image galleries (<a href="{relocatable: Screenshots_1.page}">online demo</a>)
+* Output names for page files now customizable (see <a href="{relocatable: documentation/plugins/filehandlers/page.page}">PageFileHandler</a>)
+* On-the-fly creation of thumbnails for images with RMagick
 * New tags: <a href="{relocatable: documentation/plugins/tags/sitemap.page}">sitemap</a>
 * Tag @lang@ renamed, new name @langbar@!
 * New parameters for @menu@ tag

data/doc/src/meta.info

@@ -2,7 +2,7 @@ index.page:
   orderInfo: 1
 
 download.page:
-  orderInfo: 11
+  orderInfo: 8
 
 features.page:
   orderInfo: 5
@@ -11,20 +11,20 @@ api.html:
   dest: rdoc/index.html
   title: API Reference
 
-documentation/api.html:
-  dest: ../rdoc/index.html
+documentation/references/api.html:
+  dest: ../../rdoc/index.html
   title: API Reference
   inMenu: true
   orderInfo: 60
 
-documentation/wiki.html:
+wiki.html:
   dest: http://webgen.rubyforge.org/wiki/wiki.pl
-  title: Wiki Web
+  title: WikiWiki Web
   inMenu: true
-  orderInfo: 50
+  orderInfo: 10
 
 documentation/index.page:
   orderInfo: 9
 
-designs:
+images:
   indexFile: ~

data/doc/src/screenshots.gallery

@@ -0,0 +1,33 @@
+--- 
+mainPage: 
+  orderInfo: 20
+imagesPerPage: 20
+files: images/screenshots/*
+thumbnailSize: ''
+mainPageTemplate: ''
+title: Screenshots
+galleryOrderInfo: 50
+images/screenshots/wge-image.png: 
+  title: Gallery editor with image preview
+  description: "When an image is selected in the image list, the pane right of it displays the
+    image."
+  orderInfo: 3
+galleryPageInMenu: false
+mainPageInMenu: true
+galleryPageTemplate: ''
+images/screenshots/wge-layout-preview.png: 
+  title: Gallery editor with layout preview
+  description: This shows the gallery editor with the layout preview open. You can see how a sample gallery looks with a specific layout.
+  orderInfo: 4
+galleryPages: {}
+imagePageTemplate: ''
+images/screenshots/wge-main-disabled.png: 
+  title: Gallery editor main window disabled
+  description: This screenshot show how the gallery editor appears when started.
+  orderInfo: 1
+images/screenshots/wge-main.png: 
+  title: Gallery editor main window active
+  description: This screenshot shows the normal appearance of the gallery editor.
+  orderInfo: 2
+imagePageInMenu: false
+layout: default

data/install.rb

@@ -3,7 +3,7 @@ require 'rpa/install'
 
 class Install_webgen < RPA::Install::FullInstaller
   name 'webgen'
-  version '0.3.6-1'
+  version '0.3.7-1'
   classification Application
   build do
     installdocs %w[COPYING ChangeLog TODO]

data/lib/webgen.rb

@@ -0,0 +1,275 @@
+#
+#--
+#
+# $Id: webgen.rb 360 2005-11-02 08:24:26Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+#
+
+require 'rbconfig'
+require 'fileutils'
+require 'cmdparse'
+require 'webgen/plugin'
+require 'webgen/gui/common'
+
+
+module Webgen
+
+  class Color
+
+    @@colors = {:bold => [0, 1], :green => [0, 32], :lblue => [1, 34], :lred => [1, 31], :reset => [0, 0]}
+
+    def self.colorify
+      @@colors.each do |color, values|
+        module_eval <<-EOF
+        def Color.#{color.to_s}
+        "\e[#{values[0]};#{values[1]}m"
+        end
+        EOF
+      end
+    end
+
+    def self.method_missing( id )
+      ''
+    end
+
+  end
+
+  class CreateCommand < CmdParse::Command
+
+    def initialize
+      super( 'create', false )
+      self.short_desc = "Creates the basic directories and files for webgen"
+      self.description = "You can optionally specify a template and/or a style which should be used. " \
+      "This allows you to create a good starting template for your website."
+      self.options = CmdParse::OptionParserWrapper.new do |opts|
+        opts.separator "Options:"
+        opts.on( '-t', '--template TEMPLATE', 'Specify the template which should be used' ) {|@template|}
+        opts.on( '-s', '--style STYLE', 'Specify the style which should be used' ) {|@style|}
+        opts.separator ""
+        opts.separator "Available templates and styles:"
+        opts.separator opts.summary_indent + "Templates: " + Webgen::Website.templates.join(', ')
+        opts.separator opts.summary_indent + "Styles: " + Webgen::Website.styles.join(', ')
+      end
+      @template = 'default'
+      @style = 'default'
+    end
+
+    def usage
+      "Usage: #{commandparser.program_name} [global options] create DIR"
+    end
+
+    def execute( args )
+      if args.length == 0
+        raise OptionParser::MissingArgument.new( 'DIR' )
+      else
+        Webgen.create_website( args[0], @template, @style )
+      end
+    end
+
+  end
+
+  class CleanCommand < CmdParse::Command
+
+    module ::FileUtils
+
+      def fu_output_message( msg )
+        logger.info { msg }
+      end
+
+      def ask_before_delete( ask, func, list, options = {} )
+        newlist = [*list].collect {|e| "'" + e + "'"}.join(', ')
+        if ask
+          print "Really delete #{newlist}? "
+          return unless /y|Y/ =~ gets.strip
+        end
+        self.send( func, list, options.merge( :verbose => true ) )
+      end
+
+    end
+
+    class CleanWalker < Webgen::Plugin
+
+      summary "Deletes the output file for each node."
+      depends_on 'TreeWalker'
+
+      attr_writer :ask
+
+      def handle_node( node, level )
+        file = node.recursive_value( 'dest' )
+        return if !File.exists?( file ) || node['int:virtualNode']
+        if File.directory?( file )
+          begin
+            FileUtils.ask_before_delete( @ask, :rmdir, file )
+          rescue Errno::ENOTEMPTY => e
+            logger.info "Cannot delete directory #{file}, as it is not empty!"
+          end
+        else
+          FileUtils.ask_before_delete( @ask, :rm, file, :force => true )
+        end
+      end
+
+    end
+
+    def initialize;
+      super( 'clean', false )
+      self.short_desc = "Removes the generated or all files from the output directory"
+      self.options = CmdParse::OptionParserWrapper.new do |opts|
+        opts.separator( "Options" )
+        opts.on( '--all', '-a', "Removes ALL files from the output directory" ) { @all = true }
+        opts.on( '--interactive', '-i', "Ask for each file" ) { @ask = true }
+      end
+      @all = false
+      @ask = false
+    end
+
+    def execute( args )
+      if @all
+        logger.info( "Deleting all files from output directory..." )
+        outDir = Plugin['Configuration']['outDirectory']
+        FileUtils.ask_before_delete( @ask, :rm_rf, outDir ) if File.exists?( outDir )
+      else
+        tree = Plugin['FileHandler'].build_tree
+        logger.info( "Deleting generated files from output directory..." )
+        Plugin['CleanWalker'].ask = @ask
+        Plugin['TreeWalker'].execute( tree, Plugin['CleanWalker'], :backward )
+      end
+      logger.info( "Webgen finished 'clean' command" )
+    end
+
+  end
+
+  class WebgenCommandParser < CmdParse::CommandParser
+
+    def initialize
+      super( true )
+      self.program_name = "webgen"
+      self.program_version = Webgen::VERSION
+      self.options = CmdParse::OptionParserWrapper.new do |opts|
+        opts.separator "Global options:"
+        opts.on( "--verbosity LEVEL", "-V", Integer, "The verbosity level" ) { |verbosity| Plugin.set_param( 'Logging', 'verbosityLevel', verbosity ) }
+        opts.on( "--[no-]logfile", "-L", "Log to file" ) { |logfile| Plugin.set_param( 'Logging', 'logToFile', logfile ) }
+      end
+
+      # Run command
+      run = CmdParse::Command.new( 'run', false )
+      run.short_desc = "Runs webgen"
+      run.set_execution_block {|args| Webgen.run_webgen }
+      self.add_command( run, true )
+
+      # Show command
+      show = CmdParse::Command.new( 'show', true )
+      show.short_desc = "Show various information"
+      self.add_command( show )
+
+      # Show plugins command
+      showPlugins = CmdParse::Command.new( 'plugins', false )
+      showPlugins.short_desc = "Show the available plugins"
+      showPlugins.set_execution_block do |args|
+        print "List of loaded plugins:\n"
+
+        headers = Hash.new {|h,k| h[k] = (k.nil? ? "Other Plugins" : k.gsub(/([A-Z][a-z])/, ' \1').strip) }
+
+        ljustlength = 30 + Color.green.length + Color.reset.length
+        header = ''
+        Plugin.config.sort { |a, b| a[0].name <=> b[0].name }.each do |klass, data|
+          newHeader = headers[klass.name[/^.*?(?=::)/]]
+          unless newHeader == header
+            print "\n  #{Color.bold}#{newHeader}#{Color.reset}:\n";
+            header = newHeader
+          end
+          print "    - #{Color.green}#{data.plugin}#{Color.reset}:".ljust(ljustlength) +"#{data.summary}\n"
+        end
+      end
+      show.add_command( showPlugins )
+
+      # Show params command
+      showConfig = CmdParse::Command.new( 'config', false )
+      showConfig.short_desc = "Show the parameters of all plugins or of the specified one"
+      showConfig.set_execution_block do |args|
+        puts "List of plugin parameters:"
+        puts
+        ljustlength = 25 + Color.green.length + Color.reset.length
+        Plugin.config.sort { |a, b| a[0].name[/\w*$/] <=> b[0].name[/\w*$/] }.each do |klass, data|
+          next if args.length > 0 && args[0] != data.plugin
+          puts "  #{Color.bold}#{data.plugin}#{Color.reset}:"
+          puts "    #{Color.green}Summary:#{Color.reset}".ljust(ljustlength) + data.summary if data.summary
+          puts "    #{Color.green}Description:#{Color.reset}".ljust(ljustlength) + data.description if data.description
+          puts "    #{Color.green}Tag name:#{Color.reset}".ljust(ljustlength) + (data.tag == :default ? "Default tag" : data.tag) if data.tag
+          puts "    #{Color.green}Handled paths:#{Color.reset}".ljust(ljustlength) + data.path.inspect if data.path
+
+          data.table.keys.find_all {|k| /^registered_/ =~ k.to_s }.each do |k|
+            name = k.to_s.sub( /^registered_/, '' ).tr('_', ' ').capitalize + " name"
+            puts "    #{Color.green}#{name}:#{Color.reset}".ljust(ljustlength) + data.send( k )
+          end
+
+          if data.params
+            puts "\n    #{Color.green}Parameters:#{Color.reset}"
+            data.params.sort.each do |key, item|
+              print "      #{Color.green}Parameter:#{Color.reset}".ljust(ljustlength)
+              puts Color.lred + item.name + Color.reset + " = " + Color.lblue +  item.value.inspect + Color.reset + " (" + item.default.inspect + ")"
+              puts "      #{Color.green}Description:#{Color.reset}".ljust(ljustlength) + item.description
+              puts
+            end
+          end
+          puts
+        end
+      end
+      show.add_command( showConfig )
+
+      self.add_command( CreateCommand.new )
+      self.add_command( CleanCommand.new )
+      self.add_command( CmdParse::HelpCommand.new )
+      self.add_command( CmdParse::VersionCommand.new )
+    end
+
+  end
+
+  # Run webgen
+  def self.run_webgen( directory = Dir.pwd )
+    Dir.chdir( directory )
+
+    logger.info "Starting Webgen..."
+    tree = Plugin['FileHandler'].build_tree
+    Plugin['TreeWalker'].execute( tree ) unless tree.nil?
+    Plugin['FileHandler'].write_tree( tree ) unless tree.nil?
+    logger.info "Webgen finished"
+  end
+
+  # Create a website in the +directory+, using the +template+ and the +style+.
+  def self.create_website( directory, template = 'default', style = 'default' )
+    templateDir = File.join( CorePlugins::Configuration.data_dir, 'website_templates', template )
+    styleDir = File.join( CorePlugins::Configuration.data_dir, 'website_styles', style )
+    raise ArgumentError.new( "Invalid template <#{template}>" ) if !File.directory?( templateDir )
+    raise ArgumentError.new( "Invalid style <#{style}>" ) if !File.directory?( styleDir )
+
+    raise ArgumentError.new( "Website directory <#{directory}> does already exist!") if File.exists?( directory )
+    FileUtils.mkdir( directory )
+    FileUtils.cp_r( Dir[File.join( templateDir, '*' )], directory )
+    FileUtils.cp_r( Dir[File.join( styleDir, '*' )], File.join( directory, 'src' ) )
+  end
+
+  # Main program for the webgen CLI command.
+  def self.cli_main
+    Color.colorify if $stdout.isatty && !Config::CONFIG['arch'].include?( 'mswin32' )
+    Plugin['Configuration'].cmdparser = WebgenCommandParser.new
+    Plugin['Configuration'].cmdparser.parse do |level, cmdName|
+      Plugin['Configuration'].init_all if level == 0
+    end
+  end
+
+end

data/lib/webgen/composite.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: composite.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: composite.rb 271 2005-05-09 08:50:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner