webgen 0.3.8 → 0.4.0

data/doc/src/documentation/plugins/filehandlers/page.page

@@ -1,170 +0,0 @@
----
-title: Page Handler
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: PageFileHandler}</notextile>
-
-h2. Description
-
-Page description files are used to specify the actual content for the website. They contain the
-content for the webpage and, optionally, meta information.
-
-h2(#structure). File format
-
-The format of these files is a very simple one and can be divided into two cases:
-
-# Only content
-# Meta information and content
-
-A simple file may look like this:
-<pre>
-This is the content!!!
-</pre>
-
-Only content is specified in this file. Meta information can be specified at the beginning of the
-file:
-<pre>
-\---
-title: The title set by Meta info
-\---
-This is the content of the file
-</pre>
-
-In this example, meta information is specified ("more info":#meta). Note the three dashes at the
-beginning of the file. This indicates that the following 'block' is used for meta information. If
-the three dashes at the beginning are omitted, then the parser won't know that the following block
-contains meta information and thinks it is content. If not specified, the default name for the
-content block is @content@.
-
-If you want to include a line in your file which only has three dashes, you have to write this:
-<pre>
-\\---
-</pre>
-
-The meta information is separated from the content by another three dashes and so the content itself
-builds a second 'block'. The following examples contains three blocks, the meta information block
-and two content blocks.
-<pre>
-\---
-title: The title set by Meta info
-\---
-This is the 1. content of the file
-\---
-This is the 2. content of the file
-</pre>
-
-However, without naming blocks they cannot be accessed. You can specify the name and the content
-formatting using meta information. Look at the following example:
-<pre>
-\---
-title: The title set by Meta info
-blocks:
-  - \{name: content, format: textile}
-  - \{name: sidebar, format: markdown}
-\---
-This is the 1. content of the file
-\---
-This is the 2. content of the file
-</pre>
-
-The first block in this file is named @content@ and formatted using @textile@. The second block is
-named @sidebar@ and formatted using @markdown@.
-
-h2. Content format
-
-h3. Embedded Ruby (ERB)
-
-Before the content is converted to HTML with a specific content handler, ERB is run over the
-content. This allows one to add dynamic content to the web pages without using tags. Following is an
-example of a page file which uses ERB:
-
-<notextile>
-<pre>
-\---
-title: Test page with ERB
-\---
-This page has the following meta info items:
-&lt;% node.metainfo.each do |key, value| %&gt;
-    * &lt;%=key %&gt;: &lt;%=value %&gt;
-&lt;% end %&gt;
-</pre>
-</notextile>
-
-This would output all meta information for the current page. As one can see in the example, the node
-for the current page can be accessed by using @node@. The parameter @useERB@ specifies if ERB should
-be used. To provide more control, one can enable or disable ERB for a page file by setting the meta
-information @useERB@ to @true@ or @false@.
-
-The template will always be processed with ERB!
-
-h3. Format
-
-The content of page description can be written in different formats. Have a look at the
-<a href="{relocatable: ../contenthandlers}">Content Handlers</a> to get an overview of the existing
-formats.
-
-h2. Default settings
-
-As page description files need not have meta information, defaults are used for needed parameters.
-If meta information is specified in a page description file, the default values are overridden.
-
-The following defaults are used:
-
-* Content format and name
-
-  If there is only one content in a page description file, its formatting defaults to the parameter
-  value @defaultContentFormat@ and it is named @content@.
-
-* Title, ordering and language
-
-  These values are taken from the filename, so the filename of a page description file has to be
-  formatted like this: @[ordering.]name[.language].page@ (the values in square brackets are
-  optional). In detail:
-  * ordering: The ordering is a number which is used for menu generation and the like, where it is
-    necessary to order the items. If not specified, defaults to @0@.
-  * name: This is used for the title of the page. Hyphens and underscores are replaced with spaces
-    and @name@ must not contain any dots. Also: if two page descriptions files have the same
-    @name@ part, they should define the same content for different languages as webgen consideres
-    them as "one" page file in two languages.
-  * language: This is the language code for this file. The codes defined in ISO-639-1 (2 char codes)
-    and ISO-639-2 (3 char codes) can/should be used for defining the language. However, you should stick
-    to one code and do not use any other code for the same language (i.e. only use @en@ and not
-    additionally @eng@ or vice versa). If the language is not specified, it defaults to @en@.
-
-  Consider the following examples:
-    * @name.page@ -> title: Name, language: en, ordering: 0
-    * @name.de.page@ -> title: Name, language: de, ordering: 0
-    * @01.name_of-file.de.page@ -> Title: Name of file, language: de, ordering: 01
-
-  Notice: The first two examples define content for two different languages (en and de) as they have
-  the same @name@ part.
-
-
-h2(#naming). Referencing page description files
-
-The output name of page description files can be specified using the parameter @outputNameStyle@. If
-you want to reference a page description file, you can use this output name (e.g. @name.de.html@).
-However, if you want to change the @outputNameStyle@ parameter later or set the parameter
-@defaultLangInFilename@, this link (@name.de.html@) will not work anymore.
-
-Therefore, each page description file can be referenced by specifing the name
-<code>[name_of_page_desc_file].[language].page</code> (e.g. @name.de.page@ instead of
-@name.de.html@). However, most of the time, you do not want to explicitly specify the @lang@ part in
-this standardified name because you want to reference the page description file and display it in
-the currently used language. Thus you can also use <code>[name_of_page_desc_file].page</code> (e.g.
-@name.page@). This will always reference the page description file in the correct language!
-
-I could have used the extension @html@ instead of @page@, but I think the latter is better because
-the output files need not have to have the extension @html@.
-
-h2(#meta). Meta Information
-
-Meta information can be specified at the beginning of the file as described "here":#structure. Meta
-information is formatted using YAML, a simple markup language. For more information about YAML, have
-a look at the "www.yaml.org":http://www.yaml.org!
-
-Any information can be specified. The most important use for meta information is to override values
-like the title of the page (e.g. if you want dots in it), the ordering and so on. It is also used to
-specify the names and the formatting of content blocks in the file.

data/doc/src/documentation/plugins/filehandlers/template.page

@@ -1,21 +0,0 @@
----
-title: Template File Handler
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: TemplateFileHandler}</notextile>
-
-h2. Description
-
-The template file handler processes the templates for the page description files. Templates normally
-specify the layout of the website. For this website only one template was used for all page
-description files. However, you could assign each page description file its own template, if you
-want to! (but why would one do that? :-)
-
-You must have at least one template file in the root of the source directory which is the fallback
-template if no other template can be found for a page description file. The template files are
-organized hierarchically. So if during processing webgen does not find the default template file in
-the directory in which the page file is, it searches the parent directory for the template. If it
-isn't there either, it searches the parent's parent directory and so on. If webgen gets to the root
-of the source directory and could not find a template, it will complain and stop.

data/doc/src/documentation/plugins/gallerylayouters/index.page

@@ -1,18 +0,0 @@
----
-directoryName: Gallery Layouters
----
-h2. Information
-
-<notextile>{describe: DefaultGalleryLayouter}</notextile>
-
-h2. Description
-
-Gallery layouters are used to define layouts for galleries. Each plugin defines how the main page,
-the gallery pages and the image pages look like. To do this, each plugin has to define three methods:
-
-* <tt>main( data )</tt>
-* <tt>gallery( data, gIndex )</tt>
-* <tt>image( data, gIndex, iIndex )</tt>
-
-The @data@ parameter is a @Hash@ with all the information available about the gallery. The @gIndex@
-and the @iIndex@ parameters are indices for the current gallery and the current image.

data/doc/src/documentation/plugins/htmlvalidators/index.page

@@ -1,6 +0,0 @@
----
-directoryName: HTML Validators
----
-h2. About
-
-HTML Validators are used to validate HTML files.

data/doc/src/documentation/plugins/htmlvalidators/xmllint.page

@@ -1,14 +0,0 @@
----
-title: xmllint HTML Validator
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: XmllintHTMLValidator}</notextile>
-
-h2. Description
-
-This plugin uses the @xmllint@ program from the "libxml2":http://www.xmlsoft.org package. @xmllint@
-can be used to validate an XML file against a DTD, a RelaxNG schema or a WXS schema. For more
-information about where to put the DTD or schema files, have a look at the @libxml2@ documentation
-that comes bundled.

data/doc/src/documentation/plugins/menustyles/horizontal.page

@@ -1,21 +0,0 @@
----
-title: Horizontal
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: HorizontalMenuStyle}</notextile>
-
-h2. Description
-
-Builds a horizontal menu; each menu level gets its own menu bar.
-
-h2. Example
-
-Basic menu as it appears by default, nothing styled additionally with CSS:
-
-<notextile>{menu: {menuStyle: horizontal}}</notextile>
-
-The same menu with a little CSS magic:
-
-<notextile>{menu: {menuStyle: horizontal, options: {divClass: horiz-menu}}}</notextile>

data/doc/src/documentation/plugins/menustyles/index.page

@@ -1,12 +0,0 @@
----
-directoryName: Menu Styles
----
-h2. Information
-
-<notextile>{describe: DefaultMenuStyle}</notextile>
-
-h2. Description
-
-Menu Styles are used to build different types of menus. Some web sites use vertical menus on the
-left or right side, some horizontal menus at the top. It's up to you to chose the best suited
-menu style for your website!

data/doc/src/documentation/plugins/menustyles/partial.page

@@ -1,27 +0,0 @@
----
-title: Partial
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: PartialMenuStyle}</notextile>
-
-h2. Description
-
-Builds a simple menu showing only the menu levels under the current page. This means that if you are
-in the third level of the hierarchy, the first two menu levels are not shown.
-
-h2. Style Advice
-
-The menu is constructed using HTML lists with @ul@ and @li@ tags. However, the menu looks better if
-no discs are shown for the menu items (using <code>list-style-type: none</code>).
-
-h2. Examples
-
-Basic menu as it appears by default, nothing styled additionally with CSS:
-
-<notextile>{menu: {menuStyle: partial}}</notextile>
-
-The same menu with a little CSS magic:
-
-<notextile>{menu: {menuStyle: partial, options: {divClass: partial-menu}}}</notextile>

data/doc/src/documentation/plugins/menustyles/vertical.page

@@ -1,32 +0,0 @@
----
-title: Vertical
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: VerticalMenuStyle}</notextile>
-
-h2. Description
-
-Builds a simple vertical menu. This is the most basic of all menus. Use the various parameters to
-change how many menu levels should be shown.
-
-h2. Style Advice
-
-The menu is constructed using HTML lists with @ul@ and @li@ tags. However, the menu looks better if
-no discs are shown for the menu items (using <code>list-style-type: none</code>).
-
-h2. Examples
-
-Basic menu as it appears by default, nothing styled additionally with CSS:
-
-<notextile>{menu: {menuStyle: vertical}}</notextile>
-
-The same menu with a little CSS magic:
-
-<notextile>{menu: {menuStyle: vertical, options: {divClass: vert-menu}}}</notextile>
-
-Examples of the menu with other parameter settings
-
-table{border: 1px solid black}.
-|^. \{menu: {menuStyle: vertical, options: {subtreeLevel: 1}}}{menu: {menuStyle: vertical, options: {subtreeLevel: 1}}}|^. \{menu: {menuStyle: vertical, options: {subtreeLevel: 4, showCurrentSubtreeOnly: false}}} {menu: {menuStyle: vertical, options: {subtreeLevel: 4, showCurrentSubtreeOnly: false}}}|

data/doc/src/documentation/plugins/menustyles/verticaldropdown.page

@@ -1,23 +0,0 @@
----
-title: Vertical Dropdown
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: VerticalDropdownMenuStyle}</notextile>
-
-h2. Description
-
-Builds a vertical menu with CSS drop down menus. This one is similar to the horizontal dropdown menu
-and the information on the <a href="{relocatable: horizontaldropdown.page}">Horizontal
-Dropdown</a> page also applies for this menu style.
-
-h2. Example
-
-Basic menu as it appears by default, nothing styled additionally with CSS:
-
-<notextile>{menu: {menuStyle: vertical-dropdown}}</notextile>
-
-The same menu with a little CSS magic:
-
-<notextile>{menu: {menuStyle: vertical-dropdown, options: {divClass: vert-dd-menu}}}</notextile>

data/doc/src/documentation/plugins/miscplugins/index.page

@@ -1,7 +0,0 @@
----
-title: Miscellaneous Plugins
-directoryName: Misc Plugins
----
-h2. About
-
-These plugins do not fit in any other category and are therefore located here.

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

@@ -1,20 +0,0 @@
----
-title: Breadcrumb Trail
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: BreadcrumbTrailTag}</notextile>
-
-h2. Description
-
-The breadcrumb trail tag is used to display the hierarchy for the current page. You can see it in
-action on the left side of the header.
-
-h2. Examples
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|\{breadcrumbTrail:}|{breadcrumbTrail:}|
-|<notextile>\{breadcrumbTrail: {separator: " HALLO "}}</notextile>|<notextile>{breadcrumbTrail: {separator: " HALLO "}}</notextile>|
-

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

@@ -1,19 +0,0 @@
----
-title: Date
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: DateTag}</notextile>
-
-h2. Description
-
-The date tag is used to display the current time in a specific format. You can see how the default
-output looks like in the footer.
-
-h2. Examples
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|\{date: {format: %Y-%m-%d %H:%M:%S}}|{date: {format: %Y-%m-%d %H:%M:%S}}|
-|\{date: {format: %x - %X}}|{date: {format: %y - %X}}|

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

@@ -1,23 +0,0 @@
----
-title: Download
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: DownloadTag}</notextile>
-
-h2. 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
-
-h2. Examples
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|<notextile>\{download: {url: /images/screenshots/wge-image.png, alwaysShowDownloadIcon: true}}</notextile>|<notextile>{download: {url: /images/screenshots/wge-image.png, alwaysShowDownloadIcon: true}}</notextile>|
-|<notextile>\{download: download.page}</notextile>|<notextile>{download: download.page}</notextile>|

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

@@ -1,18 +0,0 @@
----
-title: Execute Command
-inMenu: true
----
-h2. Information
-
-<notextile>{describe: ExecuteCommandTag}</notextile>
-
-h2. Description
-
-The execute command tag is used to include the output from a shell command.
-
-h2. Examples
-
-table{border:1px solid black}.
-|_.Command|_.Output|
-|\{execute: ls}|<pre class="webgen-file">{execute: ls}</pre>|
-|\{execute: uname -p}|<pre class="webgen-file">{execute: uname -p}</pre>|