docs(Context Situation): Updated Docs with Context Situation Rule

Updated the docs for the Context Situation Rule Component which allows the modelling of context situation rules Relates to CM-171 CM-172
BerniWittmann · Feb 28, 2019 · 157efdb · 157efdb
1 parent 59891bd
commit 157efdb
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/docs/components/ContextSituationRules.md b/docs/components/ContextSituationRules.md
@@ -7,8 +7,28 @@ A Component for modelling the Rules of a Context Situation
 <!-- @vuese:ContextSituationRules:props:start -->
 |Name|Description|Type|Required|Default|
 |---|---|---|---|---|
-|contextSituation|The Context Situation Object|`Object`|`true`|-|
+|value|The Context Situation Rules String|`String`|`false`|''|
 
 <!-- @vuese:ContextSituationRules:props:end -->
 
 
+## Events
+
+<!-- @vuese:ContextSituationRules:events:start -->
+|Event Name|Description|Parameters|
+|---|---|---|
+|change|Fired when the rule changes|The new rule string|
+
+<!-- @vuese:ContextSituationRules:events:end -->
+
+
+## Methods
+
+<!-- @vuese:ContextSituationRules:methods:start -->
+|Method|Description|Parameters|
+|---|---|---|
+|reset|Resets the Rules to the Rule String|-|
+
+<!-- @vuese:ContextSituationRules:methods:end -->
+
+
diff --git a/docs/index.html b/docs/index.html
@@ -12,7 +12,7 @@
     <script>
       new Docute({
         target: '#docute',
-        sidebar: JSON.parse('[{&#34;title&#34;:&#34;Components&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;ContextType&#34;,&#34;link&#34;:&#34;/components/ContextType&#34;},{&#34;title&#34;:&#34;InputType&#34;,&#34;link&#34;:&#34;/components/InputType&#34;},{&#34;title&#34;:&#34;Navigation&#34;,&#34;link&#34;:&#34;/components/Navigation&#34;},{&#34;title&#34;:&#34;Tag&#34;,&#34;link&#34;:&#34;/components/Tag&#34;},{&#34;title&#34;:&#34;TagEditor&#34;,&#34;link&#34;:&#34;/components/TagEditor&#34;},{&#34;title&#34;:&#34;InputEdit&#34;,&#34;link&#34;:&#34;/components/InputEdit&#34;},{&#34;title&#34;:&#34;ProcessModeler&#34;,&#34;link&#34;:&#34;/components/ProcessModeler&#34;},{&#34;title&#34;:&#34;ContextSituationCard&#34;,&#34;link&#34;:&#34;/components/ContextSituationCard&#34;},{&#34;title&#34;:&#34;ContextSituationRules&#34;,&#34;link&#34;:&#34;/components/ContextSituationRules&#34;},{&#34;title&#34;:&#34;ContextTypeSettings&#34;,&#34;link&#34;:&#34;/components/ContextTypeSettings&#34;},{&#34;title&#34;:&#34;FAIconPicker&#34;,&#34;link&#34;:&#34;/components/FAIconPicker&#34;},{&#34;title&#34;:&#34;GraphVisualization&#34;,&#34;link&#34;:&#34;/components/GraphVisualization&#34;},{&#34;title&#34;:&#34;ProcessModelerSettings&#34;,&#34;link&#34;:&#34;/components/ProcessModelerSettings&#34;},{&#34;title&#34;:&#34;Footer&#34;,&#34;link&#34;:&#34;/components/Footer&#34;},{&#34;title&#34;:&#34;TagSettings&#34;,&#34;link&#34;:&#34;/components/TagSettings&#34;},{&#34;title&#34;:&#34;ProcessInfoForm&#34;,&#34;link&#34;:&#34;/components/ProcessInfoForm&#34;}]},{&#34;title&#34;:&#34;Dialogs&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;ContextFactorEditDialog&#34;,&#34;link&#34;:&#34;/components/ContextFactorEditDialog&#34;},{&#34;title&#34;:&#34;ProcessPreviewDialog&#34;,&#34;link&#34;:&#34;/components/ProcessPreviewDialog&#34;}]},{&#34;title&#34;:&#34;Layouts&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;DefaultLayout&#34;,&#34;link&#34;:&#34;/components/DefaultLayout&#34;},{&#34;title&#34;:&#34;EmptyRouterViewLayout&#34;,&#34;link&#34;:&#34;/components/EmptyRouterViewLayout&#34;}]},{&#34;title&#34;:&#34;Pages&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;AboutPage&#34;,&#34;link&#34;:&#34;/components/AboutPage&#34;},{&#34;title&#34;:&#34;ContextFactorsPage&#34;,&#34;link&#34;:&#34;/components/ContextFactorsPage&#34;},{&#34;title&#34;:&#34;ContextSituationsPage&#34;,&#34;link&#34;:&#34;/components/ContextSituationsPage&#34;},{&#34;title&#34;:&#34;HomePage&#34;,&#34;link&#34;:&#34;/components/HomePage&#34;},{&#34;title&#34;:&#34;ProcessRepositoryPage&#34;,&#34;link&#34;:&#34;/components/ProcessRepositoryPage&#34;},{&#34;title&#34;:&#34;SettingsPage&#34;,&#34;link&#34;:&#34;/components/SettingsPage&#34;},{&#34;title&#34;:&#34;EditProcessPage&#34;,&#34;link&#34;:&#34;/components/EditProcessPage&#34;}]}]'.replace(/\&\#34\;/g, '"'))
+        sidebar: JSON.parse('[{&#34;title&#34;:&#34;Components&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;ContextType&#34;,&#34;link&#34;:&#34;/components/ContextType&#34;},{&#34;title&#34;:&#34;InputType&#34;,&#34;link&#34;:&#34;/components/InputType&#34;},{&#34;title&#34;:&#34;Navigation&#34;,&#34;link&#34;:&#34;/components/Navigation&#34;},{&#34;title&#34;:&#34;Tag&#34;,&#34;link&#34;:&#34;/components/Tag&#34;},{&#34;title&#34;:&#34;TagEditor&#34;,&#34;link&#34;:&#34;/components/TagEditor&#34;},{&#34;title&#34;:&#34;InputEdit&#34;,&#34;link&#34;:&#34;/components/InputEdit&#34;},{&#34;title&#34;:&#34;ContextSituationRules&#34;,&#34;link&#34;:&#34;/components/ContextSituationRules&#34;},{&#34;title&#34;:&#34;ProcessInfoForm&#34;,&#34;link&#34;:&#34;/components/ProcessInfoForm&#34;},{&#34;title&#34;:&#34;ProcessModeler&#34;,&#34;link&#34;:&#34;/components/ProcessModeler&#34;},{&#34;title&#34;:&#34;ContextTypeSettings&#34;,&#34;link&#34;:&#34;/components/ContextTypeSettings&#34;},{&#34;title&#34;:&#34;FAIconPicker&#34;,&#34;link&#34;:&#34;/components/FAIconPicker&#34;},{&#34;title&#34;:&#34;GraphVisualization&#34;,&#34;link&#34;:&#34;/components/GraphVisualization&#34;},{&#34;title&#34;:&#34;ProcessModelerSettings&#34;,&#34;link&#34;:&#34;/components/ProcessModelerSettings&#34;},{&#34;title&#34;:&#34;Footer&#34;,&#34;link&#34;:&#34;/components/Footer&#34;},{&#34;title&#34;:&#34;TagSettings&#34;,&#34;link&#34;:&#34;/components/TagSettings&#34;},{&#34;title&#34;:&#34;ContextSituationCard&#34;,&#34;link&#34;:&#34;/components/ContextSituationCard&#34;}]},{&#34;title&#34;:&#34;Dialogs&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;ContextFactorEditDialog&#34;,&#34;link&#34;:&#34;/components/ContextFactorEditDialog&#34;},{&#34;title&#34;:&#34;ProcessPreviewDialog&#34;,&#34;link&#34;:&#34;/components/ProcessPreviewDialog&#34;}]},{&#34;title&#34;:&#34;Layouts&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;DefaultLayout&#34;,&#34;link&#34;:&#34;/components/DefaultLayout&#34;},{&#34;title&#34;:&#34;EmptyRouterViewLayout&#34;,&#34;link&#34;:&#34;/components/EmptyRouterViewLayout&#34;}]},{&#34;title&#34;:&#34;Pages&#34;,&#34;links&#34;:[{&#34;title&#34;:&#34;AboutPage&#34;,&#34;link&#34;:&#34;/components/AboutPage&#34;},{&#34;title&#34;:&#34;ContextFactorsPage&#34;,&#34;link&#34;:&#34;/components/ContextFactorsPage&#34;},{&#34;title&#34;:&#34;ContextSituationsPage&#34;,&#34;link&#34;:&#34;/components/ContextSituationsPage&#34;},{&#34;title&#34;:&#34;HomePage&#34;,&#34;link&#34;:&#34;/components/HomePage&#34;},{&#34;title&#34;:&#34;ProcessRepositoryPage&#34;,&#34;link&#34;:&#34;/components/ProcessRepositoryPage&#34;},{&#34;title&#34;:&#34;SettingsPage&#34;,&#34;link&#34;:&#34;/components/SettingsPage&#34;},{&#34;title&#34;:&#34;EditProcessPage&#34;,&#34;link&#34;:&#34;/components/EditProcessPage&#34;}]}]'.replace(/\&\#34\;/g, '"'))
       })
     </script>
   </body>