Browse Source

Minor documentation fixes (#1728)

* Documentation: Linkchecker extended to tutorials.

* Documentation: minor fixes
Rainer Klute 7 years ago
parent
commit
3abe0e4f7a

+ 1 - 0
plugins/org.yakindu.sct.doc.user/misc/checkLinks_w3c.sh

@@ -67,6 +67,7 @@ then
 	--recursive --depth 1 \
 	--exclude 'https://github.com/Yakindu/.*|http://groups.google.com/.*|javascript:.*|tel:.*|mailto:.*|https://cta-redirect.hubspot.com/' \
 	https://www.itemis.com/en/yakindu/state-machine/documentation/user-guide/ \
+	https://www.itemis.com/en/yakindu/state-machine/documentation/tutorials/ \
         2>&1 | tee log.txt
 else
     echo "Unknown target: ${target}"

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

@@ -45,7 +45,7 @@ As an example, we will take the light switch statechart and generate Java source
 # In the next dialog, check the checkbox left from _light_switch.sct_, then click _Finish_.
 # Java classes implementing the statechart model are generated. You can find the generated source code in the folders _src_ and _src-gen_ within the _light_switch_ project. <p>!(standard-image)images/tuto_5min_140_generated_java_source_code.png(Generated Java source code)!</p>
 
-That's it. If you want to know more, take the time and work through the "Comprehensive Tutorial":#tutorial_comprehensive_tutorial.
+That's it. If you want to know more, take the time and work through the "Comprehensive Tutorial":../tutorials/tutorials.html#tutorial_comprehensive_tutorial.
 
 
 

+ 5 - 1
plugins/org.yakindu.sct.doc.user/src/user-guide/installation.textile

@@ -27,6 +27,8 @@ h3(#inst_eclipse). Eclipse
 
 Internally, YAKINDU Statechart Tools are based on *"Eclipse":http://www.eclipse.org/*, an integrated development environment (IDE). YAKINDU Statechart Tools are running inside the Eclipse environment. When you are installing YAKINDU Statechart Tools, a full-fledged Eclipse instance will be put on your computer. Currently it is the *Oxygen* release.
 
+###. CHECK: Is Oxygen still the current Eclipse release?
+
 If you are new to Eclipse, you might find the "Eclipse Help":http://help.eclipse.org/ useful, especially the "Workbench User Guide".
 
 If you are an experienced Eclipse user, you can install YAKINDU Statechart Tools into a existing Eclipse instance from an update site.
@@ -454,7 +456,9 @@ In order to check whether you are affected, proceed as follows:
 # In the main menu, select _Window → Preferences_. The _Preferences_ window opens.
 # In the _Preferences_ window, select _Java → Installed JREs_.
 
-If the list of installed JREs is empty, you are affected by the problem and will have to manually add a JRE definition. Click on the _Add…_ button and follow the _Add JRE_ wizard. The Eclipse documentation explains in more detail how to "add a new JRE definition":http://help.eclipse.org/neon/index.jsp?topic=%252Forg.eclipse.jdt.doc.user%252Ftasks%252Ftask-add_new_jre.htm to your workspace.
+If the list of installed JREs is empty, you are affected by the problem and will have to manually add a JRE definition. Click on the _Add…_ button and follow the _Add JRE_ wizard. The Eclipse documentation explains in more detail how to "add a new JRE definition":http://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Ftasks%2Ftask-add_new_jre.htm to your workspace.
+
+###. CHECK Does the link http://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Ftasks%2Ftask-add_new_jre.htm still point to how to add a JRE?
 
 !(standard-image)images/inst_installed_jres_010.png(Installed JREs)!