webgen 0.4.7 → 0.5.0

data/doc/src/documentation/plugins/misc/syntaxhighlighter.page

@@ -1,26 +0,0 @@
----
-title: SyntaxHighlighter
-inMenu: true
-template: /plugin.template
-plugin: Misc/SyntaxHighlighter
----
-h2(#description). Description
-
-
-This plugin is used by other plugins to highlight source code. It is used, for example, by {plugin:
-Tag/IncludeFile}.
-
-The available languages for syntax highlighting depend on the version of coderay you have installed.
-
-
-h2(#caveat). Caveat
-
-
-You should link to the @webgen-css@ resource in your template as this plugin defines some CSS
-styles!
-
-This plugin is only available if you have installed the
-"coderay":http://coderay.rubychan.de/ library. The preferred way to do this is via
-Rubygems:
-
-  gem install coderay

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

@@ -1,29 +0,0 @@
----
-title: Block
-inMenu: true
-template: /plugin.template
-plugin: Tag/Block
----
-h2(#description). Description
-
-
-This tag is used to render a page file block (for more information about blocks have a look at the
-<a href="{relocatable: /documentation/references/webpage_format.page}">WebPage Format reference</a>).
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td>\{block: extrablock}</td>
-  <td>{block: extrablock}</td>
-</tr>
-</table>
-
---- extrablock, textile
-
-Data from the block named 'extrablock'.

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

@@ -1,41 +0,0 @@
----
-title: BreadcrumbTrail
-inMenu: true
-template: /plugin.template
-plugin: Tag/BreadcrumbTrail
----
-h2(#description). Description
-
-
-The breadcrumb trail tag is used to display the hierarchy for the current page. You can see it in
-action above the main content area.
-
-The {param: Tag/BreadcrumbTrail:omitLast} parameter can be used for always omitting the last path
-component in the trail (which is normally the page itself).
-
-The {param: Tag/BreadcrumbTrail:omitIndexFile} parameter can be used to omit the last path component
-if it is an index file for an directory (see {plugin: File/DirectoryHandler} for more information
-about index files). This behaviour can be overridden for individual index files by setting the meta
-information @omitIndexFileInBreadcrumbTrail@.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td>\{breadcrumbTrail:}</td>
-  <td>{breadcrumbTrail:}</td>
-</tr>
-<tr>
-  <td><notextile>\{breadcrumbTrail: {separator: " HELLO "}}</notextile></td>
-  <td><notextile>{breadcrumbTrail: {separator: " HELLO "}}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{breadcrumbTrail: {omitLast: true}}</notextile></td>
-  <td><notextile>{breadcrumbTrail: {omitLast: true}}</notextile></td>
-</tr>
-</table>

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

@@ -1,11 +0,0 @@
----
-title: CustomVar
-inMenu: true
-template: /plugin.template
-plugin: Tag/CustomVar
----
-h2(#description). Description
-
-
-The custom variable tag is used to output the value of a custom variable defined using the {param:
-Core/Configuration:customVars} parameter.

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

@@ -1,34 +0,0 @@
----
-title: Date
-inMenu: true
-template: /plugin.template
-plugin: Tag/Date
----
-h2(#description). Description
-
-
-The date tag is used to display the current time in a specific format (the format of Ruby's inbuilt
-method <a href="http://www.ruby-doc.org/core/classes/Time.html#M000304">Time#strftime</a>). Have a
-look a the examples below to see some possible outputs.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td>\{date:}</td>
-  <td>{date:}</td>
-</tr>
-<tr>
-  <td>\{date: {format: %Y-%m-%d %H:%M:%S}}</td>
-  <td>{date: {format: %Y-%m-%d %H:%M:%S}}</td>
-</tr>
-<tr>
-  <td>\{date: {format: %x - %X}}</td>
-  <td>{date: {format: %x - %X}}</td>
-</tr>
-</table>

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

@@ -1,28 +0,0 @@
----
-title: Default
-directoryName: Tag
-inMenu: true
-omitIndexFileInBreadcrumbTrail: false
-template: /plugin.template
-plugin: Tag/Default
----
-h2(#description). Description
-
-
-The DefaultTag is the base plugin for all tag plugins. It provides the functionality for specifying
-which tag names should be handled, methods for setting the configuration and so on.
-
-
-h2(#about-tags). About Tags
-
-
-Tags are used to include dynamic content in page files. For more information, have a look at
-{plugin: Core/TagProcessor}.
-
-Each tag plugin responds to one or more tag names and creates content dynamically. webgen comes with
-a broad range of tag plugins for
-
-* generating menus and breadcrumb trails
-* including files
-* generating sitemaps
-* and much more!

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

@@ -1,60 +0,0 @@
----
-title: Download
-inMenu: true
-template: /plugin.template
-plugin: Tag/Download
----
-h2(#description). Description
-
-
-This tag is used to provide a nice download link. The download link includes the following parts:
-
-* *download icon* [optional]: an icon which shows that the file can be downloaded
-* *file icon*: an icon showing the type of the file (PDF file, music file, video file,...)
-* *link to file*: the link to the file
-* *file size*: the size of the file if it can be calculated
-
-*Caveat*: You should link to the @webgen-css@ resource in your template as this plugin defines some
-CSS styles!
-
-
-h2(#mapping-file). Format of mapping file
-
-
-You can specify additional type-to-icon mappings using the parameter {param:
-Tag/Download:mappingFile} which needs to point to a file with the mappings. The format for the file
-is YAML and following is an example:
-
-<pre>
-file-mapping:
-    /images/mytype.jpg: [.my, .mytype]
-    /images/documents.jpg: [.wpd, .doc, .sxw, .odt, .rtf]
-
-resource-mapping:
-    webgen-icons-text: [.page, .template]
-</pre>
-
-The two possible top level keys are @file-mapping@ and @resource-mapping@. The first specifies which
-image file and the second which resource should be used for the specified extensions.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td><notextile>\{download: {url: /images/thumb_example.jpg}}</notextile></td>
-  <td><notextile>{download: {url: /images/thumb_example.jpg}}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{download: {url: /images/thumb_example.jpg, alwaysShowDownloadIcon: true}}</notextile></td>
-  <td><notextile>{download: {url: /images/thumb_example.jpg, alwaysShowDownloadIcon: true}}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{download: download.page}</notextile></td>
-  <td><notextile>{download: download.page}</notextile></td>
-</tr>
-</table>

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

@@ -1,29 +0,0 @@
----
-title: ExecuteCommand
-inMenu: true
-template: /plugin.template
-plugin: Tag/ExecuteCommand
----
-h2(#description). Description
-
-
-The execute command tag is used to include the output from a shell command. It also includes a
-parameter for highlighting the output via the {plugin: Misc/SyntaxHighlighter}.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td>\{execute: uname -p}</td>
-  <td><pre>{execute: uname -p}</pre></td>
-</tr>
-<tr>
-  <td><notextile>\{execute: {command: 'echo puts LANG + 5.to_s', highlight: ruby}}</notextile></td>
-  <td><notextile>{execute: {command: 'echo puts LANG + 5.to_s', highlight: ruby}}</notextile></td>
-</tr>
-</table>

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

@@ -1,32 +0,0 @@
----
-title: HtmlMetaInfo
-inMenu: true
-template: /plugin.template
-plugin: Tag/HtmlMetaInfo
----
-h2(#description). Description
-
-
-This tag should only be used in the HTML @<head>@ section of your @default.template@. It inserts the
-@description@, @author@ and @keywords@ meta tags, filled with the information from the node's
-metainfo.
-
-h2(#examples). Examples
-
-For the following page file:
-
-<pre>
-\---
-title: Title for the page
-description: Description for this page.
-keywords: example, plugin, input
-\---
-Content
-</pre>
-
-the tag will output:
-
-<pre>
-<meta name='description' content='Description for this page.'/>
-<meta name='keywords' content='example, plugin, input'/>
-</pre>

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

@@ -1,30 +0,0 @@
----
-title: IncludeFile
-inMenu: true
-template: /plugin.template
-plugin: Tag/IncludeFile
----
-h2(#description). Description
-
-
-The include file tag is used to include the content of a file. The content can be highlighted via
-{plugin: Misc/SyntaxHighlighter} by specifying an available language for the parameter {param:
-Tag/IncludeFile:highlight}.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td>\{includeFile: {filename: includefile.page, processOutput: false}}</td>
-  <td><pre>{includeFile: {filename: includefile.page, processOutput: false}}</pre></td>
-</tr>
-<tr>
-  <td>\{includeFile: {filename: ../../../../plugin/emoticon.rb, escapeHTML: false, processOutput: false, highlight: ruby}}</td>
-  <td>{includeFile: {filename: ../../../../plugin/emoticon.rb, escapeHTML: false, processOutput: false, highlight: ruby}}</td>
-</tr>
-</table>

data/doc/src/documentation/plugins/tag/langbar.de.page

@@ -1,6 +0,0 @@
----
-title: Sprachleiste
----
-h2. Information
-
-Die deutsche Seite... enthält nicht viel Information :-)

data/doc/src/documentation/plugins/tag/langbar.fr.page

@@ -1,6 +0,0 @@
----
-title: Francais
----
-h2. Information
-
-La page Web francais...

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

@@ -1,41 +0,0 @@
----
-title: Langbar
-inMenu: true
-template: /plugin.template
-plugin: Tag/Langbar
----
-h2(#description). Description
-
-
-This tag is used to display a list of languages for a page. Take a look at the header. There you
-will find a link titled 'en'. This is the link to the english (=en) version of this page.
-
-
-h2(#examples). Examples
-
-
-This page is available in several other languages (however, with nearly no content :-)) for
-demonstration purposes.
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td>\{langbar: }</td>
-  <td>{langbar: }</td>
-</tr>
-<tr>
-  <td>\{langbar: {separator: Hallo}}</td>
-  <td>{langbar: {separator: Hallo}}</td>
-</tr>
-<tr>
-  <td>\{langbar: {showSingleLang: false}}</td>
-  <td>{langbar: {showSingleLang: false}}</td>
-</tr>
-<tr>
-  <td>\{langbar: {showOwnLang: false}}</td>
-  <td>{langbar: {showOwnLang: false}}</td>
-</tr>
-</table>

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

@@ -1,78 +0,0 @@
----
-title: Menu
-inMenu: true
-template: /plugin.template
-plugin: Tag/Menu
----
-h2(#description). Description
-
-
-The menu tag is used to generate a dynamic menu for the website. You can see such a menu on the left
-of this page.
-
-It uses the meta information @inMenu@ and @orderInfo@ to determine which pages should be in the menu
-and how they should be ordered. Then it generates an internal menu tree, one for each language, to
-speed up menu generation. When the tag is used, it is first determined which language tree should be
-used for the menu generation (the language of the page the menu tag appears in). After that a
-specific menu style is used to actually generate the menu.
-
-
-h2(#menustyle). Menu Styles
-
-
-There exist serveral different predefined menu styles (vertical, horizontal, ...). Have a look at
-the {plugin: MenuStyle} section to see which menu styles are available.
-
-
-h2(#static). Static Menus
-
-It is also possible to define a "static" menu or to augment the dynamic menu with static entries by
-using the <a href="../core/filehandler.page#metainfo-file">meta information backing file</a>.
-Following are some ideas for how to do this. Nothing is assumed, so it is valid that none or some
-page files have the @inMenu@ meta information set:
-
-* Exisiting page files can be included in the menu by specifying the needed meta information
-  directly (either in the source or the output section):
-
-  <pre>
-    features.page:
-      inMenu: true
-      orderInfo: 1
-  </pre>
-
-* Virtual files and directories can be added using the output section to structure the menu the
-  way you like it. This way it is also possible to add one page under two different headings:
-
-  <pre>
-    newdir:
-      orderInfo: 2       -> no need to specify inMenu if a page under the dir has it specified
-
-    newdir/new.page:
-      orderInfo: 1       -> orderInfo for the page
-      inMenu: true       -> it should be in the menu
-      lang: en           -> lang has to be set explicitly if the file does not exist, and if
-                            the file should only appear in the menu for one specific language:
-                            if not set, it appears in every menu
-      url: ../features.page  -> ../features.page is shown for this menu entry
-  </pre>
-
-A completely "static" menu can be generated by only using virtual directories and files in the
-output section and not setting @inMenu@ for any node.
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Usage</th><th>Output</th>
-</tr>
-<tr>
-  <td><notextile>\{menu: vertical}</notextile></td>
-  <td><notextile>{menu: vertical}</notextile></td>
-</tr>
-<tr>
-  <td><notextile>\{menu: horizontal}</notextile></td>
-  <td><notextile>{menu: horizontal}</notextile></td>
-</tr>
-</table>