apache > forrest
 
 
PDF -icon
PDF
Font size:      

Plugins Index

This is documentation for current version v0.7 (More)

Plugins Index

Plugins are a way of extending Forrest to satisfy site-specific needs. If a site requires one or more plugins then the site designer will have named them in the project.required.plugins property in the projects forrest.properties file. When Forrest builds the site it will automatically discover the plugin and install it. For more information on how to use plugins see Extending Forrest with Plugins .

This page lists all plugins that have been recognised by the Apache Forrest project. There are two sections to this page, the first is the released plugins, The second is the whiteboard plugins. Any plugins in the released section have been verified as working in the versions of Forrest specified. However, this verification does not imply that the plugins are mature, merely that they work as documented. See the plugin documentation for how mature they are and the features they support.

The second section lists plugins in the whiteboard, that is plugins that may change considerably in how they work before their first official release. These plugins may not be fully functional, in most cases they are usable, but use them with caution as they are not considered stable. You would need to keep up-to-date with the dev@ mailing list.

Note
If you have created a plugin that is not listed here please let us know.
Note
The minimum version of Forrest is for latest version of the plugin, there may be an earlier versions of the plugin for earlier versions of Forrest. If you do not define a version number for the plugin it will always use the latest version compatible with your version of Forrest. However, be aware that if you are using a development version of forrest, you will also be using development versions of the plugins.

Released Plugins

Input Plugins

Input plugins enable Forrest to work with source documents in different formats.

org.apache.forrest.plugin.input.dtdx
Description

Use the NekoDTD tool packaged as a Cocoon Generator to automatically generate some hyperlinked DTD reference documentation.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.dtdx
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.excel
Description

Reads (simple) Excel sheets from the Excel "Save As" (Type=XML).

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.excel/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.3
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.feeder
Description

Embed syndicated content in a Forrest site.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.feeder
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.listLocations
Description

Use lists of locations maintained in a simple xml format and transform them to documents.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.listLocations
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.OpenOffice.org
Description

Use various OpenOffice.org document formats as input sources.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.OpenOffice.org
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.PhotoGallery
Description

Create a photo Gallery by simply dropping your photos into a directory.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.PhotoGallery
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.3
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.projectInfo
Description

Generates project info such as changelog and todo list.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.simplifiedDocbook
Description

Enable Simplified Docbook to be used as input.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.simplifiedDocbook
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.wiki
Description

Embed various wiki documents in a Forrest site.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.rblasch.forrest.plugin.input.pod
Description

Embed Pod (Plain Old Documentation) documents in a Forrest site.

AuthorRonald Blaschke
Websitehttp://www.rblasch.org/projects/pod-input/
Download URL:http://www.rblasch.org/projects/pod-input
Latest Plugin version0.1
Minimum Forrest version required * 0.7

Output Plugins

Output plugins enable Forrest to produce documents in different formats.

org.apache.forrest.plugin.output.inputModule
Description

Enable Forrest to produce properties from an input-module.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.inputModule
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.output.pdf
Description

Enable Forrest documents to be output in PDF format.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.output.POD
Description

Enable Forrest documents to be output in Plain Old Documentation (POD) format.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.POD
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.output.Text
Description

Enable Forrest documents to be output in Text format.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Text
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.2
Minimum Forrest version required * 0.8
s5
Description

Create S5: A Simple Standards-Based Slide Show System presentations from xdocs.

AuthorRoss Gardler
Websitehttp://forrest.apache.org/~rgardler/testingGround/forrestPlugins/s5
Download URL:http://www.apache.org/~rgardler/testingGround/forrestPlugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.7

Internal Plugins

Internal plugins change the core behaviour of Forrest.

No plugins of this type available.

Whiteboard Plugins

Warning
See introduction for notes about plugins in development.
Warning
Plugins in this section may not automatically deploy when you run Forrest as they are still in development. You may need to perform some manual installation steps to use them. See the plugin documentation for more details.

Input Plugins

Input plugins enable Forrest to work with source documents in different formats.

org.apache.forrest.plugin.input.citations
Description

List of citations.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.citations/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.Daisy
Description

Allow content to be included from a Daisy CMS repository.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.Daisy/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.doap
Description

Embed DOAP files in forrest content objects.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.doap/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.ecs
Description

Process responses from Amaozons E-Commerce System web services.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.ecs/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.glossary
Description

Enable glossary: a list of technical terms and definitions.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.logs
Description

Embed log file output in Forrest sites. If Forrest is running in a dynamic environment, then pages can be updated to show recent changes in the log whenever required.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.input.logs
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.7
org.apache.forrest.plugin.input.odt
Description

Use OpenDocument Writer files (*.odt) as input sources.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.odt
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.Resume
Description

Basic support for Resumes, renders a single resume, or alloes sorting of a number of resumes on skill.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.Resume
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.input.serverStatus
Description

Provides a list of the Cocoon cache and other server status information.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.serverStatus
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8

Output Plugins

Output plugins enable Forrest to produce documents in different formats.

org.apache.forrest.plugin.output.Anakia
Description

Produce output in Anakia "xdoc" format.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/
Download URL:http://forrest.apache.org/plugins
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.output.Chart
Description

Charting plugin that utilises JChart.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.output.Chart
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.7
org.apache.forrest.plugin.output.htmlArea
Description

WYSIWYG editing of HTML documents (requires Forrest to be running dynamically).

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.output.htmlArea
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.7
org.apache.forrest.plugin.output.solr
Description

Generates solr documents from xdos. Further when run with the dispatcher it provides a GUI to manage your project in solr and a search interface to search your solr server.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.solr
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.output.voice
Description

Add voiceXML content to a Forrest page. This allows the page to be read by a voice synthesiser and navigated with voice commands.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.voice
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.themes.core
Description

The core theme package for the dispatcher.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.themes.core
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.8

Internal Plugins

Internal plugins change the core behaviour of Forrest.

org.apache.forrest.plugin.internal.dispatcher
Description

Enable Forrest to use page-specific views and contracts. Next generation skinning.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.8
org.apache.forrest.plugin.internal.IMSManifest
Description

Use an IMS Manifest file to manage site structure. Generates site.xml and tabs.xml from an imsmanifest.xml file when one is available. Also enables content in one Content Package to be embedded in another.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.internal.IMSManifest
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.7
org.apache.forrest.plugin.internal.NoteTaking
Description

Provides facilities for adding notes to pages when Forrest is run in dynamic mode.

AuthorApache Forrest Project
Websitehttp://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.NoteTaking
Download URL:http://forrest.apache.org/plugins/
Latest Plugin version0.1
Minimum Forrest version required * 0.8