RubyGems - thewoolleyman-webgen - Versions diffs - 0.5.8.20090419 - Mend

@@ -0,0 +1,6 @@
+description:
+  Provides a minimalistic default style. The style defines a horizontal header, a horizontal bar with
+  the breadcrumb trail and the language menu, then a menu on the left and a footer.
+author:
+  Thomas Leitner

data/data/webgen/website_styles/simple/src/default.css ADDED Viewed

@@ -0,0 +1,84 @@
+#all { background-color: #CCCCCC; }
+#header {
+  border-bottom: 1px solid black;
+  padding: 1ex;
+  background-color: #888888;
+}
+#header h1 {
+  margin: 0ex;
+  font-size: 300%;
+  font-style: italic;
+  font-weight: normal;
+}
+#headerbar { border-bottom: 1px solid black; }
+#footer { border-top: 1px solid black; }
+#body {
+  margin-left: 250px;
+  margin-right: 20px;
+  padding: 10px;
+}
+#menu {
+  float: left;
+  width: 230px;
+  padding: 20px 0px 0px 2px;
+}
+.bar {
+  clear: both;
+  padding: 3px;
+  text-align: center;
+  font-size: 90%;
+  background-color: #AAAAAA;
+}
+.left, .right {
+  padding: 0px 1em;
+}
+.left {
+  float: left;
+  text-align: left;
+}
+.right {
+  float: right;
+  text-align: right;
+}
+/* styling the menu */
+#menu a, #menu span {
+  text-decoration: none;
+  font-weight: bold;
+  font-size: 130%;
+}
+#menu a:hover {
+  text-decoration: underline;
+}
+#menu .webgen-menu-item-selected {
+  border-left: 3px solid black;
+}
+#menu ul {
+  list-style-type: none;
+  padding: 0px;
+  margin-left: 10px;
+}
+#menu li > ul {
+  font-size: 95%;
+}
+#menu li {
+  margin: 0.0em 0px;
+  padding: 2px 0px;
+  padding-left: 5px;
+  border-left: 3px solid #CCCCCC;
+}

data/data/webgen/website_styles/simple/src/default.template ADDED Viewed

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
+  <head>
+    <title>{title: }</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="description" content="Your description goes here..." />
+    <meta name="keywords" content="your,keywords,goes,here" />
+    <meta name="author" content="Your Name" />
+    <meta name="generator" content="webgen - http://webgen.rubyforge.com/" />
+    <link href="{relocatable: default.css}" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    <div id="header">
+      <h1>{title: }</h1>
+    </div>
+    <div id="headerbar" class="bar">
+      <span class="left">Location: {breadcrumb_trail: }</span>
+      <span class="right">Language: {langbar: }</span>
+      <div style="clear:both"></div>
+    </div>
+    <div id="menu">
+      {menu: {used_nodes: files}}
+    </div>
+    <div id="body">
+      <webgen:block name="content" />
+    </div>
+    <div id="footer" class="bar">
+      Generated by <a href="http://webgen.rubyforge.org">webgen</a> on <b>{date: }</b>
+    </div>
+  </body>
+</html>

data/data/webgen/website_templates/default/README ADDED Viewed

@@ -0,0 +1,6 @@
+description:
+  This is the default website template. It only contains the basic files and is a good
+  starting place for any website.
+author:
+  Thomas Leitner

data/data/webgen/website_templates/default/src/index.page ADDED Viewed

@@ -0,0 +1,8 @@
+---
+title: Empty index page
+in_menu: true
+routed_title: New Website
+---
+## Empty index file
+Fill this file with your own data!!!

data/data/webgen/website_templates/project/README ADDED Viewed

@@ -0,0 +1,5 @@
+description:
+  This template provides the basic files for a website for a software project.
+author:
+  Thomas Leitner

data/data/webgen/website_templates/project/src/about.page ADDED Viewed

@@ -0,0 +1,12 @@
+---
+title: About
+in_menu: true
+sort_info: 10
+---
+## About Project TODO
+Description of project!
+## About the Author
+Enter information about yourself here!

data/data/webgen/website_templates/project/src/download.page ADDED Viewed

@@ -0,0 +1,15 @@
+---
+title: Download
+in_menu: true
+sort_info: 30
+---
+## Download
+Download link will be here!
+List of dependencies:
+* Dep One v. 3.3.3
+* Dep Two v. 2.5.1 (optional)

data/data/webgen/website_templates/project/src/features.page ADDED Viewed

@@ -0,0 +1,8 @@
+---
+title: Features
+in_menu: true
+sort_info: 20
+---
+## Features
+Here is the place where the feature list for your project should go.

data/data/webgen/website_templates/project/src/index.page ADDED Viewed

@@ -0,0 +1,9 @@
+---
+title: Homepage
+in_menu: true
+sort_info: 0
+routed_title: Project TODO
+---
+## Project TODO
+This is the first page your viewers will see!

data/data/webgen/website_templates/project/src/screenshots.page ADDED Viewed

@@ -0,0 +1,18 @@
+---
+title: Screenshots
+in_menu: true
+sort_info: 40
+---
+## Screenshots
+### Main View
+Image of Main View
+Description of image
+### Next image
+Image
+bla bla bla

data/doc/contentprocessor.template ADDED Viewed

@@ -0,0 +1,11 @@
+---
+template: extensions.template
+--- name:summary pipeline:erb,tags,maruku,blocks
+As short name for the content processor (used, for example, in the `pipeline` option of a block in a
+file in [Webgen Page Format]({relocatable: webgen_page_format.html})) one of the following can be
+used: `<%= context.website.config['contentprocessor.map'].select {|k,v| v ==
+context.content_node['title']}.map {|k,v| k}.join(', ') %>`.
+--- name:content
+<webgen:block name='content' />

data/doc/contentprocessor/blocks.page ADDED Viewed

@@ -0,0 +1,129 @@
+---
+title: Webgen::ContentProcessor::Blocks
+---
+## Description
+This processor replaces a special xml tag with rendered blocks. It is used, for example, in
+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='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`. 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. 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 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
+  defined in all page files.
+All this is more easily explained with examples. Assume that we have a `default.template` file, a
+`page.template` file and a `my.page` file with the following contents:
+The `default.template` file:
+    --- name:content pipeline:blocks
+    before default
+    <webgen:block name='content' />
+    after default 1
+    <webgen:block name='content' chain='page.template;my.html' />
+    after default 2
+    <webgen:block name='optional' chain='page.template;my.html' node='first' />
+    after default 3
+    <webgen:block name='invalid' notfound='ignore' />
+    after default 4
+The `page.template` file:
+    --- name:content pipeline:blocks
+    before page 1
+    <webgen:block name='content' />
+    after page 1
+And the `my.page` file:
+    --- name:content pipeline:
+    The content of the page file.
+    --- name:optional pipeline:
+    Optional content.
+When `my.page` gets rendered to `my.html`, the node chain looks like this by default:
+    default.template ---> my.html
+The first webgen block tag just inserts the rendered block named `content` of `my.page`. The second
+block tag uses a custom node chain. Therefore the block named `content` of `page.template` gets
+rendered using the node chain:
+    page.template ---> my.html
+and then inserted. The third block tag uses the same custom node chain but for a block named
+`optional`. This block does not exist in `page.template` but it does exist in `my.page`. Since the
+`node` attribute is set to `first`, the first node `page.template` in the node chain is ignored and
+the block is found in `my.page` (if the `node` attribute is not specified, an error will be raised).
+The fourth block tag specifies a block name that does not occur in `my.page`. However, since the
+optional attribute `notfound` is set to `ignore`, this error is ignored.
+Summing up the above, the rendered file `my.html` will then look like this:
+    before default 1
+    The content of the page file.
+    after default 1
+    before page 1
+    The content of the page file.
+    after page 1
+    after default 2
+    Optional content.
+    after default 3
+    after default 4

data/doc/contentprocessor/builder.page ADDED Viewed

@@ -0,0 +1,80 @@
+---
+title: Webgen::ContentProcessor::Builder
+---
+## Description
+This content processor can be used to programatically create XHTML/XML documents
+([Reference][1]). The top builder object is provided through the `xml` object. There are also other
+objects provided by webgen available - have a look at the [erb documentation]({relocatable:
+erb.html}).
+> This extension is only available if you have installed the [builder][1] library. The preferred way
+> to do this is via Rubygems:
+>
+>     gem install builder
+{.warning}
+## Examples
+Here is a short sample of content that is valid Ruby and uses the special `xml` object:
+    xml.h1("This a h1 header", :id => 'myid')
+    xml.p do |p|
+      p.text! "You can just write "
+      p.b "your"
+      p.text! "paragraphs here and"
+      p.a("link", :href => "http://someurl.com")
+      p.text! "them below. This is also a"
+      p.i "nice"
+      p.text! "format!"
+    end
+    xml.blockquote(:class => 'information') do |bq|
+      bq.text! "Citations are easy too."
+      bq.text! "Really. And you can assign them attributes."
+    end
+    xml.ul do |ul|
+      ul.li "Lists"
+      ul.li "aren't"
+      ul.li "difficult"
+      ul.li "either."
+    end
+Following is a complete example which shows how to use this extension in a page file which generates
+a custom XML document (the `content` block has to be valid Ruby!):
+    ---
+    output_path_style: [:parent, :cnbase, ['.', :lang], '.xml']
+    title: Person Object
+    template: ~
+    --- pipeline:builder
+    xml.persons(:path => node.absolute_lcn) do |p|
+      p.person do |b|
+        b.firstname('Thomas')
+        b.lastname('Leitner')
+      end
+      p.person do |b|
+        b.firstname('Other first')
+        b.lastname('Other last')
+      end
+    end
+The above will produce the following output:
+    <persons path="/test.xml">
+      <person>
+        <firstname>Thomas</firstname>
+        <lastname>Leitner</lastname>
+      </person>
+      <person>
+        <firstname>Other first</firstname>
+        <lastname>Other last</lastname>
+      </person>
+    </persons>
+[1]: http://builder.rubyforge.org "Homepage of builder library"