webgen 0.3.8 → 0.4.0

data/doc/src/download.page

@@ -2,7 +2,8 @@
 title: Download & Installation
 inMenu: true
 ---
-h2. Download
+h2(#download). Download
+
 
 The newest version of webgen can be downloaded from Rubyforge.
 
@@ -10,36 +11,64 @@ Homepage: "webgen.rubyforge.org":http://webgen.rubyforge.org
 
 Download: "http://rubyforge.org/frs/?group_id=296":http://rubyforge.org/frs/?group_id=296
 
-h2. Dependencies
+
+h2(#deps). Dependencies
+
 
 * "cmdparse":http://cmdparse.rubyforge.org version 2.0.0 or higher
-* "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 image galleries
 
-h2. Installation
+* [optional] "RedCloth":http://redcloth.rubyforge.org version 2.0.10 or higher if you want Textile
+  support
+
+* [optional] "BlueCloth":http://www.deveiate.org version 1.0.0 or higher if you want Markdown
+  support
+
+* [optional] "RMagick":http://rmagick.rubyforge.org/ version 1.7.1 or higher if you want automatic
+  thumbnail creation for image galleries
+
+* [optional] "builder":http://builder.rubyforge.org/ version 2.0.0 or higher if you want programatic
+  HTML/XML file generation
+
+* [optional] "exifr":http://exifr.rubyforge.org/ version 0.9.4 or higher if you want to be able to
+  have EXIF information available for image galleries
+
+* [optional] "coderay":http://coderay.rubychan.de/ version 0.7.4.215 or higher if you want syntax
+  highlighting to be available for certain plugins
+
+
+All the optional libraries can be installed via Rubygems (which I recommend). You can check the
+availability of the libraries by executing
+
+  $ webgen check libs
+
+The output tells you whether webgen has been able to load the optional libraries or not!
 
-There are many ways to install webgen. Choose the one you like best:
 
-* Via RPA
- <pre>
-  $ rpa install webgen
- </pre>
+h2(#installation). Installation
+
+
+The easiest way to install webgen is via Rubygems
 
-* Via RubyGems
- <pre>
   $ gem install webgen
- </pre>
 
-* The do-it-yourself way
- <pre>
+However, you can also use the included @setup.rb@ installation method:
+
   $ ruby setup.rb config
   $ ruby setup.rb setup
   $ ruby setup.rb install
- </pre>
 
-* The simplified do-it-yourself way
- <pre>
+Or all commands together via
+
   $ rake install
- </pre>
+
+
+The above listed methods also work when installing on Windows (preferred way is via Rubygems).
+
+
+
+
+--- sidebar, textile
+
+<h1>Information</h1>
+
+webgen has been tested on Linux and on Windows XP with Ruby 1.8.4.

data/doc/src/examples/gallery_styles/default/default.gallery

@@ -0,0 +1,78 @@
+title: index
+images: ../../images/*
+imagesPerPage: 8
+mainPageMetaInfo:
+  inMenu: true
+
+---
+../../images/image01.jpg:
+  title: Chinese Garden
+  description: This picture show the Chinese Garden located in the outskirts of Vienna (Austria).
+
+../../images/image02.jpg:
+  title: Goldenes Dach
+  description: This is the landmark of Innsbruck (Tyrol, Austria), called the 'Goldene Dach' (golden roof).
+
+../../images/image03.jpg:
+  title: Mountains in Innsbruck
+  description: A view from the <a href='http://www.nordpark.com'>NordPark</a> in Innsbruck.
+
+../../images/image04.jpg:
+  title: Kristallwelten 1
+  description: The entry to the 'Kristallwelten' of <a href='http://www.swarovski.com'>Swarovski</a> in Innsbruck.
+
+../../images/image05.jpg:
+  title: Kristallwelten 2
+  description: On the roof of the building.
+
+../../images/image06.jpg:
+  title: Kristallwelten 3
+  description: Some crystals.
+
+../../images/image07.jpg:
+  title: Minimundus 1
+  description: A french castle
+
+../../images/image08.jpg:
+  title: Minimundus 2
+  description: A small copy of the <a href=''>Sagrada Familia</a> of Barcelona.
+
+../../images/image09.jpg:
+  title: Minimundus 3
+  description: The Stephansdom in Vienna.
+
+../../images/image10.jpg:
+  title: Minimundus 4
+  description: Overview of Minimundus, a place with smaller versions of famous buildings.
+
+../../images/image11.jpg:
+  title: Velden
+  description: Photo from Velden, Wörtersee, Carinthia, Austria
+
+../../images/image12.jpg:
+  title: Stockholm 1
+  description: A 300-year-old ship, the Wasa, located in the Wasamuseet in Stockholm.
+
+../../images/image13.jpg:
+  title: Stockholm 2
+  description: A fort near Stockholm.
+
+../../images/image14.jpg:
+  title: Stockholm 3
+  description: Overview of Gamla Stan (old town centre of Stockholm)
+
+../../images/image15.jpg:
+  title: Stockholm 4
+  description: View from a bridge in the direction of Gamla Stan
+
+../../images/image16.jpg:
+  title: Zakynthos 1
+  description: An isle that looks like a turtle
+
+../../images/image17.jpg:
+  title: Zakynthos 2
+  description: The oldest olive tree of Zakynthos.
+
+../../images/image18.jpg:
+  title: Zakynthos 3
+  description: The Navagio ship wreck, very famous Greek tourist destination.

data/doc/src/examples/gallery_styles/default/gallery_gallery.template

@@ -0,0 +1,38 @@
+--- content, html
+<div class="webgen-gallery webgen-gallery-gallery">
+<% ginfo = node.node_info[:ginfo] %>
+<table width="100%">
+<tr>
+  <td style="width: 33%" align="left">
+    <% if ginfo.prev_gallery %>
+    <a href="{relocatable: <%= ginfo.prev_gallery.pagename %>}">&lt;&lt;&nbsp;<%= ginfo.prev_gallery.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %></a>
+    <% end %>
+  </td>
+  <td style="width: 34%" align="center">
+    <% if ginfo.mainpage %>
+    <a href="{relocatable: <%= ginfo.mainpage.pagename %>}">^^&nbsp;<%= ginfo.mainpage.title %>&nbsp;^^</a>
+    <% end %>
+  </td>
+  <td style="width: 33%" align="right">
+    <% if ginfo.next_gallery %>
+    <a href="{relocatable: <%= ginfo.next_gallery.pagename %>}"><%= ginfo.next_gallery.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %>&nbsp;&gt;&gt;</a>
+    <% end %>
+  </td>
+</tr>
+</table>
+
+<table width="100%" border="1">
+<% 0.step( ginfo.cur_gallery.images.length - 1, 5 ) do |row_index| %>
+  <tr>
+  <% row_index.upto( [row_index + 4, ginfo.cur_gallery.images.length - 1].min ) do |col_index|%>
+    <td align="center">
+      <a href="{relocatable: <%= ginfo.cur_gallery.images[col_index].pagename %>}">
+        <%= ginfo.cur_gallery.images[col_index].thumbnail('class'=>'webgen-gallery-thumbnail') %><br />
+        <%= ginfo.cur_gallery.images[col_index].title %>
+      </a>
+    </td>
+  <% end %>
+  </tr>
+<% end %>
+</table>
+</div>

data/doc/src/examples/gallery_styles/default/gallery_image.template

@@ -0,0 +1,30 @@
+--- content, html
+<div class="webgen-gallery webgen-gallery-image">
+<% ginfo = node.node_info[:ginfo] %>
+<table width="100%">
+<tr>
+  <td style="width: 33%" align="left">
+    <% if ginfo.prev_image %>
+    <a href="{relocatable: <%= ginfo.prev_image.pagename %>}">&lt;&lt;&nbsp;<%= ginfo.prev_image.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %></a>
+    <% end %>
+  </td>
+  <td style="width: 34%" align="center">
+    <a href="{relocatable: <%= ginfo.cur_gallery.pagename %>}">
+    <%= ginfo.cur_gallery.thumbnail('class'=>'webgen-gallery-thumbnail') %><br />^<%= ginfo.cur_gallery.title %>^
+    </a>
+  </td>
+  <td style="width: 33%" align="right">
+    <% if ginfo.next_image %>
+    <a href="{relocatable: <%= ginfo.next_image.pagename %>}"><%= ginfo.next_image.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %>&nbsp;&gt;&gt;</a>
+    <% end %>
+  </td>
+</tr>
+</table>
+
+<p style="text-align: center">
+<img src="{relocatable: <%= ginfo.cur_image.filename %>}" alt="<%= ginfo.cur_image.title %>" /> <br />
+</p>
+
+<p><%= ginfo.cur_image['description'] %></p>
+
+</div>

data/doc/src/examples/gallery_styles/default/gallery_main.template

@@ -0,0 +1,18 @@
+--- content, html
+<div class="webgen-gallery webgen-gallery-main">
+<% ginfo = node.node_info[:ginfo] %>
+<table width="100%">
+<% 0.step( ginfo.galleries.length - 1, 5 ) do |row_index| %>
+  <tr>
+  <% row_index.upto( [row_index + 4, ginfo.galleries.length - 1].min ) do |col_index| %>
+    <td align="center">
+      <a href="{relocatable: <%= ginfo.galleries[col_index].pagename %>}">
+        <%= ginfo.galleries[col_index].thumbnail('class'=>'webgen-gallery-thumbnail') %><br />
+        <%= ginfo.galleries[col_index].title %>
+      </a>
+    </td>
+  <% end %>
+  </tr>
+<% end %>
+</table>
+</div>

data/doc/src/examples/gallery_styles/index.page

@@ -0,0 +1,22 @@
+---
+title: Index
+directoryName: Gallery Styles
+---
+h2. List of gallery styles
+
+The gallery style example pages open in an iframe when you use the menu items. Use the links
+provided below to open the gallery style example pages directly (fullscreen).
+
+Following is the list of all available gallery styles:
+
+
+* <a href='default/index.html'>default</a>
+
+  * *Author*: Thomas Leitner
+  * *Description*: Provides a simple and useful gallery style with thumbnail previews that link to the next and previous picture or gallery page.
+* <a href='slides/index.html'>slides</a>
+
+  * *Author*: Thomas Leitner (created gallery style) Corban Brook (original collage creation routines)
+  * *Description*: A style which uses RMagick to generate a slide background for the thumbnails and a collage for the main page, prettier than the default style ;-) This style was done after reading an article by Corban Brook on rendering collages with Ruby and RMagick.
+  * *Plugin files*: collage.rb
+  * *Usage*: This style uses a layouter plugin for creating the collage and slide backgrounds. Therefore you have to explicitly specify in the gallery file that you want to use the layouter slides. The plugin also only generates images if they do not exist. So, if there is already a collage image, a new one will not be created.

data/doc/src/examples/gallery_styles/slides/gallery_gallery.template

@@ -0,0 +1,62 @@
+--- content, html
+<%
+ginfo = node.node_info[:ginfo]
+if ginfo[:collage_node].nil?
+  log(:error) { "Use of templates from gallery style 'slides' only possible if option layouter is set to 'slides' in gallery file!" }
+else
+%>
+
+
+<div class="webgen-gallery webgen-gallery-gallery" style="background-color: <%= ginfo[:collage_node].collage_color %>">
+<table width="100%" style="padding: 5px; margin-bottom: 10px;">
+<tr>
+  <td style="width: 33%; padding: 2px;" align="left">
+    <% if ginfo.prev_gallery %>
+    <a href="{relocatable: <%= ginfo.prev_gallery.pagename %>}">
+      &lt;&lt; previous gallery
+      <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+        <%= ginfo.prev_gallery.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %>
+      </span>
+    </a>
+    <% end %>
+  </td>
+  <td style="width: 34%;" valign="top" align="center">
+    <% if ginfo.mainpage %>
+    <a href="{relocatable: <%= ginfo.mainpage.pagename %>}"><img src="<%= ginfo[:collage_thumb_node].path %>" alt="back to main" /></a>
+    <% end %>
+  </td>
+  <td style="width: 33%; padding: 2px;" align="right">
+    <% if ginfo.next_gallery %>
+    <a href="{relocatable: <%= ginfo.next_gallery.pagename %>}">
+      next gallery &gt;&gt;
+      <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+        <%= ginfo.next_gallery.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %>
+      </span>
+    </a>
+    <% end %>
+  </td>
+</tr>
+</table>
+
+<table width="100%">
+<% 0.step( ginfo.cur_gallery.images.length - 1, 5 ) do |row_index| %>
+  <tr>
+  <% row_index.upto( [row_index + 4, ginfo.cur_gallery.images.length - 1].min ) do |col_index|%>
+    <td align="center">
+      <a href="{relocatable: <%= ginfo.cur_gallery.images[col_index].pagename %>}">
+        <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+          <%= ginfo.cur_gallery.images[col_index].thumbnail('class'=>'webgen-gallery-thumbnail') %>
+       </span>
+       <br />
+       <%= ginfo.cur_gallery.images[col_index].title %>
+      </a>
+    </td>
+  <% end %>
+  </tr>
+<% end %>
+</table>
+
+</div>
+
+
+<% end %>

data/doc/src/examples/gallery_styles/slides/gallery_image.template

@@ -0,0 +1,53 @@
+--- content, html
+<%
+ginfo = node.node_info[:ginfo]
+if ginfo[:collage_node].nil?
+  log(:error) { "Use of templates from gallery style 'slides' only possible if option layouter is set to 'slides' in gallery file!" }
+else
+%>
+
+
+<div class="webgen-gallery webgen-gallery-image" style="background-color: <%= ginfo[:collage_node].collage_color %>">
+<table width="100%" style="padding: 5px; margin-bottom: 10px;">
+<tr>
+  <td style="width: 33%; padding: 2px;" align="left">
+    <% if ginfo.prev_image %>
+    <a href="{relocatable: <%= ginfo.prev_image.pagename %>}">
+      &lt;&lt; previous image
+      <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+        <%= ginfo.prev_image.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %>
+      </span>
+    </a>
+    <% end %>
+  </td>
+  <td style="width: 34%; padding: 2px;" valign="top" align="center">
+    <a href="{relocatable: <%= ginfo.cur_gallery.pagename %>}">
+      <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+        <%= ginfo.cur_gallery.thumbnail('class'=>'webgen-gallery-thumbnail') %>
+      </span>
+      ^<%= ginfo.cur_gallery.title %>^
+    </a>
+  </td>
+  <td style="width: 33%; padding: 2px;" align="right">
+    <% if ginfo.next_image %>
+    <a href="{relocatable: <%= ginfo.next_image.pagename %>}">
+      next image &gt;&gt;
+      <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+        <%= ginfo.next_image.thumbnail('style'=>'vertical-align: middle', 'class'=>'webgen-gallery-thumbnail') %>
+      </span>
+    </a>
+    <% end %>
+  </td>
+</tr>
+</table>
+
+<p style="text-align: center">
+<img src="{relocatable: <%= ginfo.cur_image.filename %>}" alt="<%= ginfo.cur_image.title %>" /> <br />
+</p>
+
+<p><%= ginfo.cur_image['description'] %></p>
+
+</div>
+
+
+<% end %>

data/doc/src/examples/gallery_styles/slides/gallery_main.template

@@ -0,0 +1,32 @@
+--- content, html
+<%
+ginfo = node.node_info[:ginfo]
+if ginfo[:collage_node].nil?
+  log(:error) { "Use of templates from gallery style 'slides' only possible if option layouter is set to 'slides' in gallery file!" }
+else
+%>
+
+
+<div class="webgen-gallery webgen-gallery-main" style="background-color: <%= ginfo[:collage_node].collage_color %>">
+<p style="text-align: center"><img src="<%= ginfo[:collage_node].path %>" alt="collage" /></p>
+<table width="100%">
+<% 0.step( ginfo.galleries.length - 1, 5 ) do |row_index| %>
+  <tr>
+  <% row_index.upto( [row_index + 4, ginfo.galleries.length - 1].min ) do |col_index| %>
+    <td align="center">
+      <a href="{relocatable: <%= ginfo.galleries[col_index].pagename %>}">
+        <span class="thumb thumb-<%= ginfo['title'].tr(' ', '_') %>">
+          <%= ginfo.galleries[col_index].thumbnail('class'=>'webgen-gallery-thumbnail') %>
+        </span>
+        <br />
+        <%= ginfo.galleries[col_index].title %>
+      </a>
+    </td>
+  <% end %>
+  </tr>
+<% end %>
+</table>
+</div>
+
+
+<% end %>

data/doc/src/examples/gallery_styles/slides/slides.gallery

@@ -0,0 +1,79 @@
+title: index
+images: ../../images/*
+imagesPerPage: 8
+mainPageMetaInfo:
+  inMenu: true
+layouter: slides
+thumbnailResizeMethod: :cropped
+---
+../../images/image01.jpg:
+  title: Chinese Garden
+  description: This picture show the Chinese Garden located in the outskirts of Vienna (Austria).
+
+../../images/image02.jpg:
+  title: Goldenes Dach
+  description: This is the landmark of Innsbruck (Tyrol, Austria), called the 'Goldene Dach' (golden roof).
+
+../../images/image03.jpg:
+  title: Mountains in Innsbruck
+  description: A view from the <a href='http://www.nordpark.com'>NordPark</a> in Innsbruck.
+
+../../images/image04.jpg:
+  title: Kristallwelten 1
+  description: The entry to the 'Kristallwelten' of <a href='http://www.swarovski.com'>Swarovski</a> in Innsbruck.
+
+../../images/image05.jpg:
+  title: Kristallwelten 2
+  description: On the roof of the building.
+
+../../images/image06.jpg:
+  title: Kristallwelten 3
+  description: Some crystals.
+
+../../images/image07.jpg:
+  title: Minimundus 1
+  description: A french castle
+
+../../images/image08.jpg:
+  title: Minimundus 2
+  description: A small copy of the <a href=''>Sagrada Familia</a> of Barcelona.
+
+../../images/image09.jpg:
+  title: Minimundus 3
+  description: The Stephansdom in Vienna.
+
+../../images/image10.jpg:
+  title: Minimundus 4
+  description: Overview of Minimundus, a place with smaller versions of famous buildings.
+
+../../images/image11.jpg:
+  title: Velden
+  description: Photo from Velden, Wörtersee, Carinthia, Austria
+
+../../images/image12.jpg:
+  title: Stockholm 1
+  description: A 300-year-old ship, the Wasa, located in the Wasamuseet in Stockholm.
+
+../../images/image13.jpg:
+  title: Stockholm 2
+  description: A fort near Stockholm.
+
+../../images/image14.jpg:
+  title: Stockholm 3
+  description: Overview of Gamla Stan (old town centre of Stockholm)
+
+../../images/image15.jpg:
+  title: Stockholm 4
+  description: View from a bridge in the direction of Gamla Stan
+
+../../images/image16.jpg:
+  title: Zakynthos 1
+  description: An isle that looks like a turtle
+
+../../images/image17.jpg:
+  title: Zakynthos 2
+  description: The oldest olive tree of Zakynthos.
+
+../../images/image18.jpg:
+  title: Zakynthos 3
+  description: The Navagio ship wreck, very famous Greek tourist destination.