webgen 0.3.8 → 0.4.0

data/bin/webgen-gui

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# -*- ruby -*-
-
-require 'webgen/gui/main'
-
-$app = Qt::Application.new( ARGV )
-main = Webgen::GUI::MainWindow.new
-$app.setMainWidget( main )
-main.show
-$app.exec

data/data/webgen/website_templates/default/config.yaml

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

data/doc/plugin/clidesc.rb

@@ -1,46 +0,0 @@
-require 'cgi'
-
-module WebgenDocuPlugins
-
-  class CliDescTag < Tags::DefaultTag
-
-    summary "Describes the CLI interface"
-
-    tag 'clidesc'
-
-    def initialize
-      super
-      @processOutput = false
-    end
-
-    def process_tag( tag, node, refNode )
-      wcp = Webgen::WebgenCommandParser.new
-      output = ''
-      output << "<p><b>Global Options:</b></p>"
-      output << "<pre>#{CGI::escapeHTML(wcp.options.summarize.to_s)}</pre>"
-      output << "<p><b>Commands:</b></p>"
-      output << "<dl>"
-      output << show_command( wcp.main_command )
-      output << "</dl>"
-    end
-
-    def show_command( cmd )
-      output = ''
-      cmd.commands.sort.each do |name, command|
-        output << "<dt>#{name}</dt>"
-        output << "<dd>#{CGI::escapeHTML(command.short_desc)}<br />#{CGI::escapeHTML(command.description)+'<br />' if command.description}"
-        output << "#{CGI::escapeHTML(command.usage)}"
-        output << "<pre>#{CGI::escapeHTML(command.options.summarize.to_s)}</pre>"
-        if command.has_commands?
-          output << "<dl>"
-          output << show_command( command )
-          output << "</dl>"
-        end
-        output << "</dd>"
-      end
-      output
-    end
-
-  end
-
-end

data/doc/plugin/source.rb

@@ -1,21 +0,0 @@
-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/about.page

@@ -1,22 +0,0 @@
----
-title: About
-inMenu: true
-orderInfo: 2
----
-h2. About _webgen_
-
-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.
-
-When webgen is run it combines the template with each of the page description files and generates
-the HTML output files. During this process special tags are substituted so that, for example, a menu
-is generated. Actually, this page was generated with webgen and, for example, the menu that you can
-see was created dynamically. For more information look at the documentation!
-
-h2. Author
-
-* *Thomas Leitner*
-* Web: "http://webgen.rubyforge.org":http://webgen.rubyforge.org
-* e-Mail: "t_leitner@gmx.at":mailto:t_leitner@gmx.at
-* GPG Key-Id: 0xD942E7F6

data/doc/src/documentation/cli.page

@@ -1,12 +0,0 @@
----
-title: Command Line Interface
-inMenu: true
-orderInfo: 17
----
-h2. Command Line Interface
-
-The command line interface (CLI) has a command style syntax like Subversion's @svn@ or Rubygems'
-@gem@. Following are the available commands and their parameters. Have a look at the usage
-description to see how to use each command.
-
-<notextile>{clidesc: }</notextile>

data/doc/src/documentation/plugins/contenthandlers/html.page

@@ -1,11 +0,0 @@
----
-title: HTML
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: HTMLContentHandler}</notextile>
-
-h2. Description
-
-Handles content written in plain HTML.

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

@@ -1,7 +0,0 @@
----
-directoryName: Content Handlers
----
-h2. About
-
-Content handlers are used to handle different content formats. This allows one to write the page
-descriptions using the format he likes.

data/doc/src/documentation/plugins/contenthandlers/markdown.page

@@ -1,11 +0,0 @@
----
-title: Markdown
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: MarkdownContentHandler}</notextile>
-
-h2. Description
-
-Handles content written using Markdown markup ("Reference":http://daringfireball.net/projects/markdown/)

data/doc/src/documentation/plugins/contenthandlers/rdoc.page

@@ -1,11 +0,0 @@
----
-title: RDOC
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: RDocContentHandler}</notextile>
-
-h2. Description
-
-Handles content written in RDOC (default documentation system for Ruby source files).

data/doc/src/documentation/plugins/contenthandlers/textile.page

@@ -1,11 +0,0 @@
----
-title: Textile
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: TextileContentHandler}</notextile>
-
-h2. Description
-
-Handles content written using Textile markup ("Reference":http://hobix.com/textile/).

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

@@ -1,12 +0,0 @@
----
-title: Configuration
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: Configuration}</notextile>
-
-h2. Description
-
-The configuration plugin provides a place for all the parameters which have global influence, like
-the global language setting.

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

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

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

@@ -1,13 +0,0 @@
----
-title: Logging
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: Logging}</notextile>
-
-h2. Description
-
-The logging plugin provides a logging mechanism which can be used to analyse errors of the website.
-If the parameter @logToFile@ is true, then the log messags will not appear on the error console but
-they are written to log files which reside in the @log@ directory.

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

@@ -1,34 +0,0 @@
----
-title: Resource Manager
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: ResourceManager}</notextile>
-
-h2. Description
-
-The ResourceManager plugin is used to define and access various resources. A resource is identified
-via the resource name and is written to a certain output path (relative to the output directory).
-There are two different types of resources: file resources and memory resources.
-
-*   A *file* resources references a certain file which gets copied to its output path when webgen is
-    writing out all files. These files resources can refernce any kind of file (images, videos,
-    audio files, HTML files,...).
-
-*   A *memory* resource only exists during a run of webgen. Plugins can use such resources to provide
-    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
-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/filehandlers/backing.page

@@ -1,46 +0,0 @@
----
-title: Backing File Handler
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: BackingFileHandler}</notextile>
-
-h2. Description
-
-The backing file handler is used to set meta information for other files. It can be used to set
-additional meta information for page description files. However, its main purpose is to add virtual
-pages and directories.
-
-h2. File Format
-
-The files are written in YAML and have a very easy structure:
-<pre>
-filename1.en.page:
-  title: File one
-  orderInfo: 45
-  additional_metainfo: my_used_value
-
-filename1.de.page:
-  title: German version of File one
-
-docu/external.html:
-  dest: http://www.my-homepage.com
-  title: My external homepage
-  inMenu: true
-</pre>
-
-As you can see, you use the name of a file as top level key and then you specify every meta
-information you want. You can use relative and absolute paths in the filenames. However, you cannot
-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: 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
-does not exist, a node for that file will be created. This will also create the whole directory tree
-this virtual node is in. It allows you, for example, to add external items to the menu. In this case
-you need to specify the +dest+ meta information which points to the actual location of the
-referenced page.
-

data/doc/src/documentation/plugins/filehandlers/copy.page

@@ -1,12 +0,0 @@
----
-title: File Copy Handler
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: CopyFileHandler}</notextile>
-
-h2. Description
-
-The file copy handler copies files without modification from the source to the target directory.
-This is useful, for example, for CSS stylesheets and images.

data/doc/src/documentation/plugins/filehandlers/directoryhandler.page

@@ -1,35 +0,0 @@
----
-title: Directory Handler
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: DirectoryHandler}</notextile>
-
-h2. Description
-
-The directory handler is used for processing directories. It creates the target directories and
-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 images 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.
-
-If you do not want to use directory index files, you can set the parameter @indexFile@ to @nil@ in
-the configuration file, like this:
-
-<pre>
-DirectoryHandler:
-  indexFile: ~
-</pre>
-

data/doc/src/documentation/plugins/filehandlers/gallery.page

@@ -1,86 +0,0 @@
----
-title: Gallery File Handler
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: GalleryFileHandler}</notextile>
-
-h2. Description
-
-This file handler uses image gallery description files to automatically build image galleries.
-These image galleries are highly configurable and themeable through the use of page templates.
-
-h2. Gallery Description Files
-
-The gallery description files have YAML as file format and can either be written by hand or can be
-edited using the <a href="{relocatable: /documentation/webgen_gallery_editor.page}">webgen-gallery-editor</a>.
-
-A gallery description file specifies
-
-* which images should be used
-* the titles/descriptions of the images
-* the templates which should be used
-* meta information for the pages
-* the layout
-
-The two most important things on this list are which images should be used and the layout. The
-images have to be in the website source directory! You can/should not specify images outside the
-source directory as these images are not automatically copied to the destination directory and
-automatice thumbnail creation may not work correctly. And the layout defines how the main, gallery
-and image pages look like.
-
-Here is an example gallery description file:
-<pre>
-title: Example Gallery
-imagesPerPage: 32
-files: example/**/*.jpg
-
-mainPage:
-    inMenu: false
-    template: hello.template
-    metainfo: is defined here
-
-galleryPages:
-    metainfo: is defined here
-
-example/dir1/img1.jpg:
-    title: Test title
-    description: Long description of image
-
-example/img2.jpg
-    title: Title2 of pic
-</pre>
-
-So, we define the title of the gallery first and change the @picsPerPage@ setting. Every plugin
-parameter can be changed by using its name as key and assigning a new value to it. The key
-@mainPage@ can be used to set meta information for the main page. Likewise, the key @galleryPages@
-can be used to set meta information for the gallery pages and if the key is the name of an image,
-its value is used as meta information for the image.
-
-You can specify the order of the images by setting the @orderInfo@ meta information on the images.
-Normally, the images are sorted by their title or, if no title was entered, by their filename. By
-setting the @orderInfo@ meta information you can reorder them.
-
-h2. Types of Generated Pages
-
-There are three different page types:
-
-* *main page*: It should have a list of all galleries. It is not generated if there is only
-  one gallery; this gallery becomes the main page.
-
-* *gallery pages*: Each gallery page should have a list of all the images on it. The number of
-  images per gallery page can be defined via a parameter.
-
-* *image pages*: Each image page should display its image and, maybe, additional information.
-
-h2. Layouter plugins
-
-Each layouter plugin defines a different "style" of image gallery. Have a look at the available
-layouter plugins and choose one for your image gallery. If you think they do not look good enough,
-you can define your own layouter in the extension file. You only need to derive a new class from
-DefaultGalleryLayouter and define the layout methods.
-
-h2. Examples
-
-You can view an example gallery <a href="{relocatable: /Screenshots_1.page}">here</a>!

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

@@ -1,34 +0,0 @@
----
-directoryName: File Handlers
----
-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 specifies path patterns for the files he handles (you can see which paths are
-handled by a file handler in its information section). 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. If two path patterns would match the same path, the one with
-fewer asterisks and question marks is used because that one "seems" to be more specific.
-
-
-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|
-
-
-