Browse Source

Merge pull request #903 from Yakindu/issue_#349_edit_on_github

Documentation: "Edit on GitHub" links introduced (issue 349 pro)
Andreas Mülder 9 years ago
parent
commit
c66b69e116

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

@@ -183,6 +183,13 @@
                 </fileset>
             </replaceregexp>
 
+            <!-- Add CSS class "eclipsehelp" to BODY element -->
+            <replaceregexp byline="true" match='&lt;body&gt;' replace='&lt;body class="eclipsehelp"&gt;'>
+                <fileset dir="${help.dir}">
+                    <include name="**/*.html" />
+                </fileset>
+            </replaceregexp>
+
             <!-- Fix "pro-feature" DIV elements -->
             <replaceregexp byline="false"
                            flags="g"
@@ -290,7 +297,8 @@
 
 
     <!-- Creates a certain part of the HTML documentation for the website. -->
-    <macrodef name="create-website-part" description="Creates a certain part of the HTML documentation for the website.">
+    <macrodef name="create-website-part"
+              description="Creates a certain part of the HTML documentation for the website.">
         <attribute name="name" />
         <attribute name="title" />
         <element name="textile-files" />

+ 19 - 1
plugins/org.yakindu.sct.doc.user/css/ysct.css

@@ -113,4 +113,22 @@ span.pro-feature:before {
 	position:relative;
 	top:0;
 	left:0
-}
+}
+
+/* Edit on GitHub: */
+
+.sct-docs h1 {
+	/* Make some room for the "Edit on GitHub link": */
+	margin-right: 10rem;
+}
+
+.sct-docs .edit-on-github {
+	float: right;
+	text-align: right;
+	position: relative;
+	top: 4ex;
+}
+
+.eclipsehelp .edit-on-github {
+	display: none
+}

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/installation/installation.textile

@@ -1,4 +1,6 @@
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/installation/installation.textile
+
 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.

+ 4 - 0
plugins/org.yakindu.sct.doc.user/src/tutorials/tutorials.textile

@@ -1,4 +1,6 @@
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/tutorials/tutorials.textile
+
 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:
@@ -43,6 +45,8 @@ As an example, we will take the light switch statechart and generate Java source
 That's it. If you want to know more, take the time and work through the "Comprehensive Tutorial":#oss_comprehensive-tutorial.
 
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/tutorials/tutorials.textile
+
 h1(#oss_comprehensive-tutorial). Comprehensive tutorial
 
 This tutorial introduces YAKINDU Statechart Tools (SCT) which provides an integrated modeling environment for the specification and development of reactive, event-driven systems based on the concept of state machines or statecharts. It is an easy-to-use tool featuring sophisticated graphical statechart editing, validation and simulation of statecharts as well as code generation for C, C&#43;&#43;, or Java.

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/advanced_simulation.textile

@@ -3,6 +3,8 @@ p.
 
 ==<div class="pro-feature">==
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/advanced_simulation.textile
+
 h1(#advsim_simulation). Debugging with breakpoints and snapshots
 
 h2(#advsim_introduction). Introduction

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/c-domain.textile

@@ -3,6 +3,8 @@ p.
 
 ==<div class="pro-feature">==
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/c-domain.textile
+
 h1(#cdom_deep-c-integration). Deep C Integration: Integrating your C source code with your statecharts
 
 h2(#cdom_introduction). Introduction

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/editing_statecharts.textile

@@ -1,4 +1,6 @@
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/editing_statecharts.textile
+
 h1(#editing-statecharts). Editing statecharts
 
 h2(#creating-and-deleting-statecharts). Creating and deleting statecharts

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/generating_code.textile

@@ -1,4 +1,6 @@
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/generating_code.textile
+
 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@.

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/overview.textile

@@ -1,4 +1,6 @@
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/overview.textile
+
 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:

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/sctunit.textile

@@ -3,6 +3,8 @@ p.
 
 ==<div class="pro-feature">==
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/sctunit.textile
+
 h1. SCTUnit
 
 h2. What is SCTUnit for?

+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/simulating_statecharts.textile

@@ -1,4 +1,6 @@
 
+p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/simulating_statecharts.textile
+
 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.

File diff suppressed because it is too large
+ 2 - 0
plugins/org.yakindu.sct.doc.user/src/user-guide/statechart_language.textile