RubyGems - webgen - Versions diffs - 0.4.7 → 0.5.0 - Mend

webgen 0.4.7 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (782) hide show

data/data/webgen/website_styles/andreas06/{images → src/images}/bodybg.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas06/{images → src/images}/boxbg.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas06/{images → src/images}/greypx.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas06/{images → src/images}/header.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas06/{images → src/images}/innerbg.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas06/{images → src/images}/leaves.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas06/{images → src/images}/tabs.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas07/{browserfix.css → src/browserfix.css} RENAMED

File without changes

data/data/webgen/website_styles/andreas07/{default.css → src/default.css} RENAMED

File without changes

data/{doc/examples → data/webgen}/website_styles/andreas07/src/default.template RENAMED

@@ -1,4 +1,3 @@
---- content, html
 <?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:}">
@@ -9,7 +8,6 @@
     <meta name="author" content="Your Name" />
     <meta name="generator" content="webgen - http://webgen.rubyforge.org" />
     <link rel="stylesheet" type="text/css" href="{relocatable: default.css}" />
-    <link rel="stylesheet" type="text/css" href="{resource: webgen-css}" />
     <!--[if IE 6]>
         <link rel="stylesheet" href="{relocatable: browserfix.css}" type="text/css" />
         <![endif]-->
@@ -22,7 +20,7 @@
       <h2>your website slogan</h2>
       <div id="menu">
-        {menu: {menuStyle: vertical, options: {maxLevels: 1}}}
+        {menu: {max_levels: 1}}
       </div>
       <h3>Links:</h3>
@@ -35,7 +33,7 @@
     </div>
     <div id="content">
-      {block:}
+      <webgen:block name="content" />
       <h2>site info</h2>
       <p>&copy; 2005-2006 Your Name | Generated by <a href="http://webgen.rubyforge.org">webgen</a> | Design by <a href="http://andreasviklund.com">Andreas Viklund</a>.</p>

data/data/webgen/website_styles/andreas07/{images → src/images}/bodybg.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas07/{images → src/images}/sidebarbg.gif RENAMED

File without changes

data/data/webgen/website_styles/andreas08/{default.css → src/default.css} RENAMED

File without changes

data/{doc/examples → data/webgen}/website_styles/andreas08/src/default.template RENAMED

@@ -1,4 +1,3 @@
---- content, html
 <?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:}">
@@ -8,7 +7,6 @@
     <meta name="keywords" content="your,keywords,goes,here" />
     <meta name="generator" content="webgen - http://webgen.rubyforge.org" />
     <link rel="stylesheet" href="{relocatable: default.css}" type="text/css" media="screen,projection" />
-    <link rel="stylesheet" type="text/css" href="{resource: webgen-css}" />
     <title>{title:}</title>
   </head>
@@ -21,18 +19,18 @@
       </div>
       <div id="navigation">
-        {menu: {menuStyle: vertical, options: {maxLevels: 1}}}
+        {menu: {max_levels: 1}}
       </div>
       <div id="content">
-        {block:}
+        <webgen:block name="content" />
       </div>
       <div id="subcontent">
         <div class="small box"><strong>Note: </strong>This is a box. It can be used for special messages both in the sidebar and the content section. You could use it for special notes and announcements, but also as a frame for photos. This space can be used for a short website presentation!</div>
         <h2>Nested Menu</h2>
-        {menu: vertical}
+        {menu: }
         <h2>Links</h2>
         <ul class="linkblock">

data/data/webgen/website_styles/andreas09/{default.css → src/default.css} RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{default.template → src/default.template} RENAMED

@@ -1,4 +1,3 @@
---- content, html
 <?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:}">
@@ -9,7 +8,6 @@
     <meta name="author" content="Your Name / Original design by Andreas Viklund - http://andreasviklund.com" />
     <meta name="generator" content="webgen - http://webgen.rubyforge.org" />
     <link rel="stylesheet" href="{relocatable: default.css}" type="text/css" media="screen" />
-    <link rel="stylesheet" href="{resource: webgen-css}" type="text/css" media="screen" />
     <title>{title:}</title>
   </head>
@@ -22,14 +20,14 @@
       </div>
       <div id="mainmenu">
-        {menu: {menuStyle: vertical, options: {maxLevels: 1}}}
+        {menu: {max_levels: 1}}
       </div>
       <div id="wrap">
         <div id="leftside">
           <h1>Page Menu</h1>
-          {menu: {menuStyle: section}}
+          {menu: {used_nodes: fragments}}
 	  <h1>Color</h1>
 	  <p>This website style is available in many different colors. Just copy one of the <code>menuhover-COLOR.jpg</code> and <code>bodybg-COLOR.jpg</code> over <code>menuhover.jpg</code> and <code>bodybg.jpg</code> and your are done. You can then delete the other menuhover-* and bodybg-* images.</p>
@@ -52,13 +50,13 @@
         </div>
         <div id="navbar" class="content">
-          <span class="leftbox">Location: {breadcrumbTrail: }</span>
+          <span class="leftbox">Location: {breadcrumb_trail: }</span>
           <span class="rightbox">Language: {langbar: }</span>
           <div class="clearingdiv">&nbsp;</div>
         </div>
         <div id="content">
-          {block:}
+          <webgen:block name="content" />
         </div>
         <div class="clearingdiv">&nbsp;</div>

data/data/webgen/website_styles/andreas09/{images → src/images}/bodybg-black.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/bodybg-green.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/bodybg-orange.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/bodybg-purple.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/bodybg-red.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/bodybg.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/footerbg.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/menuhover-black.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/menuhover-green.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/menuhover-orange.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/menuhover-purple.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/menuhover-red.jpg RENAMED

File without changes

data/data/webgen/website_styles/andreas09/{images → src/images}/menuhover.jpg RENAMED

File without changes

data/data/webgen/website_styles/{default → simple}/README RENAMED

File without changes

data/data/webgen/website_styles/{default → simple/src}/default.css RENAMED

File without changes

data/{doc/examples/website_styles/default → data/webgen/website_styles/simple}/src/default.template RENAMED

@@ -1,4 +1,3 @@
---- content, html
 <?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:}">
@@ -10,7 +9,6 @@
     <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" />
-    <link href="{resource: webgen-css}" rel="stylesheet" type="text/css" />
   </head>
   <body>
     <div id="header">
@@ -18,17 +16,17 @@
     </div>
     <div id="headerbar" class="bar">
-      <span class="left">Location: {breadcrumbTrail: }</span>
+      <span class="left">Location: {breadcrumb_trail: }</span>
       <span class="right">Language: {langbar: }</span>
       <div style="clear:both"></div>
     </div>
     <div id="menu">
-      {menu: vertical}
+      {menu: }
     </div>
     <div id="body">
-      {block: }
+      <webgen:block name="content" />
     </div>
     <div id="footer" class="bar">

data/data/webgen/website_templates/default/README CHANGED

@@ -4,5 +4,3 @@ description:
 author:
   Thomas Leitner
----
-note: This file can be deleted!

data/data/webgen/website_templates/default/src/index.page CHANGED

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

data/data/webgen/website_templates/project/README CHANGED

@@ -1,9 +1,5 @@
 description:
   This template provides the basic files for a website for a software project.
-  You just need to fill in the correct data in the provided files and there
-  you go!
 author:
   Thomas Leitner
----
-note: This file can be deleted!

data/data/webgen/website_templates/project/src/about.page CHANGED

@@ -1,12 +1,12 @@
 ---
 title: About
-inMenu: true
-orderInfo: 10
+in_menu: true
+sort_info: 10
 ---
-h2. About Project XXX
+## About Project TODO
 Description of project!
-h2. About the Author
+## About the Author
-bla bla bla
+Enter information about yourself here!

data/data/webgen/website_templates/project/src/download.page CHANGED

@@ -1,9 +1,9 @@
 ---
 title: Download
-inMenu: true
-orderInfo: 30
+in_menu: true
+sort_info: 30
 ---
-h2. Download
+## Download
 Download link will be here!

data/data/webgen/website_templates/project/src/features.page CHANGED

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

data/data/webgen/website_templates/project/src/index.page CHANGED

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

data/data/webgen/website_templates/project/src/screenshots.page CHANGED

@@ -1,17 +1,17 @@
 ---
 title: Screenshots
-inMenu: true
-orderInfo: 40
+in_menu: true
+sort_info: 40
 ---
-h2. Screenshots
+## Screenshots
-h3. Main View
+### Main View
 Image of Main View
 Description of image
-h3. Next image
+### Next image
 Image

data/doc/contentprocessor/erb.page ADDED

@@ -0,0 +1,38 @@
+---
+title: Webgen::ContentProcessor::Erb
+---
+> TODO: This needs to be redone
+{.exclamation}
+#### Evaluating ERB Tags
+TODO: ev move this to the ContentProcessor/Erb documentation???
+The evaluation of ERB (embedded ruby) tags is optional and only done if the meta information
+`useERB` is set to `true`. The use of ERB allows to add dynamic content without using webgen tags.
+Following is an example of a file which uses ERB:
+<notextile>
+<pre>
+\---
+title: Test page with ERB
+useERB: true
+\---
+This page has the following meta info items:
+&lt;% node.meta_info.each do |key, value| %&gt;
+    * &lt;%=key %&gt;: &lt;%=value %&gt;
+&lt;% end %&gt;
+</pre>
+</notextile>
+This would output all meta information for the file. There are some objects available which you can
+use in your ERB code:
+* `node`: the node for the current file (normally a page file)
+* `ref_node`: the reference node, i.e. the node in which the content will be embedded (normally a
+  template file)
+*Caveat*: you may need to ensure that the ERB start and end tags are not processed by the content
+converter. For example, with Textile you may need to surround the ERB code with &lt;textile&gt;
+tags!

data/doc/contentprocessor/tags.page ADDED

@@ -0,0 +1,61 @@
+---
+title: Webgen::ContentProcessor::Tags
+---
+> TODO: This needs to be redone!
+{.exclamation}
+### webgen Tags
+TODO: remove this whole section since it depends on the processing pipeline??? or add a special
+section explaining the processing pipeline. ev. move this to the docu for the tags processor. or
+still better move this to its own reference section since this is a special webgen construct
+Tags are used to generate content. During processing of a file in WebPage Format so called 'tags'
+are replaced with dynamic content. For example, the menu you can see to the left was generated by a
+tag. This makes it easier to add or remove menu items. If the menu was not generated, you would have
+to change every file which uses the menu.
+#### Usage
+Tags are defined by a special markup code. A tag has the following structure:
+    \{tagname: {parameters}}
+Every time a tag is found in a file, the registered plugin for the tag is called. The plugin returns
+a string which is put into the output file instead of the tag. The output a tag plugin can produce
+ranges from something simple to something complex. For example, the Tag/Meta plugin copies any
+additional meta information specified in the file verbatim into the correct place in the output
+file. And in contrast, the Tag/Menu plugin generates a whole menu tree.
+If you want to use the markup code used for tags, you need to escape the tag with a backslash, like
+this:
+    \\\{tagname: {parameters}}
+#### Parameters
+A tag can have zero or more parameters some of which are mandatory. You can see the supported
+parameters (and if they are mandatory) for each tag on the tag's plugin page. The default mandatory
+parameter can be specified in a special way, see the examples below. The format used for parsing the
+parameters is YAML.
+Here some examples with tags and parameters:
+<table class="examples">
+<tr>
+  <th>Usage</th><th>Output</th>
+</tr>
+<tr>
+  <td>`\{tagname: }`</td>
+  <td>No parameters specified</td>
+</tr>
+<tr>
+  <td>`\{tagname: test.html}`</td>
+  <td>The default mandatory parameter is set to `test.html`. This form can only be used if there is only one mandatory parameter</td>
+</tr>
+<tr>
+  <td>`\{tagname: {param1: value1, param2: value2}}`</td>
+  <td>Two parameters (param1 and param2) specified</td>
+</tr>
+</table>

data/doc/extensions.page ADDED

@@ -0,0 +1,11 @@
+---
+title: Extensions
+in_menu: true
+---
+> TODO: This needs to be filled with real docu.
+{.exclamation}
+# webgen Extensions
+webgen comes with many extensions. Below is a list of all extensions:

data/doc/faq.page ADDED

@@ -0,0 +1,177 @@
+---
+title: FAQ
+---
+# General Questions
+> This section does not have any content yet. If you have any good questions, please write an email!
+{.exclamation}
+# How to ...
+This section provides quick answers and links to more information for the most commonly asked
+questions.
+### ... create a website?
+Use the `webgen` command to create the needed directories
+    webgen create -t project -s andreas07 my_site
+This will create a webgen website in the directory `my_site` using the specified template and style.
+### ... set configuration options?
+You can set any configuration options via the configuration file called `config.yaml`. For example,
+say you want to set the option `website.link_to_current_page` to `true`, then you would add the
+following to the configuration file:
+    website.link_to_current_page: true
+There is a second possibility for webgen tags: you can set the options directly in the tag
+definition, like this:
+    \{menu: {start_level: 2, min_levels: 3}}
+And if you want to have complete control over the configuration options, you can use the file
+`ext/init.rb`. For example, the following specifies that all page files should be in the menu by
+default:
+    config = Webgen::WebsiteAccess.website.config
+    config['sourcehandler.default_meta_info']['Webgen::SourceHandler::Page']['in_menu'] = true
+### ... change the default language?
+To use, for example, German as the default language, put the following into the configuration file:
+    website.lang: de
+The value needs to be a valid ISO-639-1/2 language code.
+### ... use a different processing pipeline for page files?
+If you want to change the processing pipeline (ie. how a page file get rendered), you need to add
+the following to your configuration file:
+    default_meta_info:
+      Webgen::SourceHandler::Page:
+        blocks:
+          default:
+            pipeline: erb,tags,textile,blocks
+Substitute the value of the `pipeline` key approriately.
+If you just want to change the pipeline for one block, you can do it like this:
+    --- pipeline:erb,tags,textile,blocks
+    This is the content of the block
+### ... set the default meta information for files created by a specific source handler?
+Use the configuration file! For example, to change the meta information `in-menu` sothat it defaults
+to `true` for all page files use the following in your configuration file:
+    default_meta_info:
+      Webgen::SourceHandler::Page:
+        inMenu: true
+The key `default_meta_info` is a special key in the configuration file which allows to update the
+default meta information for a source handler and not to substitute it.
+### ... ignore files in the source directory?
+This can be done using the `sourcehandler.ignore` configuration options. For example, to ignore all
+files starting with `core`, you would put the following in the configuration file:
+    sourcehandler.ignore: [**/core*]
+The value of this option has to be an array of path patterns. Be aware that this overwrites the
+default setting.
+### ... change the output name style?
+You have several options of varying granularity:
+* Set the meta information `output_path_style` for all source handlers:
+      default_meta_info:
+        :all:
+          output_path_style: [:parent, :cnbase, [., :lang], :ext]
+* Set the meta information `output_path_style` for a specific source handler to only change the
+  output paths of this source handler (the page source handler in the following example):
+      default_meta_info:
+        Webgen::SourceHandler::Page:
+          output_path_style: [:parent, :cnbase, [., :lang], :ext]
+* Add the meta information `output_path_style` to a single file via, for example, a meta information
+  backing file.
+### ... modify the template chain?
+To stop the template chain at a specific template or even at the page file itself, specify a
+null template in the meta information, like this:
+    template: ~
+To nest templates, you just need to specify the template, in which this template/page file should be
+nested, in the meta information:
+    template: my_special.template
+Be aware that if no `template` meta information is specified for a page or template file, the
+template handler automatically searches for a default template in the directory and the parent
+directories of the file!
+### ... localize a directory name?
+Just set the `routed_title` meta information on the correct localized directory index files.
+### ... provide additional attributes on links to a file?
+You can specify additional attributes for a link to a file by using the `link_attrs` meta
+information. Take the following page file:
+    ---
+    title: Tutorial
+    in_menu: true
+    link_attrs:
+      title: This is a rather large tutorial
+      accesskey: D
+      tabindex: 5
+    ---
+    Yippieh, this is my tutorial!
+When a link to this page is created, the specified attributes get additionally set on the link!
+### ... add page specific sidebar content?
+There are many ways to accomplish this, I will show only one way here using blocks. Add the
+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') %>
+      \<webgen:block name='sidebar' />
+    <% end %>
+This will include the contents of the block `sidebar` in the sidebar if such a block exists for a
+page. You can then add a sidebar block to each page file which needs it. Following is such a sample
+page file:
+    This is the main content block
+    --- sidebar
+    This is the sidebar block and everything in here goes to the sidebar!
+### ... create XML output?
+This can be achieved manually (by removing any markup processor in the processing pipeline of the
+page file and then directly creating the XML elements) or by changing the processing pipeline to
+include content processor `builder` which provides an easy way of programmatically creating an XML
+compliant file. More information on this can be found on the documentation page of
+Webgen::ContentProcessor::Builder!
+### ... create a static menu?
+You can use virtual nodes to define virtually any menu structure you like, including things like
+having menu entries that point to the same page and links to external pages.