Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPierre-Charles David2017-09-08 05:00:18 -0400
committerPierre-Charles David2017-09-08 05:13:46 -0400
commitbf46808af145d943439cd6c8fb4fa4665e15740f (patch)
tree4fb44f9a677d00d8bb6db18845e58e0e3b9961b1
parent422ae26154673e565c48cf2ca2c730ff339eb045 (diff)
downloadorg.eclipse.sirius-bf46808af145d943439cd6c8fb4fa4665e15740f.tar.gz
org.eclipse.sirius-bf46808af145d943439cd6c8fb4fa4665e15740f.tar.xz
org.eclipse.sirius-bf46808af145d943439cd6c8fb4fa4665e15740f.zip
[519566] Document how to refer to external VSMs for properties customizationsv5.0.2rc2v5.0.2
Bug: 519566 Change-Id: I05f749a44569df4a0d7f53e25637af81f27aad6a Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.html26
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.textile8
2 files changed, 34 insertions, 0 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.html b/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.html
index 39b763c1da..55f1ac0e41 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.html
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.html
@@ -1405,6 +1405,32 @@
<a href="#extends">extension</a> and the
<a href="#overrides">overriding</a>.
</p>
+ <p>Note that both mechanisms can be used to customize properties view descriptions which are defined in other projects. To allow references from you VSM to elements defined in other modelers, you must first
+ <em>load</em> them in your VSM editor, or you will not see the elements you need as targets for extension/overriding. To load an external VSM, right-click anywhere inside the VSM editor, and select
+ <em>Load Resource...</em>. A dialog will appear asking for the URI of the model to load (the
+ <code>.odesign</code> file you want to refer to). Several forms of URIs are possible:
+ </p>
+ <ul>
+ <li>If you don&#8217;t have the customized plug-in in your workspace, you must currently enter the URI manually, using the syntax
+ <code>platform:/plugin/&lt;projectName&gt;/&lt;path&gt;/&lt;to&gt;/&lt;example&gt;.odesign</code>, for example
+ <code>platform:/plugin/org.eclipse.emf.ecoretools.design/description/ecore.odesign</code>.
+ </li>
+ <li>If the VSM you want to extend is already present in your development workspace, you can use the
+ <em>Browse Workspace...</em> button to select it.
+ </li>
+ </ul>
+ <p>Note that in the later case (VSM selected from the workspace), if you want to test your modeler directly from your development environment, in your test session make sure to select the extended VSM
+ <strong>from the workspace</strong>, as this is the one your own VSM refers to, and not the one which may also be avaible from your plug-ins. In the viewpoint selection dialog, the version from the workspace will have a small folder decorator in addition to the normal viewpoint icon. Once everything is deployed as plug-ins, which is the nominal case for end-users, this distinction disappears and everything should work fine.
+ </p>
+ <p>Note also that if you define in your project
+ <em>A</em> customizations for properties views defintions defined in another project
+ <em>B</em>, you should make sure to declare the dependency in project
+ <em>A</em>'s
+ <code>MANIFEST.MF</code>, otherwise it will be possible for users to install
+ <em>A</em> without having
+ <em>B</em> available, which will prevent
+ <em>A</em> from working correctly.
+ </p>
<h3 id="extends">Extends</h3>
<p>A
<a href="#pages">page</a> can extend another page defined somewhere else (in another
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.textile
index 3fe7acf334..61b9a3a3cd 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/properties/Properties_View_Description.textile
@@ -557,6 +557,14 @@ h2(#extensibility_features). Extensibility Features
Sirius has specific support for extending and overriding properties view descriptions without modifying the original one. The purpose is to be able to reuse or modify a part of a properties view. Its exits two different concepts to customize a properties view description: the "extension":#extends and the "overriding":#overrides.
+Note that both mechanisms can be used to customize properties view descriptions which are defined in other projects. To allow references from you VSM to elements defined in other modelers, you must first _load_ them in your VSM editor, or you will not see the elements you need as targets for extension/overriding. To load an external VSM, right-click anywhere inside the VSM editor, and select _Load Resource..._. A dialog will appear asking for the URI of the model to load (the @.odesign@ file you want to refer to). Several forms of URIs are possible:
+* If you don't have the customized plug-in in your workspace, you must currently enter the URI manually, using the syntax @platform:/plugin/<projectName>/<path>/<to>/<example>.odesign@, for example @platform:/plugin/org.eclipse.emf.ecoretools.design/description/ecore.odesign@.
+* If the VSM you want to extend is already present in your development workspace, you can use the _Browse Workspace..._ button to select it.
+
+Note that in the later case (VSM selected from the workspace), if you want to test your modeler directly from your development environment, in your test session make sure to select the extended VSM *from the workspace*, as this is the one your own VSM refers to, and not the one which may also be avaible from your plug-ins. In the viewpoint selection dialog, the version from the workspace will have a small folder decorator in addition to the normal viewpoint icon. Once everything is deployed as plug-ins, which is the nominal case for end-users, this distinction disappears and everything should work fine.
+
+Note also that if you define in your project _A_ customizations for properties views defintions defined in another project _B_, you should make sure to declare the dependency in project _A_'s @MANIFEST.MF@, otherwise it will be possible for users to install _A_ without having _B_ available, which will prevent _A_ from working correctly.
+
h3(#extends). Extends
A "page":#pages can extend another page defined somewhere else (in another "category":#categories or in another properties view description). This mechanism is used to _specialize_ (modify or re-use) an existing page. This feature is available for the "pages":#pages, the "groups":#groups, the "containers":#containers_and_layout, the "dynamic mappings":#dynamic_mappings and the "widgets":#widgets.

Back to the top