jamesgolick-webby 0.9.5

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

@@ -0,0 +1,28 @@
+---
+title:      Learn
+created_at: 2008-08-24 15:36:06.596051 -06:00
+filter:
+  - erb
+  - textile
+---
+h1. <%= h(@page.title) %>
+
+This section is devoted to learning more about Webby. Located below are the various "official" documents to assist you on your way to becoming prolific with Webby.
+
+If you cannot find your answer here, head on over to the <%= link_to_page('Communicate') %> section where the mailing list might help you.
+
+p(pull). *<%= link_to_page('Tutorial') %>*
+
+p(pulltext). The tutorial is a great introduction to Webby if you want to hit the ground running and figure things out as you go. Following along with the tutorial on your own computer will get you comfortable with the basic concepts of Webby.
+
+p(pull). *<%= link_to_page('User Manual') %>*
+
+p(pulltext). The user manual provides a more in-depth look into Webby. It assumes no prior experience with Webby, and it goes into more detail about the various aspects of creating a webby site and working with Webby itself. The user manual is the place to go if you want to go beyond the basics.
+
+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') %>*
+
+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/reference/index.txt

@@ -0,0 +1,204 @@
+---
+title:      Reference
+created_at: 2008-03-04 22:00:08.439182 -07:00
+filter:
+  - erb
+  - textile
+  - outline
+content_for_head: |
+ <link rel="stylesheet" href="/css/coderay.css" type="text/css" media="screen, projection" />
+ <link rel="stylesheet" href="/css/uv/twilight.css" type="text/css" media="screen, projection" />
+---
+<div class="toc push-1">
+
+p(title). Table of Contents
+
+<toc toc_range="h2-h6" />
+</div>
+
+h1. <%= h(@page.title) %>
+
+h3. Resources
+
+Resources are the files that are found in the _content_ and _layouts_ folders of a webby site. They come in the following four flavors:
+
+* *Pages*  --  contain meta-data at the top of the file, are found in the content folder, and are processed by the Webby filter engine
+* *Files*  --  are found in the content folder and copied "as is" to the output folder
+* *Partials*  --  contain snippets of text that can be used in multiple locations; partial filenames begin with an underscore are are _not_ copied to the output folder
+* *Layouts*  --  are found in the layout folder and provide the basic framework of the webpage - the header, the footer, the navigation
+
+h3. Attributes
+
+Attributes are defined in the meta-data section of pages and layouts.
+
+<div class="label">destination</div>
+<div class="desc">
+Defines the path in the output directory where the rendered page should be stored.
+</div>
+
+<div class="label">dirty</div>
+<div class="desc">
+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.
+</div> 
+
+<div class="label">extension</div>
+<div class="desc">
+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
+
+</div>
+
+<div class="label">filter</div>
+<div class="desc">
+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.
+</div>
+
+<div class="label">layout</div>
+<div class="desc">
+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.
+</div>
+
+The following attributes are defined for each page in the content folder. These attributes cannot be changed in the page's meta-data section. However, they are available to the ERB filter when rendering the contents of a page.
+
+<div class="label">path</div>
+<div class="desc">
+The full path to the file in the _content_ folder
+</div>
+
+<div class="label">dir</div>
+<div class="desc">
+The relative directory in the output folder where the page will be rendered
+</div>
+
+<div class="label">filename </div>
+<div class="desc">
+The name of the file in the _content_ folder excluding any path information and extension
+</div>
+
+<div class="label">ext</div>
+<div class="desc">
+The extension of the file in the _content_ folder
+</div>
+
+<div class="label">mtime</div>
+<div class="desc">
+The modification time of the file in the _content_ folder
+</div>
+
+<div class="label">number</div>
+<div class="desc">
+Reserved variable used for multi-page content
+</div>
+
+<div class="label">url</div>
+<div class="desc">
+A URL suitable for creating a link to the page
+</div>
+
+<div class="label">render</div>
+<div class="desc">
+Returns the contents of the page as rendered by the Webby filter engine
+</div>
+
+h3. Filters
+
+h3. ERB Variables & Methods
+
+h4. coderay
+
+The coderay method is used to generate syntax highlighting on a block of code. You will need to have the coderay gem installed on your system, and you will need to include the coderay CSS stylesheet in your pages for the syntax highlighting markup to take effect.
+
+The full list of "coderay options":/rdoc/classes/Webby/Helpers/CodeRayHelper.html can be found in the source documentation.
+
+<pre>
+<%% coderay :lang => 'ruby', :line_numbers => 'inline' do -%>
+class Object
+  def returning( r )
+    yield r if block_given?
+    r
+  end
+end
+<%% end -%>
+</pre>
+
+<% coderay :lang => "ruby", :line_numbers => "inline" do -%>
+class Object
+  def returning( r )
+    yield r if block_given?
+    r
+  end
+end
+<% end -%>
+
+
+h4. graphviz
+
+The graphviz method is used to convert a DOT script into an image and insert the image into the page. If the DOT script contains URL references, then an image map will also be generated. The resulting image will then have "clickable" regions that link to the URLs specified.
+
+"Graphviz":http://www.graphviz.org/ needs to be installed on your system in order to use the graphviz method. The full list of "graphviz options":/rdoc/classes/Webby/Helpers/GraphvizHelper.html can be found in the source documentation.
+
+<pre>
+<%% graphviz :path => 'images', :alt => 'hello world graph' do -%>
+digraph hello_world {
+  rankdir = LR;
+  Hello -> World;
+}
+<%% end -%>
+</pre>
+
+<% graphviz :path => "images", :alt => "hello world graph" do -%>
+digraph hello_world {
+  rankdir = LR;
+  Hello -> World;
+}
+<% end -%>
+
+
+h4. tex2img
+
+The tex2img method is used to convert a LaTeX script into an image and insert the image into the page. "LaTeX":http://www.latex-project.org/ and "ImageMagick":http://www.imagemagick.org/script/index.php need to be instaled on your system in order to use the tex2img maethod.
+
+The full list of "tex2img options":/rdoc/classes/Webby/Helpers/TexImgHelper.html can be found in the source documentation.
+
+<pre>
+<%% tex2img 'wave_eq', :path => 'images', :alt => 'wave equation' do -%>
+$\psi_{tot}(x,-t_0,r) = \frac{1}{(2\pi)^2} \int\!\!\!\int
+\tilde\Psi_{tot}\left(k_x,\frac{c}{2}\sqrt{k_x^2 + k_r^2},r=0\right)$
+<%% end -%>
+</pre>
+
+<% tex2img 'wave_eq', :path => 'images', :alt => 'wave equation' do -%>
+$\psi_{tot}(x,-t_0,r) = \frac{1}{(2\pi)^2} \int\!\!\!\int
+\tilde\Psi_{tot}\left(k_x,\frac{c}{2}\sqrt{k_x^2 + k_r^2},r=0\right)$
+<% end -%>
+
+
+h4. uv
+
+The uv method is used to generate syntax highlighting on a block of code. You will need to have the "Ultraviolet":http://ultraviolet.rubyforge.org/ gem installed on your system, and you will need to include the desired CSS stylesheet in your pages for the syntax highlighting markup to take effect.
+
+The full list of "ultraviolet options":/rdoc/classes/Webby/Helpers/UltraVioletHelper.html can be found in the source documentation.
+
+<pre>
+<%% uv :lang => "ruby", :line_numbers => true do -%>
+# Initializer for the class.
+def initialize( string )
+  @str = string
+end
+<%% end -%>
+</pre>
+
+<% uv :lang => "ruby", :line_numbers => true, :theme => 'twilight' do -%>
+# Initializer for the class.
+def initialize( string )
+  @str = string
+end
+<% end -%>
+
+
+h3. Rake Tasks
+
+h3. Site Defaults

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

@@ -0,0 +1,74 @@
+---
+title:      Release 0.9.0
+created_at: 2008-08-18 16:05:25.189950 -06:00
+filter:
+  - erb
+  - textile
+release_name: Vegan Velociraptor
+---
+h2. <%= h(@page.title) %>
+
+Release 0.9.0 adds new features and fixes some bugs. Most notably is the move away from the rake command line application, and the daily usage of the *webby* command line application to build sites.
+
+* 2 major enhancements
+** The "rake" command line tool has been replaced by the "webby" command line tool for day to day site tasks
+** Now using the "rdiscount" gem for markdown syntax
+* 4 minor enhancements
+** Layouts can exist in subdirectories of the layouts folder
+** Addition of a "tumblog" template
+** Addition of a sitemap file (Ana Nelson)
+** Updated to version 6.4.2 of ImageMagick for tex2img conversions
+* 5 bug fixes
+** Better error message when an unknown filter is given
+** Table of contents generation bug
+** Failing to clean out the "content_for" cache when doing a multi-page render
+** Explicitly loading the RedCloth gem
+** Handling exceptions from system calls on the Windows platform
+
+h3. Steps to Upgrade a Site
+
+* rename *Rakefile* to *Sitefile*
+* edit the *Sitefile* and remove the @load tasks/setup.rb@ line
+* remove *setup.rb* from the *tasks* folder
+* remove the following files from the *tasks* folder _unless you have modified them_
+** build.rake
+** create.rake
+** deploy.rake
+** growl.rake
+** heel.rake
+** validate.rake
+
+h3. Rationale
+
+*webby vs. rake*
+
+The most prominent change in this release is the move away from the rake command line application. The webby command line application has taken its place. The impetus for this change is rake's inability to handle command line arguments being passed to individual tasks. Specifically, when creating a new page in a site the filename of the page is passed on the command line. Much "hackery" was taking place behind the scenes in order for this to work with the rake command line app.
+
+Since "hackery" is prone to break, the immediate benefit of the webby command line app is future stability in the face of changes to rake. The rake infrastructure is still used under the hood, but the webby command line app now handles parsing of tasks and task arguments. This is a much more graceful solution.
+
+*webby-gen*
+
+A second command line application has been created -- *webby-gen*. When a new webby site was created with the old webby command line app, it was an "all or nothing" affair. Blueprint style sheets were created alongside S5 presentation templates with a smattering of blog support thrown in for good measure. Each of these can now be created independently of the others. Furthermore, a site template can be instantiated into an already existing site. Support for S5 presentations can be included into a site if it is needed.
+
+An attempt was made to roll all this functionality into the webby command line app. However, all the options proved to be cumbersome for one utility. Occam's razor was applied to split the two.
+
+*sitefile*
+
+Slightly related to the "webby vs. rake" section above, I wanted to make a distinction between the "old way" of doing things and the "new way" of doing things. Of all the choices made in the release this was the most capricious.
+
+*tasks*
+
+It simply made sense to move the vast majority of the common website tasks into the webby gem itself. I found that these same task files were repeated over and over again in all the sites, and they were not being modified at all. This fact combined with the move to the webby command line app provided for a convenient way to use the tasks from the webby gem.
+
+Some of the site templates (blog and tumblog, for example) still create rake tasks in the tasks folder. These are examples of specific behaviors that are good to be able to dissect for inspiration.
+
+h3. Thanks
+
+Thanks to everyone who has helped make Webby possible!
+If you've made a website with webby, thanks.
+If you've contributed some source code, thanks.
+If you've written up some documentation, thanks.
+If you've told a friend, thanks.
+
+Blessings,
+TwP

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/release-notes/rel-0-9-2/index.txt

@@ -0,0 +1,14 @@
+---
+title:      Release 0.9.2
+created_at: 2008-09-11 19:33:47.822421 -06:00
+filter:
+  - erb
+  - textile
+release_name: Gallus Gallus Toothicus ++
+---
+h2. <%= h(@page.title) %>
+
+Release 0.9.2 is a bug-fix release. No new features or enhancements.
+
+* 1 bug fix
+** Layouts were not being found if more than one layout was in a directory in the layouts folder

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

@@ -0,0 +1,47 @@
+---
+title:      Release 0.9.3
+created_at: 2008-10-08 21:22:41.217238 -06:00
+filter:
+  - erb
+  - textile
+release_name: Bill Gates Alien Love Child
+---
+h2. <%= h(@page.title) %>
+
+Release 0.9.3 adds several new features and fixes a few bugs. The two most significant features are a "wikiwords" filter and a special webby gem for the windows platform. See below for more information.
+
+* 4 minor enhancements
+** Added a "wikiwords" filter to process [[text]] as links to other pages (thanks to Paul)
+** Added colorization to the output text (facets gem required)
+** Replaced the Heel webserver with webrick
+** Special windows version with windows line endings in generated files
+* 2 bug fixes
+** Fixed a bug on Windows where line endings were messing with meta-data
+** The paginator was not linking correctly back to the first page from subsequent pages in a list
+
+h3. Wiki Words
+
+Wiki Words provide a convenient way to link to other pages in a site based on the page titles. Page titles surrounded by double brackets will be converted into a link to that particular page.
+
+<pre>
+<%= Webby::YAML_SEP %> 
+title:      Special Report
+created_at: 2008-10-08 21:22:41.217238 -06:00
+filter:
+  - wikiwords
+  - textile
+<%= Webby::YAML_SEP %> 
+h1. Special Report
+
+This page is a special report that links to some [[Other Page]] in the site and
+offers a little more information. You can find out more in the [[Reference]]
+page, too.
+</pre>
+
+So, in the example above two links will be generated. One will link to the "Other Page" and the second will link to the "Reference" page.
+
+h3. Windows Support
+
+This release also fixes a few issues with webby on the windows platform. Both issues concern windows line endings versus UNIX line endings in files. The code that parses meta-data has been updated to be line ending agnostic -- so no need to use UNIX line endings in the windows world.
+
+The second issue is a windows specific version of the webby gem. This gem has the template site files converted to the windows line ending style. So when a site is created using the webby-gen command, the resulting files should be in the native windows format.