Author: guixl Date: Tue Aug 3 06:25:53 2010 New Revision: 981756 URL: http://svn.apache.org/viewvc?rev=981756&view=rev Log: improve web site user guide content
Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_1.png (with props) commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_2.png (with props) commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_3.png (with props) commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_4.png (with props) commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/debug-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/guide.xml Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_1.png URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_1.png?rev=981756&view=auto ============================================================================== Binary file - no diff available. Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_1.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_2.png URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_2.png?rev=981756&view=auto ============================================================================== Binary file - no diff available. Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_2.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_3.png URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_3.png?rev=981756&view=auto ============================================================================== Binary file - no diff available. Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_3.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_4.png URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_4.png?rev=981756&view=auto ============================================================================== Binary file - no diff available. Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/resources/images/debug_4.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=981756&r1=981755&r2=981756&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 Tue Aug 3 06:25:53 2010 @@ -23,6 +23,7 @@ <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 name="Create SCXML debug environment" href="/guide/debug-scxml.html" /> </item> <item name="Document" href="/document.html" collapse="true"> <item name="Data Model History" href="/document/history.html" /> Modified: 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=981756&r1=981755&r2=981756&view=diff ============================================================================== --- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml (original) +++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide.xml Tue Aug 3 06:25:53 2010 @@ -46,6 +46,7 @@ <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> + <li><a href="guide/debug-scxml.html">Create SCXML debug environment in Visual SCXML </a> - Guide about how to create Apache Commons SCXML based debug environment in Visual SCXML.</li> </ul> </subsection> Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/debug-scxml.xml URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/debug-scxml.xml?rev=981756&view=auto ============================================================================== --- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/debug-scxml.xml (added) +++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/debug-scxml.xml Tue Aug 3 06:25:53 2010 @@ -0,0 +1,63 @@ +<?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 - Create SCXML debug environment</title> + <author email="d...@commons.apache.org">Commons Documentation Team</author> + </properties> + + <body> + + <section name="Step 1"> + <p>We intergate Apache Commons SCXML to provide debug environment for SCXML document in Visual SCXML, if you want to create debug class for one SCXML .modeling file, just right click + the modeling file, select "SCXML" -> "Create Apache Commons SCXML Debug Runtime", as shown in the following figure.</p> + <p><img src="../images/debug_1.png" alt="Commons SCXML- Eclipse visual editor"/></p> + <a name="pieces"/> + </section> + + <section name="Step 2"> + + <p>Then, you should select location for the Java SCXML debug class, re-name this Java class or not, and follow the instructions to finish debug class creation process. + </p> + <p><img src="../images/debug_2.png" alt="Commons SCXML- Eclipse visual editor"/></p> + <p>Or you can just click "finish" button to apply default setting.</p> + + <a name="pieces"/> + </section> + + <section name="Step 3"> + <p>After the two steps, Visual SCXML create a Java class to debug SCXML document and also we can find some jars in our project folders, they are basic jars for Apache Commons SCXML engine. And Visual SCXML + will add these jars into our project build path. If you want to learn more about Apache Commons SCXML, just click <a href="http://commons.apache.org/scxml">here</a>. In fact, you can edit this Java file if you like.</p> + <p><img src="../images/debug_3.png" alt="Commons SCXML- Eclipse visual editor"/></p> + <a name="pieces"/> + </section> + + <section name="Step 4"> + <p>Then, you can use debug class to test your SCXML document's service logic. Just run this Java file, input commend or SCXML event in Eclipse console view, Visual SCXML just supplies simple debug functions for us, + we will keep on improving this debug function in the coming days. + </p> + <p><img src="../images/debug_4.png" alt="Commons SCXML- Eclipse visual editor"/></p> + <a name="pieces"/> + </section> + + </body> + +</document> + Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/src/site/xdoc/guide/debug-scxml.xml ------------------------------------------------------------------------------ svn:eol-style = native