Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpguilet2017-06-27 09:36:06 +0000
committerPierre Guilet2017-06-27 13:18:14 +0000
commitd320406fcbd1a67cbdb0b6d055332cfca706c449 (patch)
tree171d6108571f5c1a5eca546b057c7ea559902a7d
parent0fd0d931e7cdd0d055055894299f24ea391793ee (diff)
downloadorg.eclipse.sirius-d320406fcbd1a67cbdb0b6d055332cfca706c449.tar.gz
org.eclipse.sirius-d320406fcbd1a67cbdb0b6d055332cfca706c449.tar.xz
org.eclipse.sirius-d320406fcbd1a67cbdb0b6d055332cfca706c449.zip
[517049] update aird editor documentation
Bug: 517049 Change-Id: I7a2d850007f5e9d09eca1689773cf704a82a984b Signed-off-by: pguilet <pierre.guilet@obeo.fr>
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.html49
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.textile19
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_create_rep_double_click.pngbin51992 -> 51250 bytes
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_full.pngbin168540 -> 207084 bytes
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_new_rep_menu.pngbin95155 -> 119865 bytes
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_representation.pngbin0 -> 31292 bytes
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_uncontrol.pngbin0 -> 55275 bytes
7 files changed, 57 insertions, 11 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.html b/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.html
index 3474cc27bb..5563cbd27d 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.html
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.html
@@ -41,7 +41,7 @@
<a href="#model_creation_wizard">Creating New Models</a>
</li>
<li>
- <a href="#removing_model">Removing a Model From The aird Editor</a>
+ <a href="#removing_model">Removing Model Dependencies And Representations From The Aird Editor</a>
</li>
<li>
<a href="#quick_editing">Models Quick Editing</a>
@@ -256,16 +256,49 @@
<code>aird</code> file and have a generated name.
</li>
</ul>
- <h3 id="removing_model">Removing a Model From The aird Editor</h3>
- <p>To remove a semantic model loaded in the aird file, just select it in the editor and click on the
+ <h3 id="removing_model">Removing Model Dependencies And Representations From The Aird Editor</h3>
+ <p>To remove a
+ <strong>representation</strong> from the aird file, you can either select it in the editor and click on the
<strong>
<i>Remove</i>
- </strong> button. This action does not delete the physical file.
+ </strong> button. Or use the right click contextual action
+ <strong>
+ <i>Delete</i>
+ </strong> or the
+ <strong>
+ <i>DEL</i>
+ </strong> keyboard key.
+ </p>
+ <p>To remove
+ <strong>models dependencies</strong>, you must select it or one of its children elements in the editor and click on the
+ <strong>
+ <i>Remove</i>
+ </strong> button. Note that this action does not delete the physical model file.
+ </p>
+ <p>The removal can be applied only if some rules are respected. If they are not, the remove button will still be active and its activation, will inform you of the reasons why you cannot proceed the removal.</p>
+ <p>The rules regarding models dependencies removal are the following :</p>
+ <ul>
+ <li>A model dependency cannot be removed if at least one of its element contains a representation. Note that the representation can be invisible if the viewpoint providing it is not enabled.</li>
+ </ul>
+ <p>
+ <img border="0" src="images/aird_editor_remove_semantic_model_representation.png"/>
</p>
- <p>Note that if you are working inside a project with the
- <em>Modeling</em> nature, it is not possible to remove a semantic model which is located inside the project. Indeed, the
- <em>Modeling</em> nature ensures that all model files stored inside the project are always loaded in the project&#8217;s
- <code>aird</code> file.
+ <ul>
+ <li>A model dependency cannot be removed if you are working inside a project with the
+ <em>Modeling</em> nature and the semantic model is located inside this project. Indeed, the
+ <em>Modeling</em> nature ensures that all model files stored inside the project are always loaded in the project&#8217;s
+ <code>aird</code> file.
+ </li>
+ </ul>
+ <ul>
+ <li>A model dependency cannot be removed if it is a fragment of a model. In this situation you need to use the
+ <strong>
+ <i>Uncontrol</i>
+ </strong> action to remove it.
+ </li>
+ </ul>
+ <p>
+ <img border="0" src="images/aird_editor_remove_semantic_model_uncontrol.png"/>
</p>
<h3 id="quick_editing">Models Quick Editing</h3>
<p>The normal way to display and edit models with Sirius is to do it through one or several Sirius-defined representations (
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.textile b/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.textile
index 4a2eee6c66..507d5430a7 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/Aird_Editor.textile
@@ -115,11 +115,24 @@ The aird editor features a generic model creation wizard that can be used to cre
* Once the metamodel is selected, the second page asks for the type of the root element in the new model file. By default Sirius will try to infer good candidates for this root element type, and show only those. You can deselect the _Show only suggested root types_ checkbox to reveal *all* the concrete types defined in the metamodel you selected.
* Finally, the third page of the wizard will ask you for the name and location of the new file to create. By default, the file will be created in the same project as the @aird@ file and have a generated name.
-h3(#removing_model). Removing a Model From The aird Editor
+h3(#removing_model). Removing Model Dependencies And Representations From The Aird Editor
-To remove a semantic model loaded in the aird file, just select it in the editor and click on the *__Remove__* button. This action does not delete the physical file.
+To remove a *representation* from the aird file, you can either select it in the editor and click on the *__Remove__* button. Or use the right click contextual action *__Delete__* or the *__DEL__* keyboard key.
-Note that if you are working inside a project with the _Modeling_ nature, it is not possible to remove a semantic model which is located inside the project. Indeed, the _Modeling_ nature ensures that all model files stored inside the project are always loaded in the project's @aird@ file.
+To remove *models dependencies*, you must select it or one of its children elements in the editor and click on the *__Remove__* button. Note that this action does not delete the physical model file.
+
+The removal can be applied only if some rules are respected. If they are not, the remove button will still be active and its activation, will inform you of the reasons why you cannot proceed the removal.
+
+The rules regarding models dependencies removal are the following :
+* A model dependency cannot be removed if at least one of its element contains a representation. Note that the representation can be invisible if the viewpoint providing it is not enabled.
+
+!images/aird_editor_remove_semantic_model_representation.png!
+
+* A model dependency cannot be removed if you are working inside a project with the _Modeling_ nature and the semantic model is located inside this project. Indeed, the _Modeling_ nature ensures that all model files stored inside the project are always loaded in the project's @aird@ file.
+
+* A model dependency cannot be removed if it is a fragment of a model. In this situation you need to use the *__Uncontrol__* action to remove it.
+
+!images/aird_editor_remove_semantic_model_uncontrol.png!
h3(#quick_editing). Models Quick Editing
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_create_rep_double_click.png b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_create_rep_double_click.png
index 2631653df1..1f4a6cb791 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_create_rep_double_click.png
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_create_rep_double_click.png
Binary files differ
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_full.png b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_full.png
index 8f13913495..5b627ba115 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_full.png
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_full.png
Binary files differ
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_new_rep_menu.png b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_new_rep_menu.png
index 7106cc7090..402a6f071c 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_new_rep_menu.png
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_new_rep_menu.png
Binary files differ
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_representation.png b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_representation.png
new file mode 100644
index 0000000000..f5cbdddb2c
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_representation.png
Binary files differ
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_uncontrol.png b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_uncontrol.png
new file mode 100644
index 0000000000..9d8993b8c0
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/general/images/aird_editor_remove_semantic_model_uncontrol.png
Binary files differ

Back to the top