Location: webgen / Documentation / Plugins Language: en Feedback: Click here

About

All available plugins in the distribution are described in this section. Choose a plugin namespace to get more information!

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 API documentation!

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 File/DefaultHandler)
• HtmlValidator/: HTML validator plugins
• MenuStyle/: menu style plugins
• Misc/. miscellaneous plugins
• Tags/: all tag plugins used by Core/TagProcessor

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 for more information about supported types!