Merge pull request #642 from Yakindu/issue_doc_structure

Issue doc structure

plugins/org.yakindu.sct.doc.user/build.xml

@@ -118,7 +118,7 @@
 
 
     <!-- Generates the documentation as Eclipse help. -->
-    <target name="generate.eclipsehelp"
+    <target name="generate.eclipsehelp.old"
             description="Generates the documentation as Eclipse help from the textile (wikitext) sources."
             depends="init.wikitext">
         <wikitext.conversion src.dir="${src.dir.name}"
@@ -129,6 +129,56 @@
     </target>
 
 
+    
+    <target name="generate.eclipsehelp"
+            description="Generates the documentation as separate Eclipse help (HTML) files from their respective textile (wikitext) sources."
+            depends="init.wikitext">
+
+        <sequential>
+            <taskdef classpathref="wikitext.classpath"
+                     resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
+
+            <wikitext-to-eclipse-help markupLanguage="Textile"
+                                      multipleOutputFiles="false"
+                                      navigationImages="true"
+                                      formatoutput="true"
+                                      validate="true"
+                                      failOnValidationError="true"
+                                      failOnValidationWarning="false"
+                                      title="YAKINDU Statechart Tools – Open Edition"
+                                      helpPrefix="help">
+                <fileset dir="src">
+                    <include name="**/*.textile" />
+                </fileset>
+                <stylesheet url="../css/style.css" />
+            </wikitext-to-eclipse-help>
+
+            <!-- Files have been generated in the source directory, which is bad practice. Move them to the destination
+                 directory: -->
+            <move todir="help" flatten="no" verbose="no">
+                <fileset dir="src" >
+                    <include name="**/*.html" />
+                    <include name="**/*-toc.xml" />
+                </fileset>
+            </move>
+
+            <!-- Copy the CSS files to the destination directory: -->
+            <copy todir="help/${css.dir.name}">
+                <fileset dir="${css.dir}">
+                    <include name="*" />
+                </fileset>
+            </copy>
+
+            <!-- Copy the image files to the destination directory: -->
+            <copy todir="help">
+                <fileset dir="src">
+                    <include name="**/images/*" />
+                </fileset>
+            </copy>
+        </sequential>
+    </target>
+
+
 
     <!-- Converts a Textile document into Eclipsehelp format. Produces an HTML document and a corresponding toc.xml -->
     <macrodef name="wikitext.conversion"

plugins/org.yakindu.sct.doc.user/build2.xml

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project default="generate.help" basedir=".">
+
+	<property name="wikitext.standalone" location="${basedir}/lib" />
+	<property name="help.prefix" value="help" />
+	<property name="help.dir" location="${basedir}/${help.prefix}" />
+
+	<path id="wikitext.classpath">
+		<fileset dir="${wikitext.standalone}">
+			<include name="**/*.jar" />
+		</fileset>
+	</path>
+
+	<taskdef classpathref="wikitext.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
+
+	<target name="assemble.sections" description="Joins individual wiki source files so that they can be presented to the Eclipse help generator as a single file.">
+		<assemble.section.sources src.dir="${help.dir}/04_C-Code_Generator" src.list="sec_04" dest.file="c_code_generator.textile" />
+		<assemble.section.sources src.dir="${help.dir}/05_Java-Code_Generator" src.list="sec_05" dest.file="java_code_generator.textile" />
+	</target>
+
+
+	<!-- Building the master TOC (toc.xml) and registering it along with the sub-TOCs produced by this target in the plugin.xml file must still be done manually. -->
+	<!-- 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">
+-->
+	<target name="generate.help" description="Runs the Eclipse help generator on the listed wiki source files" depends="assemble.sections">
+		<generate.section.help src.dir="${basedir}/src/Part1-Installation-Guide" src.file="00_installation.textile" prefix="${help.prefix}/Part1-Installation-Guide" />
+		<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_Tasks" src.file="tasks.textile" prefix="${help.prefix}/03_Tasks" />
+		<generate.section.help src.dir="${help.dir}/04_Reference" src.file="reference.textile" prefix="${help.prefix}/04_Reference" />
+	</target>
+
+	<target name="clean">
+		<delete>
+			<fileset dir="${help.dir}">
+				<include name="**/**/*.html" />
+				<include name="**/**/*toc.xml" />
+				<!-- Include joined source files produced by assemble.sections here 
+				<include name="**/**/c_code_generator.textile" />
+				<include name="**/**/java_code_generator.textile" />-->
+			</fileset>
+		</delete>
+	</target>
+
+	<macrodef name="assemble.section.sources" description="Concats individual wiki source files">
+		<attribute name="src.dir" />
+		<attribute name="index.file" default="@{src.dir}/index.txt" />
+		<attribute name="src.list" />
+		<attribute name="dest.file" />
+		<sequential>
+			<loadfile srcfile="@{index.file}" property="@{src.list}">
+				<filterchain>
+					<tokenfilter>
+						<replacestring from="\n" to="," />
+					</tokenfilter>
+				</filterchain>
+			</loadfile>
+			<!-- Attribute fixlastline does not work (on the Mac). Begin wiki files with new line for now! -->
+			<concat destfile="@{src.dir}/@{dest.file}" append="false" fixlastline="yes">
+				<filelist dir="@{src.dir}" files="${@{src.list}}" />
+			</concat>
+		</sequential>
+	</macrodef>
+
+	<macrodef name="generate.section.help" description="Runs the Eclipse help generator on the provided wiki input file. Produces an HTML document and a corresponding toc.xml">
+		<attribute name="src.dir" />
+		<attribute name="src.file" />
+		<attribute name="prefix" />
+		<sequential>
+			<wikitext-to-eclipse-help markupLanguage="Textile" multipleOutputFiles="false" navigationImages="true" formatoutput="true" helpPrefix="@{prefix}">
+				<fileset dir="@{src.dir}">
+					<include name="@{src.file}" />
+				</fileset>
+					<stylesheet url="../style.css" />
+			</wikitext-to-eclipse-help>
+		</sequential>
+	</macrodef>
+
+</project>

plugins/org.yakindu.sct.doc.user/contexts.xml

@@ -3,26 +3,26 @@
 <contexts>
    <context id="sc_properties_entry_entrykind" title="Entry">
       <description>An entry, possibly with a shallow or deep history, defines which state is to be activated first in a state machine or region.</description>
-      <topic href="help/documentation.html#entry" label="Entry"/>
-      <topic href="help/documentation.html#shallow-history" label="Shallow History state"/>
-        <topic href="help/documentation.html#deep-history" label="Deep History state"/>
+      <topic href="help/Part2-User-Guide/30_statechart_language.html#entry" label="Entry"/>
+      <topic href="help/Part2-User-Guide/30_statechart_language.html#shallow-history" label="Shallow History state"/>
+        <topic href="help/Part2-User-Guide/30_statechart_language.html#deep-history" label="Deep History state"/>
    </context>
    <context id="sc_properties_state_expression" title="State">
       <description>States are central elements of a state machine.</description>
-      <topic href="help/documentation.html#state" label="State"/>
+      <topic href="help/Part2-User-Guide/30_statechart_language.html#state" label="State"/>
    </context>
    <context id="sc_properties_statechart_expression" title="Expressions">
       <description>Expressions are used to declare events, variables etc. and to define behavior.</description>
-      <topic href="help/documentation.html#expressions" label="Expression reference"/>
+      <topic href="help/Part2-User-Guide/30_statechart_language.html#expressions" label="Expression reference"/>
    </context>
    <context id="sc_properties_transition_expression" title="Transition">
       <description>A transition is the transfer of one state to another. Transitions are diagrammed as arrows. They can carry events and actions, but don't need to.</description>
-      <topic href="help/documentation.html#transition" label="Transition reference"/>
+      <topic href="help/Part2-User-Guide/30_statechart_language.html#transition" label="Transition reference"/>
    </context>
    <context id="sgen_feature" title="Genmodel Features">
-      <topic href="help/documentation.html" label="YAKINDU Statechart Tools User Guide"/>
+      <topic href="help/Part2-User-Guide/60_generating_code.html" label="Generating state machine code"/>
    </context>
    <context id="stext_keyword">
-      <topic href="help/documentation.html" label="YAKINDU Statechart Tools User Guide"/>
+      <topic href="help/Part2-User-Guide/30_statechart_language.html" label="YAKINDU Statechart Tools User Guide"/>
    </context>
 </contexts>

plugins/org.yakindu.sct.doc.user/css/custom.css

@@ -265,3 +265,22 @@ div.example {
 .to-be-written {
 	background-color: yellow;
 }
+
+
+body {counter-reset: h1}
+h1 {counter-reset: h2}
+h2 {counter-reset: h3}
+h3 {counter-reset: h4}
+h4 {counter-reset: h5}
+h5 {counter-reset: h6}
+
+h1:before {counter-increment: h1; content: counter(h1) ". "}
+h2:before {counter-increment: h2; content: counter(h1) "." counter(h2) ". "}
+h3:before {counter-increment: h3; content: counter(h1) "." counter(h2) "." counter(h3) ". "}
+h4:before {counter-increment: h4; content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) ". "}
+h5:before {counter-increment: h5; content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) ". "}
+h6:before {counter-increment: h6; content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) "." counter(h6) ". "}
+
+h1.nocount:before h2.nocount:before, h3.nocount:before, h4.nocount:before, h5.nocount:before, h6.nocount:before { content: ""; counter-increment: none } 
+
+

plugins/org.yakindu.sct.doc.user/plugin.xml

@@ -3,7 +3,14 @@
 <plugin>
 
     <extension point="org.eclipse.help.toc">
-        <toc file="help/documentation-toc.xml" primary="true" />
+        <toc file="toc.xml" primary="true" />
+        <toc file="help/Part1-Installation-Guide/00_installation-toc.xml" primary="false"/>
+        <toc file="help/Part2-User-Guide/20_tutorial-toc.xml" primary="false" />
+        <toc file="help/Part2-User-Guide/50_simulating_statecharts-toc.xml" primary="false" />
+        <toc file="help/Part2-User-Guide/30_statechart_language-toc.xml" primary="false" />
+        <toc file="help/Part2-User-Guide/60_generating_code-toc.xml" primary="false" />
+        <toc file="help/Part2-User-Guide/10_overview-toc.xml" primary="false" />
+        <toc file="help/Part2-User-Guide/40_editing statecharts-toc.xml" primary="false" />
     </extension>
 
     <extension point="org.eclipse.help.contexts">