You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by rg...@apache.org on 2005/04/23 02:18:00 UTC
svn commit: r164304 -
/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml
Author: rgardler
Date: Fri Apr 22 17:18:00 2005
New Revision: 164304
URL: http://svn.apache.org/viewcvs?rev=164304&view=rev
Log:
add basic docs
Modified:
forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.Daisy/src/documentation/content/xdocs/index.xml
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=164304&r1=164303&r2=164304&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 Fri Apr 22 17:18:00 2005
@@ -23,15 +23,67 @@
<body>
<section>
<title>Apache Forrest - org.apache.forrest.plugin.input.Daisy Plugin</title>
- <p>This plugin retrieves documents from a <a href="http://www.cocoondev.org/daisy">Daisy</a>
+ <p>This plugin retrieves documents from a
+ <a href="http://www.cocoondev.org/daisy">Daisy</a>
repository.</p>
-
- <section>
- <title>Examples</title>
- <ul>
- <li><a href="daisy/index.html?repositoryType=daisy&repositoryURL=www.cocoondev.org">Daisy Home Page</a> (retrieved live, you must be online)</li>
- </ul>
- </section>
+ </section>
+
+ <section>
+ <title>Usage</title>
+
+ <p>Perhaps the most important thing to realise about this plugin is that
+ there is no relationship between the Forrest URL space and the URL space
+ defined in the Daisy repository. That is the path to and the name of each
+ document within Forrest needs not be the same as the path to and the name
+ of the document within the Daisy repository.</p>
+
+ <p>This enables the repository to be structured in a way that is
+ appropriate for it's editors and the Forrest document collection can
+ be structured in a way that is appropriate for the target audience. In
+ fact, it is possible to use the same document from a Daisy repository in
+ multiple Forrest collections each using a completely different URL
+ space that is custom designed for the end user of the document
+ collection.</p>
+
+ <p>In order to tell Forrest which document to retrieve from the
+ repository you need to pass a number of request parameters in the URL.
+ These are listed in the table below.</p>
+
+ <table>
+ <caption>Request Parameters</caption>
+ <tr>
+ <th>Parameter</th>
+ <th>Comments</th>
+ </tr>
+ <tr>
+ <th>repositoryURL</th>
+ <td>The URL of the Daisy-Wiki interface to the repository.</td>
+ </tr>
+ <tr>
+ <th>repositoryPort</th>
+ <td>The Port number of the daisy-wiki application. If
+ ommitted the default value of 80 is used.</td>
+ </tr>
+ <tr>
+ <th>repositoryCollection</th>
+ <td>The name of the collection in which the document is stored.</td>
+ </tr>
+ <tr>
+ <th>documentID</th>
+ <td>The ID of the document within Daisy. This can be the numeric
+ identifier used by Daisy repository or it can be any valid ID as
+ defined within the Daisy-Wiki. The documentID can also define
+ a version and/or variant of the document if required. This is done
+ in exactly the same way as would be done in he Daisy-Wiki.</td>
+ </tr>
+ </table>
+
+ <section>
+ <title>Examples</title>
+ <ul>
+ <li><a href="daisy/index.html?repositoryURL=www.cocoondev.org&repositoryCollection=daisy&documentID=index">Daisy Home Page</a> (retrieved live, you must be online)</li>
+ </ul>
+ </section>
</section>
</body>
</document>