webgen 0.3.8 → 0.4.0

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

@@ -0,0 +1,29 @@
+---
+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

@@ -0,0 +1,29 @@
+---
+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.
+
+
+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>
+</table>

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

@@ -0,0 +1,34 @@
+---
+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

@@ -0,0 +1,27 @@
+---
+title: Default
+directoryName: Tag
+inMenu: true
+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

@@ -0,0 +1,60 @@
+---
+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

@@ -0,0 +1,29 @@
+---
+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/includefile.page

@@ -0,0 +1,30 @@
+---
+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/{tags → tag}/langbar.de.page

@@ -1,5 +1,5 @@
 ---
-title: Tag für Sprache
+title: Sprachleiste
 ---
 h2. Information
 

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

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

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

@@ -0,0 +1,41 @@
+---
+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

@@ -0,0 +1,78 @@
+---
+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>

data/doc/src/documentation/plugins/{tags → tag}/meta.page

@@ -1,20 +1,21 @@
 ---
 title: Meta
 inMenu: true
+template: /plugin.template
+plugin: Tag/Meta
 dummyForMeta: This is content specified in the meta information section.
 ---
-h2. Information
+h2(#description). Description
 
-<notextile>{describe: MetaTag}</notextile>
-
-h2. 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 the content part of the file and the value gets substituted
+<code>\{revision: }</code> into a block of the page file and the value gets substituted
 automatically.
 
-h2. Examples
+
+h2(#examples). Examples
+
 
 There is a meta information called 'dummyForMeta' defined for this page, so when this tag
-is used @\{dummyForMeta:}@, you get this '@{dummyForMeta:}@'.
+@\{dummyForMeta:}@ is used, you get this '@{dummyForMeta:}@'.

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

@@ -0,0 +1,46 @@
+---
+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>