webgen 0.4.7 → 0.5.0

data/doc/src/documentation/plugins/tag/meta.page

@@ -1,21 +0,0 @@
----
-title: Meta
-inMenu: true
-template: /plugin.template
-plugin: Tag/Meta
-dummyForMeta: This is content specified in the meta information section.
----
-h2(#description). Description
-
-
-The meta tag is used to copy meta information verbatim to the output file. For example, if you
-define a meta information with the key <code>revision</code>, you could put the tag
-<code>\{revision: }</code> into a block of the page file and the value gets substituted
-automatically.
-
-
-h2(#examples). Examples
-
-
-There is a meta information called 'dummyForMeta' defined for this page, so when this tag
-@\{dummyForMeta:}@ is used, you get this '@{dummyForMeta:}@'.

data/doc/src/documentation/plugins/tag/news.page

@@ -1,48 +0,0 @@
----
-title: News
-inMenu: true
-template: /plugin.template
-plugin: Tag/News
----
-h2(#description). Description
-
-This plugin creates a 'news' tag which can be used to display the contents of a news file.
-
-The news file by default is 'news.yaml' and placed in the root of the webgen website directory.
-This can be changed with the 'filename' parameter.
-
-The yaml file has the basic format of
-
-  date: content
-  date: content
-
-Where the date has the format indicated by the 'dateFormat' parmater which by default is YYYY-MM-DD.
-The content is formated according to the 'contentFormat' parameter and is textile by default.  I
-recommend using the '|' version of block text for the content.  For example:
-
-<pre>
-  2007-03-20: |
-      h2. this is an entry
-
-      This is some content
-</pre>
-
-When utilized in a template the 'news' tag can optionally take to additional parameters 'maxEntries'
-and 'maxParagraphs'.
-
-* maxEntries: the N most recent entries by date in the news.yaml file to display.
-
-* maxParagraphs: the content of an entry is truncated to N paragraphs, where a paragraphs ending is
-                 defined by "\n\n"
-
-So the following usage of the news tag would disply the first
-paragraph of the most recent item in the news.yaml file.
-
-  \{news: {options: {maxEntries: 1, maxParagraphs: 1}}}
-
-While this usage would display all the contents of the news.yaml file sorted in reverse
-chronological order and displayed fully.
-
-  \{news: }
-
-

data/doc/src/documentation/plugins/tag/relocatable.page

@@ -1,46 +0,0 @@
----
-title: Relocatable
-inMenu: true
-template: /plugin.template
-plugin: Tag/Relocatable
----
-h2(#description). Description
-
-
-This tag ensures that the relative path to the referenced file is always correct.
-
-It is used to change the directory part of the supplied path name and is most often used in template
-files. A relocatable tag looks like this: @\{relocatable: default.css}@. If this was put into a
-template and the template was used by a file in a subdirectory, then the @relocatable@ tag would put
-@../default.css@ into the output file; thus ensuring that the relative path to file is valid!
-
-However, if the specified path is an absolute URL, it will just return it.
-
-*Be aware* that the tag resolves the specified path by using the output names (and the
-<a href="{relocatable: ../file/pagehandler.page#pagename}">standardized page names</a>) of the nodes.
-Also, if the path points to a directory, the path to its index file is returned.
-
-Additionally, if you add an URL fragment to the path, it will also be checked if it exists. This can
-be turned off by setting the parameter {param: Tag/Relocatable:resolveFragment} to @false@.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td><notextile>\{relocatable: /default.css}</notextile></td>
-  <td><notextile>{relocatable: /default.css}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{relocatable: ../core/configuration.page}</notextile></td>
-  <td><notextile>{relocatable: ../core/configuration.page}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{relocatable: ../core}</notextile></td>
-  <td><notextile>{relocatable: ../core}</notextile></td>
-</tr>
-</table>

data/doc/src/documentation/plugins/tag/resource.page

@@ -1,35 +0,0 @@
----
-title: Resource
-inMenu: true
-template: /plugin.template
-plugin: Tag/Resource
----
-h2(#description). Description
-
-
-The resource tag is used to include a resource either verbatim (i.e. its content is copied) or by
-its path. For more information about resources have a look at the {plugin: Core/ResourceManager}.
-
-This tag is mostly used in templates to include the webgen CSS and JS resources.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td><notextile>\{resource: webgen-logo}</notextile></td>
-  <td><notextile>{resource: webgen-logo}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{resource: w3c-valid-xhtml11}</notextile></td>
-  <td><notextile>{resource: w3c-valid-xhtml11}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{resource: {name: webgen-css, insert: data}}</notextile></td>
-  <td><notextile>{resource: {name: webgen-css, insert: data}}</notextile></td>
-</tr>
-</table>

data/doc/src/documentation/plugins/tag/sitemap.page

@@ -1,35 +0,0 @@
----
-title: Sitemap
-inMenu: true
-template: /plugin.template
-plugin: Tag/Sitemap
----
-h2(#description). Description
-
-
-The SitemapTag is used to display a site map of the current website. There are two operation modi:
-if the parameter {param: Tag/Sitemap:honorInMenu} is @true@, then only those pages are shown in the
-sitemap for which the @inMenu@ meta information is set. If it is @false@, then all pages are
-displayed. The tag also respects the @orderInfo@ meta information!
-
-*Caveat*: Only page files are shown in the sitemap and from those not all, but only the ones in the
-language of the page file the sitemap tag is used in (i.e. the tag shows the sitemap for a specific
-language).
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td><notextile>\{sitemap: }</notextile></td>
-  <td><notextile>{sitemap: }</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{sitemap: {honorInMenu: false}}</notextile></td>
-  <td><notextile>{sitemap: {honorInMenu: false}}</notextile></td>
-</tr>
-</table>

data/doc/src/documentation/plugins/tag/wikilink.page

@@ -1,33 +0,0 @@
----
-title: WikiLink
-inMenu: true
-template: /plugin.template
-plugin: Tag/WikiLink
----
-h2(#description). Description
-
-
-This tag can be used to add a link to a wiki page. It is used on this website to automatically
-provide a "Feedback" link for each page.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td><notextile>\{wikilink: }</notextile></td>
-  <td><notextile>{wikilink: }</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{wikilink: {relURL: hallo}}</notextile></td>
-  <td><notextile>{wikilink: {relURL: hallo}}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{wikilink: {relURL: hallo, linkText: MoinMoin}}</notextile></td>
-  <td><notextile>{wikilink: {relURL: hallo, linkText: MoinMoin}}</notextile></td>
-</tr>
-</table>

data/doc/src/documentation/references/index.page

@@ -1,34 +0,0 @@
----
-title: References
-directoryName: References
----
-h2. About
-
-
-This part of the documentation contains some references for your convenience:
-
-* <b><a href="{relocatable: webpage_format.page}">WebPage Format Reference</a></b>
-
-  Describes the structure and format of the WebPage Format, the format used, for
-  example, for page and template files.
-
-* <b><a href="{relocatable: sipttra_format.page}">sipttra Format Reference</a></b>
-
-  Describes the sipptra (Simple Plain Text Tracker) format.
-
-* <b><a href="{relocatable: meta_info_reference.page}">Meta Information Reference</a></b>
-
-  Provides an overview over all special meta information keys that can be used in conjunction with
-  webgen.
-
-* <b><a href="{relocatable: resource_reference.page}">Resource Reference</a></b>
-
-  Provides an overview over all predefined resources!
-
-* <b><a href="{relocatable: parameter_reference.page}">Parameter Reference</a></b>
-
-  Lists the parameters for all plugins for easy search and retrieval.
-
-* <b><a href="{relocatable: /api.html}">API Reference</a></b>
-
-  Provides detailed API documentation through RDOC generated documents.

data/doc/src/documentation/references/meta_info_reference.page

@@ -1,136 +0,0 @@
----
-title: Meta Info Reference
-inMenu: true
----
-h2. Meta Information Reference
-
-Following is a list of all the meta information items that are used in one way or another by a
-plugin, be it a file handler plugin, a tag plugin...
-
-<table class="metainfo">
-<tr>
-  <th>Name</th><th>Type</th><th>Example</th><th>Valid for</th><th>Description</th>
-</tr>
-<tr>
-  <th>blocks</th>
-  <td>Array of Arrays</td>
-  <td>[[content, markdown], [sidebar, html]]</td>
-  <td>Page/Template file</td>
-  <td>Sets the name and format of content blocks. Each sub-array contains, in this order, the name
-      of the block and its format.</td>
-</tr>
-<tr>
-  <th>directoryName</th>
-  <td>String</td>
-  <td>Image Directory</td>
-  <td>Any</td>
-  <td>Only used if set on a directory index file; specifies the title of the directory for
-      which it is the index file. If it is not specified, the title of the directory will be
-      used.</td>
-</tr>
-<tr>
-  <th>emoticonPack</th>
-  <td>String</td>
-  <td>bigeyes</td>
-  <td>Page file</td>
-  <td>Sets the emoticon package which should be used for the page.</td>
-</tr>
-<tr>
-  <th>indexFile</th>
-  <td>String</td>
-  <td>getting.page</td>
-  <td>Directory</td>
-  <td>Sets the directory index file for the directory overriding the default value.</td>
-</tr>
-<tr>
-  <th>inMenu</th>
-  <td>Boolean</td>
-  <td>true</td>
-  <td>Any</td>
-  <td>Specifies if the file/directory should appear in menus.</td>
-</tr>
-<tr>
-  <th>lang</th>
-  <td>String</td>
-  <td>de</td>
-  <td>Page file</td>
-  <td>Sets the language for the page file. Has to be a valid ISO-639-1/2 character code for the language.</td>
-</tr>
-<tr>
-  <th>linkAttrs</th>
-  <td>Hash</td>
-  <td>\{title: Hallo, class: extra}</td>
-  <td>Any</td>
-  <td>Specifies additional attribute-value pairs (in form of a Hash) that should be added to a link to the file/directory.</td>
-</tr>
-<tr>
-  <th>link_callback</th>
-  <td>String (Ruby code)</td>
-  <td><code>"<a#{attrs}>#{link_text} + some text</a>"</code></td>
-  <td>Any</td>
-  <td>
-    Can be used to customize the link generated for the node. The available variables are: <br />
-
-    +node+: The node to which the link points.<br />
-    +ref_node+: The reference node.<br />
-    +attrs+: A string of compiled HTML attributes that should be on the link element.<br />
-    +link_text+: The text for the link.<br />
-    +context+: An optional hash with context information. The key :caller is set to the plugin which invoked
-               the link generation, e.g. MenuStyle/Vertical or Tag/Langbar. Optional other key-value pairs are
-               provided depending on the plugin.
-  </td>
-</tr>
-<tr>
-  <th>omitIndexFileInBreadcrumbTrail</th>
-  <td>Boolean</td>
-  <td>false</td>
-  <td>Index file</td>
-  <td>Controls whether the index file should appear in a breadcrumb trail despite the setting of the
-      {param: Tag/BreadcrumbTrail:omitIndexFile} parameter.
-  </td>
-</tr>
-<tr>
-  <th>orderInfo</th>
-  <td>Integer</td>
-  <td>15</td>
-  <td>Any</td>
-  <td>Sets the ordering information for the file/directory. The value 0 is used as default and means 'not set'.
-      You should only use numbers greater than zero. However, if you want a menu item to always appear as first item,
-      it is recommended to use the value -1. When sorting nodes, the @orderInfo@ value is used first. If the values for both
-      nodes are the same, then they are sorted according to their @title@ meta information.
-  </td>
-</tr>
-<tr>
-  <th>outputNameStyle</th>
-  <td>String</td>
-  <td>[:name, [".", :lang], ".html"]</td>
-  <td>Page file</td>
-  <td>Sets a custom output name style for the specified page file only. The basename is substituted for the value @:name@
-      and the language for the value @:lang@. Strings are used verbatim. If @:lang@ is specified in a sub-array, the whole
-      sub-array is omitted, if the parameter {param: File/PageHandler:defaultLangInFilename} is false.
-  </td>
-</tr>
-<tr>
-  <th>template</th>
-  <td>String</td>
-  <td>my.template</td>
-  <td>Page/Template file</td>
-  <td>Sets the template for the page/template file overriding the default value. If set to @nil@, no
-      template is used for the page/template file!</td>
-</tr>
-<tr>
-  <th>title</th>
-  <td>String</td>
-  <td>New Title</td>
-  <td>Any</td>
-  <td>Sets the title for the file/directory.</td>
-</tr>
-<tr>
-  <th>useERB</th>
-  <td>Boolean</td>
-  <td>false</td>
-  <td>Page/Template file</td>
-  <td>Specifies if the content blocks of the page/template file should be processed with ERB overriding the default value.</td>
-</tr>
-</table>
-

data/doc/src/documentation/references/parameter_reference.page

@@ -1,11 +0,0 @@
----
-title: Plugin Parameter Reference
-inMenu: true
----
-h2. Plugin Parameter Reference
-
-Each plugin can specify <a href="{relocatable: ../plugins}">parameters</a>. Here is a list of all
-available parameters for a quick lookup, ordered by category and then name (only plugins with
-parameters are shown!):
-
-<notextile>{listPluginParameters:}</notextile>

data/doc/src/documentation/references/resource_reference.page

@@ -1,18 +0,0 @@
----
-title: Resource Reference
-inMenu: true
----
-h2. Resource Reference
-
-
-The following list shows all resources that are shipped with webgen and that can be used via the
-{plugin: Tag/Resource} plugin.
-
-*Credits*:
-
-* webgen-icons-<notextile>*</notextile>: These icons were taken from the "CrystalClear" package from
-"http://www.kde-look.org/content/show.php?content=25668":http://www.kde-look.org/content/show.php?content=25668
-* webgen-emoticons-<notextile>*</notextile>: Credits for the individual emoticon packs are listed on the {plugin:
-Misc/SmileyReplacer} page
-
-<notextile>{predefinedResources:}</notextile>

data/doc/src/documentation/references/sipttra_format.page

@@ -1,241 +0,0 @@
----
-title: Sipttra Format
-inMenu: true
----
-
-h1. The Sipttra Format
-
-
-h2(#sipttra). What is sipptra?
-
-
-sipttra is the acronym for <b>S</b>imple <b>P</b>lain <b>T</b>ext <b>T</b>racker. It is a ticket
-tracker which stores everything inside a human readable text file. Therefore it can be used with any
-text editor and no additional program to edit it is needed.
-
-sipttra supports categories with different types, a special milestone category and, naturally,
-tickets.
-
-As everything is stored in a text file, sipttra is not intended to be used by many concurrent users.
-It is a simple and easy system for one-man-projects as well as small projects with not many
-developers.
-
-
-h2(#structure). Types
-
-
-sipttra is line and not character based. This means that it only operates on whole lines and each
-line can have a different type. This section describes the available types and the next section
-explains how these types can be used in a sipttra file.
-
-
-h3(#categories). Categories
-
-
-A category has a name and a type which have to be unique among all categories. Therefore it is not
-possible to define two equal category lines in one sipttra file. Tickets can only be defined for
-categories. The category type further distinquishes the tickets of a category name. For example,
-normally you have at least open bugs and closed bugs. For sipttra, this means that you have defined
-a category named bugs with type open and another category named bugs with type closed.
-
-A category is defined like this:
-
-<pre>
-  ### CATEGORY (type) ###
-</pre>
-
-or
-
-<pre>
-  # CATEGORY (type) #
-</pre>
-
-The line has to start with one or more hashes, the category name, the category type and finally the
-same number of hashes as at the start of the line. These items have to be separated from each other
-by spaces.
-
-The tickets of a category are of the same type as the category itself. The special type @closed@
-signifies that the tickets in the category are closed, tickets from all other category types are
-considered to be open.
-
-
-h3(#milestones). Milestone Category
-
-
-The milestone category is defined like a normal category. However, the type in parenthesis is
-omitted, like this:
-
-<pre>
-  ### Milestones ###
-</pre>
-
-A sipttra file can contain exactly one such milestone category! This is the only distinction between
-normal categories and the milestone category.
-
-
-h3(#tickets). Tickets
-
-
-Tickets are defined like this:
-
-<pre>
-   * NAME (YYYY-MM-DD) [BELONGS_TO] summary
-     further description
-
-     still in the description
-</pre>
-
-Basically all parts are optional. However, if no summary is specified it is assumed to be empty. The
-name uniquely distinguishes the ticket among all tickets independent of the category. The date in
-parenthesis is considered to be the due date, ie. the date on which this ticket should be closed.
-The 'belongs to' part in square brackets defines a relationship to another ticket. The summary part
-is a short description of the ticket. All following lines which are either empty or indented exactly
-two spaces belong to the detailed description of the ticket (one can use Markdown syntax in the
-detailed description). *Caveats*: if one wants to only specify a name and a summary for a ticket,
-these two parts have to be separated by a colon sothat the parser can distinguish them. Also be
-aware that the spaces between the individual parts are mandatory!
-
-Here are some examples for valid tickets:
-
-<pre>
-  * name1: summary
-
-  * name2 (2007-02-15) my summary here
-
-  * name3 [othername] yeah, this also works
-    with additional description
-
-    which still belongs to ticket name3
-</pre>
-
-Two important attributes for tickets are defined indirectly:
-
-* status: The status is defined by the category type to which a ticket belongs
-* priority: The priorites of the tickets are defined by their order. The ticket defined first in a
-  category has the highest priority, the last defined ticket the lowest.
-
-Tickets for the milestone category are defined like normal tickets. However, milestone tickets must
-have a name defined!
-
-
-h3(#comments). Comments
-
-
-Comment lines are allowed everywhere in a sipttra file! Each line which is neither a category line,
-a ticket line or a line belonging to an additional description of a ticket becomes a comment line.
-Also be aware that if a line for a ticket or category is not well structured, it automatically
-becomes a comment line.
-
-
-h2(#fileformat). The sipttra File Format
-
-
-A sipttra file starts with an optional meta information part. If you want to have a meta information
-part the sipttra file has to start with three dashes on the first line. Everything till the next
-line with three dashes is considered to be meta information. This meta information part has to be
-valid YAML.
-
-The main part consists of the tracker definition. It is read line by line from top to bottom:
-
-* All lines before the first category line are considered to be comment lines.
-* Tickets always belong to the last defined category.
-* The same category can not be defined twice in one sipttra file!
-
-
-h2(#examples). Examples
-
-
-Here are some example sipttra files.
-
-<pre>
-\---
-webgen-metainfo:
-  inMenu: true
-  title: Project Status
-\---
-
-### Milestones ###
-
-* Feb07 (2007-02-28) Bug fixes and small enhancements
-  - include patches/requests created since 0.4.1 release
-  - add support for sipttra files, the Simple Plain Text Tracker
-
-* F: Ideas and todo items for future versions
-
-  This milestone holds all ideas/todo items/requests which are implemented some
-  time in the future.
-
-
-Here could be some potential comment! :)
-
-### Features (open) ###
-
-* T001 [Feb07] one ticket
-
-* T002 [F] another ticket
-  this is additional text
-
-
-### Features (closed) ###
-
-* T003 [F] and another closed ticket
-
-
-### Bugs (open) ###
-
-* T008 [Feb07] you should really close this bug!
-
-
-### Bugs (closed) ###
-
-* T009 [Feb07] yeah, very cool, a closed bug!
-</pre>
-
-
-<pre>
-This are just some
-comment lines
-here!
-
-### Milestones ###
-
-* Feb07 (2007-02-28) Bug fixes and small enhancements
-
-Here could be some potential comment! :)
-
-### Features (open) ###
-
-* T001 [Feb07] one ticket
-
-* T002 [Feb07] another ticket
-  this is additional text
-
-
-### Features (closed) ###
-
-* T003 [Feb07] and another closed ticket
-
-### Bugs (open) ###
-
-* T008 [Feb07] you should really close this bug!
-
-
-### Bugs (closed) ###
-
-* T009 [Feb07] yeah, very cool, a closed bug!
-</pre>
-
-
-<pre>
-### Features (open) ###
-
-* T001 [Feb07] one ticket
-
-* T002 [F] another ticket
-  this is additional text
-
-
-### Features (closed) ###
-
-* T003 [F] and another closed ticket
-</pre>