[doc] Add shapes about ViewUsages and ViewDefinitions

Signed-off-by: Axel RICHARD <[email protected]>

Author: AxelRICHARD

CHANGELOG.adoc

@@ -4,6 +4,8 @@
 
 === Shapes
 
+- Add support for `ViewUsages` and `ViewDefinitions`
+
 === Breaking changes
 
 === Dependency update

doc/shapes/2025.06/add_support_for_viewusages.adoc

@@ -0,0 +1,26 @@
+= Add support for ViewUsages
+
+This shape is the container shape for the support of `ViewUsage` elements in SysON.
+
+The shapes are:
+
+* link:./diagrams_on_view_usages.adoc[Diagrams on ViewUsages]
+* link:./display_view_usages_in_diagrams.adoc[Display ViewUsages in Diagrams]
+* link:./manage_update_of_view_usages_in_diagrams.adoc[Manage Update of ViewUsages in Diagrams]
+
+The work to do (ordered by priority):
+
+. Allow creation of `ViewUsages` from _New object_ menu in _Explorer_ view.
+. Create `ViewUsage` semantic element in addition to _diagram representation_ on _New representation_ menu in _Explorer_ view.
+. Update _Explorer_ view to open associated _diagram representation_ when a `ViewUsage` is selected.
+. Update _Explorer_ view to hide _diagram representation_.
+. Update _Details_ view to display two tabs when a `ViewUsage` is selected: one for the semantic element, and one for the associated _diagram representation_. 
+. Display `ViewUsages` in diagrams by implementing a new custom shape (like for `Packages` or `Comments`).
+. Update SysON metamodel if needed to handle the list of semantic elements associated to a `ViewUsage`.
+. Display `ViewUsages` contents in diagrams.
+. Add new menu allowing to hide `ViewUsages` graphical elements in diagrams and display `ViewUsages` graphical elements' contents in `ViewUsages` graphical elements' container.
+. Add new option in "Manage Visibility" action, allowing to reveal a parent `ViewUsage` graphical element.
+. Update Sirius Web to allow switching of _NodeDescription_ on graphical elements.
+. Merge all SysON _DiagramDescriptions_ in one.
+. Create migration participants for existing diagrams.
+. Add new menu allowing to switch the appearance of a diagram/graphical element/set of graphical element.

doc/shapes/2025.06/diagrams_on_view_usages.adoc

@@ -0,0 +1,55 @@
+= Diagrams on ViewUsages
+
+The parent shape of this is link:./add_support_for_viewusages.adoc[Add support for ViewUsages].
+
+== Problem
+
+With the current version 2025.4.0 of SysON, diagrams (GV, IV) are attached to semantic objects like Packages, Parts, Actions...
+
+In the SysMLv2 specification, the ViewDefinition concept allows to define how to render elements (textual, graphical...) and `ViewUsage` is an instance of a ViewDefinition.
+
+== Key Result
+
+To comply with the specification, SysON should use `ViewUsages` and `ViewDefinitions` to handle diagrams.
+When end-users click on _New Representation_ on a semantic element, then _DiagramDescriptions_ are proposed in the list of representations, as of the current version.
+Then end-users click on _CREATE_ button, a `ViewUsage` is created, typed with the `ViewDefinition` corresponding to the selected _DiagramDescription_.
+
+Then, no diagram tree item is created/visible under this `ViewUsage`.
+When end-users click on this `ViewUsage`, the diagram is opened.
+
+In the _Details_ view, it will not be possible to change the type of a `ViewUsage` for now.
+In the _Details_ view, when a `ViewUsage` is selected, two tabs are displayed: one for the semantic element, and one for the representation.
+The tab for the representation will be read-only.
+
+There will be only one _Diagram_ per `ViewUsage`.
+
+When end-users click on _New Object_ on a semantic element, and select a `ViewUsage`, then a `ViewUsage` typed by default with the _General View_ `ViewDefinition` from the standard library will be created.
+A _General View_ diagram will also be created as well.
+
+== Solution
+
+=== Breadboarding
+
+When end-users click on New Object menu, `ViewUsages` are available:
+
+image:images/new_object_menu_view_usage.png[New object menu]
+
+Once the `ViewUsage` created, its is displayed in the _Explorer_ view:
+
+image:images/explorer_view_usage.png[New ViewUsage]
+
+When end-users click on New representation menu, `ViewDefinitions` (or _DiagramDescriptions_?) are available:
+
+image:images/new_representation_menu.png[New representation]
+
+=== Cutting backs
+
+When a `ViewUsage` is renamed, the associated representation will not be  renamed as well.
+
+== Rabbit holes
+
+No rabbit holes found.
+
+== No-gos
+
+N/A

doc/shapes/2025.06/display_view_usages_in_diagrams.adoc

@@ -0,0 +1,49 @@
+= Display ViewUsages in Diagrams
+
+The parent shape of this is link:./add_support_for_viewusages.adoc[Add support for ViewUsages].
+
+== Problem
+
+With the current version 2025.4.0 of SysON, it is not possible to display `ViewUsage` elements in diagrams.
+
+== Key Result
+
+`ViewUsage` elements are now displayed in diagrams.
+They should be represented as "framed view", as described in _8.2.3.26 Views and Viewpoints Graphical Notation_ of the SysMLv2 specification.
+
+A `ViewUsage` diagram element has the same palette than background palette of diagram that would have been created on the semantic element containing the `ViewUsage`.
+
+A new menu "Show/Hide > View frame" is available on a `ViewUsage`.
+This menu allows to hide the framed view but not its contents.
+
+When "Hide View frame" is clicked, the framed view is not on the diagram anymore and its contents are then moved into the original diagram.
+
+It will be possible for end-users to reveal an hidden `ViewUsage` through:
+
+* the _filter elements_ tool of the diagram toolbar.
+* a graphical element who was previously inside the hidden framed view.
+In this case, the "manage visibility" action will allow to reveal its hidden framed view.
+
+== Solution
+
+=== Breadboarding
+
+The new menu item "Show View frame"/"Hide View frame" in "Show/Hide" section:
+
+image:images/diagram_element_showhide_view_frame.png[Diagram Element ShowHide View frame]
+
+The new option "View frame" in "Manage Visibility" action dialog:
+
+image:images/diagram_element_manage_visibility_view_frame.png[Diagram Element Manage Visibility View frame]
+
+=== Cutting backs
+
+_Renderings_, _filters_ and _satisfy_ properties of `ViewUsages` won't be taken into account for now.
+
+== Rabbit holes
+
+No rabbit holes found
+
+== No-gos
+
+N/A