Browse Source

#5 - integrated mylin wikitext based doc infrastructure (merged from branch)

terfloth@itemis.de 14 years ago
parent
commit
5d68b1f6ec

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

@@ -1,3 +1,3 @@
-#Tue Aug 09 20:09:37 CEST 2011
+#Wed Aug 10 14:44:14 CEST 2011
 eclipse.preferences.version=1
 eclipse.preferences.version=1
 encoding/<project>=UTF-8
 encoding/<project>=UTF-8

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

@@ -0,0 +1,8 @@
+<?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>

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

@@ -0,0 +1,15 @@
+<?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>

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

@@ -0,0 +1,17 @@
+<?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>

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

@@ -0,0 +1,23 @@
+<?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>

+ 11 - 0
plugins/org.yakindu.sct.doc.user/help/04_C-Code_Generator/c_code_generator-toc.xml

@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="help/04_C-Code_Generator/c_code_generator.html" label="c_code_generator">
+	<topic href="help/04_C-Code_Generator/c_code_generator.html" label="C-Code Generator">
+		<topic href="help/04_C-Code_Generator/c_code_generator.html#Introduction" label="Introduction"></topic>
+		<topic href="help/04_C-Code_Generator/c_code_generator.html#ExampleScenario" label="Example Scenario"></topic>
+		<topic href="help/04_C-Code_Generator/c_code_generator.html#StartingtheWorkflow" label="Starting the Workflow"></topic>
+		<topic href="help/04_C-Code_Generator/c_code_generator.html#CodeIntegrationintoanExistingProject" label="Code Integration into an Existing Project"></topic>
+		<topic href="help/04_C-Code_Generator/c_code_generator.html#StateMachineAccess" label="State Machine Access"></topic>
+		<topic href="help/04_C-Code_Generator/c_code_generator.html#OperatingSystemandDriversfortheExampleDevice" label="Operating System and Drivers for the Example Device"></topic>
+	</topic>
+</toc>

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

@@ -0,0 +1,18 @@
+<?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>c_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="CCodeGenerator">C-Code Generator</h1>
+		<h2 id="Introduction">Introduction</h2>
+		<h2 id="ExampleScenario">Example Scenario</h2>
+		<h2 id="StartingtheWorkflow">Starting the Workflow</h2>
+		<h2 id="CodeIntegrationintoanExistingProject">Code Integration into an Existing Project</h2>
+		<h2 id="StateMachineAccess">State Machine Access</h2>
+		<h2 id="OperatingSystemandDriversfortheExampleDevice">Operating System and Drivers for the Example Device</h2>
+	</body>
+</html>

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

@@ -0,0 +1,13 @@
+h1. C-Code Generator
+
+h2. Introduction
+
+h2. Example Scenario
+
+h2. Starting the Workflow
+
+h2. Code Integration into an Existing Project
+
+h2. State Machine Access
+
+h2. Operating System and Drivers for the Example Device

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

@@ -0,0 +1,15 @@
+<?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>

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

@@ -0,0 +1,21 @@
+<?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>

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

@@ -0,0 +1,19 @@
+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

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

@@ -0,0 +1,15 @@
+<?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>

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

@@ -0,0 +1,21 @@
+<?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>

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

@@ -0,0 +1,25 @@
+<?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>

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

@@ -0,0 +1,39 @@
+<?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>