[seam-commits] Seam SVN: r9088 - trunk/doc/Seam_Reference_Guide/en-US.
seam-commits at lists.jboss.org
seam-commits at lists.jboss.org
Mon Sep 22 03:58:25 EDT 2008
Author: nickarls
Date: 2008-09-22 03:58:25 -0400 (Mon, 22 Sep 2008)
New Revision: 9088
Added:
trunk/doc/Seam_Reference_Guide/en-US/Rss.xml
Modified:
trunk/doc/Seam_Reference_Guide/en-US/Dependencies.xml
trunk/doc/Seam_Reference_Guide/en-US/master.xml
Log:
RSS documentation
Modified: trunk/doc/Seam_Reference_Guide/en-US/Dependencies.xml
===================================================================
--- trunk/doc/Seam_Reference_Guide/en-US/Dependencies.xml 2008-09-22 07:24:28 UTC (rev 9087)
+++ trunk/doc/Seam_Reference_Guide/en-US/Dependencies.xml 2008-09-22 07:58:25 UTC (rev 9088)
@@ -163,6 +163,21 @@
<para>Required when using Seam's <trademark class="registered">Microsoft</trademark> <trademark class="registered">Excel</trademark> features</para>
</entry>
</row>
+
+ <row>
+ <entry>
+ <para><literal>jboss-seam-rss.jar</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Required when using Seam's RSS generation features</para>
+ </entry>
+ </row>
<row>
<entry>
@@ -595,7 +610,7 @@
<para>war</para>
</entry>
<entry>
- <para>JExcelAPI Library</para>
+ <para>JExcelAPI library</para>
</entry>
</row>
@@ -618,6 +633,162 @@
</tgroup>
</table>
</section>
+
+ <section id="dependencies.rss">
+ <title>Seam RSS support</title>
+
+ <table>
+ <title>Seam RSS Dependencies</title>
+
+ <tgroup cols="4">
+ <colspec colnum="1" colwidth="4*" />
+ <colspec colnum="2" colwidth="2*" />
+ <colspec colnum="3" colwidth="3*" />
+ <colspec colnum="4" colwidth="5*" />
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Name</para>
+ </entry>
+ <entry align="center">
+ <para>Type</para>
+ </entry>
+ <entry align="center">
+ <para>Scope</para>
+ </entry>
+ <entry align="center">
+ <para>Notes</para>
+ </entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para><literal>yarfraw.jar</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>YARFRAW RSS library</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>JAXB</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>JAXB XML parsing libraries</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>http-client.jar</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Apache HTTP Client libraies</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>commons-io</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Apache commons IO library</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>commons-lang</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Apache commons lang library</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>commons-codec</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Apache commons codec library</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>commons-collections</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Apache commons collections library</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para><literal>jboss-seam-rss.jar</literal></para>
+ </entry>
+ <entry align="center">
+ <para>runtime</para>
+ </entry>
+ <entry align="center">
+ <para>war</para>
+ </entry>
+ <entry>
+ <para>Seam RSS core library</para>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
<section>
Added: trunk/doc/Seam_Reference_Guide/en-US/Rss.xml
===================================================================
--- trunk/doc/Seam_Reference_Guide/en-US/Rss.xml (rev 0)
+++ trunk/doc/Seam_Reference_Guide/en-US/Rss.xml 2008-09-22 07:58:25 UTC (rev 9088)
@@ -0,0 +1,261 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+
+<chapter id="rss">
+ <title>RSS support</title>
+ <para>
+ It is now easy to integrate RSS feeds in Seam through the
+ <ulink url="http://yarfraw.sourceforge.net/">YARFRAW</ulink>
+ library. The RSS support is currently in the state of "tech preview"
+ in the current release.
+ </para>
+
+ <section id="rss.installation">
+ <title>Installation</title>
+ <para>
+ To enable RSS support, include the <literal>jboss-seam-rss.jar</literal>
+ in your applications <literal>WEB-INF/lib</literal> directory. The RSS
+ library also has some dependent libraries that should be placed in the
+ same directory. See <xref linkend="dependencies.rss"/> for a list of
+ libraries to include.
+ </para>
+ <para>
+ The Seam RSS support requires the use of Facelets as the view
+ technology.
+ </para>
+ </section>
+ <section id="rss.usage">
+ <title>Generating feeds</title>
+ <para>
+ The <literal>examples/rss</literal> project contains an example of
+ RSS support in action. It demonstrates proper deployment
+ packaging, and it shows the exposed functionality.
+ </para>
+ <para>
+ A feed is a xhtml-page that consist of a feed and a list of nested
+ entry items.
+ </para>
+ <programlisting role="XML">
+ <![CDATA[
+ <r:feed
+ xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:ui="http://java.sun.com/jsf/facelets"
+ xmlns:r="http://jboss.com/products/seam/rss"
+ title="#{rss.feed.title}"
+ uid="#{rss.feed.uid}"
+ subtitle="#{rss.feed.subtitle}"
+ updated="#{rss.feed.updated}"
+ link="#{rss.feed.link}">
+ <ui:repeat value="#{rss.feed.entries}" var="entry">
+ <r:entry
+ uid="#{entry.uid}"
+ title="#{entry.title}"
+ link="#{entry.link}"
+ author="#{entry.author}"
+ summary="#{entry.summary}"
+ published="#{entry.published}"
+ updated="#{entry.updated}"
+ />
+ </ui:repeat>
+ </r:feed>
+ ]]>
+ </programlisting>
+ </section>
+
+ <section id="rss.feeds">
+ <title>Feeds</title>
+ <para>
+ Feeds are the top-level entities that describe the properties of the
+ information source. It contains zero or more nested entries.
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*" />
+ <colspec colnum="2" colwidth="3*" />
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><r:feed></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>uid</literal>
+ —An optional unique feed id. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>title</literal>
+ —The title of the feed. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>subtitle</literal>
+ —The subtitle of the feed. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>updated</literal>
+ —When was the feed updated? The value is a date.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>link</literal>
+ —The link to the source of the information.
+ The value is a string.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Child elemenents</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>Zero or more feed entries</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Facets</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>none</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
+ <section id="rss.entries">
+ <title>Entries</title>
+ <para>
+ Entries are the "headlines" in the feed.
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colnum="1" colwidth="1*" />
+ <colspec colnum="2" colwidth="3*" />
+ <tbody>
+ <row>
+ <entry valign="top">
+ <para>
+ <literal><r:feed></literal>
+ </para>
+ </entry>
+ <entry valign="top">
+ <para>
+ <emphasis>Attributes</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>uid</literal>
+ —An optional unique entry id. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>title</literal>
+ —The title of the entry. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>link</literal>
+ —A link to the item. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>author</literal>
+ —The author of the story. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>summary</literal>
+ —The body of the story. The value is a string.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>summaryFormat</literal>
+ —The format of the body of the story. The value is a string
+ and valid values are "text" and "html". Defaults to "html".
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>published</literal>
+ —When was the story first published? The value is a date.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>updated</literal>
+ —When was the story updated? The value is a date.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Child elemenents</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>none</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis>Facets</emphasis>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>none</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
+ <section id="rss.links">
+ <title>Links and further documentation</title>
+ <para>
+ The core of the RSs functionality is based on the YARFRAW library
+ which can be found on http://yarfraw.sourceforge.net/ and most
+ features and possible limitations are inherited from here.
+ </para>
+ <para>
+ For details on the ATOM 1.0 format, have a look at
+ <ulink url="http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html">
+ the specs</ulink>
+ </para>
+ <para>
+ For details on the RSS 2.0 format, have a look at
+ <ulink url="http://cyber.law.harvard.edu/rss/rss.html">the specs</ulink>
+ </para>
+ </section>
+</chapter>
Modified: trunk/doc/Seam_Reference_Guide/en-US/master.xml
===================================================================
--- trunk/doc/Seam_Reference_Guide/en-US/master.xml 2008-09-22 07:24:28 UTC (rev 9087)
+++ trunk/doc/Seam_Reference_Guide/en-US/master.xml 2008-09-22 07:58:25 UTC (rev 9088)
@@ -23,6 +23,7 @@
<xi:include href= "Text.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href= "Itext.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href= "Excel.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href= "Rss.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href= "Mail.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href= "Jms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href= "Cache.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
More information about the seam-commits
mailing list