commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gu...@apache.org
Subject svn commit: r959243 - in /commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site: ./ resources/ resources/images/ xdoc/ xdoc/guide/
Date Wed, 30 Jun 2010 09:33:32 GMT
Author: guixl
Date: Wed Jun 30 09:33:32 2010
New Revision: 959243

URL: http://svn.apache.org/viewvc?rev=959243&view=rev
Log:
add some instruction contents for the web site

Added:
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-1.png  
(with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-2.png  
(with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-3.png  
(with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-4.png  
(with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-5.png  
(with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/run-source-code.png
  (with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/scxml-eclipse.png
  (with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml   (with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/run-source-code.xml
  (with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/scxml-documents.xml
  (with props)
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/using-visual-scxml.xml
  (with props)
Modified:
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/site.xml
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/index.xml

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-1.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-1.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-1.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-2.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-2.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-2.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-3.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-3.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-3.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-4.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-4.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-4.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-5.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-5.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/guide-5.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/run-source-code.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/run-source-code.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/run-source-code.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/scxml-eclipse.png
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/scxml-eclipse.png?rev=959243&view=auto
==============================================================================
Binary file - no diff available.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/scxml-eclipse.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Modified: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/site.xml?rev=959243&r1=959242&r2=959243&view=diff
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/site.xml (original)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/site.xml Wed Jun 30 09:33:32 2010
@@ -20,6 +20,10 @@
 
     <menu name="Commons SCXML Eclipse">
       <item name="Overview"    href="/index.html"/>
+      <item  name="User Guide" href="/guide.html" collapse="true">
+      	<item name="Run source code"  href="/guide/run-source-code.html" />
+       	<item name="Using Visual SCXML" href="/guide/using-visual-scxml.html" />
+       </item>
       <item name="Wiki"        href="http://wiki.apache.org/commons/SCXML/HomePage"/>
     </menu>
     

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml?rev=959243&view=auto
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml (added)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml Wed Jun 30 09:33:32
2010
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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>Visual SCXML Guide</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+ <section name="Visual SCXML Guide">
+
+  <p>This is a collection of notes about all things of Eclipse based Visual SCXML editor,
a scratch pad of
+  sorts, aimed at noting down usages for the frequently needed bits of Visual
+  SCXML and some related and interesting (to some of us) tidbits.
+  </p>
+
+  <subsection name="Introduction">
+   <p>State Chart XML (SCXML) is a general-purpose event-based state machine
+   language that can be used in many ways.</p>
+   <ul>
+    <li><a href="guide/scxml-documents.html">SCXML documents</a> - A five
+    minute introduction to SCXML documents.</li>
+    <li><a href="guide/run-source-code.html">Visual SCXML Editor</a> -
How to run soure code of Eclipse based Visual SCXML editor</li>
+   </ul>
+  </subsection>
+
+  <subsection name="Trying out Visual SCXML Editor">
+   <p>Contains guides about how to use Visual SCXML eidtor, including edit SCXML document,
export SCXML editor and import SCXML document to edit it.</p>
+   <ul>
+    <li><a href="guide/using-visual-scxml.html">Have a trial of Visual SCXML
</a> - Guide about how to use Visual SCXML editor.</li>
+   </ul>
+  </subsection>
+
+  <subsection name="Core API">
+   <p>Coming soon...</p>
+  </subsection>
+
+  <subsection name="Advanced API">
+   <p>Coming soon...</p>
+  </subsection>
+
+  <subsection name="Side-effects">
+   <p>Coming soon...</p>
+  </subsection>
+
+ </section>
+
+ </body>
+
+</document>

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/run-source-code.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/run-source-code.xml?rev=959243&view=auto
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/run-source-code.xml
(added)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/run-source-code.xml
Wed Jun 30 09:33:32 2010
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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>How to run source code</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+  <section name="How to run source code">
+
+   <p>Visual SCXML is a Eclipse based <a href="http://www.w3.org/TR/scxml">SCXML</a>
editor, so if you want to run source code, you should get <a href="http://www.eclipse.org">Eclipse</a>
first.
+   Also, it is built on GMF, your eclipse must have GMF plug-in support. Then, let's have
a trial of it.
+   </p>
+  </section>
+
+  <section name="Environment">
+
+   <p>System development environment: <br />
+   Eclipse Ganymede Packages with plunges:<br />
+org.eclipse.emf.cdo.sdk 1.0.0.v200806180411<br />
+org.eclipse.emf.compare.sdk 0.8.0.v200806180301<br />
+org.eclipse.emf.ecore.sdo.sdk 2.4.0.v200806091234<br />
+org.eclipse.emf.ecoretools.diagram.search 0.7.0.v200806130939<br />
+org.eclipse.emf.ecoretools.sdk 0.8.0.v200806130600<br />
+org.eclipse.emf.emfqtv.all.sdk 1.2.0.v200805130238-35-9-FF4TAdDtyhfiKaEtz0gsQQT<br />
+org.eclipse.emf.mint.sdk 0.7.0.v200806172223<br />
+org.eclipse.emf.sdk 2.4.0.v200806091234<br />
+org.eclipse.emf.search.sdk 0.7.0.v200806130939<br />
+org.eclipse.emf.teneo.sdk 1.0.0.v200806111928-3--87D3BKcgLUKa6ESidYXUVVFGE<br />
+org.eclipse.epp.usagedata.feature 1.0.0.R200806162215<br />
+org.eclipse.gef.sdk 3.4.0.v20080115-7B7E-97OK5c7PDdDMPMcHNPTM3CD<br />
+org.eclipse.gmf.sdk 2.1.0.v20080501-1739-7_77-A9Tdn-VSYbUc0oz-hiY5gdz<br />
+org.eclipse.jet.sdk 0.9.0.v20080516-07X-82Te4djSEJpBWJX<br />
+org.eclipse.m2m.atl.sdk 2.0.0.v200806101117<br />
+org.eclipse.m2m.qvt.oml.sdk 1.0.0.v20080611-1330-7_--AAKDAeC4okgF98SvgNel8wUW<br />
+org.eclipse.mylyn.bugzilla_feature 3.0.0.v20080619-1900<br />
+org.eclipse.mylyn.context_feature 3.0.0.v20080619-1900<br />
+org.eclipse.mylyn.ide_feature 3.0.0.v20080619-1900<br />
+org.eclipse.mylyn.java_feature 3.0.0.v20080619-1900<br />
+org.eclipse.mylyn.team_feature 3.0.0.v20080619-1900<br />
+org.eclipse.mylyn_feature 3.0.0.v20080619-1900<br />
+org.eclipse.net4j.sdk 1.0.0.v200806180305<br />
+org.eclipse.ocl.all.sdk 1.2.0.v200805130238-67_8Y_-NQOdLfTWFhivwhwxdBhdq<br />
+org.eclipse.sdk 3.4.0.v20080522-7O7S-CHEp2gcoGjmFFomLz-d5M8NdvuPgDrH17jw0Mvhe<br />
+org.eclipse.uml2.diagram.clazz.search 0.7.0.v200806130939<br />
+org.eclipse.uml2.sdk 2.2.0.v200805201126<br />
+org.eclipse.uml2.search 0.7.0.v200806130939<br />
+org.eclipse.uml2tools.sdk 0.8.0.v200806112132<br />
+org.eclipse.xsd.sdk 2.4.0.v200806091234<br />
+   	<br />
+   	Such a long list of plug-ins, isn't it ? In fact, you can get the whole package here:
+   	<a href="http://www.eclipse.org/downloads/packages/eclipse-modeling-tools-includes-incubating-components/ganymeder">http://www.eclipse.org/downloads/packages/eclipse-modeling-tools-includes-incubating-components/ganymeder</a>

+   </p>
+  </section>
+
+  <section name="Run source code">
+   <p>Download source code from <a href="/source-repository.html">here</a>
first, if you use SVN, you can directly check out projects into your workspace.
+   Then right click the project "org.apache.commons.scxml.modeling.editor", select "Run As"
-> "Eclipse Application", here we go.
+   </p>
+   <p>
+	<img src="../images/run-source-code.png" alt="Commons SCXML- Eclipse visual editor"/>
+	</p>
+  </section>
+  
+  <section name="Others">
+   <p>This project is in develop period, if you have any questions or suggestions,
please contact guixl@apache.org, Thank you.
+   </p>
+	<a name="pieces"/>
+  </section>
+  
+ </body>
+
+</document>
+

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/run-source-code.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/scxml-documents.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/scxml-documents.xml?rev=959243&view=auto
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/scxml-documents.xml
(added)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/scxml-documents.xml
Wed Jun 30 09:33:32 2010
@@ -0,0 +1,322 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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>Five minute SCXML tutorial</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+  <section name="What is SCXML?">
+
+   <p>State Chart XML (SCXML) is a general-purpose event-based state
+      machine language that can be used in many ways.</p>
+
+   <p>The definitive guide to authoring SCXML documents is the
+      <a href="http://www.w3.org/TR/scxml/">W3C Working Draft
+      of the SCXML specification</a>.</p>
+
+  </section>
+
+  <section name="Contents">
+
+   <p>This document contains the following sections:
+    <ul>
+     <li><a href="#hello">Hello World</a></li>
+     <li><a href="#transitions">Transitions</a></li>
+     <li><a href="#composite">Composite states</a></li>
+     <li><a href="#parallel">Parallel</a></li>
+     <li><a href="#custom">Hello World with a custom action</a></li>
+    </ul>
+   </p>
+
+   <a name="hello"/>
+  </section> 
+
+  <section name="Hello World">
+
+   <p>Here is the canonical
+      <a href="http://svn.apache.org/repos/asf/commons/proper/scxml/trunk/src/test/java/org/apache/commons/scxml/hello-world.xml">hello
world example</a>
+      for SCXML. The interesting bits are:</p>
+
+   <pre>
+    &lt;scxml xmlns="http://www.w3.org/2005/07/scxml"
+              version="1.0"
+              initialstate="hello"&gt;
+
+     &lt;state id="hello" final="true"&gt;
+      &lt;onentry&gt;
+       &lt;log expr="'hello world'" /&gt;
+      &lt;/onentry&gt;
+     &lt;/state&gt;
+
+    &lt;/scxml&gt;
+   </pre>
+
+   <p>
+    <ul>
+     <li>The document declares an initial state of "hello", which is the entry
+         point into the state machine.
+     </li>
+     <li>Once the state "hello" is entered the "executable content" contained
+         in the &lt;onentry&gt; is immediately executed.
+     </li>
+     <li>Similarly, there is also the symmetric &lt;onexit&gt;, which holds
+         executable content to be executed when a state is being exited.</li>
+     <li>The final attribute on state "hello" indicates that the state
+         machine has "run to completion".</li>
+     <li>Executable content is made of a series of "actions".</li>
+     <li>The "standard actions" defined by the SCXML specification are:
+         &lt;var&gt;, &lt;assign&gt;, &lt;log&gt;, &lt;send&gt;,
+         &lt;cancel&gt;, &lt;if&gt;, &lt;elseif&gt;, &lt;else&gt;.</li>
+    </ul>
+   </p>
+
+   <a name="transitions"/>
+  </section>
+
+  <section name="Transitions">
+
+   <p>Transitions allow the state machine to change state. A transition is
+      "followed" if its "trigger event" is received, and the
+      "guard condition", if one is available is valid.
+   </p>
+
+   <p>Here are some transition variants:</p>
+
+   <pre>
+    &lt;!--
+      ... begin scxml, some states ...
+    --&gt;
+
+     &lt;state id="foo1"&gt;
+      &lt;!--
+        ... some content ...
+      --&gt;
+      &lt;transition target="bar" /&gt;
+     &lt;/state&gt;
+
+     &lt;state id="foo2"&gt;
+      &lt;!--
+        ... some content ...
+      --&gt;
+      &lt;transition event="foo.bar" target="bar" /&gt;
+     &lt;/state&gt;
+
+     &lt;state id="foo3"&gt;
+      &lt;!--
+        ... some content ...
+      --&gt;
+      &lt;transition event="foo.bar" cond="some-boolean-expression"
+                     target next="bar" /&gt;
+     &lt;/state&gt;
+
+     &lt;state id="bar"&gt;
+      &lt;!--
+        ... some content ...
+      --&gt;
+     &lt;/state&gt;
+
+    &lt;!--
+       ... remaining states, end scxml ...
+    --&gt;
+   </pre>
+
+   <p>
+    <ul>
+     <li>The first transition in document order is an "immediate"
+         transition. "foo1" is the source, and "bar" is the
+         destination (transition target).
+     </li>
+     <li>The second transition waits for the trigger event "foo.bar".
+     </li>
+     <li>The third waits for "foo.bar" and the guard condition
+         specified by its "cond" attribute to evaluate to true
+         the instant the event is received.
+     </li>
+    </ul>
+   </p>
+
+   <a name="composite"/>
+  </section>
+
+  <section name="Composite states">
+
+   <p>States can contain states, so we can think of an
+      SCXML document as a recursive transition network. Here is
+      a snippet (here is the entire version of this
+      <a href="http://svn.apache.org/repos/asf/commons/proper/scxml/trunk/src/test/java/org/apache/commons/scxml/env/jexl/microwave-01.xml">microwave
example</a>
+      ):</p>
+
+   <pre>
+    &lt;!--
+      ... begin snippet ...
+    --&gt;
+
+     &lt;state id="on"&gt;
+      &lt;initial&gt;
+       &lt;transition target="idle"/&gt;
+      &lt;/initial&gt;
+
+      &lt;state id="idle"&gt;
+       &lt;!-- content for state "idle" --&gt;
+      &lt;/state&gt;
+
+      &lt;state id="cooking"&gt;
+       &lt;!-- content for state "cooking" --&gt;
+      &lt;/state&gt;
+
+      &lt;!-- other content for state "on" --&gt;
+
+    &lt;!--
+      ... end snippet ...
+    --&gt;
+   </pre>
+
+   <p>
+    <ul>
+     <li>The state "on" is an example of a composite state.</li>
+     <li>It contains two states, "idle" and "cooking". Since
+         there are no other sibling states, this means that when the
+         microwave is turned on, it must be in either idle or cooking
+         state.
+     </li>
+     <li>Since there are multiple states in the state "on", an
+         &lt;initial&gt; element is required. This becomes the "active"
+         child state when a transition is made to the composite state.
+         (in this case, a transition to state "on", causes the "idle"
+         state to be active).
+     </li>
+     <li>States can be recursively nested to any depth.</li>
+    </ul>
+   </p>
+
+   <a name="parallel"/>
+  </section>
+
+  <section name="Parallel">
+
+   <p>This is a wrapper element that encapsulates multiple
+      &lt;state&gt;s -- or state machines, since in the section on
+      composite states we took a look at the "recursion" or
+      "nesting" for the &lt;state&gt; element, whereby each state
+      can become a state machine in its own right -- that are "active"
+      at the same time. Here is
+      a relevant snippet (the entire version of this
+      <a href="http://svn.apache.org/repos/asf/commons/proper/scxml/trunk/src/test/java/org/apache/commons/scxml/env/jexl/microwave-02.xml">parallel
microwave example</a>
+      ):</p>
+
+   <pre>
+    &lt;!--
+      ... begin snippet ...
+    --&gt;
+
+     &lt;state id="microwave"&gt;
+      &lt;parallel id="parts"&gt;
+       &lt;state id="oven"&gt;
+
+        &lt;!-- state machine for "oven" (idle/cooking) --&gt;
+
+       &lt;/state&gt;
+
+       &lt;state id="door"&gt;
+
+        &lt;!-- state machine for "door" (open/closed) --&gt;
+
+       &lt;/state&gt;
+      &lt;/parallel&gt;
+     &lt;/state&gt;
+
+    &lt;!--
+      ... end snippet ...
+    --&gt;
+   </pre>
+
+   <p>
+    <ul>
+     <li>The state "microwave" is an example of a "orthogonal"
+         state (one that owns a parallel).</li>
+     <li>It contains two state machines, "oven" and "door". These
+         state machines are "active" at the same time. These are
+         known as "regions".
+     </li>
+     <li>Transition may occur within a region or from a region to
+         outside the &lt;parallel&gt; (see below), but never from
+         one region to another ("across" regions).
+     </li>
+     <li>There is no need for an &lt;initial&gt; element within
+         a &lt;parallel&gt;</li>
+     <li>The state machine must enter all regions at the same time,
+         and an outbound transition out of the &lt;parallel&gt;
+         from any region causes the state machine to exit all
+         regions.</li>
+     <li>When all regions reach a "final" state, an "id.done" event
+         is fired, where "id" is the id of the parent &lt;parallel&gt;
+         </li>
+    </ul>
+   </p>
+
+   <a name="custom"/>
+  </section>
+
+  <section name="Hello World with a custom action">
+
+   <p>The Commons SCXML implementation allows you to register custom actions.
+      Here is the Commons SCXML
+      <a href="http://svn.apache.org/repos/asf/commons/proper/scxml/trunk/src/test/java/org/apache/commons/scxml/custom-hello-world-02.xml">hello
world example using a custom action</a>.
+      The interesting bits are:</p>
+
+   <pre>
+    &lt;scxml xmlns="http://www.w3.org/2005/07/scxml"
+              xmlns:my="http://my.custom-actions.domain/CUSTOM"
+              version="1.0"
+              initialstate="custom"&gt;
+
+     &lt;state id="custom" final="true"&gt;
+      &lt;onentry&gt;
+       &lt;my:hello name="world" /&gt;
+      &lt;/onentry&gt;
+     &lt;/state&gt;
+
+    &lt;/scxml&gt;
+   </pre>
+
+   <p>
+    <ul>
+     <li>&lt;my:hello&gt; is an example of a custom action whose local
+         name is "hello" and is bound to the fictitious namespace
+         "http://my.custom-actions.domain/CUSTOM"
+     </li>
+     <li>The custom action hello merely logs a hello to the value of
+         the name attribute, and thus the above example produces results
+         identical to the initial hello world example above.
+     </li>
+     <li>For details, see the section on
+         <a href="custom-actions.html">custom actions</a> in this guide.
+     </li>
+    </ul>
+   </p>
+
+  </section>
+
+ </body>
+
+</document>

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/scxml-documents.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/using-visual-scxml.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/using-visual-scxml.xml?rev=959243&view=auto
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/using-visual-scxml.xml
(added)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/using-visual-scxml.xml
Wed Jun 30 09:33:32 2010
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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>Visual SCXML - How to use it</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+  <section name="Add a SCXML modeling file">
+   <p>In the running Eclipse environment, click menu “new”, select more,and
select “Modeling diagram ”in SCXML folder, click "next" -> "next" and then "finished".</p>
+	<p><img src="../images/guide-1.png" alt="Commons SCXML- Eclipse visual editor"/></p>
+	<a name="pieces"/>
+  </section>
+
+  <section name="Edit SCXML diagram content">
+
+   <p>You can edit SCXML diagram in this editor, use tools in palette tool bar, create
states, execute content and data model and other elements in W3C's SCXML recommendation specification:
+   </p>
+   <p><img src="../images/guide-2.png" alt="Commons SCXML- Eclipse visual editor"/></p>
+   <p>And as you see in the diagram above, you can edit elements' properties in Eclipse
property view.</p>
+
+   <a name="pieces"/>
+  </section>
+  
+  <section name="Export a SCXML document">
+   <p>Right click the SCXML "modeling" file which you would like to export, select
"Export SCXML document", and fill a filename, click "Finish" to finish export operation.</p>
+	<p><img src="../images/guide-3.png" alt="Commons SCXML- Eclipse visual editor"/></p>
+	<a name="pieces"/>
+  </section>
+  
+  <section name="Import a SCXML document into workspace ">
+   <p>If you want to import a SCXML document in your disk to workspace, and then edit
it, Visual SCXML supplies this function too. Just click "New" in "File" menu, select other
and "Import SCXML document" in SCXML folder.
+   In the next page, you should select the file which you would like to import, click "Load
Scxml Document" button to explor files in your disk, then click "Finish". If everything goes
well, you will finish a SCXML document import process.
+   </p>
+	<p><img src="../images/guide-4.png" alt="Commons SCXML- Eclipse visual editor"/></p>
+	<p><img src="../images/guide-5.png" alt="Commons SCXML- Eclipse visual editor"/></p>
+	<a name="pieces"/>
+  </section>
+
+  <section name="Others">
+   <p>This project is in develop period, if you have any questions or suggestions,
please contact guixl@apache.org, Thank you.
+   </p>
+	<a name="pieces"/>
+  </section>
+  
+ </body>
+
+</document>
+

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/using-visual-scxml.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/index.xml?rev=959243&r1=959242&r2=959243&view=diff
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/index.xml (original)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/index.xml Wed Jun 30 09:33:32
2010
@@ -23,14 +23,20 @@
 
   <body>
   
-    <section name="Commons SCXML - Eclipse">
-      State Chart XML (SCXML) provides a generic state-machine based execution
-      environment based on Harel State Tables. It is very useful to handle
-      complex state transfer logic, but if a SCXML file is large and complex,
-      it may become too difficult to maintain and refactor or to test its
-      logic. This project aims to provide an Eclipse and GMF based visual
+    <section name="Eclipse Based Visual SCXML Editor">
+      <p><a href="http://www.w3.org/TR/scxml/">State Chart XML</a> is very
useful to handler complex status transfer logic. <a href="http://commons.apache.org/scxml/index.html">Commons
SCXML</a> is an implementation aimed at creating and maintaining a Java SCXML engine
capable of executing a state machine defined using a SCXML document, while abstracting out
the environment interfaces.
+     </p>
+     <p>
+       Now,more and more developers use it to help handler complex program logic,but edit
a State Chart XML is so boring and mistakable.If a SCXML file is really so huge and complex,it
will become too difficult to maintain and refactor or to test its logic validity.For example,if
a SCXML flow has more than 20 States,it is possible to form an dead loop due to developer's
glitch. In fact, the archives of the Apache Commons SCXML user mailing list will show many
queries asking for it over the years.Obviously, Eclipse is the most power and popular Integration
Develop Environment for developers, if it supplies an editor or even debuger for State Chart
XML, isn't it cool ?
+      </p>
+      <p>
+      This project aims to provide an Eclipse and GMF based visual
       editor and debugger for SCXML, which can also be used to generate SCXML
       documents and code from a state chart.
+      </p>
+	<p>
+	<img src="images/scxml-eclipse.png" alt="Commons SCXML- Eclipse visual editor"/>
+	</p>
 
       <subsection name="Status">
       <p>



Mime
View raw message