Sitemap reference doc should be updated to reflect plugin architecture

• Key: FOR-546
• Type: Improvement
• Status: Closed
• Resolution: Fixed
• Priority: Major
• Assignee: Unassigned
• Reporter: Ron Blaschke
• Component/s: Documentation and website
• Affects Version/s: 0.7
• Fix Version/s: 0.8

Description

The example at http://forrest.apache.org/0.7/docs/sitemap-ref.html#pdf uses a fo2pdf serializer. This probaly worked in versions < 0.7, because the PDF output feature was in the core, and the serializer was very likely declared there.

With version 0.7, PDF output is moved to a plugin, the fo2pdf serializer seems to be no longer there. The serializer should probably be added to the example, for completeness.

  <map:components>
    <map:serializers>
      <map:serializer name="fo2pdf"
                      src="org.apache.cocoon.serialization.FOPSerializer"
                      mime-type="application/pdf"/>
    </map:serializers>
  </map:components>

I found out about this because my sitemap uses the fo2pdf too (docbook to PDF), and had to add the serializer.

Comments

[Ross Gardler]

If you want to output PDF documents then just add the PDF plugin to your forrest.properties and request the PDF document as normal. There is no need to add anything to your sitemap.

The document you reference is intended to help people understand how the forrest sitemaps work so that they can learn how to extend them.

However, with the creation of plugins this document is largely outdated. It should be updated to reflect the use of, and creation of, plugins.

[Ross Gardler]

Updated priority and title to better reflect the issue.

[Ron Blaschke]

Sorry, should have been more specific. I am using the docbook stylesheets (http://docbook.sourceforge.net/projects/xsl/index.html), and my own pipeline.

    <map:pipeline>
      <map:match pattern="design.pdf">
        <map:generate src="{project:content.xdocs}design.xml"/>
        <map:transform src="resources/stylesheets/docbook/fo/docbook.xsl"/>
        <map:serialize type="fo2pdf"/>
      </map:match>
    </map:pipeline>

I know, this is my problem and not forrest's, but adding the fo2pdf serializer is something that people need to be aware of when upgrading from 0.6 to 0.7. But I guess http://forrest.apache.org/0.7/docs/faq.html#docbook a sufficient hint...

[Thorsten Scherler]

Added note to look into the plugin.

[David Crossley]

I think that you closed this issue too early Thorsten. Please see Ross' comments on 18/Jun/05 ... the whole document needs attention. I added a note to issue FOR-922 to cover it.