diff options
| author | Pierre-Charles David | 2014-05-28 09:03:08 +0000 |
|---|---|---|
| committer | Maxime Porhel | 2014-05-28 09:34:45 +0000 |
| commit | 16a21e991ef8babd46e25493ddaa82e9f27bcf7b (patch) | |
| tree | dd8090c6757c7c095675e403a558a56ca8b2283a | |
| parent | 0b17d4c9cf447592499e15f7ad1f5666cfc32dbc (diff) | |
| download | org.eclipse.sirius-16a21e991ef8babd46e25493ddaa82e9f27bcf7b.tar.gz org.eclipse.sirius-16a21e991ef8babd46e25493ddaa82e9f27bcf7b.tar.xz org.eclipse.sirius-16a21e991ef8babd46e25493ddaa82e9f27bcf7b.zip | |
[435753] More documentation updates
Complete the previous commit with a few instances that were missed.
Bug: 435753
Change-Id: Ida87ea7d53fa3f620907473bfe10401dab1c050d
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
6 files changed, 82 insertions, 82 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html index 8e9d30d6e0..f7533b6dc2 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html @@ -299,7 +299,7 @@ <p id="mappings"> <strong>Mappings.</strong> All these graphical elements are described using the concept of a <em>mapping</em> (for example a - <em>Node Mapping</em> to describe a kind of nodes). A mapping is an element defined inside the VSM which identifies a sub-set of the elements in the semantic model and associates a graphical representation to them: it + <em>Node</em> mapping to describe a kind of nodes). A mapping is an element defined inside the VSM which identifies a sub-set of the elements in the semantic model and associates a graphical representation to them: it <em>maps</em> semantic elements onto some graphical notation. At runtime, each active mapping (i.e. defined in a layer which is enabled) will produce zero or more graphical elements on the diagram, depending on how many semantic elements currently match the mapping’s definition. In the default functioning mode, whenever the semantic model changes Sirius will automatically re-compute which graphical elements should appear on the diagram according to the active mappings, and create or remove the necessary elements. </p> <p>You can think of the set of mappings defined in a diagram as a description of how to @@ -398,8 +398,8 @@ </p> <h3 id="nodes">Nodes</h3> <p>A - <em>Node Mapping</em> is used to represent model elements graphically as atomic elements, i.e. elements which can not contain other elements. - <em>Node Mappings</em> can appear directly inside a layer description, in which case the node will appear directly on the diagram, or inside another element (for example a container). A node mapping which is defined inside another element can be either a + <em>Node</em> mapping is used to represent model elements graphically as atomic elements, i.e. elements which can not contain other elements. + <em>Node</em> mappings can appear directly inside a layer description, in which case the node will appear directly on the diagram, or inside another element (for example a container). A node mapping which is defined inside another element can be either a <em>sub-node mapping</em>, in which case it will appear inside its parent (which must be a container), or a <em>bordered node mapping</em>, in which case it will appear on the border of its parent (which may be a container or a node, including another bordered node). Bordered node mappings are useful to represent ports. </p> @@ -428,7 +428,7 @@ <p>The definition of a node mapping follows the general rules described <a href="#mappings">above</a> to determine the semantic elements for which a node should be created. All the properties available in the <em>Behavior</em> category of the - <em>Node Mapping</em> configuration allow you to see all the various tools, defined elsewhere in the VSM, which apply to this mapping. + <em>Node</em> mapping configuration allow you to see all the various tools, defined elsewhere in the VSM, which apply to this mapping. </p> <p>A node can not contain sub-nodes, but it can have <em>bordered nodes</em>, which are defined inside the node mapping ( @@ -436,7 +436,7 @@ <em>reuse</em> node mappings defined elsewhere in the VSM using the <em>Reused Bordered Node Mappings</em> property in the <em>Import</em> category. The effect at runtime is the same as if you had created an equivalent - <em>Bordered Node Mapping</em> inside the node mapping. + <em>Bordered Node</em> mapping inside the node mapping. </p> <p><div style="display: none"> <br/> @@ -579,7 +579,7 @@ </p> <p> <strong>Node Creation.</strong> The only type of tool which is really specific to node mappings is the - <em>Node Creation Tool</em>, used to create new nodes. These work like all the other creation tools. You simply specify the + <em>Node Creation</em> tool, used to create new nodes. These work like all the other creation tools. You simply specify the <em>Node Mappings</em> that this tool can create and specify the behavior of the tool inside the <em>Begin</em> element using all the standard <a href="../general/Model_Operations.html">model operations</a>. @@ -593,9 +593,9 @@ </p> <h3 id="containers">Containers</h3> <p>A - <em>Container Mapping</em> is used to represent model elements graphically as containers, which can contain sub-elements (including other containers, recursively). A container can also have + <em>Container</em> mapping is used to represent model elements graphically as containers, which can contain sub-elements (including other containers, recursively). A container can also have <em>bordered nodes</em>, which are like normal nodes but appear on the border of the container, for example to represent ports. - <em>Container Mappings</em> can appear directly inside a layer description, in which case the container will appear directly on the diagram, or inside another container mapping. + <em>Container</em> mappings can appear directly inside a layer description, in which case the container will appear directly on the diagram, or inside another container mapping. </p> <p> <img border="0" src="images/styles/Containers_on_diagram_or_another_container.png"/> @@ -603,7 +603,7 @@ <p>The definition of a container mapping follows the general rules described <a href="#mappings">above</a> to determine the semantic elements for which a container should be created. All the properties available in the <em>Behavior</em> category of the - <em>Container Mapping</em> configuration allow you to see all the various tools, defined elsewhere in the VSM, which apply to this mapping. + <em>Container</em> mapping configuration allow you to see all the various tools, defined elsewhere in the VSM, which apply to this mapping. </p> <p>A container can contain <em>sub-containers</em>, @@ -690,8 +690,8 @@ <em>Advanced</em> section) on which the tool should be applicable, even though these mapping can not contain containers of the type you will create. In this case, the container created by the tool will actually appear elsewhere on the diagram, but it can often help usability to allow users to click on related elements. </p> <p> - <strong>Container Drop Description</strong> You can associate a - <em>Container Drop Description</em> to your container mappings to react to drag’n’drop operations into the container. The + <strong>Container Drop</strong> You can associate a + <em>Container Drop</em> description to your container mappings to react to drag’n’drop operations into the container. The <em>Drag Source</em> property indicates if you want to react to graphical elements from a diagram, to semantic model elements dragged from another Eclipse view (for example from the <em>Model Explorer</em>), or both. The <em>Containers</em> property indicates for which drop kind of container mappings this tool applies. The @@ -930,7 +930,7 @@ <a href="#tools">tools</a> section for a general presentation of how tools are defined. This section only presents tools which are specific to edges. </p> <p> - <strong>Edge Creation Tool.</strong> This tool is used to create new edges. They work like all the other creation tools. You simply specify the + <strong>Edge Creation.</strong> This tool is used to create new edges. They work like all the other creation tools. You simply specify the <em>Edge Mappings</em> that this tool can create and specify the behavior of the tool inside the <em>Begin</em> element using all the standard <a href="../general/Model_Operations.html">model operations</a>. @@ -1189,7 +1189,7 @@ <p> <strong>Tools Applicability</strong>. Most tools apply to a set of <em>Mappings</em>, sometimes only on certain kinds of mappings (e.g. - <em>Container Drop Description</em> only makes sense for container mappings). For tools which create new elements, the + <em>Container Drop</em> description only makes sense for container mappings). For tools which create new elements, the <em>Mappings</em> correspond to the kinds of elements the tool will create. For other tools, it corresponds to the kinds of element the tool can be applied to. </p> <p>Many tools also support the notion of @@ -1265,15 +1265,15 @@ <p>See the description in the <a href="#edge_tools">edge-specific tools section</a>. </p> - <h4 id="container_drop">Container Drop Description</h4> + <h4 id="container_drop">Container Drop</h4> <p>See the description in the <a href="#container_tools">container-specific tools section</a>. </p> - <h4 id="reconnect_edge">Reconnect Edge Description</h4> + <h4 id="reconnect_edge">Reconnect Edge</h4> <p>See the description in the <a href="#edge_tools">edge-specific tools section</a>. </p> - <h4 id="paste_description">Paste Description</h4> + <h4 id="paste_description">Paste</h4> <p>The paste tool aims to define operations to paste the given copied semantic element, accessible through the <em>copiedElement</em> variable, into the semantic paste receiver, accessible through the <em>container</em> variable. The @@ -1290,10 +1290,10 @@ <strong>TODO</strong> Description not clear at all. <br/></div> </p> - <h4 id="delete_tool">Delete Element Description</h4> + <h4 id="delete_tool">Delete Element</h4> <p>If you do not associate a - <em>Delete Tool</em> to a mapping, the default delete behavior when the user deletes a graphical element is to remove the target semantic element and all the associated semantic elements from the semantic model. If you want a different behavior or if you want to forbid the deletion of some elements, you must set an explicit - <em>Delete Tool</em>. Delete tools are invoked when the user select the + <em>Delete</em> tool to a mapping, the default delete behavior when the user deletes a graphical element is to remove the target semantic element and all the associated semantic elements from the semantic model. If you want a different behavior or if you want to forbid the deletion of some elements, you must set an explicit + <em>Delete</em> tool. Delete tools are invoked when the user select the <em>Delete from model</em> action (from the context menu, from the tab-bar or using the <em>Delete</em> key). The <em>element</em> variable will be set to the main semantic target element being deleted (excluding any associated semantic elements) while the @@ -1301,7 +1301,7 @@ <em>containerView</em> tell you which graphical view is being deleted and in which context it is. </p> <p>If you want to completely disable deletion for some elements, you can either create a - <em>Delete Tool</em> which does nothing for these elements or, if possible, setup the tool’s + <em>Delete</em> tool which does nothing for these elements or, if possible, setup the tool’s <em>Precondition</em> to return <em>false</em> for these elements. Setting a precondition is usually preferred as it will mark the <em>Delete</em> action as disabled in the UI (tab-bar and context menu) while a tool which simply does nothing can still be invoked by users, but with no effect. Note however that the @@ -1329,9 +1329,9 @@ <p> <em>Note:</em> Edges can have up to three different labels (one in the center and one at each extremity), but currently if a <em>Direct Edit</em> tool is associated to an - <em>Edge Mapping</em>, only the center label (if it exists) can be edited. This restriction will probably be lifted in future versions. + <em>Edge</em> mapping, only the center label (if it exists) can be edited. This restriction will probably be lifted in future versions. </p> - <h4 id="selection_wizard">Selection Wizard Description</h4> + <h4 id="selection_wizard">Selection Wizard</h4> <p>This tool can be used to open a wizard dialog asking the user to select one or several model elements. The body of the tool is then executed in the context of the element selected by the user.</p> <p>When the tool is selected, the user must first select a diagram element as the tool’s target. Then a dialog box opens with a list of candidate elements to select. The list is computed from the target using expressions you specify in the tool’s description.</p> <p>The @@ -1354,10 +1354,10 @@ <p> <img border="0" src="images/styles/Selection_Tool.png"/> </p> - <h4 id="pane_based_selection_wizard">Pane-Based Selection Wizard Description</h4> + <h4 id="pane_based_selection_wizard">Pane-Based Selection Wizard</h4> <p>The <em>Pane-Based Selection Wizard</em> is very similar to the - <a href="#selection_wizard">Selection Wizard Description</a>. It differs only in the presentation of the selection window. The pane-based wizard offers two panels: on the left are all the candidates, which corresponds to the contents of the basic + <a href="#selection_wizard">Selection Wizard</a>. It differs only in the presentation of the selection window. The pane-based wizard offers two panels: on the left are all the candidates, which corresponds to the contents of the basic <em>Selection Wizard</em>. On the right is the current selection. The user has buttons to add or remove candidates from the left panel into the right one. The <em>Pre Selected Candidates Expression</em> can be used to define the initial content of the right-side panel. </p> @@ -1371,9 +1371,9 @@ </p> <h4 id="representation_creation">Representation Creation</h4> <p>Each dialect supported by Sirius defines a tool which can be used to create a new representation using this dialect. They are (using the default supported dialects): - <em>Diagram Creation Description</em>, - <em>Table Creation Description</em> and - <em>Tree Creation Description</em>. + <em>Diagram Creation</em> description, + <em>Table Creation</em> description and + <em>Tree Creation</em> description. </p> <p>These tools (one for each kind of representation supported by Sirius) can be used to create (and open) a new representation from an existing diagram element. They will be available to end-users in the <em>Navigate</em> context menu on compatible diagram elements. To configure the tool, simply select in the @@ -1390,9 +1390,9 @@ </p> <h4 id="representation_navigation">Representation Navigation</h4> <p>Each dialect supported by Sirius defines a tool which can be used to navigate to existing representation of this dialect. They are (using the default supported dialects): - <em>Diagram Navigation Description</em>, - <em>Table Navigation Description</em> and - <em>Tree Navigation Description</em>. + <em>Diagram Navigation</em> description, + <em>Table Navigation</em> description and + <em>Tree Navigation</em> description. </p> <p>These tools are very similar to the <a href="#representation_creation">representation creation tools</a>. The only differences is that they allow users to navigate to existing representation instead of creating new ones. If such a tool exists, the @@ -1401,7 +1401,7 @@ <em>Navigation name expression</em> ( <em>Advanced</em> category) to be used in the menu entry instead of using the title of the existing representation. This can be useful to make it more explicit what the relationship is between the current element and the target tree. </p> - <h4 id="double_click_tool">Double-Click Tool</h4> + <h4 id="double_click_tool">Double-Click</h4> <p>This tool is used to trigger operations when the user double-clicks on an element. The <em>Mappings</em> property indicate for what kinds of element this tool is applicable. </p> @@ -1434,9 +1434,9 @@ <em>External Java Action</em> tool simply creates a menu entry in the context menu which directly invokes any <a href="../general/Model_Operations.html#external_java_action">External Java Action</a> you can define. </p> - <h4 id="request_description">Request Description</h4> + <h4 id="request_description">Request</h4> <p>This tool is for advanced uses only. It requires understanding and extending GMF, the graphical framework used by Sirius to display diagrams. A - <em>Request Description</em> tool will contribute an item in the palette, and when invoked on a graphical element it will send a GMF request to the corresponding edit part. The type of the request to send is specified as a fixed string in the + <em>Request</em> description tool will contribute an item in the palette, and when invoked on a graphical element it will send a GMF request to the corresponding edit part. The type of the request to send is specified as a fixed string in the <em>Type</em> property. The target edit part should have an edit policy capable of understanding and reacting to the request. </p> <p><div style="display: none"> diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile index 9d5e304b10..ba285f4938 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile @@ -162,7 +162,7 @@ h4(#node_tools). Node Tools See the "tools":#tools section for a general presentation of how tools are defined. This section only presents tools which are specific to nodes. -*Node Creation.* The only type of tool which is really specific to node mappings is the _Node Creation Tool_, used to create new nodes. These work like all the other creation tools. You simply specify the _Node Mappings_ that this tool can create and specify the behavior of the tool inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +*Node Creation.* The only type of tool which is really specific to node mappings is the _Node Creation_ tool, used to create new nodes. These work like all the other creation tools. You simply specify the _Node Mappings_ that this tool can create and specify the behavior of the tool inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. By default, your node creation tools will be available on all the graphical elements which can contain an instance of the _Node Mappings_ you specified in the tool, and users will see a "forbidden" sign if they try to apply the tool on an incompatible type of element. You can specify a _Precondition_ to forbid the application of the tool on some of the elements where it would normally be allowed. The precondition is evaluated in the context of the _view element_ on which the user has put the mouse. If it returns a false value, the tool's application will be forbidden. Symmetrically, you can specify _Extra Mappings_ (_Advanced_ section) on which the tool should be applicable, even though these mapping can not contain nodes of the type you will create. In this case, the node created by the tool will actually appear elsewhere on the diagram, but it can often help usability to allow users to click on related elements. @@ -211,7 +211,7 @@ See the "tools":#tools section for a general presentation of how tools are defin By default, your container creation tools will be available on all the graphical elements which can contain an instance of the _Container Mappings_ you specified in the tool, and users will see a "forbidden" sign if they try to apply the tool on an incompatible type of element. You can specify a _Precondition_ to forbid the application of the tool on some of the elements where it would normally be allowed. The precondition is evaluated in the context of the _view element_ on which the user has put the mouse. If it returns a false value, the tool's application will be forbidden. Symmetrically, you can specify _Extra Mappings_ (_Advanced_ section) on which the tool should be applicable, even though these mapping can not contain containers of the type you will create. In this case, the container created by the tool will actually appear elsewhere on the diagram, but it can often help usability to allow users to click on related elements. -*Container Drop Description* You can associate a _Container Drop_ description to your container mappings to react to drag'n'drop operations into the container. The _Drag Source_ property indicates if you want to react to graphical elements from a diagram, to semantic model elements dragged from another Eclipse view (for example from the _Model Explorer_), or both. The _Containers_ property indicates for which drop kind of container mappings this tool applies. The _Mappings_ property indicates what kinds of graphical elements can be dropped into the specified containers, when the _Drag Source_ is _Diagram_ or _Both_. The body of the tool (the "model operations":../general/Model_Operations.html ) specify how to react when an element is dropped into a container. +*Container Drop* You can associate a _Container Drop_ description to your container mappings to react to drag'n'drop operations into the container. The _Drag Source_ property indicates if you want to react to graphical elements from a diagram, to semantic model elements dragged from another Eclipse view (for example from the _Model Explorer_), or both. The _Containers_ property indicates for which drop kind of container mappings this tool applies. The _Mappings_ property indicates what kinds of graphical elements can be dropped into the specified containers, when the _Drag Source_ is _Diagram_ or _Both_. The body of the tool (the "model operations":../general/Model_Operations.html ) specify how to react when an element is dropped into a container. __WARNING__: if you choose _Model_ or _Both_ as source, your tool must be prepared to accept any type of source element which can be present in the _Model Explorer_ view, including elements which have no relation to the source mappings you specified for the tool. Use a precondition to check the nature of the element being dragged (available through the @element@ variable) to disable the tool source elements your tool does not support. @@ -298,7 +298,7 @@ h4(#edge_tools). Edge Tools See the "tools":#tools section for a general presentation of how tools are defined. This section only presents tools which are specific to edges. -*Edge Creation Tool.* This tool is used to create new edges. They work like all the other creation tools. You simply specify the _Edge Mappings_ that this tool can create and specify the behavior of the tool inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +*Edge Creation.* This tool is used to create new edges. They work like all the other creation tools. You simply specify the _Edge Mappings_ that this tool can create and specify the behavior of the tool inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. Because edges have two ends, their creation requires users to specify both the source and target elements. By default, the possible sources are all the instances of one of the _Source Mappings_ specified for this kind of edge (and similarly for the possible targets). You can restrict this using the _Connection Start Precondition_ (resp. _Connection Complete Precondition_) to forbid the use of the tool from (resp. to) some element. @@ -458,15 +458,15 @@ h4(#edge_creation). Edge Creation See the description in the "edge-specific tools section":#edge_tools. -h4(#container_drop). Container Drop Description +h4(#container_drop). Container Drop See the description in the "container-specific tools section":#container_tools. -h4(#reconnect_edge). Reconnect Edge Description +h4(#reconnect_edge). Reconnect Edge See the description in the "edge-specific tools section":#edge_tools. -h4(#paste_description). Paste Description +h4(#paste_description). Paste The paste tool aims to define operations to paste the given copied semantic element, accessible through the _copiedElement_ variable, into the semantic paste receiver, accessible through the _container_ variable. The _copiedView_ and _containerView_ variables reference the corresponding graphical element. The _Containers_ property indicates the mappings to which this tool apply. @@ -478,11 +478,11 @@ Its semantic target is the copied semantic element. If the copied element was a *TODO* Description not clear at all. </div> -h4(#delete_tool). Delete Element Description +h4(#delete_tool). Delete Element -If you do not associate a _Delete Tool_ to a mapping, the default delete behavior when the user deletes a graphical element is to remove the target semantic element and all the associated semantic elements from the semantic model. If you want a different behavior or if you want to forbid the deletion of some elements, you must set an explicit _Delete Tool_. Delete tools are invoked when the user select the _Delete from model_ action (from the context menu, from the tab-bar or using the _Delete_ key). The _element_ variable will be set to the main semantic target element being deleted (excluding any associated semantic elements) while the _elementView_ and _containerView_ tell you which graphical view is being deleted and in which context it is. +If you do not associate a _Delete_ tool to a mapping, the default delete behavior when the user deletes a graphical element is to remove the target semantic element and all the associated semantic elements from the semantic model. If you want a different behavior or if you want to forbid the deletion of some elements, you must set an explicit _Delete_ tool. Delete tools are invoked when the user select the _Delete from model_ action (from the context menu, from the tab-bar or using the _Delete_ key). The _element_ variable will be set to the main semantic target element being deleted (excluding any associated semantic elements) while the _elementView_ and _containerView_ tell you which graphical view is being deleted and in which context it is. -If you want to completely disable deletion for some elements, you can either create a _Delete Tool_ which does nothing for these elements or, if possible, setup the tool's _Precondition_ to return _false_ for these elements. Setting a precondition is usually preferred as it will mark the _Delete_ action as disabled in the UI (tab-bar and context menu) while a tool which simply does nothing can still be invoked by users, but with no effect. Note however that the _Precondition_ will be evaluated each time the user selects and element to decide whether or not the delete action should be enabled in the UI. A precondition which is complex to evaluate can have a negative impact on the perceived performance of the modeler. +If you want to completely disable deletion for some elements, you can either create a _Delete_ tool which does nothing for these elements or, if possible, setup the tool's _Precondition_ to return _false_ for these elements. Setting a precondition is usually preferred as it will mark the _Delete_ action as disabled in the UI (tab-bar and context menu) while a tool which simply does nothing can still be invoked by users, but with no effect. Note however that the _Precondition_ will be evaluated each time the user selects and element to decide whether or not the delete action should be enabled in the UI. A precondition which is complex to evaluate can have a negative impact on the perceived performance of the modeler. h4(#direct_edit). Direct Edit Label @@ -495,7 +495,7 @@ Inside a _Direct Edit Label_ tool, you _must_ specify an _Edit Mask Variable_ el _Note:_ Edges can have up to three different labels (one in the center and one at each extremity), but currently if a _Direct Edit_ tool is associated to an _Edge_ mapping, only the center label (if it exists) can be edited. This restriction will probably be lifted in future versions. -h4(#selection_wizard). Selection Wizard Description +h4(#selection_wizard). Selection Wizard This tool can be used to open a wizard dialog asking the user to select one or several model elements. The body of the tool is then executed in the context of the element selected by the user. @@ -511,9 +511,9 @@ The _Candidates Expression_ should return a list of elements from which the user !images/styles/Selection_Tool.png! -h4(#pane_based_selection_wizard). Pane-Based Selection Wizard Description +h4(#pane_based_selection_wizard). Pane-Based Selection Wizard -The _Pane-Based Selection Wizard_ is very similar to the "Selection Wizard Description":#selection_wizard. It differs only in the presentation of the selection window. The pane-based wizard offers two panels: on the left are all the candidates, which corresponds to the contents of the basic _Selection Wizard_. On the right is the current selection. The user has buttons to add or remove candidates from the left panel into the right one. The _Pre Selected Candidates Expression_ can be used to define the initial content of the right-side panel. +The _Pane-Based Selection Wizard_ is very similar to the "Selection Wizard":#selection_wizard. It differs only in the presentation of the selection window. The pane-based wizard offers two panels: on the left are all the candidates, which corresponds to the contents of the basic _Selection Wizard_. On the right is the current selection. The user has buttons to add or remove candidates from the left panel into the right one. The _Pre Selected Candidates Expression_ can be used to define the initial content of the right-side panel. <div style="display: none"> *TODO* What is the context where the tool's body is executed if several elements are selected? @@ -533,7 +533,7 @@ Each dialect supported by Sirius defines a tool which can be used to navigate to These tools are very similar to the "representation creation tools":#representation_creation. The only differences is that they allow users to navigate to existing representation instead of creating new ones. If such a tool exists, the _Navigate_ context menu on an element will contains an entry for each corresponding representation which already exists on the element selected (or reachable from the selected element using the _Browse expression_). You can specify a _Navigation name expression_ (_Advanced_ category) to be used in the menu entry instead of using the title of the existing representation. This can be useful to make it more explicit what the relationship is between the current element and the target tree. -h4(#double_click_tool). Double-Click Tool +h4(#double_click_tool). Double-Click This tool is used to trigger operations when the user double-clicks on an element. The _Mappings_ property indicate for what kinds of element this tool is applicable. @@ -557,7 +557,7 @@ h4(#external_java_action). External Java Action The _External Java Action_ tool simply creates a menu entry in the context menu which directly invokes any "External Java Action":../general/Model_Operations.html#external_java_action you can define. -h4(#request_description). Request Description +h4(#request_description). Request This tool is for advanced uses only. It requires understanding and extending GMF, the graphical framework used by Sirius to display diagrams. A _Request_ description tool will contribute an item in the palette, and when invoked on a graphical element it will send a GMF request to the corresponding edit part. The type of the request to send is specified as a fixed string in the _Type_ property. The target edit part should have an edit policy capable of understanding and reacting to the request. diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.html b/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.html index 8324145bff..2ff1f5157d 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.html +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.html @@ -54,13 +54,13 @@ <a href="#mappings">Mappings</a> <ol style="list-style: disc;"> <li> - <a href="#InstanceRoleMapping">Instance Role Mapping</a> + <a href="#InstanceRole">Instance Role</a> </li> <li> - <a href="#ExecutionMappings">Execution Mappings</a> + <a href="#Executions">Executions</a> </li> <li> - <a href="#BasicMessageMapping">Basic Message Mapping</a> + <a href="#BasicMessages">Basic Messages</a> </li> </ol> </li> @@ -403,7 +403,7 @@ </li> </ul> <img border="0" src="images/mappings.png"/> - <h3 id="InstanceRoleMapping">Instance Role Mapping</h3> + <h3 id="InstanceRole">Instance Role</h3> <p>Firstly, create the instance role mapping. It graphically corresponds to the box at the top of the lifeline.</p> <img border="0" src="images/new_instance_role_mapping.png"/> <p>Set the mandatory properties @@ -415,7 +415,7 @@ <p>The Semantic Candidates Expression is an Acceleo expression returning the semantic elements for which the mapping will be evaluated and then a graphical element will represent the semantic element on the diagram.</p> <p>Don’t forget to create a new Style for the instance role mapping.</p> <img border="0" src="images/instance_role_mapping_style.png"/> - <h3 id="ExecutionMappings">Execution Mappings</h3> + <h3 id="Executions">Executions</h3> <p>Execution mappings are used when you have an element which is composed by a start, a duration and a finish element. </p> <p>We will define the execution mappings:</p> <img border="0" src="images/new_execution_mapping.png"/> @@ -449,7 +449,7 @@ <img border="0" src="images/execution_mapping_reused.png"/> <p>For both execution mappings, don’t forget to create a New Style:</p> <img border="0" src="images/execution_mapping_style.png"/> - <h3 id="BasicMessageMapping">Basic Message Mapping</h3> + <h3 id="BasicMessages">Basic Messages</h3> <p>Now, we will define the basic message mapping:</p> <img border="0" src="images/new_message_mapping.png"/> <p>Create the basic message mapping:</p> @@ -494,7 +494,7 @@ </li> </ul> <img border="0" src="images/basic_message_mapping_visual3.png"/> - <h4 id="LostandFoundmessages">Lost and Found messages</h4> + <h4 id="LostandFoundMessages">Lost and Found Messages</h4> <p>Standard node mappings, direct children of a layer of the current sequence diagram description, can be used to represent the unknown message end. Lost and found messages should be created using a generic tool.</p> <h2 id="tools">Tools</h2> <h3 id="JavaServices">Java Services</h3> diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.textile index ce26d35f2b..c34cc0cc04 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.textile +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/sequences/Sequence Diagrams.textile @@ -178,7 +178,7 @@ We want to represent on a sequence diagram four different elements and then asso !images/mappings.png! -h3. Instance Role Mapping +h3. Instance Role Firstly, create the instance role mapping. It graphically corresponds to the box at the top of the lifeline. @@ -194,7 +194,7 @@ Don't forget to create a new Style for the instance role mapping. !images/instance_role_mapping_style.png! -h3. Execution Mappings +h3. Executions Execution mappings are used when you have an element which is composed by a start, a duration and a finish element. @@ -230,7 +230,7 @@ For both execution mappings, don't forget to create a New Style: !images/execution_mapping_style.png! -h3. Basic Message Mapping +h3. Basic Messages Now, we will define the basic message mapping: @@ -261,7 +261,7 @@ Set the mandatory properties: !images/basic_message_mapping_visual3.png! -h4. Lost and Found messages +h4. Lost and Found Messages Standard node mappings, direct children of a layer of the current sequence diagram description, can be used to represent the unknown message end. Lost and found messages should be created using a generic tool. diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/tables/Tables.html b/plugins/org.eclipse.sirius.doc/doc/specifier/tables/Tables.html index fb67c5f8de..f44c9703cb 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/tables/Tables.html +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/tables/Tables.html @@ -162,14 +162,14 @@ </ul> <h3 id="line_mappings">Line Mappings</h3> <p>The lines which will appear in a table (and their organization in sub-lines) are defined by the - <em>Line Mapping</em> elements inside the + <em>Line</em> mapping elements inside the <em>Table Description</em> element. A <em>Table Description</em> contains - <em>Line Mappings</em> which define which elements will appear as top-level lines of the table, while each - <em>Line Mapping</em> can contain sub-mappings which define its own direct sub-lines. If an element (the table or a line mapping) contains several sub-mappings, the element’s content will appear in the order of the mappings: first all the instances of the first mapping, then the instances of the second one, etc. + <em>Line</em> mappings which define which elements will appear as top-level lines of the table, while each + <em>Line</em> mapping can contain sub-mappings which define its own direct sub-lines. If an element (the table or a line mapping) contains several sub-mappings, the element’s content will appear in the order of the mappings: first all the instances of the first mapping, then the instances of the second one, etc. </p> <p>A - <em>Line Mapping</em> is defined by a + <em>Line</em> mapping is defined by a <em>Domain Class</em> and a <em>Semantic Candidates Expression</em>. The <em>Semantic Candidates Expression</em> indicates where to look in the semantic model for elements which should be represented by the mapping. The expression is evaluated in the context of the parent’s semantic element (the parent being either the table itself or a parent line). It should return a set of semantic elements. Only those which are instances of the specified @@ -185,7 +185,7 @@ <em>Label</em> category) is evaluated in the context of a line’s target and should return the text to be shown for the line in the header column (on the left of the table). </p> <p>A - <em>Line Mapping</em> may + <em>Line</em> mapping may <em>Reuse Sub Lines</em> (see the <em>Import</em> category), including itself, as sub-mappings. The effect is exactly the same as if the reused mapping(s) were created as children if the parent. However because a mapping can reuse itself or one of its parent mapping, this allows to create table of infinite depth (or at least not bounded a priori). The <em>Reused in Mappings</em> property is the symmetrical of @@ -224,13 +224,13 @@ </ul> <h3 id="feature_column_mapping">Feature Column Mappings</h3> <p>The columns which will appear in an edition table are defined by the - <em>Feature Column Mapping</em> elements inside the + <em>Feature Column</em> mapping elements inside the <em>Table Description</em> element. They are named - <em>Feature Column Mappings</em> because they normally represent a property (maybe computed) of the elements which are represented by the table’s lines, and also to distinguish them from the kind of columns which appear in + <em>Feature Column</em> mappings because they normally represent a property (maybe computed) of the elements which are represented by the table’s lines, and also to distinguish them from the kind of columns which appear in <a href="#cross_tables">cross tables</a>. </p> <p>A - <em>Feature Column Mapping</em> is defined by its + <em>Feature Column</em> mapping is defined by its <em>Feature Name</em>, which should normally be the name of a valid feature (attribute or reference) of the element which appear in the tables' lines. If a line represents a semantic element <em>S1</em> but you want on some column to show a property of an element reachable from <em>S1</em> instead of @@ -288,12 +288,12 @@ <em>Create Column Tools</em>, which behave exactly like <em>Create Line</em> tools, except that they apply to <a href="#element_column_mapping"> - <em>Element Column Mappings</em> + <em>Element Column</em> mappings </a> (see below) and are used to create new columns in the table. </p> <h3 id="element_column_mapping">Element Column Mappings</h3> <p>In cross tables, columns represent elements instead of elements' properties (as is the case for edition tables). The set of columns is defined by one or more - <em>Element Column Mappings</em>. They are almost identical to + <em>Element Column</em> mappings. They are almost identical to <a href="#line_mappings">line mappings</a>, except that: </p> <ul> @@ -304,7 +304,7 @@ </li> </ul> <p> - <em>Element Column Mappings</em> can contain a + <em>Element Column</em> mappings can contain a <em>Create Column Tool</em> and a <em>Delete Column Tool</em>, which are specified and behave in a similar way than the <em>Create Line</em> and @@ -314,7 +314,7 @@ <p>They can also contain style definitions (including conditional style), which apply to all the cells in the column (unless overridden by the intersection mapping). For a given cell, the styles defined on the column mapping overrides the styles which are defined on the line mapping (if any).</p> <h3 id="intersection_mapping">Intersection Mappings</h3> <p>The line and element column mappings in a cross table define which lines and columns will be present in the tables, but not the contents of the cells. This is defined by - <em>Intersection Mappings</em>. The + <em>Intersection</em> mappings. The <em>Line Mapping</em> and <em>Column Mapping</em> properties indicate which cells the mapping describes. The <em>Label Expression</em>, evaluated in the context of the cell’s targets semantic element, should return the text to show in the cell, while the @@ -349,7 +349,7 @@ </p> <h4 id="intersection_mapping_style">Intersection Style</h4> <p>An - <em>Intersection Mapping</em> can contain style elements, including conditional styles. If they are present, they override any style set on the corresponding column mapping or line mapping. + <em>Intersection</em> mapping can contain style elements, including conditional styles. If they are present, they override any style set on the corresponding column mapping or line mapping. </p> <h4 id="intersection_mapping_tools">Intersection Tools</h4> <p>Intersection mappings can contain two kinds of tools:</p> diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/trees/Trees.html b/plugins/org.eclipse.sirius.doc/doc/specifier/trees/Trees.html index 3d561a12b7..ebf2ba602f 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/trees/Trees.html +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/trees/Trees.html @@ -132,7 +132,7 @@ <p>The main concepts which define a tree are:</p> <ul> <li> - <em>Tree Item Mappings</em>, which describe the elements that will appear on this tree, and how they map to the underlying semantic elements they represent; + <em>Tree Item</em> mappings, which describe the elements that will appear on this tree, and how they map to the underlying semantic elements they represent; </li> <li> <em>Styles</em>, which describe the graphical appearance of these representation elements; @@ -171,7 +171,7 @@ <code>element</code> variable) to disable the tool source elements your tool does not support. </li> <li> - <em>Tree Creation Description</em>: This tool can be used to create (and open) a new tree from an existing tree item. It will be available to end-users in the + <em>Tree Creation</em>: This tool can be used to create (and open) a new tree from an existing tree item. It will be available to end-users in the <em>Navigate</em> context menu on compatible tree items. To configure the tool, simply select in the <em>Mappings</em> property which kinds of tree items the tool should appear on (you can be more precise using the <em>Precondition</em> expression if necessary), and select which kind of tree should be created using the @@ -180,7 +180,7 @@ <em>Advanced</em> category) to navigate from the element selected to the one one which the new tree should actually be created. Finally, any operation you specify in the body of the tool will be executed when the tool is invoked; you can use it to initialize the content of the model represented. </li> <li> - <em>Tree Navigation Description</em>: This tool is very similar to the previous one. The only differences is that it allows users to navigate to existing trees instead of creating new ones. If such a tool exists, the + <em>Tree Navigation</em>: This tool is very similar to the previous one. The only differences is that it allows users to navigate to existing trees instead of creating new ones. If such a tool exists, the <em>Navigate</em> context menu on an item will contains an entry for each corresponding tree which already exists on the element selected (or reachable from the selected element using the <em>Browse expression</em>). You can specify a <em>Navigation name expression</em> ( @@ -189,13 +189,13 @@ </ul> <h2 id="mappings">Tree Item Mappings</h2> <p>Trees are recursive by nature. There contents is specified using a single concept of - <em>Tree Item Mapping</em> which can be composed recursively. A + <em>Tree Item</em> mapping which can be composed recursively. A <em>Tree Description</em> contains - <em>Tree Item Mappings</em> which define which elements will appear at the top-level of the tree, while each - <em>Tree Item Mapping</em> can contain sub-mappings which define its own direct content. If an element (the tree or a tree item mapping) contains several sub-mappings, the element’s content will appear in the order of the mappings: first all the instances of the first mapping, then the instances of the second one, etc. + <em>Tree Item</em> mappings which define which elements will appear at the top-level of the tree, while each + <em>Tree Item</em> mapping can contain sub-mappings which define its own direct content. If an element (the tree or a tree item mapping) contains several sub-mappings, the element’s content will appear in the order of the mappings: first all the instances of the first mapping, then the instances of the second one, etc. </p> <p>A - <em>Tree Item Mapping</em> is defined by a + <em>Tree Item</em> mapping is defined by a <em>Domain Class</em>, a <em>Semantic Candidates Expression</em> and an optional <em>Precondition Expression</em> (in the @@ -210,11 +210,11 @@ <em>Advanced Category</em>), which is evaluated in the context of the target and may return more semantic elements. Any change in the target element or one of the associated elements will automatically trigger a refresh of the tree item. </p> <p>A - <em>Tree Item Mapping</em> may + <em>Tree Item</em> mapping may <em>Specialize</em> another mapping, in which case it will inherit all of the specialized mapping’s properties for which it does not specify an explicit value. </p> <p>A - <em>Tree Item Mapping</em> may + <em>Tree Item</em> mapping may <em>Reuse</em> (see the <em>Imports</em> category) existing mappings, including itself, as sub-mappings. The effect is exactly the same as if the reused mapping(s) were created as children if the parent. However because a mapping can reuse itself or one of its parent mapping, this allows to create trees of infinite depth (or at least not bounded a priori). </p> @@ -237,7 +237,7 @@ <em>Advanced</em> category). This is especially useful if you have several items which represent different aspects of the same semantic element and thus share the same target. </p> <p> - <em>Tree Item Mappings</em> can have one ore more + <em>Tree Item</em> mappings can have one ore more <em>Conditional Style</em>. They are normal style elements with the same properties as described above, but wrapped in a <em>Conditional Style</em> element which defines a boolean expression. If an item mapping contains such styles, then for each instance of the mapping, the conditional styles will first be tried, in the order of their definitions. The first style whose condition returns <code>true</code> for the item’s target is used (and the remaining ones are not tested). If none of the conditional style apply, the default one is used. Note that because the conditions are tested in the order of definition, you should order them from the most likely to the least likely to optimize performance. @@ -270,7 +270,7 @@ </li> <li> <em>Drop Tool</em>: When defined inside a - <em>Tree Item Mapping</em>, a + <em>Tree Item</em> mapping, a <em>Drop Tool</em> specifies what happens when the user drops an element onto an instance of the mapping. The <em>Drag source</em> property indicates whether the tool accepts elements dragged from a tree representation (value <em>Tree</em>), from the |