gettalong-webgen 0.5.7.20090227 → 0.5.8.20090507

data/data/webgen/{website_styles → website_bundles/style}/andreas06/src/default.css

@@ -259,7 +259,7 @@ margin: 0px;
 padding: 0px;
 }
 
-.nav, #leftside #submenu ul a {
+.nav, #leftside #submenu ul a, #leftside #submenu ul span {
 color:#d04a10;
 display:block;
 font-size:1.1em;
@@ -271,20 +271,22 @@ text-decoration:none;
 width:125px;
 }
 
-.nav:hover, #leftside #submenu ul a:hover {
+.nav:hover, #leftside #submenu ul a:hover, #leftside #submenu ul span:hover,
+#leftside #submenu ul li.webgen-menu-item-selected a, #leftside #submenu ul li.webgen-menu-item-selected span {
 border:1px solid #fa9035;
 color:#505050;
 padding:1px 1px 1px 9px;
 }
 
-.sub, #leftside #submenu ul ul a {
+.sub, #leftside #submenu ul ul a, #leftside #submenu ul ul span {
 font-size:0.9em;
 margin-left:20px;
 padding:1px 1px 1px 6px;
 width:105px;
 }
 
-.sub:hover, #leftside #submenu ul ul a {
+.sub:hover, #leftside #submenu ul ul a:hover, #leftside #submenu ul ul span:hover,
+#leftside #submenu ul ul li.webgen-menu-item-selected a, #leftside #submenu ul ul li.webgen-menu-item-selected span {
 border:1px solid #fa9035;
 color:#505050;
 padding:0 0 0 5px;

data/data/webgen/{website_styles → website_bundles/style}/andreas06/src/default.template

@@ -37,8 +37,8 @@
           <div id="leftside">
             <a id="sectionmenu"></a>
             <p class="soft">Some text here, maybe a website description</p>
-            <% if node.level > 1 %>
-	    <h1>Site menu:</h1>
+            <% if context.node.level > 1 %>
+            <h1>Site menu:</h1>
             <div id="submenu">{menu: {start_level: 2, max_levels: 2}}</div>
 	    <% end %>
           </div>

data/data/webgen/website_skeleton/README

@@ -5,6 +5,6 @@ description:
   When using the standard settings, the sources are in the directory `src` and
   the generated output goes into `out`. Extensions can be placed under `ext`.
 
-  For configuration purposes, use the config.rb or config.yaml files.
+  For configuration purposes, use the config.yaml file.
 ---
 note: This file can be deleted!

data/data/webgen/website_skeleton/config.yaml

@@ -10,8 +10,9 @@
 #
 # Have a look at the documentation of the individual configuration options to see
 # the allowed format of the values. Since this is a YAML file, you can easily set
-# configuration options to strings, integers, dates, arrays, hashes and more.
+# configuration options as strings, integers, dates, arrays, hashes and more.
 #
-# The available configuration options can be listed using the `webgen config`
-# command, for example: `webgen config sourcehandler` will list all options starting
-# with sourcehandler.
+# The available configuration options can be found on the homepage in the
+# Configuration Option Reference at
+#
+#     http://webgen.rubyforge.org/documentation/reference_configuration.html

data/doc/contentprocessor/blocks.page

@@ -8,26 +8,59 @@ templates to define the place where the actual page content should be.
 
 The general syntax is as follows:
 
-    <webgen:block name='BLOCK_NAME' chain='(L)CN;(L)CN;...' node='first' notfound='ignore' />
+    <webgen:block name='BLOCK_NAME' chain='(L)CN;(L)CN;...' node='next|first|current' notfound='ignore' />
 
 So it is basically an XML tag with the mandatory attribute `name` and the optional attributes
-`chain`, `node` and `notfound`:
+`chain`, `node` and `notfound`. The attributes are explained below but first comes a small
+explanation of how this tag works.
+
+webgen uses a node chain when rendering a page file. The default node chain is automatically
+determined via the `template` meta information (see [SourceHandler::Template]({relocatable:
+../sourcehandler/template.html})) and the important thing to keep in mind is that the first node in
+the node chain is always the currently rendered template/page.
+
+For example, consider a `default.template` with a block tag of `<webgen:block name='content' />` and
+an `index.page` that should be rendered. This would result in a node chain of (note that the CN of a
+page file has the extension `html`)
+
+    default.template ---> index.html
+
+During the rendering of the `index.page`, the node chain like shown above is created and rendering
+is started at the *first* node in the chain, in this case at `default.template`. When the block tag
+is encountered, it is replaced by the block named `content`, after rendering it according to its
+render pipeline, of the `index.page`. If such a block tag was not in the template, then the content
+of the `index.page` file would never be inserted into the output file! The behaviour of the block
+tag can be customized by using the various attributes.
+
+Summing up: the `template` meta information is used to create a node chain which is then used by the
+block tag to render the appropriate blocks.
+
+Following is the documentation for the available attributes of the tag:
 
 * The `name` attribute is the only mandatory attribute and it specifies the name of the block that
-  should be rendered in place of the block tag. The next node in the used node chain (if there is
-  only one node left in the node chain that node is used) needs to have a block that has such a name
-  (this behaviour can be changed with the `node` attribute), otherwise an error is raised. The
-  block is rendered according to its render pipeline and then inserted.
+  should be rendered in place of the block tag. If the used node (see the `node` attribute) has no
+  such named block, an error is raised.
 
 * The optional attribute `chain` specifies the node chain that should be used for rendering the
   block. Its value needs to be a list of (localized) canonical names of nodes separated by
   semicolons that should be used as node chain. If this attribute is not specified the default node
   chain is used.
 
-* The optional attribute `node` specifies which node in the node chain should be used. If this
-  attribute is not specified, the next node in the node chain is used. If it is specified with the
-  value `first`, then the node chain is traversed till a node is found that has a block with the
-  specified name. If no such node is in the node chain, an error is raised.
+* The optional attribute `node` specifies which node in the node chain should be used.
+
+  * If this attribute is not specified or its value is `next`, the next node in the node chain (i.e.
+    the second node) is used. If there is only one node left in the node chain that node is used.
+
+  * If the attribute has a value of `first`, then the node chain is traversed till a node is found
+    that has a block with the specified name. If no such node is in the node chain, an error is
+    raised. If the attribute `chain` is also used, then the search starts at the first node of the
+    node chain. Otherwise it starts at the second node.
+
+  * If the attribute has a value of `current`, the currently processed node is used (i.e. the first
+    node in the node chain).
+
+    > Note that the attribute `chain` is not used in this situation!
+    {.important}
 
 * If the optional attribute `notfound` has a value of `ignore`, all errors that can occur are
   ignored. This is especially useful when used in templates to include blocks that may not be

data/doc/contentprocessor/builder.page

@@ -52,7 +52,7 @@ a custom XML document (the `content` block has to be valid Ruby!):
     title: Person Object
     template: ~
     --- pipeline:builder
-    xml.persons(:path => node.absolute_lcn) do |p|
+    xml.persons(:path => context.node.absolute_lcn) do |p|
       p.person do |b|
         b.firstname('Thomas')
         b.lastname('Leitner')

data/doc/contentprocessor/erb.page

@@ -7,19 +7,20 @@ This processer uses ERB (embedded Ruby) to process content. For detailed informa
 a look at its documentation by executing `ri ERB` or the [ruby documentation
 site](http://www.ruby-doc.org/)!
 
-You can use the following special objects in your ERB code:
+You can use the special object `context` in your ERB code which provides the whole rendering context
+and the following useful methods:
 
-* `context`: This object provides the whole rendering context, the following objects are just for
-  backwards compatibility.
+* `website`: Provides access to the `Webgen::Website` object which can be used to access all aspects
+  of the currently rendered website.
 
-* `ref_node` (or `context.ref_node`): The reference node which is the source of the ERB code that is
-  executed. Should be used, for example, for resolving paths.
+* `node` (or `content_node`): The node that gets currently rendered. Should be used for retrieving
+  meta information.
 
-* `node` (or `context.content_node`): The node that gets currently rendered. Should be used for
-  retrieving meta information.
+* `ref_node`: The reference node which is the source of the ERB code that is executed. Should be
+  used, for example, for resolving paths.
 
-* `dest_node` (or `context.dest_node`): The node in which the result gets inserted. Should be used
-  for calculating relative paths.
+* `dest_node`: The node in which the result gets inserted. Should be used for calculating relative
+  paths.
 
 Here is a small usage example. The following put in a page file
 
@@ -29,7 +30,7 @@ Here is a small usage example. The following put in a page file
     <%% end %>
 
     Outputting all meta information:
-    <%% node.meta_info.each do |k,v| %>
+    <%% context.node.meta_info.each do |k,v| %>
       * <%%= k %> = <%%= v %>
     <%% end %>
 
@@ -41,7 +42,7 @@ Here is a small usage example. The following put in a page file
     <% end %>
 
     Outputting all meta information:
-    <% node.meta_info.each do |k,v| %>
+    <% context.node.meta_info.each do |k,v| %>
       * <%= k %> = <%= v %>
     <% end %>
 

data/doc/contentprocessor/redcloth.page

@@ -12,6 +12,8 @@ RedCloth library. For detailed information about Textile have a look at the [Tex
 >     gem install RedCloth
 {.warning}
 
+You can use the configuration option `contentprocessor.redcloth.hard_breaks` to enable/disable the
+conversion of single newlines into HTML break tags.
 
 Example
 -------
@@ -36,4 +38,4 @@ Here is a short sample of a text in Textile markup:
 
 
 [1]: http://hobix.com/textile/
-[2]: http://whytheluckystiff.net/ruby/redcloth/
+[2]: http://whytheluckystiff.net/ruby/redcloth/

data/doc/extensions.page

@@ -6,11 +6,11 @@ title: Extensions
 Following is a listing of all available extensions:
 
 <%
-pattern = /#{File.join(node.parent.absolute_lcn, '/')}(contentprocessor|output|source|sourcehandler|tag|)\/.*html$/
-context.content_node.tree.node_access[:alcn].select {|alcn, n| alcn =~ pattern}.sort.each do |alcn, n|
+pattern = /#{File.join(context.node.parent.absolute_lcn, '/')}(contentprocessor|output|source|sourcehandler|tag|)\/.*html$/
+context.node.tree.node_access[:alcn].select {|alcn, n| alcn =~ pattern}.sort.each do |alcn, n|
 next if n.is_fragment?
 %>
-* <%= dest_node.link_to(n) %>
+* <%= context.dest_node.link_to(n) %>
 <%
 end
 %>

data/doc/faq.page

@@ -10,14 +10,17 @@ title: FAQ
 
 *   **Why can I specify multiple blocks in a page/template file?**
 
-    This allows you to provide different content parts for one page. For example, image you have a
+    This allows you to provide different content parts for one page. For example, imagine you have a
     layout with a sidebar and you want to have page specific sidebar contents. The easiest way to
     achieve that is to add a `sidebar` block to the page files that provide a page specific sidebar
-    content and conditionally include the `sidebar` block in your `default.template`, like this:
+    content and include the `sidebar` block in your `default.template`, like this:
 
-        <%% if node.node_info[:page].blocks.has_key?('sidebar') %>
-          \<webgen:block name='sidebar' />
-        <%% end %>
+        <webgen:block name='sidebar' notfound="ignore" chain="first" />
+
+    By using `notfound="ignore"` we tell webgen to ignore errors when such a block is not found and
+    the `chain="first"` attribute tells webgen to search through the whole node chain for such a
+    block. The latter is needed when nested templates are used because by default only the next node
+    in the chain is inspected.
 
 *   **What do I have to do to use the extensions?**
 
@@ -43,9 +46,9 @@ questions.
 
 Use the `webgen` command to create the needed directories
 
-    webgen create -t project -s andreas07 my_site
+    webgen create -b default -b andreas07 my_site
 
-This will create a webgen website in the directory `my_site` using the specified template and style.
+This will create a webgen website in the directory `my_site` using the specified bundles.
 
 ### ... set configuration options?
 
@@ -176,7 +179,7 @@ There are many ways to accomplish this, I will show only one way here using bloc
 following to the sidebar part in your `default.template` (ensure that you haven't disabled `erb` in
 the processing pipeline):
 
-    <%% if node.node_info[:page].blocks.has_key?('sidebar') %>
+    <%% if context.node.node_info[:page].blocks.has_key?('sidebar') %>
       <webgen:block name='sidebar' />
     <%% end %>
 
@@ -208,8 +211,8 @@ having menu entries that point to the same page and links to external pages.
 
 ### ... use short menu title?
 
-You can use a special of the meta information `link_attrs` to achieve that. Just use the following
-in the meta information block of the page file for which you want a short menu title:
+You can use the special meta information key `link_attrs` to achieve that. Just use the following in
+the meta information block of the page file for which you want a short menu title:
 
     link_attrs:
       :link_text: Short title

data/doc/getting_started.page

@@ -21,21 +21,18 @@ The directory in which these directories are in is called the *website directory
 
 Don't worry too much about these directories since webgen is able to create the correct directory
 structure for you. By running the command `webgen create sample_site`, the website directory
-`sample_site` is created with the default website template and website style. You can naturally use
-any available template or style by passing their names to the respective options of the `create`
-command.
-
-> A *website template* provides a starting point for your website. For example, the `project`
-> template defines several pages including a features and about page.
->
-> A *website style* defines the look and feel of your website. webgen comes with many predefined
-> styles (nearly all of them are converted open source web design styles).
+`sample_site` is created with the default website bundles applied. You can naturally use any
+available bundles by passing their names to the `-b` option of the `create` command.
+
+> A *website bundle* defines some starting content for a website. The `default` bundle defines just
+> a sample content file sothat some output can be viewed after webgen is run. All other bundles are
+> style bundles which define the look and feel of your website. webgen comes with many predefined
+> style bundles and nearly all of them are converted open source web design styles.
 {.information}
 
-Don't worry if you don't like the used website style - you can easily change it later. Have a look
-at [the examples section](0.4.x/examples/website_styles/index.html) (note: these are still the
-example from the previous version of webgen but the styles haven't changed) to see demonstrations
-for all shipped website templates and styles!
+Don't worry if you don't like the used website style - you can easily change it later using the
+`webgen apply` command. Have a look at the [Website Styles Reference]({relocatable:
+reference_website_styles.html}) to see demonstrations for all shipped website templates and styles!
 
 Since the basic parts are now in place, you can generate the HTML files. There are two
 possibilities:
@@ -47,11 +44,11 @@ possibilities:
 
 Easy! webgen has used all files in the `src` directory and created the HTML output in the directory
 `out`. Now you just need to open the `out/index.html` file to view your website! However, as we did
-not write any content yet, there is not much to see (only the default pages). So let's do that now!
+not write any content yet, there is not much to see (only the default page). So let's do that now!
 
 > Since webgen automatically creates relative links, you will have a fully functional website
 > without needing a web server! This also implies that you can deploy your website to any directory
-> on your web server and it will just work!
+> on your web server and it will *just work*!
 {.information}