Author: rgardler
Date: Tue Dec 13 14:59:59 2005
New Revision: 356641
URL: http://svn.apache.org/viewcvs?rev=356641&view=rev
Log:
add some docs on the new way to generate locationmap from daisy and provide
default properties wehere possible
Added:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/default.plugin.properties.xml
(with props)
Modified:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/resources.xmap
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml
Added:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/default.plugin.properties.xml
URL:
http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/default.plugin.properties.xml?rev=356641&view=auto
==============================================================================
---
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/default.plugin.properties.xml
(added)
+++
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/default.plugin.properties.xml
Tue Dec 13 14:59:59 2005
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<properties>
+ <!-- Daisy plugin properties -->
+ <property name="daisy.pathPrefix" value=""/>
+</properties>
Propchange:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/default.plugin.properties.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/resources.xmap
URL:
http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/resources.xmap?rev=356641&r1=356640&r2=356641&view=diff
==============================================================================
---
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/resources.xmap
(original)
+++
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/resources.xmap
Tue Dec 13 14:59:59 2005
@@ -49,8 +49,8 @@
<map:pipeline>
<map:match pattern="daisy.site.*">
- <map:generate src="{lm:{0}}" />
- <map:transform src="{lm:daisy.transform.navigation.siteSnippet}"/>
+ <map:generate
src="{project:daisy.publisher.URL}blob?documentId={1}&version=live&partType=1"
/>
+ <map:transform
src="{forrest:plugins}/org.apache.forrest.plugin.input.Daisy/resources/stylesheets/navigation-to-siteSnippet.xsl"/>
<map:transform type="xinclude"/>
<map:serialize type="xml" />
</map:match>
Modified:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml?rev=356641&r1=356640&r2=356641&view=diff
==============================================================================
---
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml
(original)
+++
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml
Tue Dec 13 14:59:59 2005
@@ -31,52 +31,95 @@
<section>
<title>Usage</title>
- <warning>The 0.3-Dev Daisy plugin does not allow you to mix
- Daisy content with non-Daisy content. You should continue to
- use version 0.2 if you need to mix content from multiple sources.
- This is a temporary restriction.</warning>
-
<p>This plugin allows content to be retrieved from a
<a href="http://www.cocoondev.org/daisy/";>Daisy CMS repository</a>
and displayed alongside any other Forrest content. Unlike many
other plugins there is some configuraiton of your project requried.</p>
-
+
<section>
- <title>Locationmap Configuration</title>
-
- <p>The project locationmap for a Daisy generated site is automatically
- created from the daisy navigation documents. In order to tell Forrest
- how to generate these documents you must add a matcher to your
- project sitemap as follows:</p>
+ <title>Configuration</title>
- <source><![CDATA[
-<map:match pattern="locationmap-project.xml">
- <map:generate src="http://username:[EMAIL
PROTECTED]:9263/publisher/blob?documentId=NAVIGATION-DOCUMENT-ID&version=live&partType=1"/>
- <map:transform
src="{forrest:plugins}/org.apache.forrest.plugin.input.Daisy/resources/stylesheets/navigation-to-locationmap.xsl">
- <map:parameter name="publisherURL" value="http://username:[EMAIL
PROTECTED]:9263/publisher/"/>
- <map:parameter name="pathPrefix" value="/"/>
- </map:transform>
- <map:transform rtype="xinclude"/>
- <map:serialize type="xml"/>
-</map:match>
- ]]></source>
-
- <p>The <code>pathPrefix</code> is a prefix added to all paths to
documents
- that are to be retrieved from the Daisy repository. It can, of course,
be ommitted
- in which case there will no prefix.</p>
-
- <p>If your site needs to provide additional locationmap entires it can
- do so by including them in
-
<code>PROJECT_HOME/src/documentation/locationmap-daisy-include.xml</code>.
- The matchers in this file will override any of the auto-generated
matchers
- from the Daisy navigation file.</p>
+ <section>
+ <title>Locationmap</title>
+
+ <p>The project locationmap for a Daisy generated site is
automatically
+ created from the daisy navigation documents. This allows the URL of
the
+ published Forrest site to be set within the Daisy CMS system as
opposed
+ to using the daisy ID for the page.</p>
+
+ <p>In order for Forrest to know the id of the navigation document to
be
+ used your project must set some required properties
+ (see below for details). The project also needs to provide the
following match in
+ PROJECT_HOME/sitemap.xmap:</p>
+
+ <source><![CDATA[
+ <map:match pattern="locationmap-project.xml">
+ <map:generate
src="{project:daisy.publisher.URL}blob?documentId={project:daisy.navigation.docID}&version=live&partType=1"/>
+ <map:transform
src="{forrest:plugins}/org.apache.forrest.plugin.input.Daisy/resources/stylesheets/navigation-to-locationmap.xsl">
+ <map:parameter name="publisherURL"
value="{project:daisy.publisher.URL}"/>
+ <map:parameter name="pathPrefix"
value="{project:daisy.publisher.URL}"/>
+ <map:parameter name="navigationID"
value="{project:daisy.navigation.docID}"/>
+ </map:transform>
+ <map:transform type="xinclude"/>
+ <map:serialize type="xml"/>
+ </map:match>
+ ]]></source>
+
+ <p>If your site needs to provide additional locationmap entries it
can
+ do so by including them in
+ <code>PROJECT_HOME/src/documentation/locationmap-include.xml</code>.
+ The matchers in this file will override any of the auto-generated
matchers
+ from the Daisy navigation file. The location of this file can be
changed
+ by overriding the locationmap pattern
<code>daisy.locationmap.include</code>.</p>
- <note>It is recomended that the pipelines that generate the locationmap
- are cached for at least 1 hour. This is because it is computationally
- expensive to regenerate these files. A future version of this plugin
will provide
- a more flexible caching mechanism. But for now you need to force a
refresh
- during development.</note>
+ <note>The pipelines that generate the locationmap
+ are cached for 2 hours. This is because it is computationally
+ expensive to regenerate these files. A future version of this plugin
will provide
+ a more flexible caching mechanism. But for now you need to force a
refresh
+ during development or override the locationmap match in the plugin
sitemap.</note>
+ </section>
+ <section>
+ <title>Properties</title>
+
+ <p>The table below describes all properties that this plugin
exposes.</p>
+
+ <table>
+ <tr>
+ <th>Property Name</th>
+ <th>Description</th>
+ <th>Default</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>daisy.publisher.URL</td>
+ <td>The URL of the Diasy repository. This URL is the complete
+ URL to the publisher interface, for example
+ <code>http://username:[EMAIL
PROTECTED]:9263/publisher/</code>.</td>
+ <td>No default</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>daisy.navigation.docID</td>
+ <td>The diasy ID for the navigation document to use.</td>
+ <td>No default</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>daisy.index.docID</td>
+ <td>The daisy ID of the document to return when requesting
"/index.html".</td>
+ <td>No default</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>daisy.pathPrefix</td>
+ <td>A prefix added to all paths to documents
+ that are to be retrieved from the Daisy repository.</td>
+ <td>Empty String</td>
+ <td>No</td>
+ </tr>
+ </table>
+ </section>
</section>
<section>
