webgen logo

webgen / static website generator

static website generation made easy!

Sub Menu

Tips

  • The basics pagecontains everything one needs to get going with webgen!
  • Descriptions for plugins can be found in the plugins section

Latest news

2007-12-31: Minor release with feature enhancements. More...

2007-09-08: Small bug fix release. More...

2007-06-29: Some bug fixes and one small feature enhancement. More...

Links

Generated by webgen

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…

NameTypeExampleValid forDescription
blocks Array of Arrays [[content, markdown], [sidebar, html]] Page/Template file Sets the name and format of content blocks. Each sub-array contains, in this order, the name of the block and its format.
directoryName String Image Directory Any 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.
emoticonPack String bigeyes Page file Sets the emoticon package which should be used for the page.
indexFile String getting.page Directory Sets the directory index file for the directory overriding the default value.
inMenu Boolean true Any Specifies if the file/directory should appear in menus.
lang String de Page file Sets the language for the page file. Has to be a valid ISO-639-1/2 character code for the language.
linkAttrs Hash {title: Hallo, class: extra} Any Specifies additional attribute-value pairs (in form of a Hash) that should be added to a link to the file/directory.
link_callback String (Ruby code) "<a#{attrs}>#{link_text} + some text</a>" Any Can be used to customize the link generated for the node. The available variables are:
node: The node to which the link points.
ref_node: The reference node.
attrs: A string of compiled HTML attributes that should be on the link element.
link_text: The text for the link.
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.
omitIndexFileInBreadcrumbTrail Boolean false Index file Controls whether the index file should appear in a breadcrumb trail despite the setting of the Tag/BreadcrumbTrail:omitIndexFile parameter.
orderInfo Integer 15 Any 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.
outputNameStyle String [:name, [”.”, :lang], ”.html”] Page file 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 File/PageHandler:defaultLangInFilename is false.
template String my.template Page/Template file 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!
title String New Title Any Sets the title for the file/directory.
useERB Boolean false Page/Template file Specifies if the content blocks of the page/template file should be processed with ERB overriding the default value.