Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlorian Barbin2017-05-19 15:05:47 +0000
committerFlorian Barbin2017-05-19 15:07:37 +0000
commit045818d87118f5a9f6dddce79df9d691ade270a8 (patch)
treea7e4d4123c62fec4668ce9c601c9e7c8136ada57
parente386cb2a13a25894cc9c3463d7b7075107f73b7c (diff)
downloadorg.eclipse.sirius-045818d87118f5a9f6dddce79df9d691ade270a8.tar.gz
org.eclipse.sirius-045818d87118f5a9f6dddce79df9d691ade270a8.tar.xz
org.eclipse.sirius-045818d87118f5a9f6dddce79df9d691ade270a8.zip
[479049] Adds Specifier documentation for the feature name field.
Bug: 479049 Change-Id: I9393cc9568eb55735d84686412eac9a12a7ae90b Signed-off-by: Florian Barbin <florian.barbin@obeo.fr>
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html18
-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/featureName.pngbin0 -> 19174 bytes
3 files changed, 26 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 564348c77a..0ab46ee7f2 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
@@ -37,6 +37,9 @@
<a href="#interpreted_expressions">Interpreted Expressions</a>
</li>
<li>
+ <a href="#feature_name">Feature Name</a>
+ </li>
+ <li>
<a href="#translatable_messages">Translatable Messages</a>
</li>
<li>
@@ -328,6 +331,21 @@
<p>
<img border="0" src="images/textAreaDialog.png"/>
</p>
+ <h3 id="feature_name">Feature Name</h3>
+ <p>Some
+ <em>VSM</em> elements will need you to specify a
+ <em>Feature Name</em> (or
+ <em>Reference Name</em> on
+ <em>Create Instance</em>) to configure them (Create Instance, Set, Unset, etc.). You can easily identify
+ <em>Feature Name</em> fields by their light green background in the
+ <em>Properties</em> sheet of an element.
+ </p>
+ <p>
+ <img border="0" src="images/featureName.png"/>
+ </p>
+ <p>Auto-completion is available in these fields using the
+ <em>Ctrl+Space</em> shortcut except if the current element type cannot be inferred, usually in the case of a generic tool where the target element will be known only at runtime.
+ </p>
<h3 id="translatable_messages">Translatable Messages</h3>
<p>Many
<em>VSM</em> elements provide text fields that will be displayed when end-users reference the
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 7da06975c9..d8ec433458 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
@@ -113,6 +113,14 @@ Also, by clicking on the button next to the text field, you can open a dialog wi
!images/textAreaDialog.png!
+h3(#feature_name). Feature Name
+
+Some _VSM_ elements will need you to specify a _Feature Name_ (or _Reference Name_ on _Create Instance_) to configure them (Create Instance, Set, Unset, etc.). You can easily identify _Feature Name_ fields by their light green background in the _Properties_ sheet of an element.
+
+!images/featureName.png!
+
+Auto-completion is available in these fields using the _Ctrl+Space_ shortcut except if the current element type cannot be inferred, usually in the case of a generic tool where the target element will be known only at runtime.
+
h3(#translatable_messages). Translatable Messages
Many _VSM_ elements provide text fields that will be displayed when end-users reference the _VSM_ in a modeling project (Viewpoint name, tools...). Starting from Sirius 4.0, the value shown to the end users can be localized according to the user's language. Fields which support this feature are called _Translatable_ _Messages_ and can be easily identified by their blue background in the _Properties_ sheet of an element.
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/general/images/featureName.png b/plugins/org.eclipse.sirius.doc/doc/specifier/general/images/featureName.png
new file mode 100644
index 0000000000..7ae02b07be
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/general/images/featureName.png
Binary files differ

Back to the top