Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Grouhan2015-03-23 14:53:20 +0000
committerPierre-Charles David2015-03-23 15:02:03 +0000
commitb5db7d12d19686374a316f6da830ab7b96c032d2 (patch)
treed34354ad84038d2506d0b9470c5154b45ab6e64d
parenta66d240c6266370aad32c5e38a0d2ab9930c0e76 (diff)
downloadorg.eclipse.sirius-b5db7d12d19686374a316f6da830ab7b96c032d2.tar.gz
org.eclipse.sirius-b5db7d12d19686374a316f6da830ab7b96c032d2.tar.xz
org.eclipse.sirius-b5db7d12d19686374a316f6da830ab7b96c032d2.zip
[460712] Add documentation for the quick outlinev3.0.0M6
Bug: 460712 Change-Id: I9edf3c4f6af32bb2222705bd9cbadef3cbc75776 Signed-off-by: Benjamin Grouhan <benjamin.grouhan@obeo.fr>
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html21
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.textile8
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/general/images/quick_outline.pngbin0 -> 108501 bytes
3 files changed, 29 insertions, 0 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html
index 6449271c08..9573f754d0 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html
@@ -40,6 +40,9 @@
<a href="#model_operations">Model Operations</a>
</li>
<li>
+ <a href="#quick_outline">Quick Outline</a>
+ </li>
+ <li>
<a href="#validation">VSM Validation</a>
</li>
<li>
@@ -321,6 +324,24 @@
<em>Model Operations</em> to do so. Refer to the
<a href="Model_Operations.html">Model Operations documentation</a> for more details.
</p>
+ <h3 id="quick_outline">Quick Outline</h3>
+ <p>When defining your
+ <em>VSM</em>, a quick outline is available with the shortcut
+ <code>Ctrl</code> +
+ <code>O</code>. This allows you to rapidly search text in the displayed name or the contained String attributes of your
+ <em>VSM</em> elements.
+ </p>
+ <p>The star,
+ <code>*</code>, is a joker character, allowing you to search with more complicated patterns. Regarding this, an element is found if there is a word in its name or one of its attributes that match with the text in the filter, so if you want to search within words too, add
+ <code>*</code> at the start of your pattern. Also, you can navigate along the matching elements with
+ <code>↑</code> and
+ <code>↓</code>, and go to the selected element in your
+ <em>VSM</em> with
+ <code>Enter</code>.
+ </p>
+ <p>
+ <img border="0" src="images/quick_outline.png"/>
+ </p>
<h3 id="validation">VSM Validation</h3>
<p>It is possible to validate your
<a href="../../Glossary.html#VSM">
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.textile
index bd6e2a7fc7..dedff0cad8 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.textile
@@ -114,6 +114,14 @@ h3(#model_operations). Model Operations
Whenever a _VSM_ requires you to specify a behavior, for example inside any _Tool_ definition, you can use any of the available _Model Operations_ to do so. Refer to the "Model Operations documentation":Model_Operations.html for more details.
+h3(#quick_outline). Quick Outline
+
+When defining your _VSM_, a quick outline is available with the shortcut @Ctrl@ + @O@. This allows you to rapidly search text in the displayed name or the contained String attributes of your _VSM_ elements.
+
+The star, @*@, is a joker character, allowing you to search with more complicated patterns. Regarding this, an element is found if there is a word in its name or one of its attributes that match with the text in the filter, so if you want to search within words too, add @*@ at the start of your pattern. Also, you can navigate along the matching elements with @↑@ and @↓@, and go to the selected element in your _VSM_ with @Enter@.
+
+!images/quick_outline.png!
+
h3(#validation). VSM Validation
It is possible to validate your "_Viewpoint Specification Model_":../../Glossary.html#VSM , to check that your Representations, Mappings and Tools are correctly specified. It will help you to find missing element or erroneous one (e.g. missing required expression).
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/general/images/quick_outline.png b/plugins/org.eclipse.sirius.doc/doc/specifier/general/images/quick_outline.png
new file mode 100644
index 0000000000..61f8890b60
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/general/images/quick_outline.png
Binary files differ

Back to the top