Font size:
Welcome to the POD Output Plugin
This is documentation for current version v0.7
(More)
Apache Forrest - POD Output Plugin
This plugin allows Forrest files to be output in the Perl Plain Old Documentation (POD) format, text with minimal formatting directives. If on a *nix system with perl installed, see "man perlpod".
How to Use the POD Plugin
The plugin needs to be incorporated into your existing build of Forrest. To do this,
- cd $FORREST_HOME/plugin/
- $FORREST_HOME/tools/ant/bin/ant local-deploy
Once you have the text plugin installed, it is simply a case of requesting a file with a pod extension. For example, this page as pod.
To have a POD link created in your project documentation, there are two things you will need to do:
- Edit your forrest.properties file and add org.apache.forrest.plugin.pod-output to the project.required.plugin property.
- Edit your skinconf.xml and set the <disable-pod-link> element to false.
