Forráskód Böngészése

YAKHMI-547: Add section reference and paste SText and statechart elements to this

webmaster@wendler-im-netz.de 13 éve
szülő
commit
3c8fe5a4d0
19 módosított fájl, 598 hozzáadás és 588 törlés
  1. 3 1
      plugins/org.yakindu.sct.doc.user/.settings/org.eclipse.core.resources.prefs
  2. 4 6
      plugins/org.yakindu.sct.doc.user/build.xml
  3. 1 6
      plugins/org.yakindu.sct.doc.user/help/01_Overview/overview-toc.xml
  4. 1 1
      plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.html
  5. 1 56
      plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.textile
  6. 4 56
      plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts-toc.xml
  7. 1 89
      plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.html
  8. 15 373
      plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.textile
  9. 0 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/images/orthogonalState_example.jpg
  10. BIN
      plugins/org.yakindu.sct.doc.user/help/05_Reference/images/parallelRegions.jpg
  11. 0 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/images/shallowHistory01.jpg
  12. 0 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/images/shallowHistory02.jpg
  13. 0 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/images/shallowHistory03.jpg
  14. 0 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/images/substatemachine_example.jpg
  15. 60 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/reference-toc.xml
  16. 98 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/reference.html
  17. 405 0
      plugins/org.yakindu.sct.doc.user/help/05_Reference/reference.textile
  18. 4 0
      plugins/org.yakindu.sct.doc.user/plugin.xml
  19. 1 0
      plugins/org.yakindu.sct.doc.user/toc.xml

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

@@ -1,4 +1,4 @@
-#Tue Jan 24 06:11:42 CET 2012
+#Tue Feb 28 09:42:43 CET 2012
 eclipse.preferences.version=1
 encoding//help/01_Overview/overview-toc.xml=utf-8
 encoding//help/01_Overview/overview.html=utf-8
@@ -8,4 +8,6 @@ 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//help/05_Reference/reference-toc.xml=utf-8
+encoding//help/05_Reference/reference.html=utf-8
 encoding/<project>=UTF-8

+ 4 - 6
plugins/org.yakindu.sct.doc.user/build.xml

@@ -23,12 +23,10 @@
 	<!-- The help contexts file (contexts.xml) is not yet updated automatically, either. -->
 	<target name="generate.help" depends="assemble.sections" description="Runs the Eclipse help generator on the listed wiki source files">
 		<generate.section.help src.dir="${help.dir}/01_Overview" src.file="overview.textile" prefix="${help.prefix}/01_Overview" />
-		<generate.section.help src.dir="${help.dir}/02_Installation" src.file="installation.textile" prefix="${help.prefix}/02_Installation" />
-		<generate.section.help src.dir="${help.dir}/03_Statechart_Modeling_and_Simulation" src.file="modeling_simulation.textile" prefix="${help.prefix}/03_Statechart_Modeling_and_Simulation"/>
-		<generate.section.help src.dir="${help.dir}/04_C-Code_Generator" src.file="c_code_generator.textile" prefix="${help.prefix}/04_C-Code_Generator" />
-		<generate.section.help src.dir="${help.dir}/05_Java-Code_Generator" src.file="java_code_generator.textile" prefix="${help.prefix}/05_Java-Code_Generator" />
-		<generate.section.help src.dir="${help.dir}/06_UML_Transformation" src.file="uml_transformation.textile" prefix="${help.prefix}/06_UML_Transformation"/>
-		<generate.section.help src.dir="${help.dir}/07_Reference" src.file="sc_reference.textile" prefix="${help.prefix}/07_Reference" />
+		<generate.section.help src.dir="${help.dir}/02_Getting_Started" src.file="getting_started.textile" prefix="${help.prefix}/02_Getting_Started" />
+		<generate.section.help src.dir="${help.dir}/03_Concepts" src.file="concepts.textile" prefix="${help.prefix}/03_Concepts"/>
+		<generate.section.help src.dir="${help.dir}/04_Tasks" src.file="tasks.textile" prefix="${help.prefix}/04_Tasks" />
+		<generate.section.help src.dir="${help.dir}/05_Reference" src.file="reference.textile" prefix="${help.prefix}/05_Reference" />
 	</target>
 
 	<target name="clean">

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

@@ -1,12 +1,7 @@
 <?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#WhataretheYAKINDUStatechartTools2" label="What are the YAKINDU Statechart Tools 2">
-			<topic href="help/01_Overview/overview.html#Modeling" label="Modeling"></topic>
-			<topic href="help/01_Overview/overview.html#Simulation" label="Simulation"></topic>
-			<topic href="help/01_Overview/overview.html#CodeGeneration" label="Code Generation"></topic>
-			<topic href="help/01_Overview/overview.html#Domainspecificadaptability" label="Domain specific adaptability"></topic>
-		</topic>
+		<topic href="help/01_Overview/overview.html#WhataretheYAKINDUStatechartTools2" label="What are the YAKINDU Statechart Tools 2"></topic>
 		<topic href="help/01_Overview/overview.html#Howdoesitwork" label="How does it work?"></topic>
 		<topic href="help/01_Overview/overview.html#WhoisbehindYAKINDUStatechartTools2" label="Who is behind YAKINDU Statechart Tools 2?"></topic>
 		<topic href="help/01_Overview/overview.html#WhousestheYAKINDUStatechartTools2" label="Who uses the YAKINDU Statechart Tools 2?"></topic>

A különbségek nem kerülnek megjelenítésre, a fájl túl nagy
+ 1 - 1
plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.html


+ 1 - 56
plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.textile

@@ -14,62 +14,7 @@ The following graph shows these features and their relation to each other:
 
 !images/overview_yakindu.jpg! 
 
-h3. Modeling
-
-Yakindu Statechart Models are based on statecharts as defined by David
-Harel and are close to UML state machines. Thus, they support all
-structural model elements as defined by the UML specification, which are
-States (orthogonal and hierarchical), Regions, Transitions and Pseudo
-States (History, Deep History, Initial, Final, Choice, Join / Fork).
-In addition, Yakindu Statechart Models specify interfaces that define
-the interaction of the state machine with its environment. Besides some
-more advanced concepts like Entry / Exit Points, an interface basically
-consists of in and out Events as well as Variables including types.
-These well-defined statechart interfaces are especially useful in the
-context of component models and product line engineering.
-For defining interfaces and modeling the dynamic aspects of statecharts
-(triggers, guards and actions) SCT provides a statically typed, textual
-action language called *SText*. It tightly integrates into the graphical
-editor and supports the user with code completion, syntax highlighting,
-cross referencing and validation during modeling.
-
-h3. Simulation
-
-Yakindu Statechart Models can be executed via an integrated simulation
-engine. The simulation engine supports two different types of execution
-semantics, cycle based and event driven execution. The default execution
-semantic is cycle based which executes a statechart cycle within a fixed
-period of time and thus allows processing of concurrent events. In
-contrast, the event based approach executes a statechart cycle as soon
-as an event occurred.
-During simulation, the currently active states and the transition path
-including the previous states are highlighted in the editor for visual debugging. An additional view
-shows the variable values and allows to raise events.
-Apart from that, the engine uses a virtual time during simulation. The
-user can provide a time scaling factor that is multiplied with the real
-time. This is especially useful during debugging, if the statechart
-model contains very tight or long running time triggers.
-
-h3. Code Generation
-
-Yakindu Statechart Tools currently support the generation of Java, C and
-C++ Code.  All generators can be customized with a generator model. This
-is a textual model file where generator features, like the execution
-type (event or cycle based), or the interface styles (static or
-generic), can be specified.
-The code generation process can either be executed with a builder that
-starts code generation on resource change or manually with a context
-menu action.
-
-h3. Domain specific adaptability
-
-Yakindu Statechart Tools were developed with a domain specific
-adaptability in mind. Several extension points allow the customization
-of all mentioned aspects. It is possible to contribute a custom type
-system or custom action languages which may be a dialect of SText or a
-complete new language.
-Also, the different code generators can be customized or new code
-generators for other target languages can be plugged in easily.
+
 
 h2. How does it work?
 

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

@@ -1,61 +1,9 @@
 <?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#Statechartelements" label="State chart elements">
-			<topic href="help/03_Concepts/concepts.html#Regions" label="Regions"></topic>
-			<topic href="help/03_Concepts/concepts.html#States" label="States"></topic>
-			<topic href="help/03_Concepts/concepts.html#Transitions" label="Transitions"></topic>
-			<topic href="help/03_Concepts/concepts.html#Initialstateandfinalstate" label="Initial state and final state"></topic>
-			<topic href="help/03_Concepts/concepts.html#Choice" label="Choice"></topic>
-			<topic href="help/03_Concepts/concepts.html#Junction" label="Junction"></topic>
-			<topic href="help/03_Concepts/concepts.html#CompositeState" label="Composite State">
-				<topic href="help/03_Concepts/concepts.html#Orthogonalstates" label="Orthogonal states"></topic>
-				<topic href="help/03_Concepts/concepts.html#Submachinestates" label="Submachine states"></topic>
-			</topic>
-			<topic href="help/03_Concepts/concepts.html#ShallowHistory" label="Shallow History"></topic>
-			<topic href="help/03_Concepts/concepts.html#DeepHistory" label="Deep History"></topic>
-		</topic>
-		<topic href="help/03_Concepts/concepts.html#SText" label="SText">
-			<topic href="help/03_Concepts/concepts.html#Typesystem" label="Typesystem"></topic>
-			<topic href="help/03_Concepts/concepts.html#Expressions" label="Expressions">
-				<topic href="help/03_Concepts/concepts.html#LogicalAND" label="Logical AND"></topic>
-				<topic href="help/03_Concepts/concepts.html#LogicalOR" label="Logical OR"></topic>
-				<topic href="help/03_Concepts/concepts.html#LogicalNOT" label="Logical NOT"></topic>
-				<topic href="help/03_Concepts/concepts.html#Conditionalexpression" label="Conditional expression"></topic>
-				<topic href="help/03_Concepts/concepts.html#BitwiseXOR" label="Bitwise XOR"></topic>
-				<topic href="help/03_Concepts/concepts.html#BitwiseOR" label="Bitwise OR"></topic>
-				<topic href="help/03_Concepts/concepts.html#BitwiseAND" label="Bitwise AND"></topic>
-				<topic href="help/03_Concepts/concepts.html#LogicalRelationsandShiftOperators" label="Logical Relations and Shift Operators"></topic>
-				<topic href="help/03_Concepts/concepts.html#Binaryarithmeticoperators" label="Binary arithmetic operators"></topic>
-				<topic href="help/03_Concepts/concepts.html#Unaryarithmeticoperators" label="Unary arithmetic operators"></topic>
-			</topic>
-			<topic href="help/03_Concepts/concepts.html#Statements" label="Statements"></topic>
-			<topic href="help/03_Concepts/concepts.html#Scopes" label="Scopes">
-				<topic href="help/03_Concepts/concepts.html#Namespace" label="Namespace"></topic>
-				<topic href="help/03_Concepts/concepts.html#interfacescope" label="interface scope"></topic>
-				<topic href="help/03_Concepts/concepts.html#internalscope" label="internal scope"></topic>
-			</topic>
-			<topic href="help/03_Concepts/concepts.html#Declarations" label="Declarations"></topic>
-			<topic href="help/03_Concepts/concepts.html#Events" label="Events"></topic>
-			<topic href="help/03_Concepts/concepts.html#Variables" label="Variables"></topic>
-			<topic href="help/03_Concepts/concepts.html#Actions" label="Actions">
-				<topic href="help/03_Concepts/concepts.html#after" label="after"></topic>
-				<topic href="help/03_Concepts/concepts.html#always" label="always"></topic>
-				<topic href="help/03_Concepts/concepts.html#default" label="default"></topic>
-				<topic href="help/03_Concepts/concepts.html#else" label="else"></topic>
-				<topic href="help/03_Concepts/concepts.html#entry" label="entry"></topic>
-				<topic href="help/03_Concepts/concepts.html#every" label="every"></topic>
-				<topic href="help/03_Concepts/concepts.html#exit" label="exit"></topic>
-				<topic href="help/03_Concepts/concepts.html#onCycle" label="onCycle"></topic>
-			</topic>
-			<topic href="help/03_Concepts/concepts.html#Operations" label="Operations"></topic>
-			<topic href="help/03_Concepts/concepts.html#LocalReactions" label="LocalReactions"></topic>
-			<topic href="help/03_Concepts/concepts.html#EntryPoints" label="EntryPoints"></topic>
-			<topic href="help/03_Concepts/concepts.html#ExitPoints" label="ExitPoints"></topic>
-		</topic>
-		<topic href="help/03_Concepts/concepts.html#SGraph" label="SGraph"></topic>
-		<topic href="help/03_Concepts/concepts.html#SExec" label="SExec"></topic>
-		<topic href="help/03_Concepts/concepts.html#SGen" label="SGen"></topic>
+		<topic href="help/03_Concepts/concepts.html#Modeling" label="Modeling"></topic>
+		<topic href="help/03_Concepts/concepts.html#Simulation" label="Simulation"></topic>
+		<topic href="help/03_Concepts/concepts.html#CodeGeneration" label="Code Generation"></topic>
+		<topic href="help/03_Concepts/concepts.html#Domainspecificadaptability" label="Domain specific adaptability"></topic>
 	</topic>
 </toc>

A különbségek nem kerülnek megjelenítésre, a fájl túl nagy
+ 1 - 89
plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.html


A különbségek nem kerülnek megjelenítésre, a fájl túl nagy
+ 15 - 373
plugins/org.yakindu.sct.doc.user/help/03_Concepts/concepts.textile


plugins/org.yakindu.sct.doc.user/help/03_Concepts/images/orthogonalState_example.jpg → plugins/org.yakindu.sct.doc.user/help/05_Reference/images/orthogonalState_example.jpg


BIN
plugins/org.yakindu.sct.doc.user/help/05_Reference/images/parallelRegions.jpg


plugins/org.yakindu.sct.doc.user/help/03_Concepts/images/shallowHistory01.jpg → plugins/org.yakindu.sct.doc.user/help/05_Reference/images/shallowHistory01.jpg


plugins/org.yakindu.sct.doc.user/help/03_Concepts/images/shallowHistory02.jpg → plugins/org.yakindu.sct.doc.user/help/05_Reference/images/shallowHistory02.jpg


plugins/org.yakindu.sct.doc.user/help/03_Concepts/images/shallowHistory03.jpg → plugins/org.yakindu.sct.doc.user/help/05_Reference/images/shallowHistory03.jpg


plugins/org.yakindu.sct.doc.user/help/03_Concepts/images/substatemachine_example.jpg → plugins/org.yakindu.sct.doc.user/help/05_Reference/images/substatemachine_example.jpg


+ 60 - 0
plugins/org.yakindu.sct.doc.user/help/05_Reference/reference-toc.xml

@@ -0,0 +1,60 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="help/05_Reference/reference.html" label="reference">
+	<topic href="help/05_Reference/reference.html" label="YAKINDU SCT 2Reference">
+		<topic href="help/05_Reference/reference.html#Statechartelements" label="State chart elements">
+			<topic href="help/05_Reference/reference.html#Regions" label="Regions"></topic>
+			<topic href="help/05_Reference/reference.html#States" label="States"></topic>
+			<topic href="help/05_Reference/reference.html#Transitions" label="Transitions"></topic>
+			<topic href="help/05_Reference/reference.html#Initialstateandfinalstate" label="Initial state and final state"></topic>
+			<topic href="help/05_Reference/reference.html#Choice" label="Choice"></topic>
+			<topic href="help/05_Reference/reference.html#Junction" label="Junction"></topic>
+			<topic href="help/05_Reference/reference.html#CompositeState" label="Composite State">
+				<topic href="help/05_Reference/reference.html#Orthogonalstates" label="Orthogonal states"></topic>
+				<topic href="help/05_Reference/reference.html#Submachinestates" label="Submachine states"></topic>
+			</topic>
+			<topic href="help/05_Reference/reference.html#ShallowHistory" label="Shallow History"></topic>
+			<topic href="help/05_Reference/reference.html#DeepHistory" label="Deep History"></topic>
+		</topic>
+		<topic href="help/05_Reference/reference.html#SText" label="SText">
+			<topic href="help/05_Reference/reference.html#Typesystem" label="Typesystem"></topic>
+			<topic href="help/05_Reference/reference.html#Expressions" label="Expressions">
+				<topic href="help/05_Reference/reference.html#LogicalAND" label="Logical AND"></topic>
+				<topic href="help/05_Reference/reference.html#LogicalOR" label="Logical OR"></topic>
+				<topic href="help/05_Reference/reference.html#LogicalNOT" label="Logical NOT"></topic>
+				<topic href="help/05_Reference/reference.html#Conditionalexpression" label="Conditional expression"></topic>
+				<topic href="help/05_Reference/reference.html#BitwiseXOR" label="Bitwise XOR"></topic>
+				<topic href="help/05_Reference/reference.html#BitwiseOR" label="Bitwise OR"></topic>
+				<topic href="help/05_Reference/reference.html#BitwiseAND" label="Bitwise AND"></topic>
+				<topic href="help/05_Reference/reference.html#LogicalRelationsandShiftOperators" label="Logical Relations and Shift Operators"></topic>
+				<topic href="help/05_Reference/reference.html#Binaryarithmeticoperators" label="Binary arithmetic operators"></topic>
+				<topic href="help/05_Reference/reference.html#Unaryarithmeticoperators" label="Unary arithmetic operators"></topic>
+			</topic>
+			<topic href="help/05_Reference/reference.html#Statements" label="Statements"></topic>
+			<topic href="help/05_Reference/reference.html#Scopes" label="Scopes">
+				<topic href="help/05_Reference/reference.html#Namespace" label="Namespace"></topic>
+				<topic href="help/05_Reference/reference.html#interfacescope" label="interface scope"></topic>
+				<topic href="help/05_Reference/reference.html#internalscope" label="internal scope"></topic>
+			</topic>
+			<topic href="help/05_Reference/reference.html#Declarations" label="Declarations"></topic>
+			<topic href="help/05_Reference/reference.html#Events" label="Events"></topic>
+			<topic href="help/05_Reference/reference.html#Variables" label="Variables"></topic>
+			<topic href="help/05_Reference/reference.html#Actions" label="Actions">
+				<topic href="help/05_Reference/reference.html#after" label="after"></topic>
+				<topic href="help/05_Reference/reference.html#always" label="always"></topic>
+				<topic href="help/05_Reference/reference.html#default" label="default"></topic>
+				<topic href="help/05_Reference/reference.html#else" label="else"></topic>
+				<topic href="help/05_Reference/reference.html#entry" label="entry"></topic>
+				<topic href="help/05_Reference/reference.html#every" label="every"></topic>
+				<topic href="help/05_Reference/reference.html#exit" label="exit"></topic>
+				<topic href="help/05_Reference/reference.html#onCycle" label="onCycle"></topic>
+			</topic>
+			<topic href="help/05_Reference/reference.html#Operations" label="Operations"></topic>
+			<topic href="help/05_Reference/reference.html#LocalReactions" label="LocalReactions"></topic>
+			<topic href="help/05_Reference/reference.html#EntryPoints" label="EntryPoints"></topic>
+			<topic href="help/05_Reference/reference.html#ExitPoints" label="ExitPoints"></topic>
+		</topic>
+		<topic href="help/05_Reference/reference.html#SGraph" label="SGraph"></topic>
+		<topic href="help/05_Reference/reference.html#SExec" label="SExec"></topic>
+		<topic href="help/05_Reference/reference.html#SGen" label="SGen"></topic>
+	</topic>
+</toc>

A különbségek nem kerülnek megjelenítésre, a fájl túl nagy
+ 98 - 0
plugins/org.yakindu.sct.doc.user/help/05_Reference/reference.html


A különbségek nem kerülnek megjelenítésre, a fájl túl nagy
+ 405 - 0
plugins/org.yakindu.sct.doc.user/help/05_Reference/reference.textile


+ 4 - 0
plugins/org.yakindu.sct.doc.user/plugin.xml

@@ -23,6 +23,10 @@
       <toc
             file="help/04_Tasks/tasks-toc.xml"
             primary="false">
+      </toc>
+          <toc
+            file="help/05_Reference/reference-toc.xml"
+            primary="false">
       </toc>
    </extension>
    <extension

+ 1 - 0
plugins/org.yakindu.sct.doc.user/toc.xml

@@ -6,4 +6,5 @@
    <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"/>
+   <link toc="help/05_Reference/reference-toc.xml"/>
 </toc>