Generated gh-pages for commit b158a71

Author: Leroy Ruegemer <[email protected]>

    update docs

_sources/behavior.rst.txt

@@ -10,6 +10,7 @@ The Bonsai SCXML utilises this to couple skills to rich behavior.
 
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 2
 
     Intro <behavior/scxml-intro>
+    Statemachine Configuration <behavior/config>

_sources/behavior/config.rst.txt

@@ -0,0 +1,75 @@
+.. _spec: http://www.w3.org/TR/scxml/
+.. _JEXL: https://commons.apache.org/proper/commons-jexl/reference/syntax.html
+
+.. highlight:: xml
+
+===================
+SCXML Configuration
+===================
+
+How to set Configuration
+------------------------
+
+Bonsai SCXML Statemachine Configuration is done in the datamodel of any scxm file.
+
+Example:
+
+.. code-block:: xml
+
+    <scxml xmlns="http://www.w3.org/2005/07/scxml" version="1.0" initial="A">
+        <datamodel>
+            <data id="#_STATE_PREFIX" expr="'de.unibi.citec.clf.bonsai.skills.'"/>
+        </datamodel>
+
+.. note::
+    Remember :ref:`Sourced<scxml sourcing>` files get copied into the main file.
+    Set Configurations only in the topmost scxml to avoid suprises
+
+Configurations
+--------------
+
+`#_STATE_PREFIX` 
+................
+
+defaults to: `de.unibi.citec.clf.bonsai.skills.`
+
+Package prefix for skills:
+
+.. code-block:: xml
+
+    <state id="Fatal"/>
+
+
+Results in skill: `de.unibi.citec.clf.bonsai.skills.Fatal` being executed.
+
+`#_DISABLE_DEFAULT_SLOT_WARNINGS`
+.................................
+
+defaults to `false`
+
+`#_ENABLE_SKILL_WARNINGS`
+.........................
+
+defaults to `false`
+
+`#_GENERATE_DEFAULT_SLOTS`
+..........................
+
+defaults to `false`
+
+`#_CONFIGURE_AND_VALIDATE`
+..........................
+
+defaults to `true`
+
+`#_ENABLE_CONFIG_CACHE`
+.......................
+
+defaults to `false`
+
+`#_FINAL_STATES`
+................
+
+defaults to `true`
+
+Always assume `End` and `Fatal` as final states and stop the statemachine. 

_sources/behavior/scxml-intro.rst.txt

@@ -164,6 +164,8 @@ Assign is used to update data entrys
 
 
 
+.. _scxml sourcing:
+
 Sourcing
 --------
 

_sources/general/skills.rst.txt

@@ -79,7 +79,7 @@ Skills are able to read parameter in the configure method
         text = configurator.requestValue(KEY_TEXT);
         blocking = configurator.requestOptionalBool(KEY_BLOCKING, blocking);
     }
-
+    
 
 - there are different requestTYPE methods for different types ``requestValue()`` reads the value as String.
 - Requested parameter have to be given

_static/_sphinx_javascript_frameworks_compat.js

@@ -1,20 +1,9 @@
-/*
- * _sphinx_javascript_frameworks_compat.js
- * ~~~~~~~~~~
- *
- * Compatability shim for jQuery and underscores.js.
- *
- * WILL BE REMOVED IN Sphinx 6.0
- * xref RemovedInSphinx60Warning
+/* Compatability shim for jQuery and underscores.js.
  *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
  */
 
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-
 /**
  * small helper function to urldecode strings
  *

_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -222,7 +222,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: 450px;
+    min-width: 360px;
     max-width: 800px;
 }
 
@@ -237,14 +237,8 @@ a.headerlink {
     visibility: hidden;
 }
 
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
+a:visited {
+    color: #551A8B;
 }
 
 h1:hover > a.headerlink,
@@ -335,12 +329,16 @@ p.sidebar-title {
     font-weight: bold;
 }
 
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
 
+nav.contents,
+aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -379,13 +377,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -428,10 +430,6 @@ table.docutils td, table.docutils th {
     border-bottom: 1px solid #aaa;
 }
 
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
 th {
     text-align: left;
     padding-right: 5px;
@@ -615,19 +613,26 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-dl.footnote > dt,
-dl.citation > dt {
+aside.footnote > span,
+div.citation > span {
     float: left;
-    margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
     margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
     content: "";
     clear: both;
 }
@@ -644,10 +649,6 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
-dl.field-list > dt:after {
-    content: ":";
-}
-
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -673,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -741,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {
@@ -757,6 +776,7 @@ span.pre {
     -ms-hyphens: none;
     -webkit-hyphens: none;
     hyphens: none;
+    white-space: nowrap;
 }
 
 div[class*="highlight-"] {