RubyGems - webgen - Versions diffs - 0.3.0 → 0.3.1 - Mend

webgen 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (67) hide show

data/ChangeLog +280 -0
data/Rakefile +3 -1
data/TODO +29 -12
data/VERSION +1 -1
data/doc/extension.config +11 -6
data/doc/src/about.page +21 -0
data/doc/src/default.css +17 -0
data/doc/src/default.template +3 -5
data/doc/src/design.gallery +1 -1
data/doc/src/designs/curdesign.png +0 -0
data/doc/src/designs/nostyle.png +0 -0
data/doc/src/designs/old.png +0 -0
data/doc/src/documentation/contenthandler/html.page +11 -0
data/doc/src/documentation/contenthandler/index.page +7 -0
data/doc/src/documentation/contenthandler/markdown.page +11 -0
data/doc/src/documentation/contenthandler/rdoc.page +11 -0
data/doc/src/documentation/contenthandler/textile.page +11 -0
data/doc/src/documentation/extloader.page +1 -1
data/doc/src/documentation/filehandler/backing.page +1 -1
data/doc/src/documentation/filehandler/galleryhandler.page +79 -0
data/doc/src/documentation/filehandler/{page.page → pagehandler.page} +2 -7
data/doc/src/documentation/gallerylayouter/defaultlayouter.page +12 -0
data/doc/src/documentation/gallerylayouter/index.page +14 -0
data/doc/src/documentation/htmlvalidator/index.page +6 -0
data/doc/src/documentation/htmlvalidator/xmllint.page +14 -0
data/doc/src/documentation/index.page +33 -6
data/doc/src/documentation/tags/index.page +2 -2
data/doc/src/documentation/tags/{lang.de.page → langbar.de.page} +0 -0
data/doc/src/documentation/tags/{lang.page → langbar.page} +6 -6
data/doc/src/documentation/tags/menu.page +1 -1
data/doc/src/documentation/tags/sitemap.page +18 -0
data/doc/src/download.page +2 -0
data/doc/src/features.page +4 -4
data/doc/src/index.page +18 -20
data/doc/src/meta.info +5 -5
data/install.rb +1 -1
data/lib/webgen/configuration.rb +35 -12
data/lib/webgen/node.rb +9 -3
data/lib/webgen/plugins/contenthandler/defaultcontenthandler.rb +39 -0
data/lib/webgen/plugins/{filehandler/pagehandler → contenthandler}/html.rb +4 -7
data/lib/webgen/plugins/{filehandler/pagehandler → contenthandler}/markdown.rb +4 -7
data/lib/webgen/plugins/{filehandler/pagehandler → contenthandler}/rdoc.rb +5 -5
data/lib/webgen/plugins/{filehandler/pagehandler → contenthandler}/textile.rb +4 -7
data/lib/webgen/plugins/filehandler/backing.rb +4 -4
data/lib/webgen/plugins/filehandler/directory.rb +25 -3
data/lib/webgen/plugins/filehandler/filecopy.rb +4 -2
data/lib/webgen/plugins/filehandler/filehandler.rb +5 -8
data/lib/webgen/plugins/filehandler/{pagehandler/page.rb → page.rb} +48 -32
data/lib/webgen/plugins/filehandler/picturegallery.rb +70 -51
data/lib/webgen/plugins/gallerylayouter/defaultgallerylayouter.rb +152 -0
data/lib/webgen/plugins/htmlvalidator/defaulthtmlvalidator.rb +37 -0
data/lib/webgen/plugins/htmlvalidator/xmllint.rb +70 -0
data/lib/webgen/plugins/tags/{lang.rb → langbar.rb} +3 -3
data/lib/webgen/plugins/tags/menu.rb +9 -13
data/lib/webgen/plugins/tags/relocatable.rb +2 -2
data/lib/webgen/plugins/tags/sitemap.rb +73 -0
data/lib/webgen/plugins/tags/tags.rb +9 -9
data/lib/webgen/plugins/treewalker.rb +2 -2
data/testsite/src/{images/bghack.png → bghack.png} +0 -0
metadata +33 -20
data/doc/src/designs/default.png +0 -0
data/doc/src/documentation/filehandler/picturegallery.page +0 -25
data/testsite/src/images/o.png +0 -0
data/testsite/src/images/smagacor.png +0 -0
data/testsite/src/images/tictactoe.png +0 -0
data/testsite/src/images/x.png +0 -0
data/testsite/src/test.gallery +0 -5

data/doc/src/default.template CHANGED

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!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="en">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
   <head>
     <title>{title: }</title>
     <link href="{relocatable: default.css}" rel="stylesheet" />
@@ -21,17 +21,15 @@
       <div id="headerbar" class="bar">
         <span class="left">Navbar: {navbar: }</span>
-        <span class="right">Language: {lang: }</span>
+        <span class="right">Language: {langbar: }</span>
         <span class="right">Feedback: {wikilink: {rootURL: http://webgen.rubyforge.org/wiki/wiki.pl?, title: Click here}}</span>
         <div style="clear:both"></div>
       </div>
       <div id="menu">
-        {menu: }
+        {menu: {subtreeLevel: 4}}
       </div>
-      <div id="feedback"></div>
       <div id="body">
         {content: }
       </div>

data/doc/src/design.gallery CHANGED

@@ -4,7 +4,7 @@ files: designs/*.png
 mainPage:
     menuOrder: 8
-designs/default.png:
+designs/curdesign.png:
     title: Default Design
     description: This is the default and the current design for the webgen homepage.

data/doc/src/designs/curdesign.png ADDED

Binary file

data/doc/src/designs/nostyle.png CHANGED

Binary file

data/doc/src/designs/old.png CHANGED

Binary file

data/doc/src/documentation/contenthandler/html.page ADDED

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

data/doc/src/documentation/contenthandler/index.page ADDED

@@ -0,0 +1,7 @@
+---
+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/contenthandler/markdown.page ADDED

@@ -0,0 +1,11 @@
+---
+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/contenthandler/rdoc.page ADDED

@@ -0,0 +1,11 @@
+---
+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/contenthandler/textile.page ADDED

@@ -0,0 +1,11 @@
+---
+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/extloader.page CHANGED

@@ -16,5 +16,5 @@ then they are only available for the current website.
 h2. The Configuration File
 The configuration file for the extension loader has to be a file with valid Ruby code. Have a look
-at the <a href="{relocatable: /api.html}">API</a> documentation to see which special methods you can
+at the <a href="{relocatable: /api.page}">API</a> documentation to see which special methods you can
 use in the configuration file.

data/doc/src/documentation/filehandler/backing.page CHANGED

@@ -12,5 +12,5 @@ The backing file handler is used to set meta information for other files. It can
 additional meta information for page description files. However, its main purpose is to add virtual
 pages and directories.
-For more information have a look at the <a href="{relocatable: /api.html}">API
+For more information have a look at the <a href="{relocatable: /api.page}">API
 documentation</a>.

data/doc/src/documentation/filehandler/galleryhandler.page ADDED

@@ -0,0 +1,79 @@
+---
+title: Picture Gallery File Handler
+inMenu: true
+---
+h2. Information
+<notextile>{describe: PictureGalleryFileHandler}</notextile>
+h2. Description
+This file handler uses picture gallery description files to automatically build picture galleries.
+These picture galleries are highly configurable and themeable through the use of page templates.
+h2. Gallery Description Files
+The gallery description files are written in YAML and specify
+* 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 picture pages look like.
+Here is an example gallery description file:
+<pre>
+title: Example Gallery
+picsPerPage: 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 a picture,
+its meta information is set to the specified values.
+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.
+* *picture pages*: Each picture page should display its picture and, maybe, additional information.
+h2. Layouter plugins
+Each layouter plugin defines a different "style" of picture gallery. Have a look at the available
+layouter plugins and choose one for your picture 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: /Design_Gallery_1.page}">here</a>!

data/doc/src/documentation/filehandler/{page.page → pagehandler.page} RENAMED

@@ -73,13 +73,8 @@ named @sidebar@ and formatted using @markdown@.
 h2. Content format
-The content of page description can be written in different formats. The following formats are
-currently available:
-* textile: Content written using Textile markup ("Reference":http://hobix.com/textile/)
-* markdown: Content written using Markdown markup ("Reference":http://www.deveiate.org)
-* rdoc: Content written using RDOC markup (default documentation system for Ruby source files)
-* html: Content in plain HTML
+The content of page description can be written in different formats. Have a look at the sub menu
+entries to get an overview of the existing formats.
 h2. Default settings

data/doc/src/documentation/gallerylayouter/defaultlayouter.page ADDED

@@ -0,0 +1,12 @@
+---
+title: Default Gallery Layouter
+inMenu: true
+---
+h2. Information
+<notextile>{describe: DefaultGalleryLayouter}</notextile>
+h2. Description
+This plugin serves as base class for all picture gallery layouters and provides a default
+implementation.

data/doc/src/documentation/gallerylayouter/index.page ADDED

@@ -0,0 +1,14 @@
+---
+directoryName: Gallery Layouters
+---
+h2. About
+Gallery layouters are used to define layouts for galleries. Each plugin defines how the main page,
+the gallery pages and the picture pages look like. To do this, each plugin has to define three methods:
+* <tt>main( data )</tt>
+* <tt>gallery( data, gIndex )</tt>
+* <tt>picture( data, gIndex, iIndex )</tt>
+The @data@ parameter is a @Hash@ with all the information available about the gallery. The @gIndex@
+and the @iIndex@ parameters are indices for the current gallery and the current image.

data/doc/src/documentation/htmlvalidator/index.page ADDED

@@ -0,0 +1,6 @@
+---
+directoryName: HTML Validators
+---
+h2. About
+HTML Validators are used to validate HTML files.

data/doc/src/documentation/htmlvalidator/xmllint.page ADDED

@@ -0,0 +1,14 @@
+---
+title: xmllint HTML Validator
+inMenu: true
+---
+h2. Information
+<notextile>{describe: XmllintHTMLValidator}</notextile>
+h2. Description
+This plugin uses the @xmllint@ program from the "libxml2":http://www.xmlsoft.org package. @xmllint@
+can be used to validate an XML file against a DTD, a RelaxNG schema or a WXS schema. For more
+information about where to put the DTD or schema files, have a look at the @libxml2@ documentation
+that comes bundled.

data/doc/src/documentation/index.page CHANGED

@@ -5,6 +5,37 @@ h2. Information
 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!
+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>
+  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
+  user can see what happened and a useful default alternative is used instead. For example, if no
+  default template was found in the source directory, a dummy template is used instead.
+  Therefore it is also not necessary to install the dependencies (although you would be wise to do
+  it, so that you can use all the features of webgen). If a dependency is not found (e.g. RedCloth
+  for Textile support), the specific feature is turned off and a warning gets issued.
+* <b>Useful default values for everything!</b>
+  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>
+  The logging mechanism is not only used to log error and warning messages, but also to log
+  informational and debug messages. For the normal user, the error and warning messages are
+  important. Developers who extend webgen by writing a new plugin can use the informational and
+  debug messages to see what is going on and to help them develop the plugin.
 h2. Usage
 Webgen uses two directories: one to read the source files from and an other to write the output
@@ -17,11 +48,6 @@ type @webgen@. If everything is okay, no output will appear and you can point yo
 output directory and view your website. If not, webgen tries to give detailed information about what
 happened and why something could not be done correctly.
-Webgen tries to compensate for errors and warnings and _should_ not abort with an error. Instead, it
-uses default values in error or warning cases and only issues messages to the log device (normally
-the screen). This also means that if a library is not found (e.g. RedCloth for Textile support),
-the plugin which uses the library is disabled.
 h2. Configuration
 Webgen provides a default configuration out of the box. If you can live with that, you do not need
@@ -44,4 +70,5 @@ looks like this:
 h2. Plugins
 Webgen is written with extensibility in mind; therefore most of its features are implemented with
-plugins, only the core functions are not plugins.
+plugins, only the core functions are not plugins. Use the menu to view the documentation for
+individual plugins.

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

@@ -19,9 +19,9 @@ Tags are defined by a special markup code. A tag has the following structure:
 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.html}">
+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.html}">
+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.
 h2. Tag Parameters

data/doc/src/documentation/tags/{lang.de.page → langbar.de.page} RENAMED

File without changes

data/doc/src/documentation/tags/{lang.page → langbar.page} RENAMED

@@ -1,10 +1,10 @@
 ---
-title: Language
+title: Language Bar
 inMenu: true
 ---
 h2. Information
-<notextile>{describe: LanguageTag}</notextile>
+<notextile>{describe: LanguageBarTag}</notextile>
 h2. Description
@@ -15,13 +15,13 @@ item.
 h2. Examples
-Here is a <a href="{relocatable: multilang.html}">link</a> to a page which is translated to several
+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>\{lang: }</notextile>|<notextile>{lang: }</notextile>|
-|\{lang: {separator: Hallo}}|{lang: {separator: Hallo}}|
-|\{lang: {showSingleLang: false}}|{lang: {showSingleLang: false}}|
+|<notextile>\{langbar: }</notextile>|<notextile>{langbar: }</notextile>|
+|\{langbar: {separator: Hallo}}|{langbar: {separator: Hallo}}|
+|\{langbar: {showSingleLang: false}}|{langbar: {showSingleLang: false}}|

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

@@ -12,7 +12,7 @@ The menu tag is used to generate a menu for the website. You can see such a menu
 page. To get a list of all supported parameters for the menu tag, have a look at its API
 documentation.
-This page is available in <a href="{relocatable: menu.html/menu.de.html}">German</a>. Try and go to
+This page is available in <a href="{relocatable: menu.page/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.

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

@@ -0,0 +1,18 @@
+---
+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. It contains all the pages of
+the web site and their hierarchy.
+h2. Examples
+table{border:1px solid black}.
+|_.Command|_.Output|
+|\{sitemap:}|{sitemap:}|

data/doc/src/download.page CHANGED

@@ -14,6 +14,8 @@ h2. Dependencies
 * "RedCloth":http://redcloth.rubyforge.org version 2.0.10 or higher if you want Textile support
 * "BlueCloth":http://www.deveiate.org version 1.0.0 or higher if you want Markdown support
+* "RMagick":http://rmagick.rubyforge.org/ version 1.7.1 or higher if you want automatic thumbnail
+  creation for picture galleries
 h2. Installation

data/doc/src/features.page CHANGED

@@ -6,9 +6,9 @@ h2. Feature list
 * Easily extendable through plugins
 * Uses templates for separating layout from content
-* Supports several different page description languages (YAML, XML, plain HTML), new ones are easy to add
-* Uses 'tags' to add generated content to the web pages
+* Supports several different content formats (Textile, Markdown, RDOC, plain HTML), new ones are easy to add
+* Uses 'tags' to add generated, ie. dynamic, content to the web pages
 * Standard distribution provides often used tags
 * Supports 'virtual files' via meta information backing files
-* Easy to configure if one needs to
-* Relatively fast: process ~1000 files in ~25 seconds on an {execute: uname -p}
+* Easy to configure if one needs to (no need if you are happy with the default values)
+* Relatively fast: processes ~1000 files in ~25 seconds on an {execute: uname -p}

data/doc/src/index.page CHANGED

@@ -12,37 +12,35 @@ Choose from the menu what you want to see from or know about webgen!
 h2. News
-*Webgen 0.3.0 was released!!!*
+*Webgen 0.3.1 released!!!*
+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/filehandler/pagehandler.page}">PageHandler</a>)
+* On-the-fly creation of thumbnails for pictures with RMagick
+* New tags: <a href="{relocatable: documentation/tags/sitemap.page}">sitemap</a>
+* Tag @lang@ renamed, new name @langbar@!
+* New parameters for @menu@ tag
+* Automatic checking of HTML files on their validness
+* Fixed bugs
+h2. News
+*Webgen 0.3.0 released!!!*
 Major changes:
 * Textile, Markdown, RDOC and HTML as content format supported!!!
-* New tags: <a href="{relocatable: documentation/tags/wikilink.html}">wikilink</a>
+* New tags: <a href="{relocatable: documentation/tags/wikilink.page}">wikilink</a>
 * Improved plugin system
 * On-the-fly creation of new tags
 * Fixed bugs
 * Improved online documentation: pages on file handlers and tags now show parameters and other
   additional info
-* Added comprehensive test suite --> TODO
+* Added comprehensive test suite
 * and more...
-h2. Description
-Webgen can be 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.
-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
 h2. And so ...
 ... have fun!