webgen 0.3.8 → 0.4.0

data/doc/src/documentation/plugins/tags/includefile.page

@@ -1,15 +0,0 @@
----
-title: Include File
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: IncludeFileTag}</notextile>
-
-h2. Description
-
-The include file tag is used to include the contents of a file.
-
-h2. Examples
-
-<pre class="webgen-file">{includeFile: {filename: includefile.page, processOutput: false}}</pre>

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

@@ -1,44 +0,0 @@
----
-directoryName: Tags
----
-h2. About
-
-Tags are used to generate content. During processing of the page description files so called 'tags'
-are substituted. For example, the menu you see to left was generated. This makes it easier to add or
-remove menu items. If the menu was not generated, you would have to change every file which uses the
-menu.
-
-webgen comes bundled with some default tag plugins. All currently available tags are exercised in
-this online demo. Choose a tag from the menu to get a detailed description of the tag.
-
-h2. Usage
-
-Tags are defined by a special markup code. A tag has the following structure:
-
-<pre>\{tagname: {parameters}}</pre>
-
-Every time a tag is found in a source file, the registered plugin for the tag is called. The plugin
-returns a string which is put into the output file instead of the tag. The output a tag plugin can
-produce ranges from something simple to something complex. For example, the <a href="{relocatable: meta.page}">
-Meta Tag</a> plugin copies any additional info specified in the source file verbatim
-into the correct place in the output file. And in contrast, the <a href="{relocatable: menu.page}">
-Menu Tag</a> plugin generates a whole menu tree.
-
-If you want to use the markup code used for tags, you need to escape the tag, like this:
-
-<pre>\\\{tagname: {parameters}}</pre>
-
-
-h2. Tag Parameters
-
-A tag can have zero or more parameters some of which are mandatory. You can see the supported
-parameters (and if they are mandatory) for each tag on the tag's page. The default mandatory
-parameter can be specified in a special way, see the examples below. The format used for parsing the
-parameters is YAML.
-
-h2. Examples
-
-table{border: 1px solid black}.
-|^. @\{tagname: }@|^. No parameter specified|
-|^. @\{tagname: test.html}@|^. The default mandatory parameter is set to @test.html@. This form can only be used if there is only one mandatory parameter|
-|^. @\{tagname: {param1: value1, param2: value2}}@|^. Two parameters (param1 and param2) specified|

data/doc/src/documentation/plugins/tags/langbar.page

@@ -1,27 +0,0 @@
----
-title: Language Bar
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: LangbarTag}</notextile>
-
-h2. Description
-
-The language tag is used to display a list of languages for a page. Take a look at the lower right
-corner of the header. There you will find a link titled 'en'. This is the link to the english (=en)
-version of this page.
-
-h2. Examples
-
-Here is a <a href="{relocatable: multilang.page}">link</a> to a page which is translated to several
-languages (more or less ;-). Have a look at it and don't forget to view the page in the other
-languages!
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|<notextile>\{langbar: }</notextile>|<notextile>{langbar: }</notextile>|
-|\{langbar: {separator: Hallo}}|{langbar: {separator: Hallo}}|
-|\{langbar: {showSingleLang: false}}|{langbar: {showSingleLang: false}}|
-|\{langbar: {showOwnLang: false}}|{langbar: {showOwnLang: false}}|
-

data/doc/src/documentation/plugins/tags/menu.de.page

@@ -1,12 +0,0 @@
----
-title: Menütag
-inMenu: true
----
-<div class="section">
-
-h2. Information
-
-Auf der linken Seite sehen sie jetzt die deutschen Menüeinträge (now you can see the german menu
-entries on the left).
-
- </div>

data/doc/src/documentation/plugins/tags/menu.page

@@ -1,19 +0,0 @@
----
-title: Menu
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: MenuTag}</notextile>
-
-h2. Description
-
-The menu tag is used to generate a menu for the website. You can see such a menu on the left of this
-page.
-
-This page is available in <a href="menu.de.html">German</a>. Try and go to the german version of
-this page. You will see that the menu items for which translations exist change their names.
-
-There exist serveral different predefined styles of menus (vertical, horizontal, ...). Have a look
-at the <a href="{relocatable: ../menustyles}">Menu Styles</a> section to see which menu styles are
-available.

data/doc/src/documentation/plugins/tags/multilang.de.page

@@ -1,4 +0,0 @@
----
-title: Seite in verschiedenen Sprachen
----
-Das ist jetzt die deutsche Version der Seite.

data/doc/src/documentation/plugins/tags/multilang.fr.page

@@ -1,4 +0,0 @@
----
-title: Francais
----
-Ceci est la version française de cette page.

data/doc/src/documentation/plugins/tags/multilang.page

@@ -1,4 +0,0 @@
----
-title: Multi language page
----
-This is the english version of this page.

data/doc/src/documentation/plugins/tags/relocatable.page

@@ -1,16 +0,0 @@
----
-title: Relocatable
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: RelocatableTag}</notextile>
-
-h2. Description
-
-The relocatable tag is used to change the path of the supplied file and is most often used in
-template files. A relocatable tag looks like this: @\{relocatable: default.css}@. If this
-was put into a template and the template was used by a file in a subdirectory, then the
-@relocatable@ tag would put @../default.css@ into the output file.
-
-This ensures that the relative path to the referenced file is always correct.

data/doc/src/documentation/plugins/tags/resource.page

@@ -1,22 +0,0 @@
----
-title: Resource
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: ResourceTag}</notextile>
-
-h2. Description
-
-The resource tag is used to include a resource either verbatim (i.e. its content is copied) or by
-path. For more information about resources have a look at the
-<a href="{relocatable: ../coreplugins/resourcemanager.page}">Resource Manager</a>.
-
-h2. Examples
-
-table{border:1px solid black}.
-|_{width: 30%}.Command|_.Output|
-|\{resource: webgen-logo}|{resource: webgen-logo}|
-|\{resource: w3c-valid-xhtml11}|{resource: w3c-valid-xhtml11}|
-|\{resource: {name: webgen-css, insert: data}}|{resource: {name: webgen-css, insert: data}}|
-

data/doc/src/documentation/plugins/tags/sitemap.page

@@ -1,17 +0,0 @@
----
-title: Sitemap
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: SitemapTag}</notextile>
-
-h2. Description
-
-The SitemapTag is used to display the site map of the current web site.
-
-h2. Examples
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|\{sitemap:}|{sitemap:}|

data/doc/src/documentation/plugins/tags/wikilink.page

@@ -1,18 +0,0 @@
----
-title: WikiLink
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: WikiLinkTag}</notextile>
-
-h2. Description
-
-This tag can be used to add a link to a wiki page. It is used on this website to automatically
-provide a "Feedback" link for each page.
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|\{wikilink: }|{wikilink: }|
-|\{wikilink: {relURL: hallo}}|{wikilink: {relURL: hallo}}|
-|\{wikilink: {relURL: hallo, title: MoinMoin}}|{wikilink: {relURL: hallo, title: MoinMoin}}|

data/doc/src/documentation/webgen_gallery_editor.page

@@ -1,82 +0,0 @@
----
-title: Webgen Gallery Editor
-inMenu: true
-orderInfo: 20
----
-h2. About
-
-This application is based on Qt > 3.1 and therefore needs the
-"qtruby":http://rubyforge.org/projects/korundum/ package. It is basically an editor for editing
-webgen gallery description files. You can easily set all of the required parameters and assign a
-title and a description to each image.
-
-<b>Be aware that this application is only alpha quality! Do not report any bugs concerning this
-application!</b>
-
-h2. How To Use
-
-h3. Starting the editor
-
-You can start the editor by calling @webgen-gallery-editor@. This opens up the main window.
-
-<img src="{relocatable: /images/screenshots/wge-main.png}" alt="Main window when editing" title="Main Window when editing" />
-
-At the beginning all widgets are disabled; they get enabled as soon as you create a new gallery
-description file or open an existing one.
-
-h3. Creating a new gallery description file
-
-Select @File->New...@ which requires you to enter a name for the new gallery description file. All
-the fields are filled with the default values. After that you can start editing!
-
-h3. Editing gallery description files
-
-You can specify the basic gallery information like gallery title, file pattern, ... in the upper
-half of the main window. The meta information you specify for the main page gets included in the
-main page; likewise the meta information you specify for the gallery pages gets included in every
-gallery page.
-
-The lower half of the main window consists of four parts
-
-* *The list of images*:
-
-  This list gets automatically updated whenever you change the file pattern. So you have a live
-  preview of which images get included in the gallery. When you click on an image, it will be shown
-  in the image preview pane. Also, the image meta information table and the title and description
-  fields will be updated to show the current values for the selected image.
-
-* *The image preview pane*:
-
-  Here you will see the selected image. It will be scaled so that it fits into the available space,
-  but it will not be enlarged if the space available is bigger than the image.
-
-* *The image meta information*:
-
-  Here you can enter additional meta information for the selected image.
-
-* *Title and Description fields*:
-
-  As these two meta information fields are used most often, they got their own widgets.
-
-
-As entering the title and description for the images is the main use for the webgen gallery editor,
-there is an easy way to do this:
-
-# Select the first image.
-
-# Enter a title in the title field. When you are finished press @CTRL+ENTER@. This will set the
-  focus to the description field.
-
-# Enter the description and when you are finished, press @CTRL+ENTER@ again. The next image will be
-  selected and the focus wil be set to the title field so that you can continue describing the images.
-
-
-h3. Using the meta information widgets
-
-You need to specify the name of the meta information in the first column and the value in the second
-column of the widget. You can only use certain kinds of values:
-
-* Integer: just type a number
-* String: just type the string
-* Boolean: the special values @true@ and @false@ will be used as boolean values.
-* Nil: the special value @nil@ will be used as nil value

data/doc/src/meta.info

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

data/doc/src/screenshots.gallery

@@ -1,33 +0,0 @@
---- 
-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

@@ -1,19 +0,0 @@
-
-require 'rpa/install'
-
-class Install_webgen < RPA::Install::FullInstaller
-  name 'webgen'
-  version '0.3.8-1'
-  classification Application
-  build do
-    installdocs %w[COPYING ChangeLog TODO]
-    installdocs 'docs'
-    installrdoc %w[README] + Dir['lib/**/*.rb']
-    installdata
-  end
-  description <<-EOF
-Webgen is a templated based static website generator.
-
-Webgen is a web page generator implemented in Ruby. It is used to generate static web pages from templates and page description files.
-  EOF
-end

data/lib/webgen.rb

@@ -1,277 +0,0 @@
-#
-#--
-#
-# $Id: webgen.rb 369 2005-12-24 11:37:40Z 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 [options] 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
-
-      module_function :ask_before_delete
-
-    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