Skip to content

Commit

Permalink
Update website for Sirius Desktop 7.4.3
Browse files Browse the repository at this point in the history 
Signed-off-by: Pierre-Charles David <[email protected]>
  • Loading branch information
@pcdavid
pcdavid committed Sep 5, 2024
1 parent cdbffe6 commit c470385
Show file tree
Hide file tree
Showing 10 changed files with 130 additions and 20 deletions.
2 changes: 1 addition & 1 deletion sirius/doc/Release_Notes_Previous.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ <h2 id="sirius6.4.0">Changes in Sirius 6.4.0</h2>
</li>
<li>
<b>The server parts which supported the Workflow feature</b>. It was our first experiment in moving Sirius to the web, but this is now replaced by the newly published
<a href="https://www.eclipse.org/sirius/sirius-web.html">Sirius Web</a>. This corresponds to all the
<a href="https://www.eclipse.dev/sirius/sirius-web.html">Sirius Web</a>. This corresponds to all the
<code>org.eclipse.sirius.server.*</code> plug-ins.
</li>
</ul>
Expand Down
37 changes: 22 additions & 15 deletions sirius/doc/i18n_changes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,15 @@ <h1 id="TranslationKeysChanges">Translation Keys Changes</h1>
<p>This document lists the changes in
<code>TranslatableMessage</code> used for Sirius internationalization in each Sirius version.
</p>
<h2 id="sirius740">Translation Keys Changes in Sirius 7.4.0 (from Sirius 7.3.0)</h2>
<h2 id="sirius743">Translation Keys Changes in Sirius 7.4.3 (from Sirius 7.4.0)</h2>
<h3 id="MessageKeysAdded">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.tools.api.Messages.ToolManagement_sha256_instanciation</code>
</li>
</ul>
<h2 id="sirius740">Translation Keys Changes in Sirius 7.4.0 (from Sirius 7.3.0)</h2>
<h3 id="MessageKeysAdded2">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.tools.api.Messages.ImageManager_projectMembersFailure</code>
Expand Down Expand Up @@ -208,7 +215,7 @@ <h3 id="MessageKeysRemoved">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius730">Translation Keys Changes in Sirius 7.3.0 (from Sirius 7.2.1)</h2>
<h3 id="MessageKeysAdded2">Message Keys Added</h3>
<h3 id="MessageKeysAdded3">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.DiagramGeneralPreferencePage_newlyCreatedElementsGroupLabel</code>
Expand All @@ -233,7 +240,7 @@ <h3 id="MessageKeysAdded2">Message Keys Added</h3>
</li>
</ul>
<h2 id="sirius707">Translation Keys Changes in Sirius 7.0.7 (from Sirius 7.0.6)</h2>
<h3 id="MessageKeysAdded3">Message Keys Added</h3>
<h3 id="MessageKeysAdded4">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.tree.ui.provider.Messages.AbstractDTreeItemRunnableWithProgress_emptyDTreeItemsParameter</code>
Expand Down Expand Up @@ -261,7 +268,7 @@ <h3 id="MessageKeysRemoved2">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius702">Translation Keys Changes in Sirius 7.0.2 (from Sirius 7.0.1)</h2>
<h3 id="MessageKeysAdded4">Message Keys Added</h3>
<h3 id="MessageKeysAdded5">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.ChangeMassivelyImagePathDialog_newLabel</code>
Expand Down Expand Up @@ -298,7 +305,7 @@ <h3 id="MessageKeysAdded4">Message Keys Added</h3>
</li>
</ul>
<h2 id="sirius701">Translation Keys Changes in Sirius 7.0.1 (from Sirius 7.0.0)</h2>
<h3 id="MessageKeysAdded5">Message Keys Added</h3>
<h3 id="MessageKeysAdded6">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.SVGImageRegistry_LoadImageError</code>
Expand Down Expand Up @@ -356,7 +363,7 @@ <h3 id="MessageKeysRenamedorMoved">Message Keys Renamed or Moved</h3>
</ul>
</li>
</ul>
<h3 id="MessageKeysAdded6">Message Keys Added</h3>
<h3 id="MessageKeysAdded7">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.viewpoint.provider.Messages.AnalysisSelectorFilteredItemsSelectionDialog_labelProviderLocal</code>
Expand Down Expand Up @@ -423,7 +430,7 @@ <h3 id="MessageKeysRemoved3">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius660">Translation Keys Changes in Sirius 6.6.0 (from Sirius 6.5.0)</h2>
<h3 id="MessageKeysAdded7">Message Keys Added</h3>
<h3 id="MessageKeysAdded8">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.sequence.ui.Messages.SequenceEMFCommandFactory_notSupportedZorderCommandsMessage</code>
Expand Down Expand Up @@ -473,7 +480,7 @@ <h3 id="MessageKeysAdded7">Message Keys Added</h3>
</ul>
<h3 id="MessageKeysRemoved4">Message Keys Removed</h3>
<h2 id="sirius650">Translation Keys Changes in Sirius 6.5.0 (from Sirius 6.4.0)</h2>
<h3 id="MessageKeysAdded8">Message Keys Added</h3>
<h3 id="MessageKeysAdded9">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.RepairEdgesWithOneBendpointMigrationParticipant_edgesModified</code>
Expand Down Expand Up @@ -657,7 +664,7 @@ <h3 id="MessageKeysRemoved5">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius640">Translation Keys Changes in Sirius 6.4.0 (from Sirius 6.3.2)</h2>
<h3 id="MessageKeysAdded9">Message Keys Added</h3>
<h3 id="MessageKeysAdded10">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.DDiagramEditorImpl_error_representationRefresh</code>
Expand Down Expand Up @@ -784,14 +791,14 @@ <h3 id="MessageKeysRemoved6">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius632">Translation Keys Changes in Sirius 6.3.2 (from Sirius 6.3.1)</h2>
<h3 id="MessageKeysAdded10">Message Keys Added</h3>
<h3 id="MessageKeysAdded11">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.viewpoint.Messages.DRepresentationDescriptorQuery_representationError</code>
</li>
</ul>
<h2 id="sirius631">Translation Keys Changes in Sirius 6.3.1 (from Sirius 6.3.0)</h2>
<h3 id="MessageKeysAdded11">Message Keys Added</h3>
<h3 id="MessageKeysAdded12">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.BundledImageShape_idMissing</code>
Expand Down Expand Up @@ -822,7 +829,7 @@ <h3 id="MessageKeysRemoved7">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius61">Translation Keys Changes in Sirius 6.1 (from Sirius 6.0)</h2>
<h3 id="MessageKeysAdded12">Message Keys Added</h3>
<h3 id="MessageKeysAdded13">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.common.ui.Messages.MigrationUIUtil_askToSaveChanges</code>
Expand Down Expand Up @@ -961,7 +968,7 @@ <h3 id="MessageKeysRemoved8">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius60">Translation Keys Changes in Sirius 6.0 (from Sirius 5.1)</h2>
<h3 id="MessageKeysAdded13">Message Keys Added</h3>
<h3 id="MessageKeysAdded14">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.ui.provider.Messages.DiagramGeneralPreferencePage_sizeGroupLabel</code>
Expand Down Expand Up @@ -1175,7 +1182,7 @@ <h3 id="MessageKeysRemoved9">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius51">Translation Keys Changes in Sirius 5.1 (from Sirius 5.0)</h2>
<h3 id="MessageKeysAdded14">Message Keys Added</h3>
<h3 id="MessageKeysAdded15">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.diagram.sequence.Messages.Range_wrongArgument</code>
Expand Down Expand Up @@ -1341,7 +1348,7 @@ <h3 id="MessageKeysRemoved10">Message Keys Removed</h3>
</li>
</ul>
<h2 id="sirius50">Translation Keys Changes in Sirius 5.0 (from Sirius 4.1)</h2>
<h3 id="MessageKeysAdded15">Message Keys Added</h3>
<h3 id="MessageKeysAdded16">Message Keys Added</h3>
<ul>
<li>
<code>org.eclipse.sirius.common.acceleo.aql.business.Messages.AQLInterpreter_errorWithExpression</code>
Expand Down
89 changes: 88 additions & 1 deletion sirius/doc/specifier/diagrams/Diagrams.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,94 @@ <h4 id="useElk">Use an ELK layout algorithm</h4>
<p>To get an overview of what is possible with ELK you can read this
<a href="https://blog.obeosoft.com/a-picture-is-worth-a-thousand-words">article</a>.
</p>
<h4 id="Useacustomlayoutalgorithm">Use a custom layout algorithm</h4>
<h5 id="elkRoutingStyleRules">Specific rules for routing style of edges</h5>
<p>Since Sirius 7.4.1, the routing styles used in Sirius diagrams are considered. They are ignored before and default ELK value was used.
<br/>In ELK, all the edges of a same container must have the same routing style. So the default translation rules between Sirius and ELK are the following:
</p>
<ul>
<li>If all edges have the same routing style, this routing style is used for all edges.</li>
<li>If there is a mix between different routing styles, the most used routing style is used for all edges.</li>
<li>If there is a mix between different routing styles and they are used the same number of times, the Oblique rotuing style has priority over Rectilinear routing style, which itself has priority over Tree routing style.</li>
</ul>
<p>&#8220;Tree routing style&#8221; does not exist on ELK, so currently it is considered as &#8220;Rectilinear&#8221; for ELK. The result with a diagram using &#8220;Tree routing style&#8221; is not guarantee.</p>
<p>If the parameter
<a href="https://eclipse.dev/elk/reference/options/org-eclipse-elk-edgeRouting.html">Edge Routing</a> is set in the VSM, it has the priority on the routing styles used in the diagram.
</p>
<h5 id="elkDebug">ELK Debug capabilities</h5>
<p>
<b>A- Specific actions to export diagram as ELK file</b>
</p>
<p>The Sirius ELK bridge offers some debug capabilities.
<br/>A first step to setting up an ELK layout is, quite often, to do so in a &#8220;pure ELK world&#8221; without the Sirius bridge. For that, with the plug-in
<code>org.eclipse.sirius.diagram.elk.debug</code> installed, it is possible to export a Sirius diagram in ELK Graph file (elkg or elkt):
<br/>
<img border="0" src="images/elkExportActionsContextualMenu.png"/>
</p>
<ul>
<li>&#8220;Export diagram as ELK Graph&#8221; creates an elkg file (with XMI format). This format is no longer used on ELK side.</li>
<li>&#8220;Export diagram as ELK Text&#8221; creates an elkt file (with ELK Text format). This format is used, for example, by the
<a href="https://rtsys.informatik.uni-kiel.de/elklive/elkgraph.html">ELKLive editor</a>. With this file, you can then check the effect of parameters directly on ELK side.
</li>
</ul>
<p>By default, these files are created in the Java temporary folder (
<code>java.io.tmpdir</code>, for example under Windows:
<code>%USER%\AppData\Local\Temp</code>). But since Sirius 7.4.2, you can configure the folder path with the system property
<code>org.eclipse.sirius.diagram.elk.targetFolderPath</code>. If this property is not set (or is invalid), the Java temporary folder is used. The value of this system property can contains variables names, like in the definition of the workspace data folder in a launch configuration. For example:
</p>
<ul>
<li>
<code>${container_loc}</code>: Returns the absolute file system path of the session&#8217;s container (container of the AIRD * file),
</li>
<li>
<code>${project_loc}</code>: Returns the absolute file system path of a session&#8217;s project,
</li>
<li>or
<code>${workspace_loc}</code>: Returns the absolute file system path of the workspace root.
</li>
</ul>
<p>
<b>Warning:</b> If you use a the &#8220;VM arguments&#8221; field in the launch configuration, you must replace the
<code>"$"</code> by a
<code>"%"</code> to avoid a replacement of the variables during the launch (and not by ElkDiagramLayoutTracer during export).
</p>
<p>
<b>B- Debug trace</b>
</p>
<p>It is possible to activate the debug trace for plug-in &#8220;org.eclipse.sirius.diagram.elk&#8221;:
<br/>
<img border="0" src="images/elkTracing.png"/>
</p>
<ul>
<li>
<code>debug</code>: Turn on debugging for the org.eclipse.sirius.diagram.elk
</li>
<li>
<code>debug/export_as_text</code>: Export diagram as ELK text format, elkt file, during each steps of the layout process
</li>
<li>
<code>debug/export_as_xmi</code>: Export diagram as ELK graph format, elkg file, during each steps of the layout process (ignored if
<code>debug/export_as_text</code> is enabled)
</li>
</ul>
<p>If enabled, this creates multiple ELK files at each step of the Sirius&#8217;s internal layout process (in
<code>org.eclipse.sirius.diagram.elk.ElkDiagramLayoutConnector</code> and in
<code>org.eclipse.sirius.diagram.elk.ELKLayoutNodeProvider</code>. This makes it easier, for example, to debug when an activated ELK option does not have the expected result.
</p>
<p>6 files are generated:
<br/>
<img border="0" src="images/elkFilesGeneratedDuringArrangeWithELK.png"/>
<br/>1- &#8220;initialState&#8221;: The result of the conversion made by Sirius.
<br/>2- &#8220;beforeELKLayout&#8221;: The result once we have applied the specific processing added via the
<code>beforeELKLayout(LayoutMapping)</code> method by the
<code>org.eclipse.sirius.diagram.elk.layout.extension</code> extension point.
<br/>3- &#8220;afterELKLayout&#8221;: The result once ELK has done its layout work.
<br/>4- &#8220;afterExtensionUpdate&#8221;: The result once we have applied the specific processing added via the
<code>afterELKLayout(LayoutMapping)</code> method by the
<code>org.eclipse.sirius.diagram.elk.layout.extension</code> extension point.
<br/>5- &#8220;afterAddingOffset&#8221;: The result once ELK has shifted the root nodes.
<br/>6- &#8220;afterResetOrigin&#8221;: The result once Sirius has applied the equivalent of the &#8220;Reset Origin&#8221; action.
</p>
<h4 id="custumLayout">Use a custom layout algorithm</h4>
<p>If you need to go beyond what already exists, you can provide your own layout algorithm programmatically (see the
<a href="../../developer/Sirius%20Developer%20Manual.html">developer documentation</a> for details).
</p>
Expand Down
Binary file added sirius/doc/specifier/diagrams/images/elkExportActionsContextualMenu.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sirius/doc/specifier/diagrams/images/elkFilesGeneratedDuringArrangeWithELK.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sirius/doc/specifier/diagrams/images/elkTracing.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 17 additions & 1 deletion sirius/doc/user/diagrams/Diagrams.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1436,7 +1436,14 @@ <h4 id="Pinunpinactions">Pin/unpin actions</h4>
<li>Pin/unpin information are persistent and saved in
<i>.aird</i> session file.
</li>
<li>it is not possible to pin/unpin edges or compartments.</li>
<li>It is not possible to pin/unpin compartments.</li>
<li>For edges, the default layout behavior can be different according to the source/target pinned status:
<ul>
<li>The edge, the source and the target are pinned: nothing moves during arrange all.</li>
<li>The edge is not pinned and, the source and the target are pinned: the edge is arranged to keep only a minimum number of bendpoints.</li>
<li>The edge is pinned and, source or/and target is not pinned: the source or the target is moved, so the corresponding extremity of the edge is also arranged (but the number of bendpoints is preserved). This combination can have strange results and is not recommended.</li>
</ul>
</li>
</ul>
<h4 id="Configuration">Configuration</h4>
<p>You have a configuration to ensure that any diagram element you move is automatically pinned and will require an unpinning operation to be movable again by a layout.</p>
Expand Down Expand Up @@ -1772,6 +1779,15 @@ <h4 id="ManagingThePalette">Managing The Palette</h4>
<p>
<img border="0" src="images/palette_moving.png"/>
</p>
<p>
<i>Customize</i>. You can locally customize your palette by editing name, description or hiding tools and tools sections. Tools sections can also be opened or pinned at start-up.
</p>
<p>
<img border="0" src="images/palette_customize_popup.png"/>
</p>
<p>
<img border="0" src="images/palette_customize_dialog.png"/>
</p>
<h4 id="standardToolId">Standard Tools</h4>
<p>A few general tools are available in standard on all Sirius diagrams. They appear in the top row of the palette, just below the header.</p>
<p>
Expand Down
Binary file added sirius/doc/user/diagrams/images/palette_customize_dialog.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sirius/doc/user/diagrams/images/palette_customize_popup.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions sirius/download.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ <h4>Install Sirius from Update Site</h4>
<br>
<h5>Latest Release</h5>
<p>Add this URL to your Eclipse Installation to reach Sirius Update Site.</p>
<p><input type="text" value="http://download.eclipse.org/sirius/updates/releases/7.4.2/2023-03"></p>
<p>You can also download the corresponding <a href="http://download.eclipse.org/sirius/updates/releases/7.4.2/org.eclipse.sirius-7.4.2-2023-03.zip">zipped archive</a> for offline installation.</p>
<p><input type="text" value="http://download.eclipse.org/sirius/updates/releases/7.4.3/2023-03"></p>
<p>You can also download the corresponding <a href="http://download.eclipse.org/sirius/updates/releases/7.4.3/org.eclipse.sirius-7.4.3-2023-03.zip">zipped archive</a> for offline installation.</p>
<br>
<h5>Latest Nightly</h5>
<p>Add this URL to your Eclipse Installation to reach Sirius Update Site.</p>
Expand Down

0 comments on commit c470385

Please sign in to comment.