You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ra...@apache.org on 2005/10/15 04:27:14 UTC
svn commit: r321279 - in /jakarta/commons/sandbox/scxml/trunk: ./ xdocs/
xdocs/usecases/ xdocs/usecases/rdc-group/
Author: rahul
Date: Fri Oct 14 19:27:10 2005
New Revision: 321279
URL: http://svn.apache.org/viewcvs?rev=321279&view=rev
Log:
Adding a usecases section - the first concrete usecase for Commons SCXML has been rdc:group.
Added:
jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/
jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml (with props)
jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/
jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml (with props)
jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml (with props)
jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml (with props)
Modified:
jakarta/commons/sandbox/scxml/trunk/project.properties
jakarta/commons/sandbox/scxml/trunk/xdocs/index.xml
jakarta/commons/sandbox/scxml/trunk/xdocs/navigation.xml
Modified: jakarta/commons/sandbox/scxml/trunk/project.properties
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/project.properties?rev=321279&r1=321278&r2=321279&view=diff
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/project.properties (original)
+++ jakarta/commons/sandbox/scxml/trunk/project.properties Fri Oct 14 19:27:10 2005
@@ -18,6 +18,7 @@
maven.xdoc.version=${pom.currentVersion}
maven.xdoc.developmentProcessUrl=http://jakarta.apache.org/commons/charter.html
maven.xdoc.includeProjectDocumentation=yes
+maven.xdoc.xml.copy=usecases/rdc-group/*.xml
maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/
Modified: jakarta/commons/sandbox/scxml/trunk/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/xdocs/index.xml?rev=321279&r1=321278&r2=321279&view=diff
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/xdocs/index.xml (original)
+++ jakarta/commons/sandbox/scxml/trunk/xdocs/index.xml Fri Oct 14 19:27:10 2005
@@ -66,6 +66,7 @@
<li>The latest <a href="xref/index.html">source</a>.</li>
<li>The <a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-scxml">nightly build</a>.</li>
<li>The <a href="http://wiki.apache.org/jakarta-commons/SCXML">wiki</a>.</li>
+ <li>Commons SCXML <a href="usecases.html">usecases</a> (case studies).</li>
</ul>
</p>
</section>
Modified: jakarta/commons/sandbox/scxml/trunk/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/xdocs/navigation.xml?rev=321279&r1=321278&r2=321279&view=diff
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/xdocs/navigation.xml (original)
+++ jakarta/commons/sandbox/scxml/trunk/xdocs/navigation.xml Fri Oct 14 19:27:10 2005
@@ -18,6 +18,20 @@
<project name="Commons SCXML">
<title>Commons SCXML</title>
<body>
+ <menu name="Commons SCXML Resources">
+
+ <item name="Usecases"
+ href="/usecases.html"
+ collapse="true">
+
+ <item name="SCXML in RDC group container"
+ href="/usecases/scxml-in-rdc-group.html" />
+
+ </item>
+
+ </menu>
+
&common-menus;
+
</body>
</project>
Added: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml?rev=321279&view=auto
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml (added)
+++ jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml Fri Oct 14 19:27:10 2005
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2003-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.
+-->
+
+<document>
+
+ <properties>
+ <title>Commons SCXML Usecases</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+ <section name="Commons SCXML Usecases">
+
+ <p>
+ <i>Q: Whats a library without usecases?</i><br/>
+ <i>A:</i>
+ </p>
+
+ <subsection name="Introduction">
+ <p>
+ There are numerous use cases for an engine like Commons SCXML. Any process
+ that can be represented as a UML state chart, for example, business process
+ flows, view navigation bits, interaction or dialog management etc. (this is,
+ by no means, a comprehensive list), can leverage the Commons SCXML engine
+ library. We illustrate just a few sample usecases within frameworks in the
+ open source community as illustrations.
+ </p>
+ </subsection>
+
+ <subsection name="Samples">
+ <p>
+ <ul>
+ <li><a href="usecases/scxml-in-rdc-group.html">Usecase 1</a> - Use in
+ <a href="http://jakarta.apache.org/taglibs/doc/rdc-doc/intro.html">
+ Reusable Dialog Components (RDC) Framework</a> <group>
+ container.</li>
+ </ul>
+ </p>
+ <br/>
+ <p>If you know of another usecase we should list or if you are interesting
+ in seeing if SCXML fits a usecase you have in mind, contact us via the
+ <a href="mail-lists.html">mailing lists</a>.
+ </p>
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml?rev=321279&view=auto
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml (added)
+++ jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml Fri Oct 14 19:27:10 2005
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<!--
+ Copyright 2004-2005 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.
+-->
+<scxml xmlns="http://www.w3.org/2005/01/SCXML"
+ version="1.0"
+ initialstate="tripType">
+
+ <state id="tripType">
+ <transition event="tripType.done">
+ <target next="departureCity"/>
+ </transition>
+ </state>
+
+ <state id="departureCity">
+ <transition event="departureCity.done">
+ <target next="arrivalCity"/>
+ </transition>
+ </state>
+
+ <state id="arrivalCity">
+ <transition event="arrivalCity.done">
+ <target next="departureDate"/>
+ </transition>
+ </state>
+
+ <state id="departureDate">
+ <transition event="departureDate.done"
+ cond="${tripType == 'round'}">
+ <target next="arrivalDate"/>
+ </transition>
+ <transition event="departureDate.done"
+ cond="${tripType == '1way'}">
+ <exit />
+ </transition>
+ </state>
+
+ <state id="arrivalDate"
+ final="true" />
+
+</scxml>
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-dialog.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml?rev=321279&view=auto
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml (added)
+++ jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml Fri Oct 14 19:27:10 2005
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!--
+ Copyright 2004-2005 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.
+-->
+<list>
+ <option value="1way"> one way </option>
+ <option value="round"> round trip </option>
+</list>
+
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/rdc-group/travel-types.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Added: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml?rev=321279&view=auto
==============================================================================
--- jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml (added)
+++ jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml Fri Oct 14 19:27:10 2005
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2003-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.
+-->
+
+<document>
+
+ <properties>
+ <title>Commons SCXML Usecases - Dialog Management Strategy for rdc:group</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+ <section name="SCXML documents to configure RDC group container instances">
+
+ <p><a href="http://jakarta.apache.org/taglibs/doc/rdc-doc/intro.html">
+ Reusable Dialog Components (RDC) Framework</a> is "<i>a framework
+ for creating JSP taglibs that aid in rapid development of voice and
+ multimodal applications</i>". The RDC Framework defines a
+ <code><group></code> container for aggregating multiple components
+ in one view. The dialog management across the child components for a
+ group is pluggable, more details are available on this RDC wiki page on
+ <a href="http://wiki.apache.org/jakarta-taglibs/ReusableDialogComponents/Tutorials/Aggregation">
+ aggregation</a>. A Commons SCXML driven dialog management strategy has
+ been incorporated into the RDC Framework, as seen
+ <a href="http://svn.apache.org/repos/asf/jakarta/taglibs/proper/rdc/trunk/src/org/apache/taglibs/rdc/dm/">
+ here</a>.
+ </p>
+
+ <subsection name="Motivation">
+ <ul>
+ <li><a href="http://www.w3.org/TR/scxml">SCXML</a> semantics are based
+ on UML state charts, and provide an easy transition from the modeling
+ layer to the runtime artifacts.</li>
+ <li>The SCXML based strategy is more expressive than the precursor
+ strategies that were previously available in the RDC distribution.</li>
+ </ul>
+ </subsection>
+
+ <subsection name="Example">
+ <p>To illustrate the use of the SCXML strategy for <rdc:group>,
+ consider a simple air travel information speech dialog, which prompts
+ the user for the trip type (one way or round trip), and collect either
+ one travel date or two depending on the answer.</p>
+
+ <p>That gives us the following JSP snippet, if named variable
+ <code>today</code> contains the <i>MMddyyyy</i> string for the
+ current date:</p>
+ <pre>
+ <rdc:group id="travelInfo"
+ strategy="org.apache.taglibs.rdc.dm.SCXMLDialog"
+ config="<a href="rdc-group/travel-dialog.xml">travel-dialog.xml</a>">
+
+ <rdc:select1 id="tripType"
+ options="<a href="rdc-group/travel-types.xml">travel-types.xml</a>"
+ echo="true" />
+
+ <rdc:usMajorCity id="departureCity" />
+
+ <rdc:usMajorCity id="arrivalCity" />
+
+ <rdc:date id="departureDate"
+ minDate="${today}"
+ confirm="true"/>
+
+ <rdc:date id="arrivalDate"
+ minDate="${departureDate}"
+ confirm="true" />
+
+ </rdc:group>
+ </pre>
+
+ <p>View the RDC documentation in Jakarta Taglibs for packaging and
+ deployment as a web application.</p>
+ </subsection>
+
+ </section>
+
+ </body>
+
+</document>
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/sandbox/scxml/trunk/xdocs/usecases/scxml-in-rdc-group.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org