You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2007/04/02 12:33:51 UTC
svn commit: r524761 - in /lenya/docu/src/documentation/content/xdocs:
docs/modules/news.xml site.xml
Author: andreas
Date: Mon Apr 2 03:33:50 2007
New Revision: 524761
URL: http://svn.apache.org/viewvc?view=rev&rev=524761
Log:
Added docs about news module
Added:
lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml
Modified:
lenya/docu/src/documentation/content/xdocs/site.xml
Added: lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml?view=auto&rev=524761
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml (added)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml Mon Apr 2 03:33:50 2007
@@ -0,0 +1,63 @@
+<?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>News Feed Module</title>
+ </header>
+ <body>
+
+ <section>
+ <title>Introduction</title>
+ <p>
+ The news module provides a resoure type which displays a list of the document's children,
+ in descending order of the creation date. The child documents are treated as news messages.
+ The news can also be rendered as an RSS feed.
+ </p>
+ </section>
+
+ <section>
+ <title>Formats</title>
+ <p>
+ The news resource type provides the following formats:
+ </p>
+
+ <dl>
+
+ <dt>xhtml</dt>
+ <dd>The usual XHTML page. It shows a list of the child documents, including the title and first paragraph.</dd>
+
+ <dt>include</dt>
+ <dd>An XHTML snippet. The view is equal to the <code>xhtml</code> format, but the content is
+ included in an <code><![CDATA[<xhtml:div id="news"/>]]></code> element. This format can be used
+ to include the news items in other pages, typically using CInclude.
+ </dd>
+
+ <dt>rss</dt>
+ <dd>The RSS view of the news items.</dd>
+
+ <dt>header</dt>
+ <dd>
+ The RSS header (<code><![CDATA[<link rel="alternate" type="application/rss+xml" ... />]]></code>),
+ pointing to the RSS feed. This is used, e.g., for Firefox' "live bookmark" feature.
+ </dd>
+ </dl>
+
+ </section>
+
+ </body>
+</document>
Modified: lenya/docu/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/site.xml?view=diff&rev=524761&r1=524760&r2=524761
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Mon Apr 2 03:33:50 2007
@@ -212,6 +212,7 @@
<monitoring href="monitoring.html" label="Monitoring"/>
<server href="webdav.html" label="WebDAV Servers"/>
</webdav>
+ <news_module href="news.html" label="News"/>
<notification href="notification.html" label="Notification"/>
</modules>
<!--+
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org