webgen 0.5.10 → 0.5.11

data/Rakefile

@@ -64,6 +64,7 @@ Webgen::WebgenTask.new('htmldoc') do |site|
         ["/website_styles/#{name.sub(prefix, '')}/", 'Webgen::Source::Resource', name, '/src/**', '/src/']
     end
     config['output'] = ['Webgen::Output::FileSystem', 'htmldoc']
+    config.default_processing_pipeline('Page' => 'erb,tags,kramdown,blocks,fragments')
   end
 end
 
@@ -160,20 +161,20 @@ EOF
 
       s.files = PKG_FILES.to_a
       s.add_dependency('cmdparse', '>= 2.0.2')
-      s.add_dependency('maruku', '0.5.9')
-      s.add_dependency('facets', '2.4.5')
+      s.add_dependency('kramdown', '>= 0.5.0')
+      s.add_development_dependency('maruku', '>= 0.6.0')
       s.add_development_dependency('rake', '>= 0.8.3')
       s.add_development_dependency('ramaze', '>= 2009.04')
       s.add_development_dependency('launchy', '>= 0.3.2')
       s.add_development_dependency('rcov', '>= 0.8.1.2.0')
-      s.add_development_dependency('rubyforge', '>= 1.0.0')
+      s.add_development_dependency('rubyforge', '>= 2.0.2')
       s.add_development_dependency('RedCloth', '>= 4.1.9')
-      s.add_development_dependency('haml', '>= 2.0.9')
+      s.add_development_dependency('haml', '>= 2.2.7')
       s.add_development_dependency('builder', '>= 2.1.0')
-      s.add_development_dependency('rdoc', '>= 2.4.2')
+      s.add_development_dependency('rdoc', '>= 2.4.3')
       s.add_development_dependency('coderay', '>= 0.8.312')
-      s.add_development_dependency('erubis', '>= 2.6.2')
-      s.add_development_dependency('rdiscount', '>= 1.2.9')
+      s.add_development_dependency('erubis', '>= 2.6.5')
+      s.add_development_dependency('rdiscount', '>= 1.3.5')
       s.add_development_dependency('archive-tar-minitar', '>= 0.5.2')
 
       s.require_path = 'lib'
@@ -199,27 +200,6 @@ EOF
       pkg.need_tar = true
     end
 
-    desc 'Generate gemspec file for github'
-    task :gemspec do
-      spec.version = Webgen::VERSION + '.' + Time.now.strftime('%Y%m%d')
-      spec.summary = 'webgen beta build, not supported!!!'
-      spec.files = spec.files.reject {|f| f == 'VERSION' || f == 'ChangeLog'}
-      spec.post_install_message = "
-
-
-WARNING: This is an unsupported BETA version of webgen which may
-still contain bugs!
-
-The official version is called 'webgen' and can be installed via
-
-    gem install webgen
-
-
-
-"
-      File.open('webgen.gemspec', 'w+') {|f| f.write(spec.to_yaml)}
-    end
-
   end
 
   desc "Upload webgen documentation to Rubyforge homepage"
@@ -250,6 +230,10 @@ The official version is called 'webgen' and can be installed via
       files = %w[.gem .tgz .zip].collect {|ext| "pkg/webgen-#{Webgen::VERSION}" + ext}
 
       rf.add_release('webgen', 'webgen', Webgen::VERSION, *files)
+
+      print 'Pushing gem to gemcutter'
+      sh "gem push pkg/webgen-#{Webgen::VERSION}.gem"
+
       puts 'done'
     end
 
@@ -282,6 +266,7 @@ The official version is called 'webgen' and can be installed via
         config['sources'] <<
           ["/documentation/website_styles/#{name.sub(prefix, '')}/", 'Webgen::Source::Resource', name, '/src/**', '/src/']
       end
+      config.default_processing_pipeline('Page' => 'erb,tags,kramdown,blocks,fragments')
     end
   end
 

data/VERSION

@@ -1 +1 @@
-0.5.10
+0.5.11

data/bin/webgen

@@ -1,6 +1,5 @@
-# -*- encoding: utf-8 -*-
-
 #!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
 
 require 'webgen/cli'
 begin

data/data/webgen/passive_sources/templates/atom_feed.template

@@ -11,6 +11,7 @@ template: ~
   </author>
 
   <link href="<%= context.node.feed_link %>" rel="alternate" />
+  <link href="<%= Webgen::Node.url(File.join(context.node['site_url'], context.node.path), false) %>" rel="self" />
   <generator uri="http://webgen.rubyforge.org/documentation/sourcehandler/feed.html" version="<%= Webgen::VERSION %>">
     webgen - Webgen::SourceHandler::Feed
   </generator>

data/data/webgen/website_bundles/style/andreas07/src/default.css

@@ -71,10 +71,10 @@ body > #sidebar
 #menu a:hover, #menu span:hover
 {color:#303030; background:#f0f0f0 url(images/sidebarbg.gif) top right repeat-y;}
 
-#menu li.webgen-menu-item-selected a, #menu li.webgen-menu-item-selected span
+#menu li.webgen-menu-item-selected a, #menu li.webgen-menu-item-selected span, #menu li.webgen-menu-submenu-inhierarchy span
 {padding:5px 18px 5px 0; background:#fafafa; border-top:2px solid #c0c0c0; border-bottom:2px solid #c0c0c0;}
 
-#menu li.webgen-menu-item-selected a:hover, #menu li.webgen-menu-item-selected span:hover
+#menu li.webgen-menu-item-selected a:hover, #menu li.webgen-menu-item-selected span:hover, #menu li.webgen-menu-submenu-inhierarchy span:hover
 {color:#505050; background:#fafafa;}
 
 /**************** Content area styles ****************/

data/data/webgen/website_skeleton/config.yaml

@@ -1,3 +1,4 @@
+#####
 # This is the YAML configuration file for webgen used to set configuration options.
 #
 # The general syntax is:
@@ -8,11 +9,27 @@
 #
 #   website.lang: de
 #
-# 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 as strings, integers, dates, arrays, hashes and more.
+# 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 as strings,
+# integers, dates, arrays, hashes and more.
 #
-# The available configuration options can be found on the homepage in the
-# Configuration Option Reference at
+# The available configuration options can be found on the homepage in the Configuration Option
+# Reference at
 #
 #     http://webgen.rubyforge.org/documentation/reference_configuration.html
+#
+# Some common use cases are shown below.
+#####
+
+## The default processing pipeline for page files. If you use a different markup language you need to
+## change 'markdown' to the short name of the content processor for the markup language.
+default_processing_pipeline:
+  Page: erb,tags,markdown,blocks,fragments
+
+## Setting the default language. The argument must be an ISO-639-1/2 language code.
+# website.lang: de
+
+## Adding some extensions to the copy source handler.
+# patterns:
+#   Copy:
+#     add: [**/*.pdf, **/*.djvu]

data/doc/contentprocessor.template

@@ -1,9 +1,9 @@
 ---
 template: extensions.template
---- name:summary pipeline:erb,tags,maruku,blocks
+--- name:summary pipeline:erb,tags,kramdown,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
+file in [Webgen Page Format](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(', ') %>`.
 

data/doc/contentprocessor/blocks.page

@@ -15,9 +15,9 @@ So it is basically an XML tag with the mandatory attribute `name` and the option
 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.
+determined via the `template` meta information (see
+[SourceHandler::Template](../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
@@ -60,7 +60,7 @@ Following is the documentation for the available attributes of the tag:
     node in the node chain).
 
     > Note that the attribute `chain` is not used in this situation!
-    {.important}
+    {:.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

@@ -5,14 +5,13 @@ title: Webgen::ContentProcessor::Builder
 
 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}).
+objects provided by webgen available - have a look at the [erb documentation](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}
+{:.warning}
 
 
 ## Examples

data/doc/contentprocessor/erb.page

@@ -57,4 +57,4 @@ output the result of the Ruby code (note the equation sign!). And the fourth lin
 > You may need to ensure that the ERB start and end tags are not processed by the content
 > processor. For example, when using the RedCloth content processor, you may need to surround the
 > ERB code with `<notextile>` tags!
-{.important}
+{:.important}

data/doc/contentprocessor/erubis.page

@@ -11,17 +11,17 @@ options.
 > way to do this is via Rubygems:
 >
 >     gem install erubis
-{.warning}
+{:.warning}
 
 [1]: http://www.kuwata-lab.com/erubis/ "Erubis Homepage"
 
 You can use some special objects provided by webgen in your embedded Ruby code. These are the same
 objects that are available to the `erb` processor, have a look at its [documentation
-page]({relocatable: erb.html}).
+page](erb.html).
 
-The default mode of Erubis works like ERB. So everyting said on the [erb page]({relocatable:
-erb.html}) is also true for Erubis. However, you can customize how this processor works by using the
-following configuration options:
+The default mode of Erubis works like ERB. So everyting said on the [erb page](erb.html) is also
+true for Erubis. However, you can customize how this processor works by using the following
+configuration options:
 
 * `contentprocessor.erubis.use_pi`: Use processing instructions instead of ERB like
   instructions. Normally you use statements like `<%% result = some_method_call(opts) %>` or `<%%=

data/doc/contentprocessor/fragments.page

@@ -10,14 +10,15 @@ attribute set.
 > context! This is to ensure that fragment nodes are not created from multiple block of one page
 > file. So this content processor has no effect when used in the pipeline of blocks except if the
 > block is named `content`.
-{.warning}
+{:.warning}
 
-The default markup language Maruku automatically generates an `id` attribute for all headers. If you
-use another markup language or plain old HTML, you might need to set the `id` attributes by hand.
+The default markup language kramdown automatically generates an `id` attribute for all headers. If
+you use another markup language or plain old HTML, you might need to set the `id` attributes by
+hand.
 
 > The reason why only header tags with an `id` attribute are used is that only those can be
 > referenced and linked to later.
-{.information}
+{:.information}
 
 The generated fragment nodes can be used like any other node. So you can link to them and use them
 in a menu. Concerning the menu, there is a setting for the `tag.menu.used_nodes` option called

data/doc/contentprocessor/haml.page

@@ -8,14 +8,13 @@ XHTML by using the Haml library. For detailed information about Haml have a look
 Homepage][1]!
 
 You can use some special objects provided by webgen in your Haml markup. These are the same objects
-that are available to the `erb` processor, have a look at its [documentation page]({relocatable:
-erb.html}).
+that are available to the `erb` processor, have a look at its [documentation page](erb.html).
 
 > This extension is only available if you have installed the [haml][1] library. The preferred way to
 > do this is via Rubygems:
 >
 >     gem install haml
-{.warning}
+{:.warning}
 
 
 ## Example

data/doc/contentprocessor/head.page

@@ -3,13 +3,23 @@ title: Webgen::ContentProcessor::Head
 ---
 ## Description
 
-This processor inserts before the end of the HTML head section links to used javascript and css
-files, inline javascript and css content and general meta tags. This functionality can be used, for
-example, by webgen tags to add needed javascript or css fragments on a page-per-page basis.
+This processor is used to insert various HTML tags (`link`, `script` and `meta`) before the end of
+the HTML head section. The tags that tags are inserted can be specified in various ways:
 
-It can also be used to insert arbitrary meta tags on a page-per-page basis. This can be done by
-setting the meta information named [`meta`]({relocatable: ../reference_metainfo.html#meta}) on a
-page file.
+* Links to used javascript and css files, inline javascript and css content and general meta tags
+  can be set by webgen tags (or by any other webgen extension) on a page-per-page basis.
+
+* Arbitrary meta tags can be inserted on a page-per-page basis by the user by setting the meta
+  information named [`meta`](../reference_metainfo.html#meta) on a page file.
+
+* Links to javascript and/or CSS files can be inserted by the user by setting the meta information
+  named [`link`](../reference_metainfo.html#link).
+
+* Arbitrary link tags can also be inserted by setting the meta information named
+  [`link`](../reference_metainfo.html#link). This allows one, for example, to specify which page
+  file logically follows or precedes a given page file.
+
+The processor also automatically inserts `link` tags to translations of the rendered page file.
 
 This content processor should be used on template files since its output is only useful in the head
 section of an HTML file. And it should be the last content processor in the pipeline because

data/doc/contentprocessor/kramdown.page

@@ -0,0 +1,49 @@
+---
+title: Webgen::ContentProcessor::Kramdown
+---
+## Description
+
+This processor converts the content, which is assumed to be in kramdown format, to HTML by using the
+[kramdown][1] library. The kramdown format is basically Markdown with some extensions like automatic
+header ID generation, using markup inside HTML elements and some more. There are a [quick
+reference][2] and a detailed [syntax documentation][3] available on the kramdown homepage.
+
+One can customize how this processor works by using the following configuration options:
+
+* `contentprocessor.kramdown.handle_links`: If `true` (the default), then all link URLs created via
+  kramdown syntax are automatically run through the [relocatable tag](../tag/relocatable.html). This
+  avoids using the `relocatable` tag explicitly but ensures valid links nonetheless.
+
+* `contentprocesoor.kramdown.options`: This configuration option can be used to customize the
+  kramdown processor. Have a look at the [kramdown homepage][1] for available options.
+
+> kramdown is the default markup content processor for webgen as its markup syntax is easy to learn
+> and nice to look at. Give it a try!
+{:.info}
+
+Example
+-------
+
+Here is a short sample of a text in kramdown markup:
+
+    # This a h1 header
+    {:#myid}
+
+    You can just write *your* paragraphs here and
+    [link][1] them below. This is **nice** format!
+
+    > Citations are easy too.
+    > Really. And you can assign them attributes.
+    {:.information}
+
+    * Lists
+    * aren't
+    * difficult
+    * either.
+
+    [1]: http://someurl.com
+
+
+[1]: http://kramdown.rubyforge.org/
+[2]: http://kramdown.rubyforge.org/syntax.html
+[3]: http://kramdown.rubyforge.org/quickref.html

data/doc/contentprocessor/less.page

@@ -0,0 +1,34 @@
+---
+title: Webgen::ContentProcessor::Less
+---
+## Description
+
+This content processor converts content in LESS format to valid CSS using the [LESS library][1].
+
+LESS is an extension of CSS which allows the use of variables, mixins, operations and nested rules.
+Since a normal CSS file is a valid LESS file, the transition to LESS is very easy. For detailed
+information about LESS have a look at its [documentation page][2]!
+
+> This extension is only available if you have installed the [less][1] library. The preferred way to
+> do this is via Rubygems:
+>
+>     gem install less
+{:.warning}
+
+
+## Example
+
+Here is a short sample of a text in LESS format:
+
+    @base: #543;
+
+    #header {
+      color: @base;
+      a {
+        color: @base * 2;
+        text-decoration: underline;
+      }
+    }
+
+[1]: http://lesscss.org/
+[2]: http://lesscss.org/docs.html

data/doc/contentprocessor/maruku.page

@@ -12,9 +12,12 @@ For detailed information about Maruku have a look at the [Maruku Homepage][1]. T
 information about the general Markdown syntax as well as information about the extras added by
 Maruku.
 
-> Maruku is the default markup content processor for webgen as its markup syntax is easy to learn
-> and nice to look at. Give it a try!
-{.info}
+> This extension is only available if you have installed the [maruku][1] library. The preferred
+> way to do this is via Rubygems:
+>
+>     gem install maruku
+{:.warning}
+
 
 Example
 -------

data/doc/contentprocessor/rdiscount.page

@@ -5,14 +5,14 @@ title: Webgen::ContentProcessor::RDiscount
 
 This processor converts the content, which is assumed to be in Markdown markup, to HTML by using the
 RDiscount library. This library is based on the C based discount library which provides very fast
-Markdown processing. However, this processor does not support advanced features like the [Maruku
-Markdown processor]({relocatable: maruku.html}) does.
+Markdown processing. However, this processor does not support advanced features like the [kramdown
+processor](kramdown.html) or [Maruku Markdown processor](maruku.html) do.
 
 > This extension is only available if you have installed the [rdiscount][1] library. The preferred
 > way to do this is via Rubygems:
 >
 >     gem install rdiscount
-{.warning}
+{:.warning}
 
 [1]: http://github.com/rtomayko/rdiscount
 

data/doc/contentprocessor/rdoc.page

@@ -11,7 +11,7 @@ for Ruby source files, [reference][1]) to HTML.
 > implementation is via Rubygems:
 >
 >     gem install rdoc
-{.warning}
+{:.warning}
 
 [1]: http://rdoc.rubyforge.org/rdoc/ "RDoc Reference"
 [2]: http://rubyforge.org/projects/rdoc/ "New RDoc implementation"

data/doc/contentprocessor/redcloth.page

@@ -10,7 +10,7 @@ RedCloth library. For detailed information about Textile have a look at the [Tex
 > way to do this is via Rubygems:
 >
 >     gem install RedCloth
-{.warning}
+{:.warning}
 
 You can use the configuration option `contentprocessor.redcloth.hard_breaks` to enable/disable the
 conversion of single newlines into HTML break tags.