Overview

+ Howto +

+ In your project's forrest.properties file make the + following changes ... +

+ Declare the org.apache.forrest.plugin.output.Anakia + plugin at the project.required.plugins property + (comma-separated list). +
+ Uncomment the project.start-uri property and set it to be + anakia-start.xml +

- One use of this plugin is to export a Forrest-based site to Anakia - "xdoc". + Now do 'forrest' to build your site as normal.

- Forrest can then be used as normal, to draw together source content - in various formats, and export a set of consistent documents. + Alongside each *.html file there will now be a matching + *.xdoc file.

- Howto +

+ How it works +

+ Explanation of how this plugin works + and how its output can be enhanced with additional processing. +

+ Without touching any of the site source content or navigation system, + we need to additionally inject another set of links to be processed. + Each html output document will then also have a matching URI with + *.xdoc extension. +

+ This is achieved with the input.xmap sitemap. For the + requested pipeline anakia-start.xml Forrest will generate + the "linkmap" of the site navigation, then apply a transformation + to amend each link. +

+ This automatically enables the crawler to gather this set of links. +

- You need a link from each page to its .xdoc version. The - easiest way to do that is with the new whiteboard - Dispatcher - functionality. Follow the "Quickstart" document. Edit your new structurer panels to add - a new contract "content-anakia-link" following the existing "content-pdf-link". - A contract is provided in the o.a.f.plugin.output.Anakia plugin at - resources/themes/common/html/content-anakia-link.ft to copy to the same place in your project. + The output.xmap sitemap then handles each xdoc URI to + transform the internal content structure. This plugin provides one + stylesheet document-to-xdoc.xsl then applies a core + transformation to make the xml output a bit more pretty.

- Don't forget to declare the o.a.f.plugin.output.Anakia plugin (and the usual Dispatcher - plugins) in your project's forrest.properties file. + To enhance the output, either amend the document-to-xdoc.xsl + stylesheet (and please send changes) or insert another transformation + of your own. In the output.xmap after the abovementioned + transformation, add the line + <map:transform src="{lm:anakia.transform.xdoc.mine}"/> + and add your stylesheet (following the locationmap naming convention) at + resources/stylesheets/xdoc-to-mine.xsl

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml?rev=952521&r1=952520&r2=952521&view=diff ============================================================================== --- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml (original) +++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml Tue Jun 8 03:35:46 2010 @@ -39,6 +39,7 @@ See http://forrest.apache.org/docs/linki + Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml?rev=952521&r1=952520&r2=952521&view=diff ============================================================================== --- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml (original) +++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml Tue Jun 8 03:35:46 2010 @@ -30,6 +30,14 @@ + + + Developed a much better way to configure this plugin. + See the overview page Howto section. + Removed the need for Dispatcher. So this plugin has no dependencies + and can be easily applied to any site using 0.8 release or newer. + + Update "content-anakia-link.ft" and instructions to use recent development @@ -47,6 +55,10 @@ + See issues at issue tracker in the + "Plugin: output.Anakia" Component. + + Enable use of the .xml filename extension, rather than the current .xdoc extension. This requires some work on Forrest internals. Modified: forrest/trunk/whiteboard/plugins/whiteboard-plugins.xml URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/whiteboard-plugins.xml?rev=952521&r1=952520&r2=952521&view=diff ============================================================================== --- forrest/trunk/whiteboard/plugins/whiteboard-plugins.xml (original) +++ forrest/trunk/whiteboard/plugins/whiteboard-plugins.xml Tue Jun 8 03:35:46 2010 @@ -237,9 +237,11 @@ author="Apache Forrest Project" website="http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/" url="http://forrest.apache.org/plugins/" - version="0.1"> + version="0.2"> - Produce output in Anakia "xdoc" format. + Produce output in Anakia-like "xdoc" format. Enables use of Forrest as a + tool for gathering input from various sources, and export a consistent + set of xml output documents. 0.8