blob: f5537464ec4fab86bc3b14b22500212d768bf0ab [file] [log] [blame]
=Papyrus-SiriusDiag Integration Introduction=
This part of the documentation deals with features provided by the integration to Papyrus.
For a better experience, you should activate the Papyrus Perspective before reading this documentation.
=How to create a new Sirius Diagram in my UML model=
Once a UML model is created, go into the ''Model Explorer'', select a UML element from which to start the document, then ''Right-Click''->''New Class Diagram''.
[[File:../../../image/user/9_NewSiriusDiagram.png]]
The corresponding sirius diagram is opened inside Papyrus.
Or from the View Explorer, click on the create view, select the root element and finally the view to create.
[[File:../../../image/user/2_NotationView.png]]
=How to show/hide Sirius Diagram in the ModelExplorer=
The created DSemanticDiagram are displayed in the ModelExplorer as children of the element .
This customization is not loaded by default.
Open the ''Model Explorer'' view and use the customize model explorer to load the ''Sirius Diagram'' customization:
[[File:../../../image/user/3_ModelExplorer.png]]
= How to use sirius diagram =
== Sirius diagram ==
To have a global overview of sirius diagram. You can have a look at the sirius diagram documentation.
See https://www.eclipse.org/sirius/doc/user/diagrams/Diagrams.html
While most part is similar to the former GMF diagram. There are some small differences between both.
=== Layers ===
Layers can be defined to hide or show several mapping and/or several tools in the palette in a diagram.
We also use this feature to show/hide applied stereotypes and qualified name in the labels of the elements displayed in the diagram.
[[File:../../../image/user/4_Layer.png]]
= Common =
== Palette tools ==
Palette tools is divided in two categories, one for the creation of element represented has nodes and the other for the creation of edge elements.
[[File:../../../image/user/5_Palette.png]]
== Drag and drop from explorer ==
Drag and drop tools have been implemented to allow to create views for existing element that are not represented yet in the diagram.
== Drag and drop inside diagram ==
Drag and drop inside diagram is also available, but depending of the kind of element that is drag and drop, the behavior can be different.
== Deletion (from diagram or model)==
Deletion of graphical element (only the view, not the semantic element) can be done using the shortcut (SHITF + DEL)
Deletion from the model can be done using a simple delete with DEL key.
== Show / Hide ==
Using the shortcut CTRL + H, you can simply show or hide and element from the diagram.
[[File:../../../image/user/5_ShowHide.png]]
== Diagram Synchronization with the ModelExplorer ==
When the user selects an element in a Sirius Diagram, this element is selected in the Papyrus ModelExplorer.
== Diagram Synchronization with the Property View ==
When the user selects an element in a Sirius Diagram, the property view of this element is displayed.
== ModelExplorer Synchronization with a Papyrus Sirius Diagram ==
When the user selects an element in the ModelExplorer, if the open Diagram contains a graphical representation of this element, this one is selected.
== Pin / Unpin ==
Pinning an element makes it protected from any action which can modify the position of this element in the diagram, such as arrange all.
== Xtext ==
Xtext autocompletion is available when renaming an element using direct edition with F2 shortcut. When using Ctrl + Space key, the auto completion tool propose a list of label to use.
[[File:../../../image/user/10_Xtext.png]]
= Sequence diagram specificity =
Sequence diagram have some specificity, like the kind of element that can be represented.
See https://www.eclipse.org/sirius/doc/user/sequences/Sequence%20Diagrams.html
=== Show Observation Point ===
To have a better view and simplify the correction of problems in sequence diagrams, it is possible to make observation points visible.
[[File:../../../image/user/8_ObservationPoint.png]]
= Class Diagram =
== Features ==
*Label of UML element with the isAbstract feature set to true are displayed in italic
*Label of UML element with the isStatic feature set to true are underlined.
===UML::Property===
*Specific menu to create a default value on a UML::Property from the diagram
[[File:../../../image/user/ClassDiagram_Property_CreateDefaultValue.png]]
*Specific menu to delete a default value on a UML::Property directly from the diagram
[[File:../../../image/user/ClassDiagram_Property_DeleteDefaultValue.png]]