Statechartz Documentation

From c4e24c70f6eefbd70d1eea89da1b0f16ed8228bf Mon Sep 17 00:00:00 2001 From: No'am Rosenthal Date: Sun, 8 Nov 2009 16:20:13 -0800 Subject: Basic documentation for Statechartz --- statechartz/doc.html | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 statechartz/doc.html diff --git a/statechartz/doc.html b/statechartz/doc.html new file mode 100644 index 0000000..14ed47b --- /dev/null +++ b/statechartz/doc.html @@ -0,0 +1,30 @@ + + Statechartz Documentation + +

Documentation for the Statechartz Javascript Library

Overview

+The Statechartz Javascript library is meant to provide heirarchical statechart support for web-sites and web-apps, based on the SCXML standard. It includes most of the basic SCXML features, including state heirarchy, parallel states, final/initial/history pseudo-states, conditional transitions and executable activities. +
+The Statechartz library is meant to help manage the complexity of web-apps, allowing for more dynamic web experience with less lines of code. + +

Browser Support

+Statechartz is currently only tested with webkit browsers (QtWebkit / Arora, Safari, Chrome). Other browser support might be added in time. + +

Authoring using SCXML

+The standard way to author for Statechartz is with SCXML. By having a separate SCXML file next to the HTML and Javascript assets, the flow can be separated from the graphics and the logic of the application. +
+Note that only a subset of the SCXML standard is supported: +The tags scxml, state, parallel, initial, final, history, transition, raise, send, if, else, elseif, script, data, and datamodel are the supported tags. +
+An SCXML file can be loaded in the 2 following ways: +

Dynamically via the Statechartz.loadScxml(Document) function. This function accepts a DOM XML Document as a parameter, and returns a Statechart object. That statechart can be started with the start() function, and events can be raised to it with the raise() function.
Statically via a link tag in the HTML head: <link rel="statechart" href="someURL.scxml"/> (See demo.html. When loaded statically, the statechart woulld be kept in document.statechart, and would start once the document is loaded. +

Documentation for the Statechartz Javascript Library

Overview

Browser Support

Authoring using SCXML

Authoring using agile Javascript syntax

Connecting with HTML and CSS

Gotchas