diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 76200cc8ea..04cd37f24b 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -187,6 +187,7 @@ In other scenarios, the default creation position border remains the eastern one - https://github.com/eclipse-sirius/sirius-web/issues/3225[#3225] [sirius-web] The confirmation dialog on delete does not propose anymore the option allowing to "Disable this confirmation dialog" when the local storage is not available. - https://github.com/eclipse-sirius/sirius-web/issues/3246[#3246] [view] Make the `ViewRepresentationDescriptionSearchService` independent from specific representations - https://github.com/eclipse-sirius/sirius-web/issues/3220[#3220] [deck] Add documentation +- https://github.com/eclipse-sirius/sirius-web/issues/3178[#3178] [portal] Add documentation for portals == v2024.1.0 diff --git a/doc/user/images/edit-portal-mode-button.png b/doc/user/images/edit-portal-mode-button.png new file mode 100644 index 0000000000..9ef4eaa7c4 Binary files /dev/null and b/doc/user/images/edit-portal-mode-button.png differ diff --git a/doc/user/images/edit-representation-mode-button.png b/doc/user/images/edit-representation-mode-button.png new file mode 100644 index 0000000000..919a415a0f Binary files /dev/null and b/doc/user/images/edit-representation-mode-button.png differ diff --git a/doc/user/images/empty-portal.png b/doc/user/images/empty-portal.png new file mode 100644 index 0000000000..5ee5b89d04 Binary files /dev/null and b/doc/user/images/empty-portal.png differ diff --git a/doc/user/images/portal-add.webm b/doc/user/images/portal-add.webm new file mode 100644 index 0000000000..6daf8e7708 Binary files /dev/null and b/doc/user/images/portal-add.webm differ diff --git a/doc/user/images/portal-move.webm b/doc/user/images/portal-move.webm new file mode 100644 index 0000000000..ba137f7ec0 Binary files /dev/null and b/doc/user/images/portal-move.webm differ diff --git a/doc/user/images/portal-remove.webm b/doc/user/images/portal-remove.webm new file mode 100644 index 0000000000..0c4281653c Binary files /dev/null and b/doc/user/images/portal-remove.webm differ diff --git a/doc/user/images/portal-resive.webm b/doc/user/images/portal-resive.webm new file mode 100644 index 0000000000..5175c208ca Binary files /dev/null and b/doc/user/images/portal-resive.webm differ diff --git a/doc/user/images/portal-sample.png b/doc/user/images/portal-sample.png new file mode 100644 index 0000000000..cea1978eff Binary files /dev/null and b/doc/user/images/portal-sample.png differ diff --git a/doc/user/images/portal-setup.webm b/doc/user/images/portal-setup.webm new file mode 100644 index 0000000000..61b7be817f Binary files /dev/null and b/doc/user/images/portal-setup.webm differ diff --git a/doc/user/images/portal-toolbar.png b/doc/user/images/portal-toolbar.png new file mode 100644 index 0000000000..c391b64667 Binary files /dev/null and b/doc/user/images/portal-toolbar.png differ diff --git a/doc/user/representation-portal.adoc b/doc/user/representation-portal.adoc new file mode 100644 index 0000000000..326e714f0e --- /dev/null +++ b/doc/user/representation-portal.adoc @@ -0,0 +1,78 @@ += Portal representation + +Portals are dashboard-like representations that can be used to view (and edit) multiple other representations at the same time: + +image::images/portal-sample.png[A portal with three different representations: a diagram, a deck and a Gantt representation] + +If the portal feature is enabled in a Sirius Web instance (which is the default), it requires no configuration and can be used by any user. +A new portal can be created on any semantic element. + +To create a new portal: + +. From the context menu of an element in the explorer, select _New Representation_ +. Choose _Portal_ as the _Representation type_ +. Give it a custom name if you want (this can always be changed later) +. Validate. + +Newly created portals are empty and are initialy in _portal edition_ mode (see below for details on the two possible modes) so that you can add other representations inside of it. + +image:images/empty-portal.png[An empty portal] + +To add a representation inside a portal: + +. Make sure the portal is in _portal edition_ mode using the "Pen" icon in the portal's toolbar. +. In the _Explorer_ view, select the representation you want to add to the portal. +This can be any kind of representation, including other portals. +. Drag and drop the repesentation from the explorer onto the portal's canvas at the location you want it. +. After the representation has been added, you can optionally resize the frame used to display it inside the portal by dragging the bottom-right corner. + +image::images/portal-setup.webm[Configuring a portal] + +While the portal, is in _portal edition_ mode, you can repeat the process to add more representations to it. + +== Portal Edition Mode _vs_ Representation Edition Mode + +A portal is always in one of two possible modes: + +* in _portal edition mode_, you can add, remove, mode and resize representations inside the portal but you can not edit the representations themselves (they are read-only). +* in _representation edition mode_, the content and layout of the portal itself is fixed, but you can interact normally with the embedded representations. + +When a new portal is created (or an empty portal is opened), it is in _portal edition mode_ so that you can directly configure its content. +Otherwise when opening an existing portal which already contains at least one representation, it is in _representation edition mode_ by default. + +You can always switch manualy between the two modes using the corresponding icons in the portal's toolbar: + +* Click on the "Pen" icon to switch to _portal edition mode_. +* Click on the "Hand" icon to switch to the _representation edition mode_. + +== Portal Edition + +When in _portal edition mode_, you can configure the contents of the portal by. + +To _add_ a new representation inside the portal, find it in the _Explorer_ view and then drag it from there onto the portal's canvas. +While dragging the representation you will see a feedback of where the new representation's frame will be placed, with the already existing frames moving around if needed. + +image::images/portal-add.webm[Adding a new representation inside a portal] + +To _resize_ the frame of a representation already embedded in the portal, simply drag it's bottom-right corner: + +image::images/portal-resize.webm[Resizing a representation inside a portal] + +To _move_ the frame of a representation already embedded in the portal, drag it from its header: + +image::images/portal-move.webm[Moving a representation inside a portal] + +To _remove_ a frame from the portal, click on the _X_ icon at the right end of the header: + +image::images/portal-remove.webm[Removing a representation from a portal] + +== Portal Toolbar + +The portal's own toolbar provides the following actions: + +image::images/portal-toolbar.png[Portal Toolbar] + +* _Toggle full screen mode_ : It allows to display the portal in full screen. +* _Share_: Provide an URL that reaches directly the current portal representation. +* _Edit portal configuration_: switch to portal edition mode. +* _Edit representations_: switch to representation edition mode.