Browse Source

Documentation: changes to generate online documentation for Hubspot in the PRO repository

* CSS modified.
* Textile files must start with an empty line, because they are concatenated.
* "Blurred" version of two image files provided. Originals are available in XCF (not deployed).
* Textiles source files must still be deployed until PRO and OSS documentation is unified in the OSS repository.
Rainer Klute 9 years ago
parent
commit
a05b978b21

+ 3 - 1
plugins/org.yakindu.sct.doc.user/build.properties

@@ -4,5 +4,7 @@ bin.includes = plugin.xml,\
                plugin.xml,\
                toc.xml,\
                help/,\
-               css/
+               css/,\
+               src/
+
 

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

@@ -164,6 +164,7 @@
             <copy todir="${help.dir}">
                 <fileset dir="src">
                     <include name="**/${img.dir}/*" />
+                    <exclude name="**/${img.dir}/*.xcf" />
                 </fileset>
             </copy>
         </sequential>

+ 4 - 13
plugins/org.yakindu.sct.doc.user/css/custom.css

@@ -119,13 +119,7 @@ body {
 }
 
 
-/* Styling of figures. By default, a figure is rendered as a <div class="figure"> … <img … /> </div> */
-.figure {
-    text-align: center;
-}
-
-img {
-	*/ it should be considered to move max-width and min-width somewhere else, because it is overwritten everywhere anyhow */
+img.standard-image {
     max-width: 61.8%;
     min-width: 38.2%;
     height: auto;
@@ -133,12 +127,11 @@ img {
     display: block;
     margin-left: auto;
     margin-right: auto;
-}
 
-img.standard-image {
-    height:auto;
     box-shadow: 10px 10px 20px #888888;
-    margin-bottom: 20px;
+    border-radius: 4px;
+    margin-top: 1.5ex;
+    margin-bottom: 2.5ex;
 }
 
 img.tiny {
@@ -305,5 +298,3 @@ h5:before {counter-increment: h5; content: counter(h1) "." counter(h2) "." count
 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 } 
-
-

+ 1 - 0
plugins/org.yakindu.sct.doc.user/src/Part1-Installation-Guide/00_installation.textile

@@ -1,3 +1,4 @@
+
 h1(#installation-guide). Installation Guide
 
 In order to start working with YAKINDU Statechart Tools, you have to install the software on your computer. We are assuming you have downloaded the software package and stored it somewhere on your machine.

BIN
plugins/org.yakindu.sct.doc.user/src/Part1-Installation-Guide/images/eclipse_install_030_eclipse_add_repository.png


BIN
plugins/org.yakindu.sct.doc.user/src/Part1-Installation-Guide/images/eclipse_install_030_eclipse_add_repository.xcf


BIN
plugins/org.yakindu.sct.doc.user/src/Part1-Installation-Guide/images/eclipse_install_040_eclipse_software_items.png


BIN
plugins/org.yakindu.sct.doc.user/src/Part1-Installation-Guide/images/eclipse_install_040_eclipse_software_items.xcf


+ 1 - 0
plugins/org.yakindu.sct.doc.user/src/Part2-User-Guide/10_overview.textile

@@ -1,3 +1,4 @@
+
 h1(#what-are-yakindu-statechart-tools). What are YAKINDU Statechart Tools?
 
 The statechart tools are a central part of YAKINDU: the modular toolkit for model-driven development of embedded systems. It is based on the open-source development platform Eclipse. YAKINDU Statechart Tools (YAKINDU SCT) provide the following tools to deal with state machine diagrams:

+ 1 - 0
plugins/org.yakindu.sct.doc.user/src/Part2-User-Guide/20_tutorial.textile

@@ -1,3 +1,4 @@
+
 h1(#oss_five-minutes-tutorial). Five-minutes tutorial
 
 The five-minutes tutorial gives you a brief introduction into YAKINDU Statechart Tools by a simple example. It models a light switch, which has the states _on_ and _off_. Operating the switch repeatedly turns the light on, off, back on again, and so forth. You can simulate this behavior in a dynamic statechart model. Here's how this looks like:

File diff suppressed because it is too large
+ 2 - 1
plugins/org.yakindu.sct.doc.user/src/Part2-User-Guide/30_statechart_language.textile


File diff suppressed because it is too large
+ 2 - 1
plugins/org.yakindu.sct.doc.user/src/Part2-User-Guide/40_editing_statecharts.textile


+ 3 - 2
plugins/org.yakindu.sct.doc.user/src/Part2-User-Guide/50_simulating_statecharts.textile

@@ -1,3 +1,4 @@
+
 h1(#simulating-statecharts). Simulating statecharts
 
 Simulating a statechart model means to execute it, raise events manually, have time-based and other events being triggered automatically, and observe the model's behavior.
@@ -73,8 +74,8 @@ By default, the _SC Simulation_ perspective shows the following views:
 * _Debug_ (top middle): This view is showing all statechart instances and allows to select one of them. YAKINDU Statechart Tools allow multiple executions of the same statechart as well as parallel executions of different statecharts at the same time.
 * _Outline_ (right): This view is a bird's eye view on the opened statechart. It also indicates the current viewport for better orientation in large models.
 * _Simulation_ (right): This view shows the current state of all variables and events during a simulation. A detailed description is available in section "&quot;The Simulation view&quot;":#oss_the-simulation-view.
-* _Breakpoints_ (right): This view shows a list of all breakpoints. You can use it for disabling, enabling, or removing breakpoints as well as for defining conditional breakpoints. *[Professional Edition only]*
-* _Snapshots_ (right): This view contains all snapshots with their respective names and timestamps. *[Professional Edition only]*
+* %(pro-feature)_Breakpoints_ (right): This view shows a list of all breakpoints. You can use it for disabling, enabling, or removing breakpoints as well as for defining conditional breakpoints.%
+* %(pro-feature)_Snapshots_ (right): This view contains all snapshots with their respective names and timestamps.%
 
 h3(#oss_displaying-simulation-progress-in-the-statechart-editor). Displaying simulation progress in the statechart editor
 

+ 1 - 0
plugins/org.yakindu.sct.doc.user/src/Part2-User-Guide/60_generating_code.textile

@@ -1,3 +1,4 @@
+
 h1(#generating-state-machine-code). Generating state machine code
 
 For configuring the code generation process, YAKINDU Statechart Tools uses a textual generator model called *SGen*. It can be created either by using the provided wizard *YAKINDU Statechart Generator Model* or by creating a new text file with the file extension @.sgen@.