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/12 13:07:30 UTC
svn commit: r527883 - in /lenya/docu/src/documentation/content/xdocs:
docs/modules/usecasedocument.xml site.xml
Author: andreas
Date: Thu Apr 12 04:07:25 2007
New Revision: 527883
URL: http://svn.apache.org/viewvc?view=rev&rev=527883
Log:
Added usecasedocument module docs
Added:
lenya/docu/src/documentation/content/xdocs/docs/modules/usecasedocument.xml
Modified:
lenya/docu/src/documentation/content/xdocs/site.xml
Added: lenya/docu/src/documentation/content/xdocs/docs/modules/usecasedocument.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/usecasedocument.xml?view=auto&rev=527883
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/usecasedocument.xml (added)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/usecasedocument.xml Thu Apr 12 04:07:25 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>The UsecaseDocument Module</title>
+ </header>
+ <body>
+
+ <section>
+ <title>Introduction</title>
+ <p>
+ The usecasedocument module provides a resource type which allows to include
+ usecases as documents. Typical usage scenarios are forms on web pages, for
+ instance search forms or contact forms. In contrast to usual usecases which refer
+ to the browser locale for i18n, the document's language is used.
+ </p>
+ <p>
+ For more information on usecases, please refer to the
+ <a href="site:usecase-framework">usecase framework</a> documentation.
+ </p>
+ </section>
+
+ <section>
+ <title>XML Format</title>
+ <p>
+ The XML of a <code>usecasedocument</code> document looks like this:
+ </p>
+ <source xml:space="preserve"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<usecase xmlns="http://apache.org/lenya/usecase/1.0" name="contactform.sendMessage"/>]]></source>
+ </section>
+
+ <section>
+ <title>Creating Usecase-Based Documents</title>
+ <p>
+ To create a usecase document, you can invoke the <code>site.create</code> usecase
+ with an additional <code>usecase</code> parameter:
+ </p>
+ <source xml:space="preserve"><![CDATA[<item uc:usecase="usecasedocument.create" href="?usecase=contactform.sendMessage">
+ <i18n:text>New Contact Form</i18n:text>
+</item>]]></source>
+ <p>
+ The creator class will take care that the usecase name is stored in the created
+ document.
+ </p>
+ </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=527883&r1=527882&r2=527883
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Thu Apr 12 04:07:25 2007
@@ -207,23 +207,26 @@
</docu1.4>
<module_list href="modules/" label="Modules" tab="modules">
<index href="index.html" label="Overview"/>
- <webdav href="webdav/" label="WebDAV">
- <webdav_index href="index.html" label="Getting started"/>
- <monitoring href="monitoring.html" label="Monitoring"/>
- <server href="webdav.html" label="WebDAV Servers"/>
- </webdav>
- <collection_module_section label="Collection">
+ <collection_module_section label="collection">
<collection_module href="collection.html" label="Overview"/>
</collection_module_section>
- <news_module_section label="News">
+ <news_module_section label="news">
<news_module href="news.html" label="Overview"/>
</news_module_section>
- <notification_module_section label="Notification">
+ <notification_module_section label="notification">
<notification href="notification.html" label="Overview"/>
</notification_module_section>
- <svg_module href="svg/" label="SVG">
+ <svg_module href="svg/" label="svg">
<svg_roundedcorners href="roundedcorners.html" label="Rounded Corners"/>
</svg_module>
+ <usecasedocument_module_section label="usecasedocument">
+ <usecasedocument_module href="usecasedocument.html" label="Overview"/>
+ </usecasedocument_module_section>
+ <webdav href="webdav/" label="webdav">
+ <webdav_index href="index.html" label="Getting started"/>
+ <monitoring href="monitoring.html" label="Monitoring"/>
+ <server href="webdav.html" label="WebDAV Servers"/>
+ </webdav>
</module_list>
<!--+
| Version 1.2 tab
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org