Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPierre-Charles David2016-03-11 16:35:59 +0000
committerPierre-Charles David2016-03-21 09:31:42 +0000
commit7b6dac390119069e35f8760d1fa360bba4d53a92 (patch)
treed500aa8225fc203eed44a99fa6f2c7f202fcea5a
parentb81b53cf852ab0e53169684eedfab83b54ea9a0b (diff)
downloadorg.eclipse.sirius-7b6dac390119069e35f8760d1fa360bba4d53a92.tar.gz
org.eclipse.sirius-7b6dac390119069e35f8760d1fa360bba4d53a92.tar.xz
org.eclipse.sirius-7b6dac390119069e35f8760d1fa360bba4d53a92.zip
[489416] Clarify MTL services syntax in documentation
Bug: 489416 Change-Id: I87a931dd8a76174a8d698585da40a43d5d0c9b10 Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.html4
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.textile2
2 files changed, 4 insertions, 2 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.html b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.html
index 500bcb17c3..d0d6b3ea6a 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.html
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.html
@@ -226,7 +226,9 @@
<code>.mtl</code> files in you Sirius project, the parent
<em>Viewpoint</em> element must have a
<em>Java Extension</em> element which references the MTL file, using the
- <code>com::example::domain::design::module</code> syntax. Also make sure to read <a href="http://www.obeonetwork.com/page/building-an-acceleo-generator" target="_blank">http://www.obeonetwork.com/page/building-an-acceleo-generator</a> to ensure the project is built correctly, or the queries defined in the
+ <code>com::example::domain::design::module</code> syntax (note that the qualified name does not contain the
+ <code>.mtl</code> or
+ <code>.emtl</code> file extension). Also make sure to read <a href="http://www.obeonetwork.com/page/building-an-acceleo-generator" target="_blank">http://www.obeonetwork.com/page/building-an-acceleo-generator</a> to ensure the project is built correctly, or the queries defined in the
<code>.mtl</code> files may not be available when the project is deployed as a plug-in.
</p>
<p>
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.textile
index f32367974c..6002d3c122 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/general/Writing_Queries.textile
@@ -78,7 +78,7 @@ Acceleo expressions are enclosed in brackets: <code>[theExpression/]</code>. Ins
Note that Acceleo expressions used inside VSMs *must* be enclosed inside a single bracket. It is not currently possible to mix Acceleo expressions and fixed text (like @"prefix[someExpression/]suffix"@). Instead, you can use Acceleo's string manipulation operations to obtain the same result: <code>[&apos;prefix&apos; + someExpression + &apos;suffix&apos;/]</code>). Related to this, auto-completion only works if you are inside a well-formed bracket (i.e. <code>[&lt;cursor&gt;/]</code>); if you have simply opened the bracket but not closed it (i.e. <code>[&lt;cursor&gt;</code>), completion will not be available.
-Acceleo expressions can transparently invoke methods from Java classes which follow the "service methods":#service_methods conventions and have been properly declared in the VSM. Note that currently this only works if the Java service class is in the same project as the _VSM_. You can also invoke Acceleo _queries_ defined in @.mtl@ files in your Viewpoint Specification Project. For this to work, your Viewpoint Specification Project should be an Acceleo Generator project, you can convert the project with the _Configure > Toggle Acceleo Nature_ contextual menu. If you want to use queries from @.mtl@ files in you Sirius project, the parent _Viewpoint_ element must have a _Java Extension_ element which references the MTL file, using the @com::example::domain::design::module@ syntax. Also make sure to read <a href="http://www.obeonetwork.com/page/building-an-acceleo-generator" target="_blank">http://www.obeonetwork.com/page/building-an-acceleo-generator</a> to ensure the project is built correctly, or the queries defined in the @.mtl@ files may not be available when the project is deployed as a plug-in.
+Acceleo expressions can transparently invoke methods from Java classes which follow the "service methods":#service_methods conventions and have been properly declared in the VSM. Note that currently this only works if the Java service class is in the same project as the _VSM_. You can also invoke Acceleo _queries_ defined in @.mtl@ files in your Viewpoint Specification Project. For this to work, your Viewpoint Specification Project should be an Acceleo Generator project, you can convert the project with the _Configure > Toggle Acceleo Nature_ contextual menu. If you want to use queries from @.mtl@ files in you Sirius project, the parent _Viewpoint_ element must have a _Java Extension_ element which references the MTL file, using the @com::example::domain::design::module@ syntax (note that the qualified name does not contain the @.mtl@ or @.emtl@ file extension). Also make sure to read <a href="http://www.obeonetwork.com/page/building-an-acceleo-generator" target="_blank">http://www.obeonetwork.com/page/building-an-acceleo-generator</a> to ensure the project is built correctly, or the queries defined in the @.mtl@ files may not be available when the project is deployed as a plug-in.
_Note:_ due to an incompatible change in serialization format in EMF 2.9, if you use external @.mtl@ files in your modeler definitions and build your modeler plug-ins using EMF 2.9 or later, the resulting modeler will not work with previous versions of EMF (as the resulting @.emtl@ files will not load correctly with EMF 2.8 and earlier). For reference, EMF 2.9 corresponds to Eclipse 4.3 (Kepler).

Back to the top