0.80 (current)0.90-dev (under development)0.70 (past)

Font size:

Plugins Index

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

Plugins Index
- Released Plugins
- Whiteboard Plugins

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 developers should 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.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.dtdx
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.apache.forrest.plugin.input.excel

Description	Reads (simple) Excel sheets from the Excel "Save As" (Type=XML).
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.excel/
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.3
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.7

org.apache.forrest.plugin.input.feeder

Description	Embed syndicated content in a Forrest site.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.feeder
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.7

org.apache.forrest.plugin.input.listLocations

Description	Use lists of locations maintained in a simple xml format and transform them to documents.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.listLocations
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.7

org.apache.forrest.plugin.input.OpenOffice.org

Description	Use various OpenOffice.org document formats as input sources.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.OpenOffice.org
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.apache.forrest.plugin.input.PhotoGallery

Description	Create a photo Gallery by simply dropping your photos into a directory.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.PhotoGallery
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.3
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.7

org.apache.forrest.plugin.input.projectInfo

Description	Generates project info such as changelog and todo list.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.apache.forrest.plugin.input.simplifiedDocbook

Description	Enable Simplified Docbook to be used as input.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.simplifiedDocbook
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.apache.forrest.plugin.input.wiki

Description	Embed various wiki documents in a Forrest site.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.rblasch.forrest.plugin.input.pod

Description	Embed Pod (Plain Old Documentation) documents in a Forrest site.
Author	Ronald Blaschke
Website	http://www.rblasch.org/projects/pod-input/
Download URL:	http://www.rblasch.org/projects/pod-input
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.6

Output Plugins

Output plugins enable Forrest to produce documents in different formats.

org.apache.forrest.plugin.output.pdf

Description	Enable Forrest documents to be output in PDF format.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_90/org.apache.forrest.plugin.output.pdf
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.3
Minimum Forrest version required	Forrest-0.9 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.apache.forrest.plugin.output.POD

Description	Enable Forrest documents to be output in Plain Old Documentation (POD) format.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.POD
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

org.apache.forrest.plugin.output.Text

Description	Enable Forrest documents to be output in Text format.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Text
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.6

s5

Description	Create S5: A Simple Standards-Based Slide Show System presentations from xdocs.
Author	Ross Gardler
Website	http://forrest.apache.org/~rgardler/testingGround/forrestPlugins/s5
Download URL:	http://www.apache.org/~rgardler/testingGround/forrestPlugins/
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7

Internal Plugins

Internal plugins change the core behaviour of Forrest.

No plugins of this type available.

Whiteboard Plugins

Warning

See introduction for warnings about plugins in development.

Note

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.Database

Description	Read content from a relational database.
Author	Apache Forrest Project
Not yet published	This plugin has not yet been deployed. Only available in the development SVN repository.
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

org.apache.forrest.plugin.input.Daisy

Description	Allow content to be included from a Daisy CMS repository.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.Daisy/
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.8 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

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.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.input.logs
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

Output Plugins

Output plugins enable Forrest to produce documents in different formats.

org.apache.forrest.plugin.OpenOffice.org-output

Description	Generate output in RTF format.
Author	Apache Forrest Project
Not yet published	This plugin has not yet been deployed. Only available in the development SVN repository.
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

org.apache.forrest.plugin.output.Chart

Description	Charting plugin that utilises JChart.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.output.Chart
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

org.apache.forrest.plugin.output.htmlArea

Description	WYSIWYG editing of HTML documents (requires Forrest to be running dynamically).
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.output.htmlArea
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

rtf-output

Description	Generate output in RTF format.
Author	Apache Forrest Project
Not yet published	This plugin has not yet been deployed. Only available in the development SVN repository.
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.6
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

Internal Plugins

Internal plugins change the core behaviour of Forrest.

org.apache.forrest.internal.GoogleSitemap

Description	Generates a google-sitemap for all pages in each site.
Author	Apache Forrest Project
Not yet published	This plugin has not yet been deployed. Only available in the development SVN repository.
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

org.apache.forrest.plugin.internal.dispatcher

Description	Enable Forrest to use page-specific views and contracts. Next generation skinning.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_90/org.apache.forrest.plugin.internal.dispatcher
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.2
Minimum Forrest version required	Forrest-0.9 is required to use the most recent version of this plugin.
Other versions	Older versions are available to suit this "0.7" version of Forrest. This will be detected automatically. For documentation, please browse.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.

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.
Author	Apache Forrest Project
Website	http://forrest.apache.org/pluginDocs/plugins_0_70/org.apache.forrest.plugin.internal.IMSManifest
Download URL:	http://forrest.apache.org/plugins/
Latest Plugin version	0.1
Minimum Forrest version required	Forrest-0.7 is required to use the most recent version of this plugin.
Initial Forrest version	This plugin was first available for Forrest-0.7
Warning	This plugin is in the whiteboard development area. See notes in the introduction above.