Update documentation for 6.4.2
Change-Id: I6216d1e5a7879003120dc9f53278eacb92700173
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
diff --git a/doc/Release_Notes.html b/doc/Release_Notes.html
index 74fb646..83d017b 100644
--- a/doc/Release_Notes.html
+++ b/doc/Release_Notes.html
@@ -13,6 +13,9 @@
<a href="#ReleaseNotesforSirius">Release Notes for Sirius</a>
<ol style="list-style: disc;">
<li>
+ <a href="#sirius6.4.2">Changes in Sirius 6.4.2</a>
+ </li>
+ <li>
<a href="#sirius6.4.1">Changes in Sirius 6.4.1</a>
</li>
<li>
@@ -143,6 +146,8 @@
<p>This document contains the release notes for recent major releases of Sirius. See also
<a href="Release_Notes_Previous.html">the release notes from previous versions</a> for details about older releases.
</p>
+ <h2 id="sirius6.4.2">Changes in Sirius 6.4.2</h2>
+ <p>This is service release with only bug fixes and minor improvements related to the new copy/paste format API introduced in 6.4.0.</p>
<h2 id="sirius6.4.1">Changes in Sirius 6.4.1</h2>
<p>This is service release to fix two issues which were not detected in time for 6.4.0. The issues only impact a new API which was introduced in 6.4.0 (Bug 563117 -
<em>Copy format to existing/new diagram based on source to target semantic elements mapping</em>).
diff --git a/doc/developer/copy_paste_format_new_semantic.html b/doc/developer/copy_paste_format_new_semantic.html
index 7aff5fe..f0aa549 100644
--- a/doc/developer/copy_paste_format_new_semantic.html
+++ b/doc/developer/copy_paste_format_new_semantic.html
@@ -9,13 +9,15 @@
<body>
<h1 id="CopyPasteFormatonnewsemantictargets">Copy-Paste Format on new semantic targets</h1>
<p>The current copy-paste format (layout and style) between diagrams relies on semantic target elements to find out which target element (paste) matches the source element (copy).</p>
- <p>This new API allows to perform this copy-paste format based on a semantic source to semantic target map. </p>
+ <p>This new API allows to perform this copy-paste format based on a semantic source to semantic target map.</p>
+ <p>As for the standard copy-paste format, only visible elements are concerned by the copy. So if elements are not visible in the source diagram, their styles and layouts will not be copied.</p>
<h2 id="APIdetails">API details</h2>
<p>A new API in
<code>org.eclipse.sirius.diagram.ui.tools.api.format.MappingBasedSiriusFormatManagerFactory</code> has been added to make it possible to apply a copy-paste format to an existing or a new diagram with different semantic targets.
</p>
<h3 id="Precondition">Precondition</h3>
<p>The target diagram should have the same description (same definition in the VSM) than the source one.</p>
+ <p>These methods update the models and need to have access to UI thread. According to these constraints, the methods must be called into a RecordingCommand and run in the UI Thread.</p>
<h3 id="Applythecopypastefromasourcediagramtoanexistingtargetdiagram">Apply the copy-paste from a source diagram to an existing target diagram</h3>
<pre> /**
* Apply format on {@code targetDiagram} based on the {@code sourceDiagram}. Format data are applied only for
@@ -44,6 +46,7 @@
</pre>
<p>This first method will perform the copy-paste format from a source diagram to an existing target diagram. The target elements on which the layout and style will be applied are retrieved by using the source-target correspondence map. </p>
<p>Note that if an element in the target diagram has no corresponding source element in the source diagram, this element will keep its current style and layout.</p>
+ <p>Elements not visible in the source diagram (hidden by user, because of a deactivated layer or because of a filter) are not considered by the copy-paste.</p>
<h3 id="Applythecopypastefromasourcediagramtoanewtargetdiagram">Apply the copy-paste from a source diagram to a new target diagram</h3>
<pre> /**
* Apply format on a new {@link DDiagram} for name {@code targetDiagramName} based on the {@code sourceDiagram}.
@@ -77,12 +80,14 @@
</pre>
<p>This method will create a new diagram, based on the correspondence map. The new diagram will be created only if the same source diagram description can be applied on the new semantic target. Once the new target diagram is created, the format from the source diagram is applied in the same way than the first method.</p>
<p>Only diagram elements for which an entry exists in the correspondence map will be created. If the new target diagram description has synchronized mapping (that means graphical elements are automatically created according to the mappings defined in the VSM), new graphical elements might appear. If those new graphical elements semantic targets have no entry in the correspondence map, they will not be formatted and will keep their default style and layout.</p>
+ <p>Elements not visible in the source diagram (hidden by user, because of a deactivated layer or because of a filter) are not considered by the copy-paste.</p>
<h3 id="FiltersandLayers">Filters and Layers</h3>
<p>Filters and layers activated in the source diagram are automatically activated in the target diagram.</p>
- <h3 id="Notes">Notes</h3>
- <p>If this option is activated (
- <code>copyNotes</code> parameter), existing notes in the source diagram are copied in the target diagram. If a note attachment exists in the source diagram, this one is also created in the target diagram, if the graphical target exists.
+ <h3 id="NotesandTexts">Notes and Texts</h3>
+ <p>If the corresponding option is activated (
+ <code>copyNotes</code> parameter), existing notes and texts in the source diagram are copied in the target diagram. If a note attachment exists in the source diagram, this one is also created in the target diagram, if the graphical target exists.
</p>
+ <p>The label of Note/Text and target of attachment are used to retrieve a potential existing Note/Text in the target diagram. In other words, if the label is different or if the target of attachment is different, a new Node/Text will be created. </p>
<h2 id="Sequencediagrams">Sequence diagrams</h2>
<p>The sequence diagram layout is linked to the semantic model: the vertical or horizontal graphical ordering perfectly match the semantic ordering.
<br/>Because of this constraint, this feature can only be applied between sequence diagrams with a perfect match between their semantic models. That means the target semantic model, on which the existing target sequence diagram or the new one are based on, has to be the exact copy of the source semantic model. All target semantic elements have to be present in the corresponding map and all source semantic elements have to be present in the map.
