Permalink
Browse files

Fixing errors in manual including rendering of angle brackets

  • Loading branch information...
TimLethbridge committed Jun 6, 2017
1 parent 6c14594 commit 88f9ea8f40364fb69c1484a1c02e632d4c8a8252
View
@@ -18,15 +18,15 @@ Code in the examples will be rendered using syntaxHighlighter. This is found in
A link will be generated from each code example to ensure that it can be displayed in UmpleOnline. Always test and comment code samples.
Instructions for building deploying the user manual can be found here: https://code.google.com/p/umple/wiki/Deploying
Instructions for building deploying the user manual can be found here: https://github.com/umple/Umple/wiki/Deploying
In short: to build on your local environment
cd trunk/build
ant -Dmyenv=local -f build.umple.xml packageDocs
then
open <yourumpledir>/dist/cruise.umple/reference/GettingStarted.html
Diagrams can be embedded in selected pages. These are stored in umplewww/examples
Diagrams must be deployed on the server when they are created or changed. This is not done automatically.
Diagrams must be promoted on the server when they are created or changed. This is not done automatically.
The program that generates the user manual is called umpledocs.jar
Code for this can be found in:
@@ -5,6 +5,8 @@ noreferences
@@description
<p>Umple is a technology for Model-Oriented Programming.</p>
<p>The Umple home page is <a href="http://www.umple.org">http://www.umple.org</a>. To download Umple for the command line or Eclipse, go to <a href="http://dl.umple.org">http://dl.umple.org</a>. To use Umple online as a web app, go to <a href="http://try.umple.org">http://try.umple.org</a></p>
<p>Umple allows you to do the following things: </p>
<ol>
@@ -69,7 +71,7 @@ pages also allows you to instantly load the examples into UmpleOnline.</p>
<p>To learn more about Umple, read the links on the left of this page, or
go to the <a href="http://www.umple.org">Umple Home page</a>. In
particular, you should browse the <a
href="http://code.google.com/p/umple/wiki/Tutorials">tutorials and videos
href="https://github.com/umple/Umple/wiki/Tutorials">tutorials and videos
about Umple</a></p>
<hr />
@@ -78,4 +80,4 @@ about Umple</a></p>
<hr />
<i>If you are an ordinary user and notice an error in this manual, <a href="https://code.google.com/p/umple/issues/list">please report it using our issue tracking system here</a> Flag it as a defect in the user documentation. If you still have trouble after reading this manual, please contact our <a href="mailto:umple-help@googlegroups.com"> help mailing list and post a request for help</a>. If you are a contributer, <a href="https://code.google.com/p/umple/wiki/Deploying">instructions on how to edit this manual are here</a>.</i>
<i>If you are an ordinary user and notice an error in this manual, <a href="https://github.com/umple/Umple/issues">please report it using our issue tracking system here</a> Flag it as a defect in the user documentation. If you still have trouble after reading this manual, please contact our <a href="mailto:umple-help@googlegroups.com"> help mailing list and post a request for help</a>. If you are a contributer, <a href=https://github.com/umple/Umple/wiki/Deploying">instructions on how to edit this manual are here</a>.</i>
@@ -53,7 +53,7 @@ noreferences
<li>Umple can be used incrementally. You can use just a few pieces of it here and there to gain substantial advantages.</li>
<li>There is an easy-to-access user manual, with examples for all constructs and messages.</li>
<li>Umple will save a lot of coding and maintenance of boilerplate code, code for patterns, and code for constructs such as state machines.</li>
<li>Studies have shown that code using Umple is actually easier to understand than traditional code, and people learn to be better modelers when using Umple. <a href="http://code.google.com/p/umple/wiki/Publications">See here for a list of peer-reviewed publications.</a></li>
<li>Studies have shown that code using Umple is actually easier to understand than traditional code, and people learn to be better modelers when using Umple. <a href="https://github.com/umple/Umple/wiki/Publications">See here for a list of peer-reviewed publications.</a></li>
<li>Umple is deliberately simpler than UML and other modeling technologies.</li>
</ul></li><br/>
@@ -60,7 +60,7 @@ MOTL can be used in two modes:
<br>
<p align="justify">
The following pages describe how to use MOTL. Many aspects of MOTL are under development. Some <a href="http://code.google.com/p/umple/wiki/DraftManualPages">future pages for tracing features under development cam be found in Umple wiki pages.</a>
The following pages describe how to use MOTL. Many aspects of MOTL are under development. Some <a href="https://github.com/umple/Umple/wiki/DraftManualPages">future pages for tracing features under development cam be found in Umple wiki pages.</a>
</p>
<hr />
@@ -18,7 +18,7 @@ noreferences
<p><b>Not certified for safety critical or mission critical use:</b> At the current time Umple-generated code <b>should not be used for mission-critical or safety critical uses</b>, including software for any device that may pose a safety risk if it performs incorrectly, or software that would cause economic damage if it failed. We intend that, in time, Umple and tools like it will in fact help improve safety and reliability. But at the current time we have not subjected Umple to the rigorous validation it needs for such uses, and there are many known issues that would preclude such current use.</p>
<p><b>Need to apply best practices:</b> Should you choose to use Umple for production use, it is <b>critical that you follow rigorous software engineering practices</b> including (but not limited to): Requirements analysis, careful design and thorough testing. <a href="http://code.google.com/p/umple/wiki/BestUmpleUsePractices">See here for a list of Umple best practies.</a></p>
<p><b>Need to apply best practices:</b> Should you choose to use Umple for production use, it is <b>critical that you follow rigorous software engineering practices</b> including (but not limited to): Requirements analysis, careful design and thorough testing. <a href="https://github.com/umple/Umple/wiki/BestUmpleUsePractices">See here for a list of Umple best practies.</a></p>
&nbsp; <br />
@@ -22,12 +22,12 @@ inconsistency, redundancy or assumption that may not be correct.</p>
<hr>
<p><i>For developers of Umple itself: The file defining the messages in English is called
<a href="http://code.google.com/p/umple/source/browse/trunk/cruise.umple/src/en.error">
<a href="https://github.com/umple/umple/blob/master/cruise.umple/src/en.error">
en.error</a> and is located in cruise.umple/src. Errors have severity 1 or 2, and warnings have severity 3, 4 and 5. When adding a message, a user manual
page should be added describing it.<br />
All
messages should be detected in the <a href="http://code.google.com/p/umple/source/browse/trunk/cruise.umple/src/UmpleInternalParser_CodeClass.ump">parsing phase by calling setFailedPosition</a>.
messages should be detected in the <a href="https://github.com/umple/umple/blob/master/cruise.umple/src/UmpleInternalParser_CodeClass.ump">parsing phase by calling setFailedPosition</a>.
<br />
It is intended in the future that
@@ -346,8 +346,6 @@ class Documenter
}
exampleOutput += nextExample;
}
exampleOutput = exampleOutput.replaceAll("<<", "&lt;&lt;");
exampleOutput = exampleOutput.replaceAll(">>", "&gt;&gt;");
htmlOutput = htmlOutput.replace("@@EXAMPLE@@", exampleOutput);
htmlOutput = htmlOutput.replace("@@UMPLE_GRAMMAR@@", grammarparser.toGrammar());
@@ -478,6 +476,8 @@ class ContentParser
0,spaceLocation);
exampleText = new String(Files.readAllBytes(Paths
.get("umpleonline/ump/"+exampleName) ));
exampleText = exampleText.replaceAll("<", "&lt;");
exampleText = exampleText.replaceAll(">", "&gt;");
exampleURL="?example="+exampleTextWithArguments;
}
catch (IOException e) {
@@ -332,7 +332,9 @@ class UmpleConsoleMain
private static void printUsage()
{
System.out.println("Usage: java -jar umple.jar [options] <umple_file>"+System.lineSeparator()+"Example: java -jar umple.jar airline.ump");
System.out.println("For more detailed information go to http://manual.umple.org"+System.lineSeparator()
+"Usage: java -jar umple.jar [options] <umple_file>"+System.lineSeparator()
+"Example: java -jar umple.jar airline.ump");
try
{
optparser.printHelpOn(System.out);
@@ -59,7 +59,8 @@ public void Usage() {
String[] args = new String[0];
UmpleConsoleMain.main(args);
Assert.assertEquals("Usage: java -jar umple.jar [options] <umple_file>"+System.lineSeparator()
Assert.assertEquals("For more detailed information go to http://manual.umple.org"+System.lineSeparator()
+"Usage: java -jar umple.jar [options] <umple_file>"+System.lineSeparator()
+ "Example: java -jar umple.jar airline.ump"+System.lineSeparator(), outErrIntercept.toString());
}
@@ -89,6 +90,7 @@ public void badArgument() {
} catch (IllegalStateException ise) {
Assert.assertTrue(outErrIntercept.toString()
.startsWith("Option:\'IDONTEXIST\' is not a recognized option"+System.lineSeparator()
+"For more detailed information go to http://manual.umple.org"+System.lineSeparator()
+ "Usage: java -jar umple.jar [options] <umple_file>"+System.lineSeparator()+"Example: java -jar umple.jar airline.ump"+System.lineSeparator()));
}
}
View
@@ -8,7 +8,7 @@ echo This should take 10-20 seconds. Do not interrupt
echo This only builds the main command line jar, not umplesync.jar, for that use qfbumple
echo You should always have done 'git pull' before running this and have resolved conflicts
set logfile="/tmp/umplebuildlog$$.txt"
ant -Dmyenv=local -f build.umple.xml ç | tee $logfile
ant -Dmyenv=local -f build.umple.xml codegen umpleParser rtcpp umpleSelf compile packageMainJar | tee $logfile
grep -qi failed $logfile
set failedstatus=$status
grep -qi error $logfile
View
@@ -143,7 +143,7 @@
<div class="level2"><a href="https://www.facebook.com/umple.org">Umple Facebook Page with news
</a></div>
<div class="level2"><a href="https://plus.google.com/b/115082368854291379160/">Umple Google+ Page
<div class="level2"><a href="https://plus.google.com/+UmpleOrg">Umple Google+ Page
</a></div>
<div class="level2"><a href="http://www.youtube.com/playlist?list=PLA6E9B1AE9E2D6677">Umple YouTube Playlist

0 comments on commit 88f9ea8

Please sign in to comment.