Documentation restructuring (issue #781)

* Restructuring done * Changes for Eclipsehelp done
itemisCREATE · Jun 30, 2016 · 4b99a8e · 4b99a8e
1 parent 07740ef
commit 4b99a8e
Show file tree

Hide file tree

Showing 272 changed files with 282 additions and 267 deletions.
diff --git a/plugins/org.yakindu.sct.doc.user/build.xml b/plugins/org.yakindu.sct.doc.user/build.xml
@@ -129,29 +129,39 @@
             <taskdef classpathref="wikitext.classpath"
                      resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
+            <!-- Textile source files to turn into HTML: -->
+            <fileset id="fileset.eclipsehelp" dir="${src.dir}">
+                <include name="installation/installation.textile" />
+                <include name="tutorials/tutorials.textile" />
+                <include name="user-guide/overview.textile" />
+                <include name="user-guide/editing_statecharts.textile" />
+                <include name="user-guide/simulating_statecharts.textile" />
+                <include name="user-guide/advanced_simulation.textile" />
+                <include name="user-guide/c-domain.textile" />
+                <include name="user-guide/statechart_language.textile" />
+                <include name="user-guide/generating_code.textile" />
+                <!-- <include name="user-guide/sctunit.textile" /> -->
+            </fileset>
+
+            <!-- Check whether we have all the expected textile source files – no more, no less: -->
+            <fail message="Number of textile source file(s) doesn't match.">
+                <condition>
+                    <resourcecount refid="fileset.eclipsehelp" when="ne" count="9" />
+                </condition>
+            </fail>
+
             <!-- Convert textile source files to HTML: -->
             <wikitext-to-eclipse-help markupLanguage="Textile"
                                       multipleOutputFiles="false"
                                       navigationImages="true"
                                       formatoutput="true"
                                       validate="true"
                                       failOnValidationError="true"
-                                      failOnValidationWarning="false"
+                                      failOnValidationWarning="true"
                                       sourceEncoding="UTF-8"
                                       title="YAKINDU Statechart Tools"
                                       helpPrefix="${help.dir}">
-                <fileset dir="${src.dir}">
-                    <include name="Part1-Installation-Guide/00_installation.textile" />
-                    <include name="Part2-User-Guide/20_tutorial.textile" />
-                    <include name="Part2-User-Guide/10_overview.textile" />
-                    <include name="Part2-User-Guide/40_editing_statecharts.textile" />
-                    <include name="Part2-User-Guide/50_simulating_statecharts.textile" />
-                    <include name="advanced_simulation/advanced_simulation.textile" />
-                    <include name="c-domain/c-domain.textile" />
-                    <include name="Part2-User-Guide/30_statechart_language.textile" />
-                    <include name="Part2-User-Guide/60_generating_code.textile" />
-                    <!-- <include name="sctunit/sctunit.textile" /> -->
-                </fileset>
+                <fileset refid="fileset.eclipsehelp" />
                 <stylesheet url="../${css.dir}/${css.root.file}" />
             </wikitext-to-eclipse-help>
 
@@ -220,12 +230,12 @@
             <create-hubspot-part name="YSCT-installation-guide" title="YAKINDU Statechart Tools Installation Guide">
                 <textile-files>
                     <filelist dir="${src.dir}">
-                        <file name="Part1-Installation-Guide/00_installation.textile" />
+                        <file name="installation.textile" />
                     </filelist>
                 </textile-files>
                 <image-files>
                     <fileset dir="${src.dir}">
-                        <include name="Part1-Installation-Guide/images/**/*" />
+                        <include name="images/**/*" />
                     </fileset>
                 </image-files>
             </create-hubspot-part>
@@ -234,12 +244,12 @@
             <create-hubspot-part name="YSCT-tutorials" title="YAKINDU Statechart Tools Tutorials">
                 <textile-files>
                     <filelist dir="${src.dir}">
-                        <file name="Part2-User-Guide/20_tutorial.textile" />
+                        <file name="tutorial.textile" />
                     </filelist>
                 </textile-files>
                 <image-files>
                     <fileset dir="${src.dir}">
-                        <include name="Part2-User-Guide/images/**/*" />
+                        <include name="images/**/*" />
                     </fileset>
                 </image-files>
             </create-hubspot-part>
@@ -248,14 +258,14 @@
             <create-hubspot-part name="YSCT-user-guide" title="YAKINDU Statechart Tools User Guide">
                 <textile-files>
                     <filelist dir=".">
-                        <file name="${src.dir}/Part2-User-Guide/10_overview.textile" />
-                        <file name="${src.dir}/Part2-User-Guide/40_editing_statecharts.textile" />
-                        <file name="${src.dir}/Part2-User-Guide/50_simulating_statecharts.textile" />
-                        <file name="${src.dir}/advanced_simulation/advanced_simulation.textile" />
-                        <file name="${src.dir}/c-domain/c-domain.textile" />
-                        <file name="${src.dir}/Part2-User-Guide/30_statechart_language.textile" />
-                        <file name="${src.dir}/Part2-User-Guide/60_generating_code.textile" />
-                        <!-- <file name="${src.dir}/sctunit/sctunit.textile" /> -->
+                        <file name="${src.dir}/overview.textile" />
+                        <file name="${src.dir}/editing_statecharts.textile" />
+                        <file name="${src.dir}/simulating_statecharts.textile" />
+                        <file name="${src.dir}/advanced_simulation.textile" />
+                        <file name="${src.dir}/c-domain.textile" />
+                        <file name="${src.dir}/statechart_language.textile" />
+                        <file name="${src.dir}/generating_code.textile" />
+                        <!-- <file name="${src.dir}/sctunit.textile" /> -->
                     </filelist>
                 </textile-files>
                 <image-files>
@@ -322,23 +332,23 @@
 
             <!-- Fragment replacements for Hubspot: -->
             <sequential unless:set="hubspot.local.files">
-                <loadfile property="hubspot.header" srcFile="${src.dir}/hubspot.header.htmlf" encoding="UTF-8" />
-                <loadfile property="hubspot.footer" srcFile="${src.dir}/hubspot.footer.htmlf" encoding="UTF-8" />
+                <loadfile property="hubspot.header" srcFile="${src.dir}/hubspot/header.htmlf" encoding="UTF-8" />
+                <loadfile property="hubspot.footer" srcFile="${src.dir}/hubspot/footer.htmlf" encoding="UTF-8" />
                 <loadfile property="hubspot.calltoaction.download"
-                          srcFile="${src.dir}/hubspot.calltoaction.download.htmlf"
+                          srcFile="${src.dir}/hubspot/calltoaction.download.htmlf"
                           encoding="UTF-8" />
             </sequential>
 
             <!-- Fragment replacements for generating local files which should look simular to Hubspot: -->
             <sequential if:set="hubspot.local.files">
                 <loadfile property="hubspot.header"
-                          srcFile="${src.dir}/hubspot.header.local.files.htmlf"
+                          srcFile="${src.dir}/hubspot/header.local.files.htmlf"
                           encoding="UTF-8" />
                 <loadfile property="hubspot.footer"
-                          srcFile="${src.dir}/hubspot.footer.local.files.htmlf"
+                          srcFile="${src.dir}/hubspot/footer.local.files.htmlf"
                           encoding="UTF-8" />
                 <loadfile property="hubspot.calltoaction.download"
-                          srcFile="${src.dir}/hubspot.calltoaction.download.local.files.htmlf"
+                          srcFile="${src.dir}/hubspot/calltoaction.download.local.files.htmlf"
                           encoding="UTF-8" />
             </sequential>
 

diff --git a/plugins/org.yakindu.sct.doc.user/contexts.xml b/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/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"/>
+      <topic href="help/user-guide/statechart_language.html#entry" label="Entry"/>
+      <topic href="help/user-guide/statechart_language.html#shallow-history" label="Shallow History state"/>
+        <topic href="help/user-guide/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/Part2-User-Guide/30_statechart_language.html#state" label="State"/>
+      <topic href="help/user-guide/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/Part2-User-Guide/30_statechart_language.html#expressions" label="Expression reference"/>
+      <topic href="help/user-guide/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/Part2-User-Guide/30_statechart_language.html#transition" label="Transition reference"/>
+      <topic href="help/user-guide/statechart_language.html#transition" label="Transition reference"/>
    </context>
    <context id="sgen_feature" title="Genmodel Features">
-      <topic href="help/Part2-User-Guide/60_generating_code.html" label="Generating state machine code"/>
+      <topic href="help/user-guide/generating_code.html" label="Generating state machine code"/>
    </context>
    <context id="stext_keyword">
-      <topic href="help/Part2-User-Guide/30_statechart_language.html" label="YAKINDU Statechart Tools User Guide"/>
+      <topic href="help/user-guide/statechart_language.html" label="YAKINDU Statechart Tools User Guide"/>
    </context>
 </contexts>
diff --git a/plugins/org.yakindu.sct.doc.user/plugin.xml b/plugins/org.yakindu.sct.doc.user/plugin.xml
@@ -4,13 +4,17 @@
 
     <extension point="org.eclipse.help.toc">
         <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" />
+
+        <!-- List all files constituting the documentation here: -->
+        <toc file="help/tutorials/tutorials-toc.xml" primary="false"/>
+        <toc file="help/user-guide/overview-toc.xml" primary="false"/>
+        <toc file="help/user-guide/editing_statecharts-toc.xml" primary="false"/>
+        <toc file="help/user-guide/simulating_statecharts-toc.xml" primary="false"/>
+        <toc file="help/user-guide/advanced_simulation-toc.xml" primary="false"/>
+        <toc file="help/user-guide/c-domain-toc.xml" primary="false"/>
+        <toc file="help/user-guide/statechart_language-toc.xml" primary="false"/>
+        <toc file="help/user-guide/generating_code-toc.xml" primary="false"/>
+        <toc file="help/installation/installation-toc.xml" primary="false"/>
     </extension>
 
     <extension point="org.eclipse.help.contexts">

diff --git a/plugins/org.yakindu.sct.doc.user/src/advanced_simulation/images/README.txt~ b/plugins/org.yakindu.sct.doc.user/src/advanced_simulation/images/README.txt~
diff --git a/...r/src/hubspot.calltoaction.download.htmlf → ...r/src/hubspot/calltoaction.download.htmlf b/...r/src/hubspot.calltoaction.download.htmlf → ...r/src/hubspot/calltoaction.download.htmlf
diff --git a/...t.calltoaction.download.local.files.htmlf → ...t/calltoaction.download.local.files.htmlf b/...t.calltoaction.download.local.files.htmlf → ...t/calltoaction.download.local.files.htmlf
diff --git a/...ndu.sct.doc.user/src/hubspot.footer.htmlf → ...ndu.sct.doc.user/src/hubspot/footer.htmlf b/...ndu.sct.doc.user/src/hubspot.footer.htmlf → ...ndu.sct.doc.user/src/hubspot/footer.htmlf
diff --git a/...user/src/hubspot.footer.local.files.htmlf → ...user/src/hubspot/footer.local.files.htmlf b/...user/src/hubspot.footer.local.files.htmlf → ...user/src/hubspot/footer.local.files.htmlf
diff --git a/...ndu.sct.doc.user/src/hubspot.header.htmlf → ...ndu.sct.doc.user/src/hubspot/header.htmlf b/...ndu.sct.doc.user/src/hubspot.header.htmlf → ...ndu.sct.doc.user/src/hubspot/header.htmlf
diff --git a/...user/src/hubspot.header.local.files.htmlf → ...user/src/hubspot/header.local.files.htmlf b/...user/src/hubspot.header.local.files.htmlf → ...user/src/hubspot/header.local.files.htmlf
diff --git a/...010_eclipse_menu_install_new_software.png → ...010_eclipse_menu_install_new_software.png b/...010_eclipse_menu_install_new_software.png → ...010_eclipse_menu_install_new_software.png
diff --git a/...se_install_020_eclipse_install_wizard.png → ...st_eclipse_020_eclipse_install_wizard.png b/...se_install_020_eclipse_install_wizard.png → ...st_eclipse_020_eclipse_install_wizard.png
diff --git a/...se_install_030_eclipse_add_repository.png → ...st_eclipse_030_eclipse_add_repository.png b/...se_install_030_eclipse_add_repository.png → ...st_eclipse_030_eclipse_add_repository.png
diff --git a/...se_install_030_eclipse_add_repository.xcf → ...st_eclipse_030_eclipse_add_repository.xcf b/...se_install_030_eclipse_add_repository.xcf → ...st_eclipse_030_eclipse_add_repository.xcf
diff --git a/...se_install_040_eclipse_software_items.png → ...st_eclipse_040_eclipse_software_items.png b/...se_install_040_eclipse_software_items.png → ...st_eclipse_040_eclipse_software_items.png
diff --git a/...se_install_040_eclipse_software_items.xcf → ...st_eclipse_040_eclipse_software_items.xcf b/...se_install_040_eclipse_software_items.xcf → ...st_eclipse_040_eclipse_software_items.xcf
diff --git a/...nstall_040_eclipse_software_items_all.png → ...clipse_040_eclipse_software_items_all.png b/...nstall_040_eclipse_software_items_all.png → ...clipse_040_eclipse_software_items_all.png
diff --git a/...s/eclipse_install_050_eclipse_trouble.png → ...ages/inst_eclipse_050_eclipse_trouble.png b/...s/eclipse_install_050_eclipse_trouble.png → ...ages/inst_eclipse_050_eclipse_trouble.png
diff --git a/...es/eclipse_install_060_eclipse_review.png → ...mages/inst_eclipse_060_eclipse_review.png b/...es/eclipse_install_060_eclipse_review.png → ...mages/inst_eclipse_060_eclipse_review.png
diff --git a/.../eclipse_install_070_eclipse_licenses.png → ...ges/inst_eclipse_070_eclipse_licenses.png b/.../eclipse_install_070_eclipse_licenses.png → ...ges/inst_eclipse_070_eclipse_licenses.png
diff --git a/...ipse_install_080_eclipse_installation.png → ...inst_eclipse_080_eclipse_installation.png b/...ipse_install_080_eclipse_installation.png → ...inst_eclipse_080_eclipse_installation.png
diff --git a/...s/eclipse_install_090_eclipse_restart.png → ...ages/inst_eclipse_090_eclipse_restart.png b/...s/eclipse_install_090_eclipse_restart.png → ...ages/inst_eclipse_090_eclipse_restart.png
diff --git a/.../eclipse_install_100_eclipse_sct_help.png → ...ges/inst_eclipse_100_eclipse_sct_help.png b/.../eclipse_install_100_eclipse_sct_help.png → ...ges/inst_eclipse_100_eclipse_sct_help.png
diff --git a/...te_010_eclipse_menu_check_for_updates.png → ...te_010_eclipse_menu_check_for_updates.png b/...te_010_eclipse_menu_check_for_updates.png → ...te_010_eclipse_menu_check_for_updates.png
diff --git a/..._update_020_eclipse_automatic_updates.png → ..._update_020_eclipse_automatic_updates.png b/..._update_020_eclipse_automatic_updates.png → ..._update_020_eclipse_automatic_updates.png
diff --git a/...ation-Guide/images/installed_jres_010.png → ...lation/images/inst_installed_jres_010.png b/...ation-Guide/images/installed_jres_010.png → ...lation/images/inst_installed_jres_010.png
diff --git a/...ages/linux_install_010_eclipse_folder.png → .../images/inst_linux_010_eclipse_folder.png b/...ages/linux_install_010_eclipse_folder.png → .../images/inst_linux_010_eclipse_folder.png
diff --git a/...es/linux_install_020_eclipse_contents.png → ...mages/inst_linux_020_eclipse_contents.png b/...es/linux_install_020_eclipse_contents.png → ...mages/inst_linux_020_eclipse_contents.png
diff --git a/...ages/linux_install_030_eclipse_splash.png → .../images/inst_linux_030_eclipse_splash.png b/...ages/linux_install_030_eclipse_splash.png → .../images/inst_linux_030_eclipse_splash.png
diff --git a/..._install_040_eclipse_workspace_dialog.png → ...st_linux_040_eclipse_workspace_dialog.png b/..._install_040_eclipse_workspace_dialog.png → ...st_linux_040_eclipse_workspace_dialog.png
diff --git a/...ges/linux_install_050_eclipse_welcome.png → ...images/inst_linux_050_eclipse_welcome.png b/...ges/linux_install_050_eclipse_welcome.png → ...images/inst_linux_050_eclipse_welcome.png
diff --git a/...s/linux_install_060_eclipse_workbench.png → ...ages/inst_linux_060_eclipse_workbench.png b/...s/linux_install_060_eclipse_workbench.png → ...ages/inst_linux_060_eclipse_workbench.png
diff --git a/...mages/macosx_install_010_applications.png → ...n/images/inst_macosx_010_applications.png b/...mages/macosx_install_010_applications.png → ...n/images/inst_macosx_010_applications.png
diff --git a/...s/macosx_install_020_security_warning.png → ...ages/inst_macosx_020_security_warning.png b/...s/macosx_install_020_security_warning.png → ...ages/inst_macosx_020_security_warning.png
diff --git a/...ges/macosx_install_050_eclipse_splash.png → ...images/inst_macosx_050_eclipse_splash.png b/...ges/macosx_install_050_eclipse_splash.png → ...images/inst_macosx_050_eclipse_splash.png
diff --git a/..._install_060_eclipse_workspace_dialog.png → ...t_macosx_060_eclipse_workspace_dialog.png b/..._install_060_eclipse_workspace_dialog.png → ...t_macosx_060_eclipse_workspace_dialog.png
diff --git a/...es/macosx_install_070_eclipse_welcome.png → ...mages/inst_macosx_070_eclipse_welcome.png b/...es/macosx_install_070_eclipse_welcome.png → ...mages/inst_macosx_070_eclipse_welcome.png
diff --git a/.../macosx_install_080_eclipse_workbench.png → ...ges/inst_macosx_080_eclipse_workbench.png b/.../macosx_install_080_eclipse_workbench.png → ...ges/inst_macosx_080_eclipse_workbench.png
diff --git a/...indows7_install_010_eclipse_extract_1.png → ...s/inst_windows7_010_eclipse_extract_1.png b/...indows7_install_010_eclipse_extract_1.png → ...s/inst_windows7_010_eclipse_extract_1.png
diff --git a/...indows7_install_020_eclipse_extract_2.png → ...s/inst_windows7_020_eclipse_extract_2.png b/...indows7_install_020_eclipse_extract_2.png → ...s/inst_windows7_020_eclipse_extract_2.png
diff --git a/...s/windows7_install_030_eclipse_folder.png → ...ages/inst_windows7_030_eclipse_folder.png b/...s/windows7_install_030_eclipse_folder.png → ...ages/inst_windows7_030_eclipse_folder.png
diff --git a/...windows7_install_040_eclipse_contents.png → ...es/inst_windows7_040_eclipse_contents.png b/...windows7_install_040_eclipse_contents.png → ...es/inst_windows7_040_eclipse_contents.png
diff --git a/...windows7_install_045_security_warning.png → ...es/inst_windows7_045_security_warning.png b/...windows7_install_045_security_warning.png → ...es/inst_windows7_045_security_warning.png
diff --git a/...s/windows7_install_050_eclipse_splash.png → ...ages/inst_windows7_050_eclipse_splash.png b/...s/windows7_install_050_eclipse_splash.png → ...ages/inst_windows7_050_eclipse_splash.png
diff --git a/..._install_060_eclipse_workspace_dialog.png → ...windows7_060_eclipse_workspace_dialog.png b/..._install_060_eclipse_workspace_dialog.png → ...windows7_060_eclipse_workspace_dialog.png
diff --git a/.../windows7_install_070_eclipse_welcome.png → ...ges/inst_windows7_070_eclipse_welcome.png b/.../windows7_install_070_eclipse_welcome.png → ...ges/inst_windows7_070_eclipse_welcome.png
diff --git a/...indows7_install_080_eclipse_workbench.png → ...s/inst_windows7_080_eclipse_workbench.png b/...indows7_install_080_eclipse_workbench.png → ...s/inst_windows7_080_eclipse_workbench.png