瀏覽代碼

YAKHMI-521 define structure for user guide

webmaster@wendler-im-netz.de 13 年之前
父節點
當前提交
7f8ccc9554
共有 46 個文件被更改,包括 120 次插入532 次删除
  1. 11 3
      plugins/org.yakindu.sct.doc.user/.settings/org.eclipse.core.resources.prefs
  2. 1 2
      plugins/org.yakindu.sct.doc.user/help/01_Overview/overview-toc.xml
  3. 1 16
      plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.html
  4. 7 9
      plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.textile
  5. 15 0
      plugins/org.yakindu.sct.doc.user/help/02_Getting_Started/getting_started-toc.xml
  6. 1 0
      plugins/org.yakindu.sct.doc.user/help/02_Getting_Started/getting_started.html
  7. 19 0
      plugins/org.yakindu.sct.doc.user/help/02_Getting_Started/getting_started.textile
  8. 18 23
      plugins/org.yakindu.sct.doc.user/help/03_Statechart_Modeling_and_Simulation/modeling_simulation.textile
  9. 0 8
      plugins/org.yakindu.sct.doc.user/help/02_Installation/installation-toc.xml
  10. 0 15
      plugins/org.yakindu.sct.doc.user/help/02_Installation/installation.html
  11. 0 7
      plugins/org.yakindu.sct.doc.user/help/02_Installation/installation.textile
  12. 7 0
      plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts-toc.xml
  13. 1 0
      plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.html
  14. 10 0
      plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.textile
  15. 0 17
      plugins/org.yakindu.sct.doc.user/help/03_Statechart_Modeling_and_Simulation/modeling_simulation-toc.xml
  16. 0 23
      plugins/org.yakindu.sct.doc.user/help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html
  17. 0 5
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/01_introduction.textile
  18. 0 6
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/02_execution_model.textile
  19. 0 16
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/03_statechart_runtime.textile
  20. 0 71
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/04_statechart_interfaces.textile
  21. 0 3
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/05_multithreading.textile
  22. 二進制
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/images/execution_model.png
  23. 二進制
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/images/timing_example01.png
  24. 二進制
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/images/transition_example01.png
  25. 0 6
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/index.txt
  26. 0 18
      plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/timerhandler_interface.textile
  27. 10 0
      plugins/org.yakindu.sct.doc.user/help/04_Tasks/tasks-toc.xml
  28. 1 0
      plugins/org.yakindu.sct.doc.user/help/04_Tasks/tasks.html
  29. 11 0
      plugins/org.yakindu.sct.doc.user/help/04_Tasks/tasks.textile
  30. 0 3
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/01_introduction.textile
  31. 0 2
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/02_example.textile
  32. 0 10
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/03_generation.textile
  33. 0 2
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/04_sourcecode.textile
  34. 0 2
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/05_integration.textile
  35. 0 5
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/index.txt
  36. 0 15
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/java_code_generator-toc.xml
  37. 0 21
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/java_code_generator.html
  38. 0 24
      plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/java_code_generator.textile
  39. 0 15
      plugins/org.yakindu.sct.doc.user/help/06_UML_Transformation/uml_transformation-toc.xml
  40. 0 21
      plugins/org.yakindu.sct.doc.user/help/06_UML_Transformation/uml_transformation.html
  41. 0 19
      plugins/org.yakindu.sct.doc.user/help/06_UML_Transformation/uml_transformation.textile
  42. 0 25
      plugins/org.yakindu.sct.doc.user/help/07_Reference/sc_reference-toc.xml
  43. 0 39
      plugins/org.yakindu.sct.doc.user/help/07_Reference/sc_reference.html
  44. 0 59
      plugins/org.yakindu.sct.doc.user/help/07_Reference/sc_reference.textile
  45. 3 15
      plugins/org.yakindu.sct.doc.user/plugin.xml
  46. 4 7
      plugins/org.yakindu.sct.doc.user/toc.xml

+ 11 - 3
plugins/org.yakindu.sct.doc.user/.settings/org.eclipse.core.resources.prefs

@@ -1,3 +1,11 @@
-#Wed Aug 10 14:44:14 CEST 2011
-eclipse.preferences.version=1
-encoding/<project>=UTF-8
+#Tue Jan 24 06:11:42 CET 2012
+eclipse.preferences.version=1
+encoding//help/01_Overview/overview-toc.xml=utf-8
+encoding//help/01_Overview/overview.html=utf-8
+encoding//help/02_Getting_Started/getting_started-toc.xml=utf-8
+encoding//help/02_Getting_Started/getting_started.html=utf-8
+encoding//help/03_Concepts/concepts-toc.xml=utf-8
+encoding//help/03_Concepts/concepts.html=utf-8
+encoding//help/04_Tasks/tasks-toc.xml=utf-8
+encoding//help/04_Tasks/tasks.html=utf-8
+encoding/<project>=UTF-8

+ 1 - 2
plugins/org.yakindu.sct.doc.user/help/01_Overview/overview-toc.xml

@@ -1,10 +1,9 @@
 <?xml version='1.0' encoding='utf-8' ?>
 <toc topic="help/01_Overview/overview.html" label="overview">
 	<topic href="help/01_Overview/overview.html" label="Overview">
-		<topic href="help/01_Overview/overview.html#YAKINDUStatechartTools" label="YAKINDU Statechart Tools">
+		<topic href="help/01_Overview/overview.html#YAKINDUStatechartTools2" label="YAKINDU Statechart Tools 2">
 			<topic href="help/01_Overview/overview.html#YAKINDUandEclipse" label="YAKINDU and Eclipse"></topic>
 			<topic href="help/01_Overview/overview.html#StatusWarrantyandLicense" label="Status, Warranty and License"></topic>
-			<topic href="help/01_Overview/overview.html#ToolArchitecture" label="Tool Architecture"></topic>
 		</topic>
 	</topic>
 </toc>

File diff suppressed because it is too large
+ 1 - 16
plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.html


+ 7 - 9
plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.textile

@@ -1,9 +1,7 @@
-h1. Overview
-
-h2. YAKINDU Statechart Tools
-
-h3. YAKINDU and Eclipse
-
-h3. Status, Warranty and License
-
-h3. Tool Architecture
+h1. Overview
+
+h2. YAKINDU Statechart Tools 2
+
+h3. YAKINDU and Eclipse
+
+h3. Status, Warranty and License

+ 15 - 0
plugins/org.yakindu.sct.doc.user/help/02_Getting_Started/getting_started-toc.xml

@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="help/02_Getting_Started/getting_started.html" label="getting_started">
+	<topic href="help/02_Getting_Started/getting_started.html" label="Getting started">
+		<topic href="help/02_Getting_Started/getting_started.html#Installation" label="Installation">
+			<topic href="help/02_Getting_Started/getting_started.html#Prerequisites" label="Prerequisites"></topic>
+			<topic href="help/02_Getting_Started/getting_started.html#InstallingtheYAKINDUPlugIns" label="Installing the YAKINDU-Plug-Ins "></topic>
+		</topic>
+		<topic href="help/02_Getting_Started/getting_started.html#TheYakinduperspective" label="The Yakindu perspective"></topic>
+		<topic href="help/02_Getting_Started/getting_started.html#Yakinduproject" label="Yakindu project"></topic>
+		<topic href="help/02_Getting_Started/getting_started.html#Editors" label="Editors"></topic>
+		<topic href="help/02_Getting_Started/getting_started.html#Views" label="Views"></topic>
+		<topic href="help/02_Getting_Started/getting_started.html#Wizards" label="Wizards"></topic>
+		<topic href="help/02_Getting_Started/getting_started.html#Generators" label="Generators"></topic>
+	</topic>
+</toc>

File diff suppressed because it is too large
+ 1 - 0
plugins/org.yakindu.sct.doc.user/help/02_Getting_Started/getting_started.html


+ 19 - 0
plugins/org.yakindu.sct.doc.user/help/02_Getting_Started/getting_started.textile

@@ -0,0 +1,19 @@
+h1. Getting started
+
+h2. Installation
+
+h3. Prerequisites
+
+h3. Installing the YAKINDU-Plug-Ins 
+
+h2. The Yakindu perspective
+
+h2. Yakindu project
+
+h2. Editors
+
+h2. Views
+
+h2. Wizards
+
+h2. Generators

+ 18 - 23
plugins/org.yakindu.sct.doc.user/help/03_Statechart_Modeling_and_Simulation/modeling_simulation.textile

@@ -1,23 +1,18 @@
-h1. Statechart Modeling and Simulation
-
-h2. The YAKINDU perspective
-
-h2. Example Step-by-Step
-
-h3. Example State Machine
-
-h3. Creating a New Project
-
-h3. Defining a State Machine 
-
-h3. Checking the State Machine
-
-h3. Project Type and Dependencies
-
-h3. Creating Check Files
-
-h3. Editing Check Files
-
-h3. Simulating a State Machine
-
-h2. Using the Example Projects
+h2. Using the Example Projects
+
+h3. Example State Machine
+
+h3. Creating a New Project
+
+h3. Defining a State Machine 
+
+h3. Checking the State Machine
+
+h3. Project Type and Dependencies
+
+h3. Creating Check Files
+
+h3. Editing Check Files
+
+h3. Simulating a State Machine
+

+ 0 - 8
plugins/org.yakindu.sct.doc.user/help/02_Installation/installation-toc.xml

@@ -1,8 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/02_Installation/installation.html" label="installation">
-	<topic href="help/02_Installation/installation.html" label="Installation">
-		<topic href="help/02_Installation/installation.html#EclipseInstallation" label="Eclipse Installation"></topic>
-		<topic href="help/02_Installation/installation.html#InstallingtheYAKINDUPlugIns" label="Installing the YAKINDU-Plug-Ins"></topic>
-		<topic href="help/02_Installation/installation.html#InstallingfromZip" label="Installing from Zip"></topic>
-	</topic>
-</toc>

+ 0 - 15
plugins/org.yakindu.sct.doc.user/help/02_Installation/installation.html

@@ -1,15 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-		<title>installation</title>
-		<link type="text/css" rel="stylesheet" href="../content/PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"/>
-		<link type="text/css" rel="stylesheet" href="../style.css"/>
-	</head>
-	<body>
-		<h1 id="Installation">Installation</h1>
-		<h2 id="EclipseInstallation">Eclipse Installation</h2>
-		<h2 id="InstallingtheYAKINDUPlugIns">Installing the YAKINDU-Plug-Ins</h2>
-		<h2 id="InstallingfromZip">Installing from Zip</h2>
-	</body>
-</html>

+ 0 - 7
plugins/org.yakindu.sct.doc.user/help/02_Installation/installation.textile

@@ -1,7 +0,0 @@
-h1. Installation
-
-h2. Eclipse Installation
-
-h2. Installing the YAKINDU-Plug-Ins
-
-h2. Installing from Zip

+ 7 - 0
plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts-toc.xml

@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="help/03_Concepts/concepts.html" label="concepts">
+	<topic href="help/03_Concepts/concepts.html" label="Yakindu Statechart tool concepts">
+		<topic href="help/03_Concepts/concepts.html#ModelValidateSimulateGenerate" label="Model, Validate, Simulate, Generate"></topic>
+		<topic href="help/03_Concepts/concepts.html#Stext" label="Stext"></topic>
+	</topic>
+</toc>

File diff suppressed because it is too large
+ 1 - 0
plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.html


+ 10 - 0
plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.textile

@@ -0,0 +1,10 @@
+h1. Yakindu Statechart tool concepts
+
+h2. Model, Validate, Simulate, Generate
+
+h2. Stext
+
+
+
+
+

+ 0 - 17
plugins/org.yakindu.sct.doc.user/help/03_Statechart_Modeling_and_Simulation/modeling_simulation-toc.xml

@@ -1,17 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html" label="modeling_simulation">
-	<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html" label="Statechart Modeling and Simulation">
-		<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#TheYAKINDUperspective" label="The YAKINDU perspective"></topic>
-		<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#ExampleStepbyStep" label="Example Step-by-Step">
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#ExampleStateMachine" label="Example State Machine"></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#CreatingaNewProject" label="Creating a New Project"></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#DefiningaStateMachine" label="Defining a State Machine "></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#CheckingtheStateMachine" label="Checking the State Machine"></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#ProjectTypeandDependencies" label="Project Type and Dependencies"></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#CreatingCheckFiles" label="Creating Check Files"></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#EditingCheckFiles" label="Editing Check Files"></topic>
-			<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#SimulatingaStateMachine" label="Simulating a State Machine"></topic>
-		</topic>
-		<topic href="help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html#UsingtheExampleProjects" label="Using the Example Projects"></topic>
-	</topic>
-</toc>

+ 0 - 23
plugins/org.yakindu.sct.doc.user/help/03_Statechart_Modeling_and_Simulation/modeling_simulation.html

@@ -1,23 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-		<title>modeling_simulation</title>
-		<link type="text/css" rel="stylesheet" href="../content/PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"/>
-		<link type="text/css" rel="stylesheet" href="../style.css"/>
-	</head>
-	<body>
-		<h1 id="StatechartModelingandSimulation">Statechart Modeling and Simulation</h1>
-		<h2 id="TheYAKINDUperspective">The YAKINDU perspective</h2>
-		<h2 id="ExampleStepbyStep">Example Step-by-Step</h2>
-		<h3 id="ExampleStateMachine">Example State Machine</h3>
-		<h3 id="CreatingaNewProject">Creating a New Project</h3>
-		<h3 id="DefiningaStateMachine">Defining a State Machine </h3>
-		<h3 id="CheckingtheStateMachine">Checking the State Machine</h3>
-		<h3 id="ProjectTypeandDependencies">Project Type and Dependencies</h3>
-		<h3 id="CreatingCheckFiles">Creating Check Files</h3>
-		<h3 id="EditingCheckFiles">Editing Check Files</h3>
-		<h3 id="SimulatingaStateMachine">Simulating a State Machine</h3>
-		<h2 id="UsingtheExampleProjects">Using the Example Projects</h2>
-	</body>
-</html>

+ 0 - 5
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/01_introduction.textile

@@ -1,5 +0,0 @@
-h1. Yakindu Statechart Generator
-
-h2. Introduction
-
-Within this documentation, we want to create a common view about the Yakindu Statechart Generator and a number of implementation variations.

+ 0 - 6
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/02_execution_model.textile

@@ -1,6 +0,0 @@
-
-h2. Description of the 'Execution Model' used in YAKINDU statechart environment
-
-The following figure shows the eCore model for the execution model (date 18:10:11):
-
-!../04_C-Code_Generator/images/execution_model.png! 

+ 0 - 16
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/03_statechart_runtime.textile

@@ -1,16 +0,0 @@
-h2. Runtime implementation alternatives
-
-This section introduces a number of details and alternatives for the implementation. The specific implementation informatio are not presented in this, but in a subsequent section. 
-
-h3. Event Based State Machine Approach
-
-The event based state machine implements a queue for events that should be handled. This queue is a first-in-first-out queue and handles one event per runCycle step.
-
-So if there a statemachine with an empty event queue and the event E1 and after that event E2 were received, the statemachine handels E1 during the first call to runCycle and handles the second Event during the second call to runCycle(). The call to runCycle is not fixed. It can be done when ever an event occurs or when there is a timeslice available.
-
-
-h3. Cycle Based State Machine Approach 
-
-The Cycle Based approach calls the runCycle method periodically (e.g. every 50 milliseconds). When an event occurs, it is sent to the statemachine via raiseEvent(). The cycle based state machine collects all events and the transition conditions, which are ordered by priority, are tested for a match with the given events. If there is a match, the transition is executed (with all exit, transition and entry actions).
-
-If one transition (the best matching one) was found and executed, all other events are deleted and the runCycle method returns. 

+ 0 - 71
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/04_statechart_interfaces.textile

@@ -1,71 +0,0 @@
-h2. Statechart Interfaces  
-
-A statechart is divided into the following building blocks:
-
-* EventHandler
-* Statechart
-* DataRepository
-* TimerHandler
-
-The main class is Statechart. It is derived from EventHandler and contains a DataRepository and a TimerHandler.
-
-h3. EventHandler
-
-The EventHandler contains only one interface method:
-
-* raiseEvent(<Event>)
-
-This virtual method is called from the outside to inform the state machine to handle an event. The action applied to this notification is up to the implementer. E.g. queuing/storing of the event or direct even handling.  
-
-h3. Statechart
-
-The Statechart contains the following interface methods:
-
-h4. init()
-
-initializes the state machine (e.g. setzt the initial state or states, initializes the timers etc). Init can be called whenever the state machine should be reseted to the start.
-
-h4. runCycle()
-
-runCycle dispatches one "Run-To-Completion" step of a state machine. This means, it will either take exactly one transition if the transition condition is met or will do nothing. The transition condition is met if one or more of the specified events are set _and_ the guard condition is true.
-When a transition is taken, the state machine executes all exit actions of the states, which are left. The exit chain is started with the most inner state to the state that both substates owns. Then the transition action is executed and all entry actions are taken up to state, the transition ends at.
-
-h4. get/setDataRepository()
-
-Setter and Getter to set the Data Repository. The Data Repository may be derived from the generated one an must therefore have a setter as well.
-
-h4. get/setTimerHandler()
-
-Setter and Getter for the TimerHandler.
-
-The TimerHandler class is only an abstract or interface class, which must have an implementation and must therfore be set and getable. 
-
-The code generator creates a DummyTimerHandler, that is initially instantiated to have no empty TimerHandler. It is placed into the statechart during the constructor call. This is necessary e.g. for the implementation of statecharts, which are not time dependent. 
-
-h4. add/remove/getEventHandler()   
-
-To handle external events, that are created by the statemachine and which must be handled by a codeblock outside the statemachine, the EventHandler should be used. The statemachine itself is an eventHandler as well, therefore two statemachines can be connected by this method and can exchange events. 
-
-The statemachine calls the method raiseEvent() for every registered EventHandler whenever an external event occurs.
-
-h3. DataRepository
-
-All variables, that are defined and used within the state chart diagram are placed into the DataRepository. This repository offers getter and setter methods to access the variables. 
-
-The Getters and Setters are called in accordance to the variable names. As variables with upper and lower cases are not prohibited and reference different resources, the getter and setter methods are created by the prefix "get_" and the variable name with all original upper and lower cases and no camel case.
-
-For the preparation for multithreading, the DataRepository defines the virtual functions lock() and unlock() which are called implicitly by the getter and setter methods. In case the state machine is running in it's own thread, the lock and unlock method can be filled within a derived class by a sufficient locking and unlocking mechanism respectively (e.g. via a mutex or semaphore). 
-
-h3. TimerHandler
-
-The code generator creates an abstract/interface class for the usage of timers. Additionally it creates a DummyTimerHandler class, that is derived from this abstract class. 
-
-The implementer has to provide two methods in an implementation derived from TimerHandler:
-
-* setTimer(eventId, time_ms, periodic)
-* resetTimer(eventId)
-
-The setTimer method has to create an operation system timer with the given wake up time. When the timer is raised by the operation system, an event with the given event Id has to be created and eventHandler method raiseEvent() has to be called with this event.     
-
-In case a state has been left due to another event than the timer event, the external timers need to be stopped. Therefore the state machine calls resetTimer() with the according event ID. The TimerHandler has to ensure, that the timerEvent will not occur in the future.
- 

+ 0 - 3
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/05_multithreading.textile

@@ -1,3 +0,0 @@
-
-h2. Multithreading
-

二進制
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/images/execution_model.png


二進制
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/images/timing_example01.png


二進制
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/images/transition_example01.png


+ 0 - 6
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/index.txt

@@ -1,6 +0,0 @@
-01_introduction.textile
-02_execution_model.textile
-04_statechart_interfaces.textile
-timerhandler_interface.textile
-03_statechart_runtime.textile
-05_multithreading.textile

+ 0 - 18
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/timerhandler_interface.textile

@@ -1,18 +0,0 @@
-
-h3. Timerhandler Interface
-
-The mechanism to generate and execute time-dependent events is the task of the specific implementation and not the task of the generated code. In default the code generator assumes that a concrete implementation is available. 
-
-The Interface should contain following methods:
-
-
-|*|*setTimer(event, time, periodic?)*|
-| |Defines an event which will be triggered after the specified Time. The third parameter should be set if the event has to be periodically triggered. The time should be specified in milliseconds.|
-
-|*|*resetTimer(event)*|
-| |Resets the timer of the event so it is not triggered anymore.|
-
-Example:
-The C++ code generator generates an abstract base class 'Timer' which contains the virtual methods 'setTimer(EventID, Time in ms, periodic occurence?)' and 'resetTimer(event)'.
-
-A concrete implementation has to fill these methods to create an event with the given ID at the end of the assigned time and commit it to the statechart via the event interface. If a State is leaved by another event before the timer event is triggered, the timer event has to be resetted with the 'resetTimer(event) method. The concrete implementation has to ensure that the started timer is stopped.

+ 10 - 0
plugins/org.yakindu.sct.doc.user/help/04_Tasks/tasks-toc.xml

@@ -0,0 +1,10 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="help/04_Tasks/tasks.html" label="tasks">
+	<topic href="help/04_Tasks/tasks.html" label="Tasks">
+		<topic href="help/04_Tasks/tasks.html#Modelastatemachine" label="Model a statemachine"></topic>
+		<topic href="help/04_Tasks/tasks.html#Validateastatemachine" label="Validate a statemachine"></topic>
+		<topic href="help/04_Tasks/tasks.html#Simulateastatemachine" label="Simulate a statemachine"></topic>
+		<topic href="help/04_Tasks/tasks.html#GenerateC" label="Generate C"></topic>
+		<topic href="help/04_Tasks/tasks.html#GenerateJava" label="Generate Java"></topic>
+	</topic>
+</toc>

File diff suppressed because it is too large
+ 1 - 0
plugins/org.yakindu.sct.doc.user/help/04_Tasks/tasks.html


+ 11 - 0
plugins/org.yakindu.sct.doc.user/help/04_Tasks/tasks.textile

@@ -0,0 +1,11 @@
+h1. Tasks
+
+h2. Model a statemachine
+
+h2. Validate a statemachine
+
+h2. Simulate a statemachine
+
+h2. Generate C
+
+h2. Generate Java

+ 0 - 3
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/01_introduction.textile

@@ -1,3 +0,0 @@
-h1. Java-Code Generator
-
-h2. Introduction

+ 0 - 2
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/02_example.textile

@@ -1,2 +0,0 @@
-
-h2. Setting Up the Example Project

+ 0 - 10
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/03_generation.textile

@@ -1,10 +0,0 @@
-
-h2. Generating Source-Code
-
-h3. Create Xtend PRoject
-
-h3. Manage Dependencies
-
-h3. Create MWE Workflow File
-
-h3. Execute MWE Workflow

+ 0 - 2
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/04_sourcecode.textile

@@ -1,2 +0,0 @@
-
-h2. The Generated Source-Code

+ 0 - 2
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/05_integration.textile

@@ -1,2 +0,0 @@
-
-h2. Integrating the Generated Java Code

+ 0 - 5
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/index.txt

@@ -1,5 +0,0 @@
-01_introduction.textile
-02_example.textile
-03_generation.textile
-04_sourcecode.textile
-05_integration.textile

+ 0 - 15
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/java_code_generator-toc.xml

@@ -1,15 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/05_Java-Code_Generator/java_code_generator.html" label="java_code_generator">
-	<topic href="help/05_Java-Code_Generator/java_code_generator.html" label="Java-Code Generator">
-		<topic href="help/05_Java-Code_Generator/java_code_generator.html#Introduction" label="Introduction"></topic>
-		<topic href="help/05_Java-Code_Generator/java_code_generator.html#SettingUptheExampleProject" label="Setting Up the Example Project"></topic>
-		<topic href="help/05_Java-Code_Generator/java_code_generator.html#GeneratingSourceCode" label="Generating Source-Code">
-			<topic href="help/05_Java-Code_Generator/java_code_generator.html#CreateXtendPRoject" label="Create Xtend PRoject"></topic>
-			<topic href="help/05_Java-Code_Generator/java_code_generator.html#ManageDependencies" label="Manage Dependencies"></topic>
-			<topic href="help/05_Java-Code_Generator/java_code_generator.html#CreateMWEWorkflowFile" label="Create MWE Workflow File"></topic>
-			<topic href="help/05_Java-Code_Generator/java_code_generator.html#ExecuteMWEWorkflow" label="Execute MWE Workflow"></topic>
-		</topic>
-		<topic href="help/05_Java-Code_Generator/java_code_generator.html#TheGeneratedSourceCode" label="The Generated Source-Code"></topic>
-		<topic href="help/05_Java-Code_Generator/java_code_generator.html#IntegratingtheGeneratedJavaCode" label="Integrating the Generated Java Code"></topic>
-	</topic>
-</toc>

+ 0 - 21
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/java_code_generator.html

@@ -1,21 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-		<title>java_code_generator</title>
-		<link type="text/css" rel="stylesheet" href="../content/PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"/>
-		<link type="text/css" rel="stylesheet" href="../style.css"/>
-	</head>
-	<body>
-		<h1 id="JavaCodeGenerator">Java-Code Generator</h1>
-		<h2 id="Introduction">Introduction</h2>
-		<h2 id="SettingUptheExampleProject">Setting Up the Example Project</h2>
-		<h2 id="GeneratingSourceCode">Generating Source-Code</h2>
-		<h3 id="CreateXtendPRoject">Create Xtend PRoject</h3>
-		<h3 id="ManageDependencies">Manage Dependencies</h3>
-		<h3 id="CreateMWEWorkflowFile">Create MWE Workflow File</h3>
-		<h3 id="ExecuteMWEWorkflow">Execute MWE Workflow</h3>
-		<h2 id="TheGeneratedSourceCode">The Generated Source-Code</h2>
-		<h2 id="IntegratingtheGeneratedJavaCode">Integrating the Generated Java Code</h2>
-	</body>
-</html>

+ 0 - 24
plugins/org.yakindu.sct.doc.user/help/05_Java-Code_Generator/java_code_generator.textile

@@ -1,24 +0,0 @@
-h1. Java-Code Generator
-
-h2. Introduction
-
-
-h2. Setting Up the Example Project
-
-
-h2. Generating Source-Code
-
-h3. Create Xtend PRoject
-
-h3. Manage Dependencies
-
-h3. Create MWE Workflow File
-
-h3. Execute MWE Workflow
-
-
-h2. The Generated Source-Code
-
-
-h2. Integrating the Generated Java Code
-

+ 0 - 15
plugins/org.yakindu.sct.doc.user/help/06_UML_Transformation/uml_transformation-toc.xml

@@ -1,15 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/06_UML_Transformation/uml_transformation.html" label="uml_transformation">
-	<topic href="help/06_UML_Transformation/uml_transformation.html" label="UML Transformation">
-		<topic href="help/06_UML_Transformation/uml_transformation.html#Introduction" label="Introduction"></topic>
-		<topic href="help/06_UML_Transformation/uml_transformation.html#UML2Model" label="UML2 Model"></topic>
-		<topic href="help/06_UML_Transformation/uml_transformation.html#TheExampleProject" label="The Example Project"></topic>
-		<topic href="help/06_UML_Transformation/uml_transformation.html#HowDoesItWork" label="How Does It Work">
-			<topic href="help/06_UML_Transformation/uml_transformation.html#NameMapping" label="Name Mapping"></topic>
-			<topic href="help/06_UML_Transformation/uml_transformation.html#NewElements" label="New Elements"></topic>
-			<topic href="help/06_UML_Transformation/uml_transformation.html#Limitations" label="Limitations"></topic>
-			<topic href="help/06_UML_Transformation/uml_transformation.html#TransformationCartridge" label="Transformation Cartridge"></topic>
-		</topic>
-		<topic href="help/06_UML_Transformation/uml_transformation.html#ExtendingaUML2StateMachine" label="Extending a UML2 State Machine	"></topic>
-	</topic>
-</toc>

+ 0 - 21
plugins/org.yakindu.sct.doc.user/help/06_UML_Transformation/uml_transformation.html

@@ -1,21 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-		<title>uml_transformation</title>
-		<link type="text/css" rel="stylesheet" href="../content/PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"/>
-		<link type="text/css" rel="stylesheet" href="../style.css"/>
-	</head>
-	<body>
-		<h1 id="UMLTransformation">UML Transformation</h1>
-		<h2 id="Introduction">Introduction</h2>
-		<h2 id="UML2Model">UML2 Model</h2>
-		<h2 id="TheExampleProject">The Example Project</h2>
-		<h2 id="HowDoesItWork">How Does It Work</h2>
-		<h3 id="NameMapping">Name Mapping</h3>
-		<h3 id="NewElements">New Elements</h3>
-		<h3 id="Limitations">Limitations</h3>
-		<h3 id="TransformationCartridge">Transformation Cartridge</h3>
-		<h2 id="ExtendingaUML2StateMachine">Extending a UML2 State Machine	</h2>
-	</body>
-</html>

+ 0 - 19
plugins/org.yakindu.sct.doc.user/help/06_UML_Transformation/uml_transformation.textile

@@ -1,19 +0,0 @@
-h1. UML Transformation
-
-h2. Introduction
-
-h2. UML2 Model
-
-h2. The Example Project
-
-h2. How Does It Work
-
-h3. Name Mapping
-
-h3. New Elements
-
-h3. Limitations
-
-h3. Transformation Cartridge
-
-h2. Extending a UML2 State Machine	

+ 0 - 25
plugins/org.yakindu.sct.doc.user/help/07_Reference/sc_reference-toc.xml

@@ -1,25 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/07_Reference/sc_reference.html" label="sc_reference">
-	<topic href="help/07_Reference/sc_reference.html" label="YAKINDU Statechart Tools Reference">
-		<topic href="help/07_Reference/sc_reference.html#StatechartElements" label="Statechart Elements">
-			<topic href="help/07_Reference/sc_reference.html#Statechart" label="Statechart">
-				<topic href="help/07_Reference/sc_reference.html#Name" label="Name"></topic>
-				<topic href="help/07_Reference/sc_reference.html#Expression" label="Expression"></topic>
-			</topic>
-			<topic href="help/07_Reference/sc_reference.html#Region" label="Region">
-				<topic href="help/07_Reference/sc_reference.html#Name2" label="Name"></topic>
-			</topic>
-			<topic href="help/07_Reference/sc_reference.html#Entry" label="Entry">
-				<topic href="help/07_Reference/sc_reference.html#Name3" label="Name "></topic>
-				<topic href="help/07_Reference/sc_reference.html#EntryKind" label="Entry Kind"></topic>
-			</topic>
-			<topic href="help/07_Reference/sc_reference.html#State" label="State">
-				<topic href="help/07_Reference/sc_reference.html#Name4" label="Name"></topic>
-				<topic href="help/07_Reference/sc_reference.html#Expression2" label="Expression"></topic>
-			</topic>
-			<topic href="help/07_Reference/sc_reference.html#Transition" label="Transition">
-				<topic href="help/07_Reference/sc_reference.html#Expression3" label="Expression"></topic>
-			</topic>
-		</topic>
-	</topic>
-</toc>

+ 0 - 39
plugins/org.yakindu.sct.doc.user/help/07_Reference/sc_reference.html

@@ -1,39 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-		<title>sc_reference</title>
-		<link type="text/css" rel="stylesheet" href="../content/PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"/>
-		<link type="text/css" rel="stylesheet" href="../style.css"/>
-	</head>
-	<body>
-		<h1 id="YAKINDUStatechartToolsReference">YAKINDU Statechart Tools Reference</h1>
-		<h2 id="StatechartElements">Statechart Elements</h2>
-		<h3 id="Statechart">Statechart</h3>
-		<p>Place description here.</p>
-		<h4 id="Name">Name</h4>
-		<p>Insert description.</p>
-		<h4 id="Expression">Expression</h4>
-		<p>Insert description.</p>
-		<h3 id="Region">Region</h3>
-		<p>Place description here.</p>
-		<h4 id="Name2">Name</h4>
-		<p>Insert description.</p>
-		<h3 id="Entry">Entry</h3>
-		<p>Place description here.</p>
-		<h4 id="Name3">Name </h4>
-		<p>Insert description.</p>
-		<h4 id="EntryKind">Entry Kind</h4>
-		<p>Insert description.</p>
-		<h3 id="State">State</h3>
-		<p>Place description here.</p>
-		<h4 id="Name4">Name</h4>
-		<p>Insert description.</p>
-		<h4 id="Expression2">Expression</h4>
-		<p>Insert description.</p>
-		<h3 id="Transition">Transition</h3>
-		<p>Place description here.</p>
-		<h4 id="Expression3">Expression</h4>
-		<p>Insert description.</p>
-	</body>
-</html>

+ 0 - 59
plugins/org.yakindu.sct.doc.user/help/07_Reference/sc_reference.textile

@@ -1,59 +0,0 @@
-h1. YAKINDU Statechart Tools Reference
-
-h2. Statechart Elements
-
-h3. Statechart
-
-Place description here.
-
-h4. Name
-
-Insert description.
-
-h4. Expression
-
-Insert description.
-
-
-h3. Region
-
-Place description here.
-
-h4. Name
-
-Insert description.
-
-
-h3. Entry
-
-Place description here.
-
-h4. Name 
-
-Insert description.
-
-h4. Entry Kind
-
-Insert description.
-
-
-h3. State
-
-Place description here.
-
-h4. Name
-
-Insert description.
-
-h4. Expression
-
-Insert description.
-
-
-h3. Transition
-
-Place description here.
-
-h4. Expression
-
-Insert description.

+ 3 - 15
plugins/org.yakindu.sct.doc.user/plugin.xml

@@ -13,27 +13,15 @@
             primary="false">
       </toc>
       <toc
-            file="help/02_Installation/installation-toc.xml"
+            file="help/02_Getting_Started/getting_started-toc.xml"
             primary="false">
       </toc>
       <toc
-            file="help/03_Statechart_Modeling_and_Simulation/modeling_simulation-toc.xml"
+            file="help/03_Concepts/concepts-toc.xml"
             primary="false">
       </toc>
       <toc
-            file="help/04_C-Code_Generator/c_code_generator-toc.xml"
-            primary="false">
-      </toc>
-      <toc
-            file="help/05_Java-Code_Generator/java_code_generator-toc.xml"
-            primary="false">
-      </toc>
-      <toc
-            file="help/06_UML_Transformation/uml_transformation-toc.xml"
-            primary="false">
-      </toc>
-      <toc
-            file="help/07_Reference/sc_reference-toc.xml"
+            file="help/04_Tasks/tasks-toc.xml"
             primary="false">
       </toc>
    </extension>

+ 4 - 7
plugins/org.yakindu.sct.doc.user/toc.xml

@@ -1,12 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?NLS TYPE="org.eclipse.help.toc"?>
 
-<toc label="YAKINDU Statechart Tools Guide">
+<toc label="YAKINDU Statechart User Guide">
    <link toc="help/01_Overview/overview-toc.xml"/>
-   <link toc="help/02_Installation/installation-toc.xml"/>
-   <link toc="help/03_Statechart_Modeling_and_Simulation/modeling_simulation-toc.xml"/>
-   <link toc="help/04_C-Code_Generator/c_code_generator-toc.xml"/>
-   <link toc="help/05_Java-Code_Generator/java_code_generator-toc.xml"/>
-   <link toc="help/06_UML_Transformation/uml_transformation-toc.xml"/>
-   <link toc="help/07_Reference/sc_reference-toc.xml"/>
+   <link toc="help/02_Getting_Started/getting_started-toc.xml"/>
+   <link toc="help/03_Concepts/concepts-toc.xml"/>
+   <link toc="help/04_Tasks/tasks-toc.xml"/>
 </toc>