Author: bdube
Date: Tue Nov 10 05:07:52 2009
New Revision: 834348
URL: http://svn.apache.org/viewvc?rev=834348&view=rev
Log:
Issue FOR-1181, due to Vicent Mas
Clarify documentation
Modified:
forrest/trunk/plugins/org.apache.forrest.plugin.input.feeder/src/documentation/content/xdocs/index.xml
Modified:
forrest/trunk/plugins/org.apache.forrest.plugin.input.feeder/src/documentation/content/xdocs/index.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/plugins/org.apache.forrest.plugin.input.feeder/src/documentation/content/xdocs/index.xml?rev=834348&r1=834347&r2=834348&view=diff
==============================================================================
---
forrest/trunk/plugins/org.apache.forrest.plugin.input.feeder/src/documentation/content/xdocs/index.xml
(original)
+++
forrest/trunk/plugins/org.apache.forrest.plugin.input.feeder/src/documentation/content/xdocs/index.xml
Tue Nov 10 05:07:52 2009
@@ -53,6 +53,13 @@
</feedDescriptor>
]]>
</source>
+
+ <p>
+ Note that the <code>feedDescriptor</code> file has
<strong>not</strong>
+ xdoc format. A file named <code>feedDescriptor.xml</code> with
exactly the
+ above content should just work.
+ </p>
+
<p>
In order to embed the data from the <code>planetApache</code>
feed you
create a link in the following form:
@@ -66,9 +73,9 @@
want the feed to be delivered in (i.e. html, pdf etc.)
</p>
<ul>
- <li><a href="samples/singleFeed.rss">As RSS</a></li>
- <li><a href="samples/singleFeed.rss.xml">As XDoc</a></li>
- <li><a href="samples/singleFeed.rss.html">As HTML</a></li>
+ <li><a href="samples/singleFeed.rss">As RSS</a> (no EXTENSION)</li>
+ <li><a href="samples/singleFeed.rss.xml">As XDoc</a> (xml
EXTENSION)</li>
+ <li><a href="samples/singleFeed.rss.html">As HTML</a> (html
EXTENSION)</li>
</ul>
</section>
</section>
