2007-02-28: webgen 0.4.2 released! Bugs fixed and some feature added! More...
2007-01-12: webgen 0.4.1 released! Bug fix for running webgen on Windows and other small updates! More...
2007-01-05: webgen 0.4.0 released! Major update to the core and plugins and many new features added! More...
Each plugin can specify parameters. Here is a list of all available parameters for a quick lookup, ordered by category and then name (only plugins with parameters are shown!):
customVars: {}
A hash with global custom variables.
lang: "en"
The default language.
loggerLevel: 2
The logging level, ranges from 0 (debug, more verbose) to 3 (error, less verbose)
outDir: "output"
The directory to which the output files are written.
srcDir: "src"
The directory from which the source files are read - is automatically set and cannot be overridden.
websiteDir: nil
The website directory - is automatically set and cannot be overridden!
defaultMetaInfo: {}
The keys for this hash are the names of file handlers, the values hashes with meta data.
ignorePaths: ["**/CVS{/**/**,/}"]
An array of path patterns which match files that should be excluded from the list of 'to be processed' files.
resources: []
User defined file resources. Value has to be an array of arrays with three strings defining name, resource path and output path
erbPaths: ["**/*.rhtml", "**/*.rcss"]
The path patterns which match the files that should get preprocessed by ERB. The leading letter r is removed from the extension.
paths: ["**/*.css", "**/*.js", "**/*.jpg", "**/*.png", "**/*.gif"]
The path patterns which match the files that should get copied by this handler.
galleryPageTemplate: "gallery_gallery.template"
The template for gallery pages. If nil or a not existing file is specified, the default template is used.
imagePageTemplate: "gallery_image.template"
The template for image pages. If nil or a not existing file is specified, the default template is used.
images: "images/**/*.jpg"
The path pattern for specifying the image files
imagesPerPage: 20
Number of images per gallery page
mainPageTemplate: "gallery_main.template"
The template for the main page. If nil or a not existing file is specified, the default template is used.
defaultLangInFilename: false
If true, the output files for the default language will have the language in the file name like all other page files. If false, they wont.
outputNameStyle: [:name, [".", :lang], ".html"]
Defines how the output name should be built. The correct name will be used for the :name part and the file language will be used for the :lang part. If defaultLangInFilename is true, the :lang part or the subarray in which the :lang part was defined, will be omitted.
validator: nil
The validator for checking HTML files on their validness. Set to an empty string or nil to prevent checking.
defaultTemplate: "default.template"
The default file name for the template file.
args: "--catalogs --noout --valid"
Arguments passed to the xmllint command
divClass: "webgen-menu"
Additional CSS class for the div-tag surrounding the menu.
selectedMenuitemClass: "webgen-menu-item-selected"
Specifies the class of the selected menu item.
submenuClass: "webgen-menu-submenu"
Specifies the class of a submenu.
submenuInHierarchyClass: "webgen-menu-submenu-inhierarchy"
Specifies the class of the submenus which are in the hierarchy of the selected menu item.
maxLevels: 3
Specifies the maximum number of levels that should be shown.
numberSections: true
Specifies whether the section titles should be numbered
maxLevels: 3
Specifies the maximum number of levels that should be shown. For example, if maxLevels = 1, then only one level is shown.
minLevels: 1
Specifies how many levels should be always be shown, ie. how deep the menu is. For example, if minLevels = 3, then three levels are always shown at least.
showCurrentSubtreeOnly: true
True if only the current subtree should be shown in the menu. If set to false, each subtree will be shown.
startLevel: 1
The level at which the menu starts. For example, if set to 2 the top most menu items are not shown.
emoticonPack: nil
The name of the emoticon package which should be used. If set to nil, smileys are not replaced.
blockName (=default mandatory parameter): "content"
The name of the block which should be rendered.
omitIndexFile: false
Omits the last path component if it is an index file.
omitLast: false
Omits the last path component.
separator: " / "
Separates the hierachy entries from each other.
var (=default mandatory parameter): nil
The variable of which the value should be retrieved.
format: "%A, %B %d %H:%M:%S %Z %Y"
The format of the date (same options as Ruby's Time#strftime).
alwaysShowDownloadIcon: false
Specifies if the download icon should always be shown, or only when no icon is available for the file type.
icon: nil
The URL to an icon which will be shown next to the name.
mappingFile: nil
An additional mapping file used for mapping extensions to icons.
url (=default mandatory parameter): nil
The URL to the file. Can be a local file or one referenced via HTTP/FTP.
command (=default mandatory parameter): nil
The command which should be executed
escapeHTML: true
Special HTML characters in the output will be escaped if true
highlight: nil
Name of language that should be used for syntax highlighting the output of the command. If set to nil, no highlighting is performed. Available langs:
processOutput: true
The output of the command will be further processed by the TagProcessor if true
escapeHTML: true
Special HTML characters in the file content will be escaped if true
filename (=default mandatory parameter): nil
The name of the file which should be included (relative to the file specifying the tag).
highlight: nil
Name of language that should be used for syntax highlighting of the content of the file. If set to nil, no highlighting is performed. Available langs:
processOutput: true
The file content will be scanned for tags if true
separator: " | "
Separates the languages from each other.
showOwnLang: true
Should the link to the currently displayed language page be shown?
showSingleLang: true
Should the link be shown although the page is only available in one language?
menuStyle (=default mandatory parameter): nil
Specifies the style of the menu.
options: {}
Options that are passed on to the plugin which layouts the menu.
path (=default mandatory parameter): nil
The path which should be relocatable
resolveFragment: true
Specifies if the fragment part (#something) in the path should also be resolved
insert: :path
What should be returned by the tag: the path to the resource (value :path) or the data (value :data)
name (=default mandatory parameter): nil
The name of the resource
honorInMenu: true
Only pages for which the 'inMenu' meta information is set are shown in the sitemap if true
itemTag: "li"
The tag used for hierarchy items.
levelTag: "ul"
The tag used for creating a new hierarchy level.
invalidChars (=mandatory parameter): " &;"
The characters which are invalid in wiki URLs.
linkText: nil
The text of the link. If it is not specified, the title of the current page is used.
relURL: nil
The relativ URL for the wiki link (the varying part that is appended to rootURL). If it is not specified, the title of the current page is used.
replacementChar (=mandatory parameter): "_"
The character(s) which should be used instead of the invalid characters.
rootURL (=mandatory parameter): "/wiki/wiki.pl?"
The root URL for the wiki link, ie. the path to the wiki CGI.