Interactive documentation.
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/EscapeJava.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateAndRunJava.xml
similarity index 90%
rename from org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/EscapeJava.xml
rename to org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateAndRunJava.xml
index 230f0ee..967e35b 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/EscapeJava.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateAndRunJava.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<compositeCheatsheet name="Building and Running an Escape model in Java">
+<compositeCheatsheet name="Creating and Running an Escape model in Java">
<taskGroup kind="set" name="Group" skip="false">
<intro>
<b>Introduction</b>
@@ -34,7 +34,7 @@
<onCompletion>
<b>Conclusion</b>
</onCompletion>
- <param name="path" value="RunEscape.xml">
+ <param name="path" value="RunEscapeJava.xml">
</param>
</task>
</taskGroup>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeAMFProject.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeAMFProject.xml
index 1e50bea..3418a9f 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeAMFProject.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeAMFProject.xml
@@ -18,7 +18,7 @@
serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.amp.amf.AgentModelingPerspective)"/>
</item>
<item
- title="Create an Escape Modeling project.">
+ title="Create an Escape Modeling project">
<description>
<b>Next, let's create the project where we'll place our model.</b>
Select File > New > Escape AMF Project. Give it a name like "escape.tutorial", then click Finish.
@@ -28,7 +28,7 @@
serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.amp.escape.amf.wizards.newProject)"/>
</item>
<item
- title="Copy a model into the project.">
+ title="Copy a model into the project">
<description>
<b>We need a model to run.</b> We'll use the epidemic model, which you can get at http://download.eclipse.org/amp/models/Epidemic.metaabm. Download the file to your computer and just drag it into the project folder you've just created. (You'll have to do this step yourself!)
</description>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeJavaModel.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeJavaModel.xml
index 2db046e..67e7ad4 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeJavaModel.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/CreateEscapeJavaModel.xml
@@ -8,7 +8,7 @@
</intro>
<item title="Create your Scape class" dialog="true" skip="false" href="/org.eclipse.jdt.doc.user/gettingStarted/qs-9.htm">
<description>
- The next step is to create the actual model class. In the main toolbar again, click on the <b>New Java Class</b> button (or the link below). If not already specified, select your project's <b>src</b> directory as the source folder. Enter <b>CoordinationGame</b> for the class name, and select the checkbox to create the <b>main()</b> method, then click <b>Finish</b>.<br/>
+ The next step is to create the actual model class. In the main toolbar again, click on the <b>New Java Class</b> button (or the link below). If not already specified, select your project's <b>src</b> directory as the source folder. Enter <b>CoordinationGame</b> for the class name, "ede.brook.model" as the package name, and select the checkbox to create the <b>main()</b> method, then click <b>Finish</b>.<br/>
<br/>
The Java editor will automatically open showing your new class.
</description>
@@ -16,13 +16,13 @@
</command>
</item>
<item
- title="Copy the coordination game code.">
+ title="Copy the Coordination Game code.">
<description>
To implement the model, we'll just copy the code from the Ascape manual.
</description>
<command
required="false"
- serialization="org.eclipse.ui.help.displayHelp(href=/org.ascape.doc/Content/manual/Appendix.html?path%=3_1_6_0_0#1.1)"/>
+ serialization="org.eclipse.ui.help.displayHelp(href=/org.ascape.doc/Content/manual/AppendixII.html?path%=#1.1)"/>
</item>
<item title="Create your Agent class" dialog="true" skip="false" href="/org.eclipse.jdt.doc.user/gettingStarted/qs-9.htm">
<description>
@@ -31,4 +31,10 @@
<command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.jdt.ui.wizards.NewClassCreationWizard)" required="false" translate="">
</command>
</item>
+ <item
+ title="Copy the Coordination Player code.">
+ <description>
+ <b>Body</b>
+ </description>
+ </item>
</cheatsheet>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/LoadAndRunExampleModels.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/LoadAndRunExampleModels.xml
new file mode 100644
index 0000000..99e180f
--- /dev/null
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/LoadAndRunExampleModels.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<compositeCheatsheet name="Load and run Escape Models">
+ <taskGroup kind="set" name="Group" skip="false">
+ <intro>
+ <b>Introduction</b>
+ </intro>
+ <onCompletion>
+ <b>Conclusion</b>
+ </onCompletion>
+ <task kind="cheatsheet" name="Load Example Projects" skip="false">
+ <intro>
+ If you have not already loaded the example models, we'll do so now.
+ </intro>
+ <param name="path" value="LoadSampleProjects.xml">
+ </param>
+ </task>
+ <task kind="cheatsheet" name="Run Model" skip="false">
+ <intro>
+ <b>Introduction</b>
+ </intro>
+ <onCompletion>
+ Congratulations! You run any other model by simply selecting it's Java file and selecting execute.
+ </onCompletion>
+ <param name="path" value="RunEscape.xml">
+ </param>
+ </task>
+ </taskGroup>
+</compositeCheatsheet>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscape.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscape.xml
index 83faba6..f084a48 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscape.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscape.xml
@@ -12,11 +12,11 @@
Go to the package explorer.
</description>
<command
- required="true"
+ required="false"
serialization="org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.jdt.ui.PackageExplorer)"/>
</item>
<item
- title="Select Model Class">
+ title="Select Prisoner's Dilemma Model">
<description>
Select a model to execute. If you've imported the example projects (just run the "Load Sample Projects" cheatsheet) you can use the Prisoner's Dilemma Model.
</description>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscapeJava.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscapeJava.xml
new file mode 100644
index 0000000..f084a48
--- /dev/null
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/cheatsheets/RunEscapeJava.xml
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<cheatsheet
+ title="Run an Example Model">
+ <intro>
+ <description>
+ In this tutorial, we'll run the model! <b>Note -- you need to have installed the example models before proceeding, or have developed your own model first!</b>
+ </description>
+ </intro>
+ <item
+ title="Select Package Explorer">
+ <description>
+ Go to the package explorer.
+ </description>
+ <command
+ required="false"
+ serialization="org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.jdt.ui.PackageExplorer)"/>
+ </item>
+ <item
+ title="Select Prisoner's Dilemma Model">
+ <description>
+ Select a model to execute. If you've imported the example projects (just run the "Load Sample Projects" cheatsheet) you can use the Prisoner's Dilemma Model.
+ </description>
+ <command
+ required="false"
+ serialization="org.eclipse.jdt.ui.commands.showElementInPackageView(elementRef=org.ascape.escape.models.brook/edu.brook.pd.PD2D)"/>
+ </item>
+ <item
+ title="Execute the model">
+ <description>
+ Now we can start the model in one of three ways.
+<ul>
+<li>Right-click and select "Execute" from the menu.</li>
+<li>Select the "Execute" from the toolbar. (Our favorite)</li>
+<li>Select "Execute" from the "Control" menu.</li>
+</ul>
+
+Or, if you hav the example models loaded, just select perform now.
+ </description>
+ <command
+ required="true"
+ serialization="org.eclipse.amp.escape.runtime.execute(elementRef=org.ascape.escape.models.brook/edu.brook.pd.PD2D)"/>
+ </item>
+
+</cheatsheet>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/plugin.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/plugin.xml
index 5285ccb..1b50860 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/plugin.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/plugin.xml
@@ -46,7 +46,7 @@
<cheatsheet
category="org.eclipse.amp.escape"
composite="false"
- contentFile="cheatsheets/EscapeJava.xml"
+ contentFile="cheatsheets/CreateAndRunJava.xml"
id="org.eclipse.amp.escape.escapeJava"
name="Build and Run an Escape Java Model">
</cheatsheet>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/AMP-toc.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/AMP-toc.xml
index 0baa690..03618ac 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/AMP-toc.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/AMP-toc.xml
@@ -70,21 +70,21 @@
<topic href="wiki/Escape.html#Developing_Models" label="Developing Models"></topic>
</topic>
<topic href="wiki/Escape.html#Reference" label="Reference">
- <topic href="wiki/Escape.html#Converting_Existing_Ascape_models" label="Converting Existing Ascape models">
- <topic href="wiki/Escape.html#Model" label="Model"></topic>
- <topic href="wiki/Escape.html#View" label="View">
- <topic href="wiki/Escape.html#Convert_the_low-level_imports_from_AWT_and_Swing_to_SWT" label="Convert the low-level imports from AWT and Swing to SWT"></topic>
- <topic href="wiki/Escape.html#Convert_color_features" label="Convert color features"></topic>
- <topic href="wiki/Escape.html#Change_agent_color_getters" label="Change agent color getters"></topic>
- <topic href="wiki/Escape.html#Get_rid_of_image_features" label="Get rid of image features"></topic>
- <topic href="wiki/Escape.html#Modify_usages_of_DrawFeatures" label="Modify usages of DrawFeatures"></topic>
+ <topic href="wiki/EscapeConverting.html" label="Converting Existing Ascape models">
+ <topic href="wiki/EscapeConverting.html#Model" label="Model"></topic>
+ <topic href="wiki/EscapeConverting.html#View" label="View">
+ <topic href="wiki/EscapeConverting.html#Convert_the_low-level_imports_from_AWT_and_Swing_to_SWT" label="Convert the low-level imports from AWT and Swing to SWT"></topic>
+ <topic href="wiki/EscapeConverting.html#Convert_color_features" label="Convert color features"></topic>
+ <topic href="wiki/EscapeConverting.html#Change_agent_color_getters" label="Change agent color getters"></topic>
+ <topic href="wiki/EscapeConverting.html#Get_rid_of_image_features" label="Get rid of image features"></topic>
+ <topic href="wiki/EscapeConverting.html#Modify_usages_of_DrawFeatures" label="Modify usages of DrawFeatures"></topic>
</topic>
- <topic href="wiki/Escape.html#Configuration" label="Configuration"></topic>
+ <topic href="wiki/EscapeConverting.html#Configuration" label="Configuration"></topic>
</topic>
<topic href="wiki/Escape.html#Current_Limitations" label="Current Limitations"></topic>
+ </topic>
<topic href="http://ascape.sourceforge.net/api/index.html" label="Escape API (external)">
</topic>
- </topic>
</topic>
<topic label="Reference">
<topic href="docs/javadoc/index.html" label="API">
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape-toc.xml b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape-toc.xml
index 67eb81d..ba43896 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape-toc.xml
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape-toc.xml
@@ -22,15 +22,15 @@
</topic>
<topic href="wiki/Escape.html#Reference" label="Reference">
<topic href="wiki/EscapeConverting.html" label="Converting Existing Ascape models">
- <topic href="wiki/Escape.html#Model" label="Model"></topic>
- <topic href="wiki/Escape.html#View" label="View">
- <topic href="wiki/Escape.html#Convert_the_low-level_imports_from_AWT_and_Swing_to_SWT" label="Convert the low-level imports from AWT and Swing to SWT"></topic>
- <topic href="wiki/Escape.html#Convert_color_features" label="Convert color features"></topic>
- <topic href="wiki/Escape.html#Change_agent_color_getters" label="Change agent color getters"></topic>
- <topic href="wiki/Escape.html#Get_rid_of_image_features" label="Get rid of image features"></topic>
- <topic href="wiki/Escape.html#Modify_usages_of_DrawFeatures" label="Modify usages of DrawFeatures"></topic>
+ <topic href="wiki/EscapeConverting.html#Model" label="Model"></topic>
+ <topic href="wiki/EscapeConverting.html#View" label="View">
+ <topic href="wiki/EscapeConverting.html#Convert_the_low-level_imports_from_AWT_and_Swing_to_SWT" label="Convert the low-level imports from AWT and Swing to SWT"></topic>
+ <topic href="wiki/EscapeConverting.html#Convert_color_features" label="Convert color features"></topic>
+ <topic href="wiki/EscapeConverting.html#Change_agent_color_getters" label="Change agent color getters"></topic>
+ <topic href="wiki/EscapeConverting.html#Get_rid_of_image_features" label="Get rid of image features"></topic>
+ <topic href="wiki/EscapeConverting.html#Modify_usages_of_DrawFeatures" label="Modify usages of DrawFeatures"></topic>
</topic>
- <topic href="wiki/Escape.html#Configuration" label="Configuration"></topic>
+ <topic href="wiki/EscapeConverting.html#Configuration" label="Configuration"></topic>
</topic>
<topic href="wiki/Escape.html#Current_Limitations" label="Current Limitations"></topic>
</topic>
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape.html b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape.html
index 2b27c27..f167f36 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape.html
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/Escape.html
@@ -142,14 +142,6 @@
</ol>
<p>Then just create new Java classes for your root model scape and agents just as you would for an Ascape project.</p>
<h1 id="Reference">Reference</h1>
-
-<h4 id="Configuration">Configuration</h4>
-<p>Instead of using Ant, Escape has really nice support for parameterizing and testing models. See <a
- href="/wiki/Experimenting_and_Testing" title="Experimenting and Testing">Experimenting and Testing</a> (todo). If
-you do want to work with ant you will need to install the plugins from the Sourceforge download site. (These have
-dependencies that I didn't want to bother with going through the Eclipse IP process to get in. If for some reason you
-think these should be part of core Escape let Miles know and I'll take care of it.) Ant has not been tested for Escape
-so it's not even clear it will work.</p>
<h2 id="Current_Limitations">Current Limitations</h2>
<ol>
<li>Escape is pretty robust, and the APIs are solid and well-tested but the runtime is not going to be as
diff --git a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/EscapeConverting.html b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/EscapeConverting.html
index 776cdee..873c841 100644
--- a/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/EscapeConverting.html
+++ b/org.eclipse.amp/doc/org.eclipse.amp.doc/wiki/EscapeConverting.html
@@ -59,7 +59,15 @@
g.setBackgroundColor(
g.fillOval(..
</pre>
-<p>That's about it, though it's probable that we've missed something. Please post a message on the amp newsgroup if
+
+<h4 id="Configuration">Configuration</h4>
+<p>Instead of using Ant, Escape has really nice support for parameterizing and testing models. See <a
+ href="/wiki/Experimenting_and_Testing" title="Experimenting and Testing">Experimenting and Testing</a> (todo). If
+you do want to work with ant you will need to install the plugins from the Sourceforge download site. (These have
+dependencies that I didn't want to bother with going through the Eclipse IP process to get in. If for some reason you
+think these should be part of core Escape let Miles know and I'll take care of it.) Ant has not been tested for Escape
+so it's not even clear it will work.</p>
+<p>That's about it, though we may have missed something. Please post a message on the amp newsgroup if
you run into any other conversion issues.</p>
</body>
</html>
\ No newline at end of file