summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-11-23 04:19:12 (EST)
committer Sven Rottstock2012-11-23 04:19:12 (EST)
commit7d09baec6e8d4aaba258b9b107038e4afd7d6dce (patch)
tree52e0c97517f31b9548a14b94d771f4de9bc8dad8
parent61333c66fc2d9b5eec2bb9b6d5884bec526c57d5 (diff)
downloadorg.eclipse.stardust.documentation-7d09baec6e8d4aaba258b9b107038e4afd7d6dce.zip
org.eclipse.stardust.documentation-7d09baec6e8d4aaba258b9b107038e4afd7d6dce.tar.gz
org.eclipse.stardust.documentation-7d09baec6e8d4aaba258b9b107038e4afd7d6dce.tar.bz2
CRNT-27129 - Added annotation details
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@61066 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/analysttoc.xml2
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect-annot.pngbin0 -> 10931 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-annotation.pngbin0 -> 2766 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/drop-annotation.pngbin0 -> 9006 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-annotation.pngbin0 -> 8115 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/prop-annot.pngbin0 -> 3678 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/specify-annot.pngbin0 -> 9904 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-annotation.htm81
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm21
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-session-log.htm2
-rw-r--r--org.eclipse.stardust.docs.analyst/html/toc.html1
11 files changed, 69 insertions, 38 deletions
diff --git a/org.eclipse.stardust.docs.analyst/analysttoc.xml b/org.eclipse.stardust.docs.analyst/analysttoc.xml
index 037058f..87653bd 100644
--- a/org.eclipse.stardust.docs.analyst/analysttoc.xml
+++ b/org.eclipse.stardust.docs.analyst/analysttoc.xml
@@ -50,6 +50,8 @@
</topic>
<topic href="html/handbooks/modelling_analyst/pep-pools-lanes.htm" label="Swim Lanes Usage">
</topic>
+ <topic href="html/handbooks/modelling_analyst/pep-annotation.htm" label="Using Annotations">
+ </topic>
<topic href="html/handbooks/modelling_analyst/pep-session-log.htm" label="Modeling Session Log">
</topic>
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect-annot.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect-annot.png
new file mode 100644
index 0000000..0daa948
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect-annot.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-annotation.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-annotation.png
new file mode 100644
index 0000000..21f426e
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-annotation.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/drop-annotation.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/drop-annotation.png
new file mode 100644
index 0000000..de66420
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/drop-annotation.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-annotation.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-annotation.png
new file mode 100644
index 0000000..c7f44aa
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/hover-annotation.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/prop-annot.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/prop-annot.png
new file mode 100644
index 0000000..52b80d7
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/prop-annot.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/specify-annot.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/specify-annot.png
new file mode 100644
index 0000000..3d09eb8
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/specify-annot.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-annotation.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-annotation.htm
index 4ad4a56..666059e 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-annotation.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-annotation.htm
@@ -10,42 +10,61 @@
<body>
<script language="JavaScript">
<!--
- writeNavigation("Swim Lanes Usage","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
- "mg-defdesk-14.htm","mg-pools-lanes.htm",
- "../../toc.html","Business Analyst Handbooks",
- "mg-preface.htm","The Modeling Guide",
- "mg-modeler-preface.html","The Process Workbench");
+ writeNavigation("Modeling Session Log","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
+ "pep-pools-lanes.htm","pep-session-log.htm",
+ "../../toc.html","Business Process Modeling Handbook");
-->
</script>
-<h1 >
- Using Annotations</h1>
-<P >
-Annotations are used as multiple-line textual comments attached to the selected model element(s). Unlike the rest of the diagram symbols, which are meaningful elements throughout the model, annotations have their meaning principally within the context of the diagram in which they are placed. In this way a symbol can be annotated by different text pieces in different diagrams. </P>
-<P >
-There are no limitations concerning the number of annotations referring to one model element (neither per diagram nor per model). Annotations can refer to all classes of model elements, including both product components as well as the relationships between them (transitions and connections).</P>
-<h2>Creating an Annotation</h2>
-<p>To create an annotation:</p>
-<ul>
- <li>Select <strong>Annotations &gt; Annotation</strong> in the diagram toolbar palette.</li>
- <li>Place the annotation on the diagram canvas and fill in the annotation text.</li>
-</ul>
- <p class="image"><img src="images/mg-defdesk-create-annotation.png" alt="Create Annotation">
- <br><strong>Figure:</strong> Creating an Annotation</p>
-<p>To link the annotation to a model element:</p>
-<ul>
- <li>Right-click the model element and select <strong>Connect</strong>.</li>
-</ul>
- <p class="image"><img src="images/mg-defdesk-connect-annotation.png" alt="Connect Annotation">
- <br><strong>Figure:</strong> Connecting an Annotation</p>
+<h1>Using Annotations</h1>
+<p>Annotations are used as multiple-line textual and informative comments attached to the model element(s).
+An element can be annotated
+using different text pieces in different diagrams. There are no limitations concerning the number of annotations referring to one
+model element (neither per diagram nor per model).
+Annotations can refer to all model elements including transitions and connections. This chapter covers the following:</p>
+
<ul>
- <li>Click the model element to connect the annotation to.</li>
+ <li><a href="#cra">Creating an Annotation</a></li>
+ <li><a href="#uan">Using Annotation Flyout Menu</a></li>
+ <li><a href="#anp">Viewing and Editing Annotation Properties</a></li>
</ul>
- <p class="image"><img src="images/mg-defdesk-connect-annotation-2.png" alt="Connect Annotation">
- <br><strong>Figure:</strong> Connecting to a Model Element</p>
-<P >
-Annotation text is displayed in a box and can be entered after the annotation symbol has been created. It supports copy and paste functionality conventional for the platform and leaves the decision where the return carriages should be placed to the user (no automatic reformatting).</P>
-<P>If you want to add text as annotation to the diagram without connecting it to a symbol and not displayed in a box, just choose <strong>Annotations &gt; Text</strong> in the diagram menu and place the text on the diagram canvas with the mouse.</P>
+
+<h2 id="cra">Creating an Annotation</h2>
+<p>To create an annotation, perform the following steps:</p>
+<ol>
+ <li>In the toolbar, click the <strong>Create Annotations</strong> icon </li>
+ <p class="image"><img src="images/cr-annotation.png" alt="Create Annotation">
+ <br><strong>Figure:</strong> Create an Annotation</p>
+
+ <li>Drop it near the element in the process diagram canvas to which you want to associate an annotation</li>
+ <p class="image"><img src="images/drop-annotation.png" alt="Create Annotation">
+ <br><strong>Figure:</strong> Drop Annotation on the Element</p>
+ <li>Double-click on the annotation symbol to specify the annotation text</li>
+ <p class="image"><img src="images/specify-annot.png" alt="Create Annotation">
+ <br><strong>Figure:</strong> Specify Annotation</p>
+ <!-- <li>Hover the mouse over the annotation symbol and click the <strong>Connect</strong> icon to connect it with the element</li>
+ <p class="image"><img src="images/connect-annot.png" alt="Create Annotation">
+ <br><strong>Figure:</strong> Connect Annotation to the element</p> -->
+</ol>
+<h2 id="uan">Using Annotation Flyout Menu</h2>
+<p>To view the annotation flyout menu, hover the mouse in the proximity of the annotation symbol
+added in the process diagram canvas.</p>
+
+<p>To delete the annotation, click the <strong>Delete</strong> icon. The annotation gets deleted.</p>
+
+<p class="image"><img src="images/hover-annotation.png" alt="Create Annotation">
+ <br><strong>Figure:</strong> Annotation Flyout Menu - Delete Icon</p>
+<h2 id="anp">Viewing and Editing Annotation Properties</h2>
+
+<p>To edit and view the properties of the annotation, click the annotation symbol in the
+process diagram canvas. The properties window is displayed
+in the top-right corner of the swim lane.</p>
+
+<p class="image"><img src="images/prop-annot.png" alt="Create Annotation">
+ <br><strong>Figure:</strong> Annotation Properties</p>
+<p>You can specify annotation text in the <strong>Content</strong> text box.</p>
+
+
<script language="JavaScript">
<!--
writeFooter();
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm
index 3468341..b91a1b3 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm
@@ -12,8 +12,8 @@
<body>
<script language="JavaScript" type="text/javascript">
<!--
- writeNavigation("Modeling Session Log","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
- "pep-events.htm","pep-session-log.htm",
+ writeNavigation("Using Annotations","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
+ "pep-events.htm","pep-annotation.htm",
"../../toc.html","Business Process Modeling Handbook");
-->
</script>
@@ -143,18 +143,27 @@ Existing elements can be dragged across lanes.
<h2 id="ges">Element Gestures</h2>
<p>To work with elements, you can use following gestures.</p>
-<h3>Clicking and Dragging a Element</h3>
+<ul>
+ <li><a href="#drag">Clicking and Dragging a Element</a></li>
+ <li><a href="#hov">Hovering the Mouse Over the Element</a></li>
+ <li><a href="#dou">Double-clicking an Element</a></li>
+ <li><a href="#click">Clicking an Element</a></li>
+ <li><a href="#ele">Dragging and Dropping of Elements</a></li>
+</ul>
+
+
+<h3 id="drag">Clicking and Dragging a Element</h3>
<p>Click on the element icon in the toolbar and place it in the lane.
Then, click on element and drag it from one lane to any another lane.
The connections
to elements remain intact.</p>
-<h3>Hovering the Mouse Over the Element</h3>
+<h3 id="hov">Hovering the Mouse Over the Element</h3>
<p>When you hover the mouse in the proximity of any element in the lane the Flyout Menu is displayed.
Also, when you hover the mouser over the element its outline changes to red color.</p>
<p class="image"><img src="images/hover-menu.png"
alt="Mouse Hover - Flyout Menu" /> <br>
<strong>Figure:</strong> Mouse Hover - Flyout Menu</p>
-<h3>Double-clicking an Element</h3>
+<h3 id="dou">Double-clicking an Element</h3>
<p>To rename the activity or subprocess activity and application, double-click on its
element name in the swim lane and specify new name.
</p>
@@ -162,7 +171,7 @@ element name in the swim lane and specify new name.
alt="Double-click on Activity Elements" /> <br>
<strong>Figure:</strong> Double-click on Activity Element</p>
-<h3>Clicking an Element</h3>
+<h3 id="click">Clicking an Element</h3>
<p>When you click any element in the swim lane, the Property panel of that element is displayed at
the right side of the swim lane. Also, the element gets selected and you can move the element across lanes.</p>
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-session-log.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-session-log.htm
index c7329d7..f5b90ed 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-session-log.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-session-log.htm
@@ -12,7 +12,7 @@
<script language="JavaScript" type="text/javascript">
<!--
writeNavigation("","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
- "pep-pools-lanes.htm","",
+ "pep-annotation.htm","",
"../../toc.html","Business Process Modeling Handbook");
-->
</script>
diff --git a/org.eclipse.stardust.docs.analyst/html/toc.html b/org.eclipse.stardust.docs.analyst/html/toc.html
index 1fda9f1..dd4ddba 100644
--- a/org.eclipse.stardust.docs.analyst/html/toc.html
+++ b/org.eclipse.stardust.docs.analyst/html/toc.html
@@ -49,6 +49,7 @@ It is intended for business analyst who can use it to create business process fl
<li><a href="handbooks/modelling_analyst/pep-org-struct.htm">Modeling the Organizational Structure</a></li>
<li><a href="handbooks/modelling_analyst/pep-events.htm">Working with Events</a></li>
<li><a href="handbooks/modelling_analyst/pep-pools-lanes.htm">Swim Lanes Usage</a></li>
+ <li><a href="handbooks/modelling_analyst/pep-annotation.htm">Using Annotations</a></li>
<li><a href="handbooks/modelling_analyst/pep-session-log.htm">Modeling Session Log</a></li>
</ul>