webgen 0.4.7 → 0.5.0

data/doc/src/documentation/plugins/file/sipttrahandler.page

@@ -1,18 +0,0 @@
----
-title: SipttraHandler
-inMenu: true
-template: /plugin.template
-plugin: File/SipttraHandler
----
-h2(#description). Description
-
-This plugin handles <a href="{relocatable:/documentation/references/sipttra_format.page}">sipttra</a>
-(Simple Plain Text Tracker) files. This is a custom text format which one can use if a sophisticated
-tracker like Bugzilla or Trac is an overkill.
-
-The special key @webgen-metainfo@ in the meta information section of a sipttra file can be used to
-define meta information for the generated page.
-
-If you have created a sipttra file, you should also use a
-<a href="{relocatable: /examples/sipttra_styles}">sipttra style</a> to specify how
-the generated tracker page should look like.

data/doc/src/documentation/plugins/file/templatehandler.page

@@ -1,51 +0,0 @@
----
-title: TemplateHandler
-inMenu: true
-template: /plugin.template
-plugin: File/TemplateHandler
----
-h2(#description). Description
-
-The template handler processes the templates found in the source directory. Templates, as the name
-already implies, normally specify the layout and the overall "picture" of a web page that is defined
-using a page file.
-
-These files have the same format as page files - more information about this format can be found
-in the <a href="{relocatable: /documentation/references/webpage_format.page}">WebPage Format reference</a>.
-The default content format for template files is HTML (contrary to page files).
-
-The parameter {param: File/TemplateHandler:defaultTemplate} specifies the name of the default
-template which is used when no explicit template for a page file is set via the meta information
-@template@. webgen assumes that the default template is in the same directory as the page file.
-However, if it can not be found there, the parent directory is searched for it and so on. If a
-default template isn't found in the root directory, no template is used at all. This means that when
-you create a default template in the root directory, it is used as template for all page files that
-have no explicit template set.
-
-webgen also uses the concept of a template chain to support multiple templates for one page file!
-For example, assume that
-
-* the page file @index.page@ has set the @template@ meta information to @special.template@,
-* the template @special.template@ has no @template@ meta information set and
-* the page file @other.page@ also has no @template@ meta information set.
-
-The template chain for @index.page@ would look like this
-
-@default.template@ <= @special.template@ <= @index.page@
-
-whereas the template chain for @other.page@ would look like this
-
-@default.template@ <= @index.page@
-
-The first case also means that the @special.template@ is nested in the @default.template@! This
-makes it possible, for example, to create a general website layout and then to create a special
-image gallery layout which uses the general one.
-
-To stop the template handler from further searching for a template, you explicitly need set a null
-template for the page or template file:
-
-  template: ~
-
-This is useful if you want to have a different @default.template@ in a sub directory which should
-provide a different look-and-feel for this subtree as the @default.template@ in the root of the
-website.

data/doc/src/documentation/plugins/file/thumbnailwriter.page

@@ -1,42 +0,0 @@
----
-title: ThumbnailWriter
-inMenu: true
-template: /plugin.template
-plugin: File/ThumbnailWriter
----
-h2(#description). Description
-
-
-This plugin is used by other plugins to create thumbnails for images. For example, the {plugin:
-File/GalleryHandler} uses it to automatically create thumbnails for all images in an image gallery.
-
-The {param: File/ThumbnailWriter:thumbnailSize} parameter has to be in the format "WIDTHxHEIGHT"
-where WIDTH and HEIGHT are numeric values specifying the width and the height for the thumbnail.
-
-The {param: File/ThumbnailWriter:resizeMethod} parameter specifies how the image should be resized
-for creating the thumbnail. *Be aware* that the value has to be a symbol, not a string (@:normal@
-instead of @normal@)!
-
-The following pictures illustrate the differences between the settings for a thumbnail size of
-100x100:
-
-<table class="examples">
-<tr>
-  <td>Original image (320x240)</td><td>@:normal@ (100x75)</td><td>@:cropped@ (100x100)</td>
-</tr>
-<tr>
-  <td style="vertical-align: top"><img src="{relocatable: /images/thumb_example.jpg}" alt="Thumbnail example image" /></td>
-  <td style="vertical-align: top"><img src="{relocatable: /images/thumb_example_normal.jpg}" alt="Thumbnail using normal resize method" /></td>
-  <td style="vertical-align: top"><img src="{relocatable: /images/thumb_example_cropped.jpg}" alt="Thumbnail using cropped resize method" /></td>
-</tr>
-</table>
-
-
-h2(#caveat). Caveat
-
-
-This plugin is only available if you have installed the
-"rmagick":http://rmagick.rubyforge.org/ library. The preferred way to do this is via
-Rubygems:
-
-  gem install rmagick

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

@@ -1,13 +0,0 @@
----
-title: Default
-directoryName: HtmlValidator
-inMenu: true
-omitIndexFileInBreadcrumbTrail: false
-template: /plugin.template
-plugin: HtmlValidator/Default
----
-h2(#description). Description
-
-
-This is the base plugin (does not provide any functionality) for all HTML validators. Have a look at
-individual validators to see what they can do for you!

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

@@ -1,12 +0,0 @@
----
-title: xmllint
-inMenu: true
-template: /plugin.template
-plugin: HtmlValidator/xmllint
----
-h2(#description). Description
-
-This plugin uses the @xmllint@ program from the "libxml2":http://www.xmlsoft.org package. @xmllint@
-can be used to validate an XML (and therefore an XHTML) 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/index.page

@@ -1,53 +0,0 @@
----
-title: Plugins
-directoryName: Plugins
----
-h2(#about). About
-
-
-All available plugins in the distribution are described in this section. Choose a plugin namespace
-to get more information!
-
-
-h2(#plugins). Plugins
-
-
-webgen is written with extensibility in mind; therefore most of its features are implemented using
-plugins, only the core functions are not plugins.
-
-Writing your own plugins is not difficult, too! If you need a specific functionality, implement a
-plugin and put it under the site specific @plugin@ directory - then the plugin gets loaded with the
-others. It's so easy!
-
-For more information have a look at the <a href="{relocatable: /api.html}">API documentation</a>!
-
-
-h3(#plugin-naming). Naming of Plugins
-
-
-Plugin names have an easy structure. The first part (before the slash) describes the namespace it is
-located in, the second part is the actual plugin name.
-
-Following is a list of the default namespaces and what they are used for:
-
-* *ContentConverter/*: plugins used for converting content into HTML
-* *Core/*: the core plugins of webgen
-* *File/*: all plugins handling files (ie. derived from {plugin: File/DefaultHandler})
-* *HtmlValidator/*: HTML validator plugins
-* *MenuStyle/*: menu style plugins
-* *Misc/*. miscellaneous plugins
-* *Tags/*: all tag plugins used by {plugin: Core/TagProcessor}
-
-
-h3(#plugin-param). Plugin Parameters
-
-
-Each plugin can define parameters which can be used to configure the plugin. These parameters are
-listed at the top of each plugin page. Also note that plugins can use the parameters from their
-"parent plugins" - this allows a group of plugins which have similar functionality (e.g. the menu
-style plugins) to share common configuration values. The names of the "parent plugins" are enclosed
-in parentheses after the plugin names in the "General Information" section.
-
-Parameters can have various types: String, Number, Boolean, Array... When setting a parameter via
-the configuration file, you need to ensure that it has the proper type. Have a look at
-"www.yaml.org":http://www.yaml.org for more information about supported types!

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

@@ -1,20 +0,0 @@
----
-title: Default
-directoryName: MenuStyle
-inMenu: true
-omitIndexFileInBreadcrumbTrail: false
-template: /plugin.template
-plugin: MenuStyle/Default
----
-h2(#description). Description
-
-
-This is the base plugin for all menu styles which are used by the {plugin: Tag/Menu} plugin. 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!
-
-This plugin defines some parameters that are used by the individual menu style plugins sothat
-the generated menus can be styled more easily with CSS.
-
-Have a look at the individual menu styles for more information!

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

@@ -1,36 +0,0 @@
----
-title: Horizontal
-directoryName: MenuStyle
-inMenu: true
-template: /plugin.template
-plugin: MenuStyle/Horizontal
----
-h2(#description). Description
-
-
-Builds a horizontal menu; each menu level gets its own menu bar.
-
-*Caveat*: You should link to the @webgen-css@ resource in your template as this plugin defines some
-CSS styles!
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Used parameters</th><th>Resulting menu</th>
-</tr>
-<tr>
-  <td>Using default values</td>
-  <td>{menu: {menuStyle: horizontal}}</td>
-</tr>
-<tr>
-  <td>Using default values and some CSS styles</td>
-  <td>{menu: {menuStyle: horizontal, options: {divClass: menu-example-horiz}}}</td>
-</tr>
-<tr>
-  <td>\{menu: {menuStyle: horizontal, options: {startLevel: 2, maxLevels: 2}}}</td>
-  <td>{menu: {menuStyle: horizontal, options: {startLevel: 2, maxLevels: 2}}}</td>
-</tr>
-</table>

data/doc/src/documentation/plugins/menustyle/horizontaldropdown.page

@@ -1,48 +0,0 @@
----
-title: HorizontalDropdown
-directoryName: MenuStyle
-inMenu: true
-template: /plugin.template
-plugin: MenuStyle/HorizontalDropdown
----
-h2(#description). Description
-
-
-Builds a horizontal menu with CSS drop down menus. This menu should work fine in any browser
-supporting CSS and the @:hover@ selector (Mozilla based browsers like Firefox, Opera and Konqueror
-are fine, does NOT work in IE 6 on Windows XP, not tested with IE 7).
-
-*Caveat*: You should link to the @webgen-css@ resource in your template as this plugin defines some
-CSS styles!
-
-
-h2(#style). Style Advice
-
-
-The menu works by only using CSS, not DHTML or anything else. Following is a list of CSS selectors
-and descriptions how these selectors can be used to style various parts of the menu. You have to pay
-attention to the last element in the selector (@ul@, @li@, or @a@). When you want to style menu
-items, you normally want to use @a@. You should also be aware of the use of the @>@ sign, there is a
-dramatic difference between writing @li a@ and @li > a@ (the former selecting ALL @a@ elements of
-the list item, i.e. all @a@ elements in submenus too; and the latter only selecting the direct
-descendants)!
-
-table{border: 1px solid black}.
-|<code>.webgen-menu-horiz-dd ul > li > a</code>|Style the top level menu items (the ones that are always shown)|
-|<code>.webgen-menu-horiz-dd ul ul</code>|Style the drop down menus|
-|<code>.webgen-menu-horiz-dd ul ul > li > a</code>|Style the drop down menu items|
-|<code>.webgen-menu-horiz-dd li:hover > a</code>|Style the hovered-over menu item|
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Used parameters</th><th>Resulting menu</th>
-</tr>
-<tr>
-  <td>Using default values</td>
-  <td>{menu: {menuStyle: horizontal-dropdown}}</td>
-</tr>
-</table>

data/doc/src/documentation/plugins/menustyle/section.page

@@ -1,34 +0,0 @@
----
-title: Section
-directoryName: MenuStyle
-inMenu: true
-template: /plugin.template
-plugin: MenuStyle/Section
----
-h2(#description). Description
-
-
-Builds a simple menu showing only the sections of the current page.
-
-
-h2(#examples). Examples
-
-<table class="examples">
-<tr>
-  <th>Used parameters</th><th>Resulting menu</th>
-</tr>
-<tr>
-  <td>Using default values</td>
-  <td>{menu: {menuStyle: section}}</td>
-</tr>
-<tr>
-  <td>\{menu: {menuStyle: section, options: {maxLevels: 1, numberSections: false}}}</td>
-  <td>{menu: {menuStyle: section, options: {maxLevels: 1, numberSections: false}}}</td>
-</tr>
-</table>
-
-
-h3(#sample). Sample sub section
-
-
-This section is just for demonstration purposes for the examples.

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

@@ -1,48 +0,0 @@
----
-title: Vertical
-directoryName: MenuStyle
-inMenu: true
-template: /plugin.template
-plugin: MenuStyle/Vertical
----
-h2(#description). Description
-
-
-This menu style builds a seemingly simple vertical menu. However, it is very flexible due to its
-many parameters that let you decide every detail of the menu. Have a look at the examples to see
-what is possible!
-
-
-h2(#style). 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 the CSS directive <code>list-style-type: none</code>).
-
-
-h2(#examples). Examples
-
-
-Following are some examples of this menu style with varying parameter values (without CSS styling).
-
-<table class="examples">
-<tr>
-  <th>Used parameters</th><th>Resulting menu</th>
-</tr>
-<tr>
-  <td>Using default values</td>
-  <td>{menu: {menuStyle: vertical}}</td>
-</tr>
-<tr>
-  <td>\{menu: {menuStyle: vertical, options: {maxLevels: 1}}}</td>
-  <td>{menu: {menuStyle: vertical, options: {maxLevels: 1}}}</td>
-</tr>
-<tr>
-  <td>\{menu: {menuStyle: vertical, options: {showCurrentSubtreeOnly: false, maxLevels: 3}}}</td>
-  <td>{menu: {menuStyle: vertical, options: {showCurrentSubtreeOnly: false, maxLevels: 3}}}</td>
-</tr>
-<tr>
-  <td>\{menu: {menuStyle: vertical, options: {startLevel: 2, maxLevels: 3}}}</td>
-  <td>{menu: {menuStyle: vertical, options: {startLevel: 2, maxLevels: 3}}}</td>
-</tr>
-</table>

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

@@ -1,29 +0,0 @@
----
-title: VerticalDropdown
-directoryName: MenuStyle
-inMenu: true
-template: /plugin.template
-plugin: MenuStyle/VerticalDropdown
----
-h2(#description). Description
-
-
-Builds a vertical menu with CSS drop down menus. This one is similar to the menu defined by {plugin:
-MenuStyle/HorizontalDropdown} and the information on its page also applies for this menu style.
-
-*Caveat*: You should link to the @webgen-css@ resource in your template as this plugin defines some
-CSS styles!
-
-
-h2(#examples). Examples
-
-
-<table class="examples">
-<tr>
-  <th>Used parameters</th><th>Resulting menu</th>
-</tr>
-<tr>
-  <td>Using default values</td>
-  <td>{menu: {menuStyle: vertical-dropdown}}</td>
-</tr>
-</table>

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

@@ -1,9 +0,0 @@
----
-title: Misc Plugins
-directoryName: Misc
----
-h2(#description). Description
-
-
-These plugins do not fit into any other category and are therefore located here. They are very
-useful nonetheless!

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

@@ -1,39 +0,0 @@
----
-title: SmileyReplacer
-inMenu: true
-template: /plugin.template
-plugin: Misc/SmileyReplacer
-emoticonPack: ~
----
-h2(#description). Description
-
-
-This plugin replaces smiley (ie. such sequences as <notextile>;-), :-)</notextile>, ...) with
-emoticons - graphics which express the same emotion as the smiley.
-
-You can enable or disable the replacement of smileys globally by setting the parameter {param:
-Misc/SmileyReplacer:emoticonPack} to an existing smiley package or @nil@. However, if a page has the
-meta information @emoticonPack@, this meta info takes precedence over the global value. So, if the
-replacement is globally enabled, you can disable it for a specifc page by setting the meta
-information @emoticonPack@ to @nil@ (this was done for this page so that you can see the character
-representation of the smileys). You can also change the used emoticon package for one page only by
-setting @emoticonPack@ to another package name.
-
-
-h2(#available-packs). Available Emoticon Packs
-
-
-Following is a table showing the available smileys and their representation with various emoticon
-packages. The header shows the smiley you have to use so that you get one of the emoticons below it,
-depending on the used emoticon package.
-
-Note: I have found these smileys in various places on the Internet and think they are free to use.
-If not, please mail me sothat I can remove them!
-
-Credits:
-
-* smellies: I have taken the smellies emoticons from "Kebawe.com":http://kebawe.com/smellies/ !
-* crystal: The crystal emoticons are from "http://kde-look.org/content/show.php?content=10681":http://kde-look.org/content/show.php?content=10681 .
-* icqstyle: These are from "http://kde-look.org/content/show.php?content=23226":http://kde-look.org/content/show.php?content=23226 .
-
-<notextile>{showEmoticonPacks:}</notextile>