[490360] Improve spec for this feature.

Bug: 490360
Change-Id: I7c2800ec6501d6aad7a99c5386ad894656b2420e
Signed-off-by: Laurent Redor <laurent.redor@obeo.fr>

8 files changed, 41 insertions, 0 deletions

diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.html b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.html
index 87a55210ac..1db594e8fc 100644
--- a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.html
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.html
@@ -24,6 +24,13 @@
 				<td>lredor</td>
 				<td>Initial version.</td>
 			</tr>
+			<tr>
+				<td>v0.2</td>
+				<td>PROPOSAL</td>
+				<td>2016-04-14</td>
+				<td>lredor</td>
+				<td>Initial version.</td>
+			</tr>
 		</table>
 		<p>
 			<em>Relevant tickets</em> :
@@ -51,12 +58,31 @@
 			<br/>
 			<img border="0" src="snapToAnotherBorderNode.png"/>
 		</p>
+		<p>To avoid too many snap guides, only center guides (horizontal and vertical) will be considered. Indeed, generally, the border nodes are small and the main goal of this feature is to align the center of border nodes. So contrary to other shapes where the guides are for bottom, center and top, or left, middle and right. Only center and middle guides are used for border nodes.</p>
 		<h3 id="Collapsedbordernodes">Collapsed border nodes</h3>
 		<p>The border node can be collapsed (with a filter for example). In this case:</p>
 		<ul>
 			<li>If the moved border node is collapsed, the collapsed border node is snapped to other shapes (not its expanded bounds).</li>
 			<li>If the moved border node is snapped to a collapsed border node, the behavior will be the same as other kind of nodes currently. It will be snapped to the collapsed border node (and not to its expanded bounds).</li>
 		</ul>
+		<p>For example in the below screenshot:</p>
+		<ul>
+			<li>A &#8211; All border nodes are collapsed through a filter. A collapsed border node is aligned to another collapsed border node.</li>
+			<li>B &#8211; This is the result.</li>
+			<li>C &#8211; And if the filter is disabled, border node are expanded and always aligned.</li>
+		</ul>
+		<p>
+			<img border="0" src="collapsedSnapToCollapsed.png"/>
+		</p>
+		<p>Another example with a snap of a normal border node to a collapsed one:</p>
+		<ul>
+			<li>A &#8211; Some border nodes are collapsed through a filter. A standard border node is aligned to a collapsed border node.</li>
+			<li>B &#8211; This is the result.</li>
+			<li>C &#8211; And if the filter is disabled, border node is expanded and always aligned.</li>
+		</ul>
+		<p>
+			<img border="0" src="nonCollapsedSnapToCollapsed.png"/>
+		</p>
 		<h3 id="Knownlimitations">Known limitations</h3>
 		<p>As a reminder (See 
 			<a href="https://www.eclipse.org/sirius/doc/user/sequences/Sequence%20Diagrams.html#introduction)">Sequence diagram introduction</a>, the snap features (snap to grid or snap to shapes) are disabled in sequence diagrams. This will obviously also the case for border nodes even with this improvement.
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.textile b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.textile
index cc43bd55b0..b17d22846d 100644
--- a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.textile
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/490360.textile
@@ -6,6 +6,7 @@ _Summary_: Allow the "Snap To Shapes" feature on border nodes.
 
 |_. Version |_. Status |_. Date        |_. Authors |_. Changes |
 | v0.1        | DRAFT    | 2016-03-24 | lredor    | Initial version. |
+| v0.2        | PROPOSAL    | 2016-04-14 | lredor    | Initial version. |
 
 _Relevant tickets_ :
 * "Bug 490360 - Allow the "Snap To Shapes" feature on border nodes":https://bugs.eclipse.org/bugs/show_bug.cgi?id=490360
@@ -22,12 +23,26 @@ The _Snap To Shapes_ feature is natively not supported by GMF. Probably because
 But with the option to "snap to all shapes" (with F4 shortcut key), this feature becomes interesting even for border nodes. To align "in" border node with "out" border node for example:
 !snapToAnotherBorderNode.png!
 
+To avoid too many snap guides, only center guides (horizontal and vertical) will be considered. Indeed, generally, the border nodes are small and the main goal of this feature is to align the center of border nodes. So contrary to other shapes where the guides are for bottom, center and top, or left, middle and right. Only center and middle guides are used for border nodes.
+
 h3. Collapsed border nodes
 
 The border node can be collapsed (with a filter for example). In this case:
 * If the moved border node is collapsed, the collapsed border node is snapped to other shapes (not its expanded bounds).
 * If the moved border node is snapped to a collapsed border node, the behavior will be the same as other kind of nodes currently. It will be snapped to the collapsed border node (and not to its expanded bounds).
 
+For example in the below screenshot:
+* A - All border nodes are collapsed through a filter. A collapsed border node is aligned to another collapsed border node.
+* B - This is the result.
+* C - And if the filter is disabled, border node are expanded and always aligned.
+!collapsedSnapToCollapsed.png!
+
+Another example with a snap of a normal border node to a collapsed one:
+* A - Some border nodes are collapsed through a filter. A standard border node is aligned to a collapsed border node.
+* B - This is the result.
+* C - And if the filter is disabled, border node is expanded and always aligned.
+!nonCollapsedSnapToCollapsed.png!
+
 h3. Known limitations
 
 As a reminder (See "Sequence diagram introduction":https://www.eclipse.org/sirius/doc/user/sequences/Sequence%20Diagrams.html#introduction), the snap features (snap to grid or snap to shapes) are disabled in sequence diagrams. This will obviously also the case for border nodes even with this improvement.
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/collapsedSnapToCollapsed.png b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/collapsedSnapToCollapsed.png
new file mode 100644
index 0000000000..61499667aa
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/collapsedSnapToCollapsed.png
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/collapsedSnapToCollapsedLarge.png b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/collapsedSnapToCollapsedLarge.png
new file mode 100644
index 0000000000..a2e7ce0cab
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/collapsedSnapToCollapsedLarge.png
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/nonCollapsedSnapToCollapsed.png b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/nonCollapsedSnapToCollapsed.png
new file mode 100644
index 0000000000..c829c50651
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/nonCollapsedSnapToCollapsed.png
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/nonCollapsedSnapToCollapsedLarge.png b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/nonCollapsedSnapToCollapsedLarge.png
new file mode 100644
index 0000000000..78db5041a4
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/nonCollapsedSnapToCollapsedLarge.png
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToAnotherBorderNode.png b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToAnotherBorderNode.png
index d4a147bd55..b19c7e2dfc 100644
--- a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToAnotherBorderNode.png
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToAnotherBorderNode.png
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToBrotherBorderNode.png b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToBrotherBorderNode.png
index 6de1d84080..f7c07ee205 100644
--- a/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToBrotherBorderNode.png
+++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490360_SnapToShapeForBorderNodes/snapToBrotherBorderNode.png