webby 0.9.0 → 0.9.1

data/History.txt

@@ -1,3 +1,14 @@
+== 0.9.1 / 2008-09-10
+
+* 1 major enhancement
+  - multiple output files can be generated from a single page
+* 2 minor enhancements
+  - simplified the handling of meta-data at the top of files
+  - pagination now honors the "page per directory" flag
+* 2 bug fixes
+  - filename extensions were not being preserved when creating a new page
+  - webby now works properly with rake 0.8.2
+
 == 0.9.0 / 2008-08-25
 
 * 2 major enhancements

data/Manifest.txt

@@ -60,7 +60,9 @@ examples/webby/content/css/uv/twilight.css
 examples/webby/content/index.txt
 examples/webby/content/learn/index.txt
 examples/webby/content/reference/index.txt
+examples/webby/content/release-notes/index.txt
 examples/webby/content/release-notes/rel-0-9-0/index.txt
+examples/webby/content/release-notes/rel-0-9-1/index.txt
 examples/webby/content/robots.txt
 examples/webby/content/script/jquery.corner.js
 examples/webby/content/script/jquery.js
@@ -134,8 +136,8 @@ lib/webby/link_validator.rb
 lib/webby/renderer.rb
 lib/webby/resources.rb
 lib/webby/resources/db.rb
-lib/webby/resources/file.rb
 lib/webby/resources/layout.rb
+lib/webby/resources/meta_file.rb
 lib/webby/resources/page.rb
 lib/webby/resources/partial.rb
 lib/webby/resources/resource.rb
@@ -152,12 +154,53 @@ lib/webby/tasks/validate.rake
 spec/core_ext/hash_spec.rb
 spec/core_ext/string_spec.rb
 spec/core_ext/time_spec.rb
+spec/data/Sitefile
+spec/data/content/_partial.txt
+spec/data/content/css/coderay.css
+spec/data/content/css/site.css
+spec/data/content/css/tumblog.css
+spec/data/content/images/tumblog/permalink.gif
+spec/data/content/images/tumblog/rss.gif
+spec/data/content/index.txt
+spec/data/content/photos.txt
+spec/data/content/tumblog/200806/the-noble-chicken/index.txt
+spec/data/content/tumblog/200807/historical-perspectives-on-the-classic-chicken-joke/index.txt
+spec/data/content/tumblog/200807/mad-city-chickens/index.txt
+spec/data/content/tumblog/200807/the-wisdom-of-the-dutch/index.txt
+spec/data/content/tumblog/200807/up-a-tree/index.txt
+spec/data/content/tumblog/index.txt
+spec/data/content/tumblog/rss.txt
+spec/data/hooligans/bad_meta_data_1.txt
+spec/data/hooligans/bad_meta_data_2.txt
+spec/data/layouts/default.txt
+spec/data/layouts/tumblog/default.txt
+spec/data/layouts/tumblog/post.txt
+spec/data/lib/breadcrumbs.rb
+spec/data/lib/tumblog_helper.rb
+spec/data/tasks/tumblog.rake
+spec/data/templates/_partial.erb
+spec/data/templates/atom_feed.erb
+spec/data/templates/page.erb
+spec/data/templates/presentation.erb
+spec/data/templates/tumblog/conversation.erb
+spec/data/templates/tumblog/link.erb
+spec/data/templates/tumblog/photo.erb
+spec/data/templates/tumblog/post.erb
+spec/data/templates/tumblog/quote.erb
 spec/spec.opts
 spec/spec_helper.rb
 spec/webby/apps/generator_spec.rb
 spec/webby/apps/main_spec.rb
+spec/webby/filters/textile_spec.rb
 spec/webby/helpers/capture_helper_spec.rb
-spec/webby/resources/file_spec.rb
+spec/webby/renderer_spec.rb
+spec/webby/resources/db_spec.rb
+spec/webby/resources/layout_spec.rb
+spec/webby/resources/meta_file_spec.rb
+spec/webby/resources/page_spec.rb
+spec/webby/resources/partial_spec.rb
+spec/webby/resources/resource_spec.rb
+spec/webby/resources/static_spec.rb
 spec/webby/resources_spec.rb
 tasks/ann.rake
 tasks/bones.rake

data/Rakefile

@@ -1,4 +1,3 @@
-# $Id$
 
 load 'tasks/setup.rb'
 
@@ -15,7 +14,7 @@ PROJ.url = 'http://webby.rubyforge.org/'
 PROJ.description = paragraphs_of('README.txt', 3).join("\n\n")
 PROJ.rubyforge.name = 'webby'
 PROJ.version = Webby::VERSION
-PROJ.release_name = 'Vegan Velociraptor'
+PROJ.release_name = 'Gallus Gallus Toothicus'
 
 PROJ.ruby_opts = %w[-W0]
 PROJ.exclude << %w(^examples/[^/]+/output ^tasks/archive ^tags$ ^webby.gemspec$)

data/examples/webby/content/css/site.css

@@ -72,7 +72,7 @@ th,td
 
 // Default Classes
 // ------------------------------------------------------------------------
-p.quiet
+.quiet
   :color = !quiet
 .alt
   :color = !alt

data/examples/webby/content/learn/index.txt

@@ -23,6 +23,6 @@ p(pull). *<%= link_to_page('Reference') %>*
 
 p(pulltext). The reference does not provide an introduction to Webby. Instead, it is an indexed collection of the various Webby features with a brief explanation of each. It is useful when you vaguely remember reading something about filters and only need a quick refresher of the details without instructional text.
 
-p(pull). *<%= link_to_page('Release Notes', :title => 'Release 0.9.0') %>*
+p(pull). *<%= link_to_page('Release Notes') %>*
 
 p(pulltext). These are the release notes for past and present versions of Webby. Actually, it's only for the current version of Webby since formal release notes were only recently thought of by the developer. %(quiet)Bad developer! No latte!!%

data/examples/webby/content/release-notes/index.txt

@@ -0,0 +1,21 @@
+---
+title:      Release Notes
+created_at: 2008-09-10 19:53:33.084767 -06:00
+dirty: true
+filter:
+  - erb
+  - textile
+---
+h2. <%= h(@page.title) %>
+
+Below are links to the release notes for the various version of Webby that have been officially released. Please note the humorous release names; these were created at great expense by a team of comedy writers hand picked by Stephen Colbert.
+
+<% @pages.find(:all,
+   :sort_by => 'title',
+   :reverse => true,
+   :in_directory => @page.directory,
+   :recursive => true).each do |page|
+   next if page == @page
+-%>
+* *<%= link_to_page page %>*  %(quiet)-- <%= h(page.release_name) %>%
+<% end -%>

data/examples/webby/content/release-notes/rel-0-9-0/index.txt

@@ -4,6 +4,7 @@ created_at: 2008-08-18 16:05:25.189950 -06:00
 filter:
   - erb
   - textile
+release_name: Vegan Velociraptor
 ---
 h2. <%= h(@page.title) %>
 

data/examples/webby/content/release-notes/rel-0-9-1/index.txt

@@ -0,0 +1,93 @@
+---
+title:      Release 0.9.1
+created_at: 2008-09-10 19:33:47.822421 -06:00
+filter:
+  - erb
+  - textile
+release_name: Gallus Gallus Toothicus
+---
+h2. <%= h(@page.title) %>
+
+Release 0.9.1 adds one new significant feature and fixes some bugs. The big new feature is the ability to generate multiple output files from a single content page. See below for more information.
+
+* 1 major enhancement
+** Multiple output files can be generated from a single page
+* 2 minor enhancements
+** Pagination now honors the "page per directory" flag
+** Simplified the handling of meta-data at the top of files
+* 2 bug fixes
+** Filename extensions were not being preserved when creating a new page
+** Webby now works properly with rake 0.8.2
+
+h3. Multiple Output Files
+
+What's that, you say? Multiple output files, you say?
+
+Why, yes!
+
+Let's take the example of a photo gallery containing a page of thumbnails that each link to a larger picture with a title and a description. To make such a creation in webby would require each "large picture" page to have it's own file in the content directory, but the only difference between these files would be the _title_ and the _description_.
+
+A better way to handle such a beastie would be a single file in the content folder that contains the titles and descriptions of *all* the photos in the meta-data. The content of this page would be filled in differently for each specific photo page generated.
+
+This is now possible in webby by specifying the specifics for each photo in separate meta-data blocks at the top of the page. One output file will be generated for each meta-data block.
+
+<pre>
+<%= Webby::YAML_SEP %> 
+title:       First Photo
+created_at: 2008-09-10 19:33:47.822421 -06:00
+filter:
+  - erb
+  - textile
+filename:    photo-1
+photo:       IMG001.jpg
+description: This is the first photo
+<%= Webby::YAML_SEP %> 
+title:       Second Photo
+filename:    photo-2
+photo:       IMG002.jpg
+description: This is the second photo
+<%= Webby::YAML_SEP %> 
+title:       Thrid Photo
+filename:    photo-3
+photo:       IMG003.jpg
+description: This is the thrid photo
+<%= Webby::YAML_SEP %>
+h1. <%%= @page.title %>
+
+!<%%= @page.photo %>!
+
+p(desc). <%%= description %>
+</pre>
+
+The example above will result in three output files being generated. The output destination is generated by combining the @directory@ / @filename@ . @extension@  One of those must be different in each meta-data block, otherwise the resulting output files will overwrite one another. In the example, I have chose to modify the @filename@.
+
+The first meta-data block defines the base set of meta-data for the page. Each subsequent meta-data block _modifies_ the meta-data of the first block. So, each resulting output file will be processed by the erb and textile filters (because they appear in the first meta-data block) without having to explicitly specify those filters in each block. Meta-data defined in the second block does not affect the third or subsequent blocks; only the *first* meta-data block defines inheritable parameters.
+
+h4. Another Example
+
+Let's say you want to generate an HTML file *and* a PDF file for a single page. This is easily done by specifying different filters.
+
+<pre>
+<%= Webby::YAML_SEP %> 
+title:      Downloadable Instructions
+created_at: 2008-09-10 19:33:47.822421 -06:00
+filter:
+  - erb
+  - textile
+<%= Webby::YAML_SEP %> 
+extension: pdf
+layout: none
+filter:
+  - erb
+  - textile
+  - htmldoc
+<%= Webby::YAML_SEP %> 
+
+content goes here ...
+</pre>
+
+In this example, the first meta-data block generates an HTML page in the standard webby fashion -- render the page and insert into the default layout. The second meta-data block adds the "htmldoc" filter<sup><a href="#fn1">1</a></sup> to the end of the filter stack. This uses the "htmldoc":http://www.htmldoc.org program to convert HTML into PDF format.
+
+Again, we specify a different output file by changing the extension from the default to "pdf", and we prevent site navigation and headers / footers from appearing in the generated PDF by setting the layout to none. The title is inherited from the first meta-data block.
+
+fn1(fn). This filter does not exist, but the "htmldoc":http://www.htmldoc.org program does exist. So the filter is not out of the question, and it most likely will make an appearance in a later release of webby.

data/examples/webby/content/tips_and_tricks/index.txt

@@ -2,6 +2,7 @@
 title:      Tips & Tricks
 created_at: 2007-08-29 08:57:11.000000 -06:00
 filter:
+- erb
 - textile
 - outline
 --- 
@@ -19,25 +20,25 @@ Pagination is the process of organizing information onto a page such that a fixe
 Let's assume that your website has a collection of articles in a folder called "articles" in the content directory. The goal is to display these articles ten at a time in reverse chronological order.
 
 <pre>
----
+<%= Webby::YAML_SEP %>
 title: Articles
 filter:
 - erb
 - textile
----
-h2. <%= h(@page.title) %>
+<%= Webby::YAML_SEP %>
+h2. <%%= h(@page.title) %>
 
-<%
+<%%
   articles = @pages.find(:all, :in_directory => "articles",
                          :sort_by => "mtime", :reverse => true)
   paginate(articles, 10) do |page|
 %>
-<%= page.render %>
+<%%= page.render %>
 <hr />
-<% end %>
+<%% end %>
 
-<%= link_to("Prev", @pager.prev) if @pager.prev? %>
-<%= link_to("Next", @pager.next) if @pager.next? %>
+<%%= link_to("Prev", @pager.prev) if @pager.prev? %>
+<%%= link_to("Next", @pager.next) if @pager.next? %>
 </pre>
 
 In the example page above, the first step is get the collection of articles we are interested in the paginating. This is done using the <code>@pages.find</code> method to retrieve all the pages from the articles folder sorted in reverse order by modification time. When we have the collection of articles, we pass them to the @paginate@ method along with the desired number of articles per page. The @paginate@ method will pass each page in the @articles@ collection to the supplied block of code, but for each ten pages passed to the block, a new webpage will be created.
@@ -61,19 +62,19 @@ h2. CodeRay
 To include "CodeRay":http://coderay.rubychan.de/ syntax highlighting support in a page you need to have the @coderay@ gem installed, and you need to include the CodeRay stylesheet in your layout. The following example shows a page that uses CodeRay syntax highlighting combined with Textile markup.
 
 <pre>
----
+<%= Webby::YAML_SEP %>
 title:  CodeRay Example
 filter:
 - erb
 - textile
---- 
-h2. <%= h(@page.title) %>
+<%= Webby::YAML_SEP %> 
+h2. <%%= h(@page.title) %>
 
 This is the @render_page@ function from the Webby static website generation
 system. It is used to render a page by applying the specified filters in
 succession to the page contents.
 
-<% coderay(:lang => "ruby", :line_numbers => "inline") do -%>
+<%% coderay(:lang => "ruby", :line_numbers => "inline") do -%>
 # call-seq:
 #    render_page    => string
 #
@@ -90,7 +91,7 @@ def render_page
 
   str
 end
-<% end -%>
+<%% end -%>
 </pre>
 
 There are more options that can be passed to the CodeRay syntax highlighter than those shown in the example above. Take a look at the RDoc documentation for the "CodeRay Helper":/rdoc/classes/Webby/Helpers/CodeRayHelper.html class for more information.

data/examples/webby/content/tutorial/index.txt

@@ -1,8 +1,12 @@
 --- 
 title:      Tutorial
 created_at: 2007-08-21 17:02:40.000000 -06:00
-filter:     textile
+filter:
+  - erb
+  - textile
 --- 
+h1. Tutorial
+
 h2. Require
 
 Webby has a family of friends that help it get it's job done. The command-line is where Webby lives and works. You should be comfortable with your terminal if you're going to get serious with Webby. Webby is built on top of "Ruby":http://www.ruby-lang.org/, and many of the templates use Ruby in one way or another. Learning a little bit about Ruby will make Webby far less intimidating.
@@ -48,14 +52,14 @@ h2. Making Changes
 Of course "Lorem Ipsum" is some great content, but if everyone posted their site in such a state the web would be a monochromatic smurf blue. Let's change that into something more creative, more us. Open the *content/index.txt* file in your favorite editor.
 
 <pre class="code">
---- 
+<%= Webby::YAML_SEP %> 
 title:      Home Page
 created_at: Tue Aug 21 17:02:40 -0600 2007
 filter:
   - erb
   - textile
---- 
-h2. <%= @page.title %>
+<%= Webby::YAML_SEP %> 
+h2. <%%= @page.title %>
 
 Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc congue ipsum
 vestibulum libero. Aenean vitae justo. Nam eget tellus. Etiam convallis, est
@@ -70,7 +74,7 @@ This is not the entire contents of the file, just to enough to get a feel for ho
 
 The content of this page is not HTML, but it ends up that way. How? Webby uses _filters_ on the page to transform the text into HTML. The *filter* item in the meta-data tells Webby which filters to apply to the page. Two filters will be applied, "erb" and "textile" - in that order. Each filter operates on the page text (everything after the meta-data).
 
-The erb filter (erb stands for "embedded Ruby") allows Webby to process Ruby statements found in the page text and to substitute the output of those Ruby statements back into the page text. The Ruby statements appear between @<%= ruby_code %>@ delimiters. The meta-data found at the top of the page is made available through the @@page@ object. You can see from the index.txt file that the page title, "Home Page", will be substituted on the first line.
+The erb filter (erb stands for "embedded Ruby") allows Webby to process Ruby statements found in the page text and to substitute the output of those Ruby statements back into the page text. The Ruby statements appear between @<%%= ruby_code %>@ delimiters. The meta-data found at the top of the page is made available through the @@page@ object. You can see from the index.txt file that the page title, "Home Page", will be substituted on the first line.
 
 The textile filter operates on all page text. It is a human readable markup that gets converted into HTML. For example, the line <notextile><code>h2.&nbsp;Litora&nbsp;Sociis</code></notextile> will be converted into <notextile><code>&lt;h2&gt;&nbsp;Litora&nbsp;Sociis&lt;/h2&gt;</code></notextile> by the textile filter. It is a powerful markup language that simplifies web publishing. 
 
@@ -101,18 +105,18 @@ h2. Change the Layout
 The next step is to change how the page looks. In fact, we want to change the appearance of all the pages in our website. This is easily done by changing the website layout file in the _layouts_ folder. Open the *layouts/default.txt* file in your favorite editor.
 
 <pre class="code">
---- 
+<%= Webby::YAML_SEP %> 
 extension: html
 filter:    erb
---- 
+<%= Webby::YAML_SEP %> 
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
 <head>
    <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
-   <title><%= @page.title %></title>
-   <meta name="author" content="<%= @page.author %>" />
+   <title><%%= @page.title %></title>
+   <meta name="author" content="<%%= @page.author %>" />
 ...
 </pre>
 

data/examples/webby/content/user-manual/index.txt

@@ -133,13 +133,13 @@ Pages are found in the _content_ folder along with regular files. Pages contain
 Let's look at an example page.
 
 <pre>
----
+<%= Webby::YAML_SEP %>
 title:      Lorem Ipsum
 created_at: Wed Aug 29 08:57:00 -0600 2007
 filter:
   - erb
   - textile
----
+<%= Webby::YAML_SEP %>
 h2. <%%= @page.title %>
 
 Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nunc congue ipsum
@@ -169,12 +169,13 @@ Attribute identifiers cannot contain spaces; they must be separated from their v
 
 There are a few attributes that control when, where, and how pages are rendered. These are listed below with a brief description of how the attribute affects the system.
 
-* *destination*  --  Defines the path in the output directory where the rendered page should be stored.
+* *directory*  --  Defines the path in the output directory where the rendered page should be stored. If left empty, then the path of the page in the content folder is used as the output directory.
 * *dirty*  --  The dirty flag is used to determine whether the page should rendered or not. Normally this is automatically determined by the filter engine, but it can be overridden by setting this attribute. If the dirty flag is set to _true_ then the page will always be rendered. If the dirty flag is set to _false_ then the page will never be rendered.
 * *extension*  --  Defines the extension that will be appended to the filename of the rendered page in the output folder. The extension is determined by looking at the following:
 ** the meta-data of the current page for an @extension@ attribute
 ** the meta-data of layout file of the current page for an @extension@ attribute
 ** the extension of this page file in the _content_ folder
+* *filename*  --  The name of the rendered page in the output folder. If left blank, the name of the file in the content folder is used.
 * *filter*  --  Defines the list of filters that will be applied to the contents of this page. If left blank, then the default filter will be applied to the page contents.
 * *layout*  --  Defines the layout that the page contents will be rendered into. The default layout will be used if this attribute is not defined. The value of @nil@ should be specified if the page should not be rendered into any layout.
 
@@ -182,12 +183,11 @@ The following attributes are defined for each page in the content folder. These
 
 * *path*  --  The full path to the file in the _content_ folder
 * *dir*  --  The relative directory in the output folder where the page will be rendered
-* *filename*  --  The name of the file in the _content_ folder excluding any path information
+* *name*  --  The name of the file in the _content_ folder excluding any path information
 * *ext*  --  The extension of the file in the _content_ folder
 * *mtime*  --  The modification time of the file in the _content_ folder
-* *number*  --  Reserved variable used for multi-page content
 * *url*  --  A URL suitable for creating a link to the page
-* *render*  --  Returns the contents of the page as rendered by the Webby filter engine
+* *destination*  --  The path in the output folder where the page will be rendered
 
 h4. Page Filters
 
@@ -213,10 +213,10 @@ The diagram to the right shows a typical page rendering process. The content of
 Layouts are treated exactly as pages are treated with one exception  --  the layout has access to the rendered contents of another page in site. The content of the page being rendered is made available to the layout via the @@content@ variable accessible from the ERB filter.
 
 <pre>
----
+<%= Webby::YAML_SEP %>
 extension: html
 filter:    erb
----
+<%= Webby::YAML_SEP %>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
 <head>
   <title><%= @page.title %></title>

data/examples/webby/layouts/default.txt

@@ -28,7 +28,7 @@ filter:
    <div class="column span-17 prepend-4 append-3 first last" id="header">
       <ul
          ><li><%= link_to_page('Learn') %></li
-         ><li><%= link_to_page('Communicate') %></a></li
+         ><li><%= link_to_page('Communicate') %></li
       ></ul>
       <h1><a href="/">Webby</a></h1>
       <p>- ascii alchemy</p>