webby 0.8.4 → 0.9.0

data/examples/webby/{Rakefile → Sitefile}

@@ -1,6 +1,4 @@
 
-load 'tasks/setup.rb'
-
 task :default => :build
 
 desc 'deploy the website to Rubyforge'
@@ -16,4 +14,6 @@ SITE.uv[:line_numbers] = true
 
 task :autobuild => :growl
 
+SITE.site_root = "http://webby.rubyforge.org"
+
 # EOF

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

@@ -0,0 +1,28 @@
+---
+title:      Communicate
+created_at: 2008-08-24 15:37:45.654428 -06:00
+filter:
+  - erb
+  - textile
+---
+h1. <%= h(@page.title) %>
+
+There is a community of people using Webby right now to make real web pages and publish them on the internet. They have walked down this path, and some have chosen to share their knowledge %(quiet)&#40;aren't they a nice bunch!)%. The Webby developer is also known to frequent the list -- your questions will most definitely find an answer ... or they might have been answered already.
+
+p(pull). *<%= link_to('Forum', 'http://groups.google.com/group/webby-forum') %>*
+
+p(pulltext). The Google group dedicated to Webby and _ASCII Alchemy_.
+
+p(pull). *Reporting Bugs*
+
+p(pulltext). The occasional bug does rear its ugly head from time to time. If this happens please report it either by e-mailing the author or in a post to the discussion group. %(quiet)Note to self: look into a real bug tracking system.%
+
+h2. Elsewhere
+
+A few kind souls have written up their experiences with Webby along with some of their tips and tricks.
+
+* <%= link_to('Building Static Websites with Webby', 'http://clarkware.com/cgi/blosxom/2008/08/06#Webby') %> -- Mike Clark
+
+h2. Errata
+
+If you're interested in the development of Webby, you can follow along at home by watching the <%= link_to('github repository', 'http://github.com/TwP/webby/tree/master') %>.

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

@@ -20,8 +20,10 @@ sass_options:
 @import blueprint/screen.css
 
 body
+  :margin       0
   :color =      !text
   :font-family  Verdana, sans-serif
+  :background   white url('background.gif') repeat-x left top
 
 // Headings
 // ------------------------------------------------------------------------
@@ -44,13 +46,13 @@ blockquote
 
 pre
   :margin-left   18px
-  :padding       8px
+  :padding       8px 8px 8px 18px
   :color =       !code
   :font-family   monospace, courier
   :overflow      auto
-  :background =  !box_bg
-  :border =      1px solid !border
-  :border-left = 7px solid !border
+//  :background =  !box_bg
+//  :border =      1px solid !border
+  :border-left = 3px solid !border
 
 hr
   :background = !highlight
@@ -78,31 +80,42 @@ p.quiet
 // My Site Stylings
 // ------------------------------------------------------------------------
 #header
-
-#navigation
+  :margin              0 0 25px 0
+  :padding-top         20px
+  a
+    :color =           !header
+    :text-decoration   none
+  h1
+    :margin            0
+    :font-size         2.0em
+    :letter-spacing    0.25em
+  p
+    :font-style        italic
+    :font-weight       normal
+    :color =           !quiet
   ul
-    :margin-left               0
-    :text-align                right
-    :font-size                 16px
-    :list-style-type           none
+    :float             right
+    :margin            0
+    :padding           0
+    :text-align        right
+    :font-size         1.0em
+    :list-style-type   circle
     li
-      :display                 block
-      :padding-right           5px
-      :background-color =      !box_bg
+      :display         inline
+      :margin          0 0 0 2.5em
       a
-        :display               block
-        :text-decoration       none
-        :margin-right          -5px
-        :padding-right         5px
-        :background-color      white
+        :color =       !quiet
+        :font-weight   bold
         &:hover
-          :background-color = !highlight
+          :color =     !header
 
 #footer
+  :margin-top        18px
+  :font-size         0.8em
   hr
     :margin-bottom   18px
   p
-    :text-align      right
+    :text-align      center
 
 .CodeRay
   pre
@@ -161,4 +174,23 @@ div.desc
   ul
     :margin-bottom 0
 
+p.TODO
+  :color            white
+  :background-color red
+  :font-weight      bold
+  :padding          5px 0.5em
+
+p.pull
+  :float         left
+  :clear         left
+  :margin        0 10px 0 -120px
+  :width         110px
+  :text-align    right
+
+p.pulltext
+  :float         left
+  :clear         right
+  :margin-right  10px
+  :width         670px
+
 // EOF

data/examples/webby/content/index.txt

@@ -1,6 +1,6 @@
 --- 
-title:      Home
-created_at: Tue Aug 21 11:25:06 -0600 2007
+title:      Webby
+created_at: 2007-08-21 11:25:06.000000 -06:00
 filter:     textile
 --- 
 *Webby* is a fantastic little website management system. It would be called a _content management system_ if it were a bigger kid. But, it's just a runt with a special knack for transforming text. And that's really all it does - manages the legwork of turning text into something else, an *ASCII Alchemist* if you will.
@@ -9,7 +9,7 @@ Webby works by combining the contents of a *page* with a *layout* to produce HTM
 
 Install Webby and try it out!
 
-  sudo gem install webby
+pre. sudo gem install webby
 
 h2. Features
 
@@ -27,11 +27,10 @@ h2. But Wait! There's More!
 
 Webby has a great _autobuild_ feature that continuously generates HTML whenever the *pages* or *layouts* change. The HTML is served up via "heel":http://copiousfreetime.rubyforge.org/heel/, a static file webserver based on mongrel. Whenever you change a page, you can immediately see those changes without having to run any commands.
 
-  $ rake autobuild
-  heel --root output --daemonize
-  [10:21:26]  INFO: starting autobuild (Ctrl-C to stop)
-  [10:21:26]  INFO: creating output/index.html
-  [10:22:57]  INFO: creating output/index.html
+pre. $ webby autobuild
+[10:21:26]  INFO: starting autobuild (Ctrl-C to stop)
+[10:21:26]  INFO: creating output/index.html
+[10:22:57]  INFO: creating output/index.html
 
 Webby is not limited to producing HTML. By no means! Do you ever get tired of repeating the same color code *#D3C4A2* in your CSS files? Webby can help. Need some customized JavaScript for your website. Webby can help. Anytime you find yourself repeating the same bit of text over and over, then you should be using Webby.
 

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', :title => 'Release 0.9.0') %>*
+
+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

@@ -13,9 +13,11 @@ content_for_head: |
 
 p(title). Table of Contents
 
-<toc />
+<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:

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

@@ -0,0 +1,73 @@
+---
+title:      Release 0.9.0
+created_at: 2008-08-18 16:05:25.189950 -06:00
+filter:
+  - erb
+  - textile
+---
+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/sitemap.txt

@@ -0,0 +1,31 @@
+---
+#
+# Define the following in your Rakefile or some
+# other location which will be accessed by tasks/setup.rb
+#
+# SITE.site_root = "http://webby.rubyforge.org"
+#
+extension: xml
+layout: nil
+index: false
+dirty: true
+filter:
+- erb
+---
+<?xml version="1.0" encoding="utf-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<% @pages.find(:in_directory => "/", :recursive => true) do |p|
+      next if p.created_at.nil?
+      next unless p['index'] || p['index'].nil?  -%>
+  <url>
+    <loc><%= SITE.site_root %><%= p.url %></loc>
+    <lastmod><%= p.mtime.xmlschema %></lastmod>
+<% if p['changefreq'] || SITE.changefreq -%>
+    <changefreq><%= p['changefreq'] || SITE.changefreq %></changefreq>
+<% end -%>
+<% if p['priority'] || SITE.priority -%>
+    <priority><%= p['priority'] || SITE.priority %></priority>
+<% end -%>
+  </url>
+<% end -%>
+</urlset>

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

@@ -1,6 +1,6 @@
 --- 
 title:      Tips & Tricks
-created_at: Wed Aug 29 08:57:11 -0600 2007
+created_at: 2007-08-29 08:57:11.000000 -06:00
 filter:
 - textile
 - outline

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

@@ -1,6 +1,6 @@
 --- 
 title:      Tutorial
-created_at: Tue Aug 21 17:02:40 -0600 2007
+created_at: 2007-08-21 17:02:40.000000 -06:00
 filter:     textile
 --- 
 h2. Require
@@ -14,13 +14,13 @@ h2. Create a Site
 You need a catchy name for your website to survive in this Web 2.0 world. Webby is distinctly Web 1.0 (or maybe Web 0.5) so we'll use the name *my_site*.
 
 <pre class="code">
-webby my_site
+webby-gen website my_site
 </pre>
 
 This command creates a new folder named _my_site_, and the new Webby based website resides there. Change directories to the _my_site_ folder and do a listing. You will see the following files and folders:
 
 <pre class="code">
-Rakefile
+Sitefile
 content/
 layouts/
 lib/
@@ -33,13 +33,13 @@ h2. Build Your Site
 
 What? Didn't we just do that?
 
-Webby creates a site template - the larval form of your new website. "Rake":http://docs.rubyrake.org/ (another command line tool) is used to generate the HTML files for your site - a unique, beautiful butterfly.
+Webby creates a site template - the larval form of your new website. The _webby_ command line tool is used to generate the HTML files for your site - a unique, beautiful butterfly.
 
 <pre class="code">
-rake
+webby
 </pre>
 
-Again, you will see lots of output scrolling across the screen. This is the rake task copying files from the _content_ folder to the _output_ folder. Some files are copied "as is", while others are compiled into HTML using your markup language of choice.
+Again, you will see lots of output scrolling across the screen. This is Webby copying files from the _content_ folder to the _output_ folder. Some files are copied "as is", while others are compiled into HTML using your markup language of choice.
 
 Point your web browser to *my_site/output/index.html* to see what your new website looks like.
 
@@ -72,33 +72,33 @@ The content of this page is not HTML, but it ends up that way. How? Webby uses _
 
 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 @<h2>Litora Sociis</h2>@ by the textile filter. It is a powerful markup language that simplifies web publishing. 
+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. 
 
-Okay, back to our regularly scheduled page changes. Go ahead and change the title of the page in the meta-data. Then run rake again.
+Okay, back to our regularly scheduled page changes. Go ahead and change the title of the page in the meta-data. Then run webby again.
 
 <pre class="code">
-rake
+webby
 </pre>
 
-You'll notice much less output than before. The rake task only builds those pages that you have modified. You'll also notice, after reloading the page in your browser, that the title has now changed.
+You'll notice much less output than before. Webby only builds those pages that you have modified. You'll also notice, after reloading the page in your browser, that the title has now changed.
 
-Play around with making changes, running rake, and seeing your changes show up in the web browser. Done? All right! Let's go on to the next section.
+Play around with making changes, running webby, and seeing your changes show up in the web browser. Done? All right! Let's go on to the next section.
 
-bq. *TIP* You can simplify this whole process - modify content, rake, view in browser - by running <notextile><code>rake&nbsp;autobuild</code></notextile> on the command line. This starts a build loop that compiles the content of your website as files change. All you need to do now is - modify content, view in browser.
+bq. *TIP* You can simplify this whole process - modify content, webby, view in browser - by running <notextile><code>webby&nbsp;autobuild</code></notextile> on the command line. This starts a build loop that compiles the content of your website as files change. All you need to do now is - modify content, view in browser.
 
 h2. Creating a Page
 
 Let's tell the world all about your new website. We'll create a new _about_ page that describes what this website is all about, who you are, and the answer to life, the universe, and everything.
 
 <pre class="code">
-rake create:page about
+webby create:page about
 </pre>
 
-The output from the command tells you that a new file has been created - @content/about.txt@. You can now edit this page, give it a title "About", and somewhere in there include _42_.
+The output from the command tells you that a new file has been created - @content/about.txt@. You can now edit this page, enter some content, and somewhere in there include _42_.
 
 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.rhtml* file in your favorite editor.
+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">
 --- 
@@ -106,7 +106,7 @@ extension: html
 filter:    erb
 --- 
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-    "DTD/xhtml1-strict.dtd">
+    "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>
@@ -128,4 +128,4 @@ h2. What Now?
 
 Let your creativity run wild!
 
-You can read more about the features of Webby in the "manual":/manual. There you'll discover how to reference layouts other than the default, how to create page templates for simplifying blog posts. Take a look at the "tips &amp; tricks":/tips_and_tricks for more ideas on simplifying your web development work cycle.
+You can read more about the features of Webby in the "user manual":/user-manual. There you'll discover how to reference layouts other than the default, how to create page templates for simplifying blog posts. Take a look at the "tips &amp; tricks":/tips_and_tricks for more ideas on simplifying your web development work cycle.