forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: rev 57432 - in forrest/trunk/plugins/feeder: . src/documentation/content/xdocs src/documentation/content/xdocs/samples
Date Thu, 11 Nov 2004 13:19:44 GMT
Author: rgardler
Date: Thu Nov 11 05:19:43 2004
New Revision: 57432

Added:
   forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/aggregateFeed.xml
  (contents, props changed)
   forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml~
   forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/singleFeed.xml   (contents,
props changed)
Modified:
   forrest/trunk/plugins/feeder/sitemap.xmap
   forrest/trunk/plugins/feeder/src/documentation/content/xdocs/index.xml
   forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml
   forrest/trunk/plugins/feeder/src/documentation/content/xdocs/site.xml
Log:
documentation improvements

Modified: forrest/trunk/plugins/feeder/sitemap.xmap
==============================================================================
--- forrest/trunk/plugins/feeder/sitemap.xmap	(original)
+++ forrest/trunk/plugins/feeder/sitemap.xmap	Thu Nov 11 05:19:43 2004
@@ -36,7 +36,9 @@
       <map:match pattern="feederAggregate/**.xml">
         <map:generate src="{project:content.xdocs}/{1}.xml"/>
         <map:transform src="{forrest:plugins}/feeder/resources/stylesheets/aggregateToRSS20.xsl"/>
-        <!--<map:transform src="{forrest:plugins}/feeder/resources/stylesheets/rss20ToXdoc.xsl"/>-->
+        <!-- FIXME: previous transform produces bad XML
+          <map:transform src="{forrest:plugins}/feeder/resources/stylesheets/rss2document.xsl"/>
+        -->
         <map:serialize type="xml"/>
       </map:match>
     </map:pipeline>

Modified: forrest/trunk/plugins/feeder/src/documentation/content/xdocs/index.xml
==============================================================================
--- forrest/trunk/plugins/feeder/src/documentation/content/xdocs/index.xml	(original)
+++ forrest/trunk/plugins/feeder/src/documentation/content/xdocs/index.xml	Thu Nov 11 05:19:43
2004
@@ -17,13 +17,31 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document> 
   <header> 
-    <title>Welcome to the Feed Plugin Example</title> 
+    <title>Welcome to the Feeder Plugin Example</title> 
   </header> 
   <body> 
+    <warning>This plugin is at an early stage of development, some features are 
+    not yet complete and the techniques for using it may change. Patches are,
+    as always, welcome</warning>
+  
     <section>
       <title>Apache Forrest - Feed Plugin</title>
-      <p>This is an example site for the Apache Forrest Feed Plugin. It
-      provides examples of all the functionality in the plugin.</p>
+      <p>This is an example site for the Apache Forrest Feeder Plugin. It
+      provides examples of all the functionality in the plugin (look on the 
+      samples tab).</p>
+     
+      <section>
+        <title>Working Features</title>
+        <ol>
+          <li><a href="samples/singleFeed.html">Embedding of an RSS</a>
feed in a Forrest page</li>
+        </ol>
+      </section>
+      <section>
+        <title>In Progress Features</title>
+        <ol>
+          <li><a href="samples/aggregateFeed.html">Aggregation of multiple feeds</a>
into a single page</li>
+        </ol>
+      </section>
     </section>
   </body>
 </document>

Added: forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/aggregateFeed.xml
==============================================================================
--- (empty file)
+++ forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/aggregateFeed.xml
Thu Nov 11 05:19:43 2004
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Feeder Plugin - Aggregate Feed example</title> 
+  </header> 
+  <body> 
+  
+    <warning>This functionlaity is not yet complete, if you make it work please
+    submit a patch.</warning>
+  
+    <p>This sample shows how a number of different feeds can be aggregated
+    into a single feed and then displayed in a Forrest site. In order to do 
+    this you must first create an aggregate descriptor file and then 
+    create a link in the following format:</p>
+      
+    <source>
+&lt;a href="/feederAggregate/path/aggregateDescriptor.typeExtension"&gt;Feed Link
Text&lt;/a&gt;
+    </source>
+      
+    <section>
+      <title>Aggregate Descriptor File</title>
+      <p>The aggregate descriptor file is an XML doucment that describes the
+      feeds that you want to collate into a single document. It has the 
+      following format:</p>
+      
+      <source><![CDATA[
+<aggregateDescriptor>
+<feed id="planetApache">
+  <url>http://www.planetapache.org/rss20.xml</url>
+</feed>
+<feed id="planetJava">
+  <url>http://planetjava.org/rss.php</url>
+</feed>
+</aggregateDescriptor>
+]]></source>
+  
+      <p><a href="/feederAggregate/samples/aggregate/demoAggregation.xml">Take
a 
+      look</a> at what the above file produces.</p>
+    </section>
+        
+  </body>
+</document>

Modified: forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml
==============================================================================
--- forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml	(original)
+++ forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml	Thu Nov
11 05:19:43 2004
@@ -20,61 +20,17 @@
     <title>Feed Plugin Samples Index</title> 
   </header> 
   <body> 
-    
-    <note>At present only RSS 2.0 is supported.</note>
-  
-    <section>
-      <title>Basic RSS Sample</title>
-      <p>This sample shows how a basic RSS feed can be converted to an XDoc and
-      included in a Forrest site. In order to do this simply create a link
-      with the following format:</p>
-      
-      <source>
-&lt;a href="/feeder/feed.domain.com/path/to/feed.rss.typeExtension"&gt;Feed Link
Text&lt;/a&gt;
-      </source>
-      
-      <p>For example, an href of 
-      <code>/feeder/www.planetapache.org/rss20.xml.html</code> will retrieve
the
-      rss feed from <code>http://www.planetapache.org/rss20.xml</code> and
-      render it as and HTML document whilst an href of 
-      <code>/feeder/www.planetapache.org/rss20.xml.html</code> will generate
a
-      PDF, <a href="/feeder/www.planetapache.org/rss20.xml.html">Try it</a>.
-      </p>
-      
-    </section>
-  
-    <section>
-      <title>Aggregated Feed Sample</title>
-      <p>This sample shows how a number of different feeds can be aggregated
-      into a single feed and then displayed in a Forrest site. In order to do 
-      this you must first create an aggregate descriptor file and then 
-      create a link in the following format:</p>
-      
-      <source>
-&lt;a href="/feederAggregate/path/aggregateDescriptor.typeExtension"&gt;Feed Link
Text&lt;/a&gt;
-      </source>
-      
       <section>
-        <title>Aggregate Descriptor File</title>
-        <p>The aggregate descriptor file is an XML doucment that describes the
-        feeds that you want to collate into a single document. It has the 
-        following format:</p>
-        
-        <source><![CDATA[
-<aggregateDescriptor>
-  <feed id="planetApache">
-    <url>http://www.planetapache.org/rss20.xml</url>
-  </feed>
-  <feed id="planetJava">
-    <url>http://planetjava.org/rss.php</url>
-  </feed>
-</aggregateDescriptor>
-  ]]></source>
-    
-        <p><a href="/feederAggregate/samples/aggregate/demoAggregation.xml">Take
a 
-        look</a> at what the above file produces.</p>        
-        
+        <title>Working Features</title>
+        <ol>
+          <li><a href="singleFeed.html">Embedding of an RSS</a> feed in
a Forrest page</li>
+        </ol>
+      </section>
+      <section>
+        <title>In Progress Features</title>
+        <ol>
+          <li><a href="aggregateFeed.html">Aggregation of multiple feeds</a>
into a single page</li>
+        </ol>
       </section>
-    </section>
   </body>
 </document>

Added: forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml~
==============================================================================
--- (empty file)
+++ forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/index.xml~	Thu Nov
11 05:19:43 2004
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Feed Plugin Samples Index</title> 
+  </header> 
+  <body> 
+    
+    <note>At present only RSS 2.0 is supported.</note>
+  
+    <section>
+      <title>Basic RSS Sample</title>
+      <p>This sample shows how a basic RSS feed can be converted to an XDoc and
+      included in a Forrest site. In order to do this simply create a link
+      with the following format:</p>
+      
+      <source>
+&lt;a href="/feeder/feed.domain.com/path/to/feed.rss.typeExtension"&gt;Feed Link
Text&lt;/a&gt;
+      </source>
+      
+      <p>For example, an href of 
+      <code>/feeder/www.planetapache.org/rss20.xml.html</code> will retrieve
the
+      rss feed from <code>http://www.planetapache.org/rss20.xml</code> and
+      render it as and HTML document whilst an href of 
+      <code>/feeder/www.planetapache.org/rss20.xml.html</code> will generate
a
+      PDF, <a href="/feeder/www.planetapache.org/rss20.xml.html">Try it</a>.
+      </p>
+      
+    </section>
+  
+    <section>
+      <title>Aggregated Feed Sample</title>
+      <p>This sample shows how a number of different feeds can be aggregated
+      into a single feed and then displayed in a Forrest site. In order to do 
+      this you must first create an aggregate descriptor file and then 
+      create a link in the following format:</p>
+      
+      <source>
+&lt;a href="/feederAggregate/path/aggregateDescriptor.typeExtension"&gt;Feed Link
Text&lt;/a&gt;
+      </source>
+      
+      <section>
+        <title>Aggregate Descriptor File</title>
+        <p>The aggregate descriptor file is an XML doucment that describes the
+        feeds that you want to collate into a single document. It has the 
+        following format:</p>
+        
+        <source><![CDATA[
+<aggregateDescriptor>
+  <feed id="planetApache">
+    <url>http://www.planetapache.org/rss20.xml</url>
+  </feed>
+  <feed id="planetJava">
+    <url>http://planetjava.org/rss.php</url>
+  </feed>
+</aggregateDescriptor>
+  ]]></source>
+    
+        <p><a href="/feederAggregate/samples/aggregate/demoAggregation.xml">Take
a 
+        look</a> at what the above file produces.</p>        
+        
+      </section>
+    </section>
+  </body>
+</document>

Added: forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/singleFeed.xml
==============================================================================
--- (empty file)
+++ forrest/trunk/plugins/feeder/src/documentation/content/xdocs/samples/singleFeed.xml	Thu
Nov 11 05:19:43 2004
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Feeder Plugin - Single Feed Example</title> 
+  </header> 
+  <body> 
+    
+    <p>This sample shows how a single RSS feed can be converted to an XDoc and
+    included in a Forrest site. In order to do this simply create a link
+    with the following format:</p>
+      
+    <source>
+&lt;a href="/feeder/feed.domain.com/path/to/feed.rss.typeExtension"&gt;Feed Link
Text&lt;/a&gt;
+    </source>
+      
+    <p>For example, an href of 
+    <code>/feeder/www.planetapache.org/rss20.xml.html</code> will retrieve the
+    rss feed from <code>http://www.planetapache.org/rss20.xml</code> and
+    render it as and HTML document whilst an href of 
+    <code>/feeder/www.planetapache.org/rss20.xml.html</code> will generate a
+    PDF, <a href="/feeder/www.planetapache.org/rss20.xml.html">Try it</a>.
+    </p>
+      
+    <warning>The way URLs are structured is due to change in the near future,
+    use at your own risk (see Forrest mailing lists for discussion).</warning>
+  </body>
+</document>

Modified: forrest/trunk/plugins/feeder/src/documentation/content/xdocs/site.xml
==============================================================================
--- forrest/trunk/plugins/feeder/src/documentation/content/xdocs/site.xml	(original)
+++ forrest/trunk/plugins/feeder/src/documentation/content/xdocs/site.xml	Thu Nov 11 05:19:43
2004
@@ -39,6 +39,8 @@
   
   <samples label="Samples" href="samples/" tab="samples">
     <index label="Index" href="index.html" description="An index of the available samples"/>
+    <singleFeed label="Single Feed" href="singleFeed.html" description="An example of
a single feed in a Forrest page"/>
+    <aggregate label="Aggregate Feed" href="index.html" description="An example of an
aggregate feed in a Forrest page"/>
   </samples>
   
   <!--

Mime
View raw message