Add documentation to explain how to aggregate using Cocoon aggregation and using XInclude

• Key: FOR-814
• Type: Task
• Status: Open
• Priority: Major
• Assignee: Unassigned
• Reporter: David Crossley
• Component/s: Documentation and website

Description

Add documentation to explain how to aggregate data.

Comments

[David Crossley]

See explanation in the thread:
http://mail-archives.apache.org/mod_mbox/forrest-user/200602.mbox/[e-mail]%3e

Using XInclude is often easier than modifying the sitemap in this way.

Here you would provide a sitemap match to generate your required data (see links in Davids mail) and then use XInclude in your source XML similar to your "transform" element above.

You can see examples of how to do this in the Chart plugin inthe whitebaord. For example "samples/graph1.xml" in the plugin docs includes:

<!-- combine is the way the datasets are placed together. I imagine "compare", "add" will be\possible among others
<graph combine="compare">
  <style>
    <!-- Use the specified "style" sheet.
    Format of the url is yet to be specified. -->
    <xi:include href="linechart1.xml"/>
  </style>

[David Crossley]

Enhanced issue summary. Also removed "Patch Available": the attachment provides some example sitemap and XSL for doing Cocoon sitemap aggregation.

[Carlos Tejo]

Example of xinclude attached.

Also, add <xinclude label="xinclude" href="xinclude.html" description="Test of Xinclude"/>

in documentation\content\xdocs\site.xml

[Gavin]

Hi Carlos, thanks for your example.

I have added it to our fresh-site area, so this example will now be part of the default site structure whenever you do a 'forrest seed-sample' to initiate a new site. It will also show shortly on our zone area (forrest.zones.apache.org).

[Gavin]

XInclude patch added, perhaps there are more examples required before closing issue?

[Gavin]

The patch has been reverted for now, nothing wrong with the patch itself, but our xdocs validation now fails if we use it. Currently it seems we have no xinclude support in our xdoc dtd, we are looking at it.

See comments on mail list at http://marc.info/?l=forrest-dev&m=121649882401304&w=2

[David Crossley]

Thanks Carlos. Now that XInclude is added to the DTD (see FOR-1032), i have added your contribution. I tweaked your explanation a bit. It is not "raw content" - that is a term that we use for something else. I also removed "tab" characters from your files - we don't use them, only spaces.

I enhanced your example to show use of XInclude in the "site.xml" navigation too. Also added an example of using xpointer, and another example of using XInclude to include a text file.

[David Crossley]

I left this issue open because the original intent was to provide documentation that shows how to use Cocoon sitemap to do aggregation.