Skip to content

Commit 47c1bdf

Browse files
committed
[doc] Update doc
Signed-off-by: Axel RICHARD <axel.richard@obeo.fr>
1 parent 20f30d3 commit 47c1bdf

9 files changed

Lines changed: 18 additions & 22 deletions

File tree

67.2 KB
Loading
191 KB
Loading
12.9 KB
Loading

doc/content/modules/user-manual/pages/features/editor.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The left sidebar provides information related to the project.
4949

5050
[%noheader]
5151
|===
52-
a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer] a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Validation]
52+
a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer, width=50%,height=50%] a|image::editor-left-sidebar-validation.png[{editor} Left sidebar Validation, width=50%,height=50%]
5353
|===
5454

5555
xref:hands-on/how-tos/user-interface-navigation.adoc#switch-left-sidebar[Explore the left sidebar...]

doc/content/modules/user-manual/pages/features/explorer.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {explorer} presents a hierarchical view of all models and their contents within the project, displayed as a tree structure with expandable and collapsible items.
66

7-
image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer]
7+
image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer, width=50%,height=50%]
88

99
* *Models*: Represented by the models existing in the specific project.
1010
* *Semantic Elements*: Located within the models, these are instances of your business domain concepts, each with its own set of children.
@@ -17,7 +17,7 @@ At the top of the {explorer}, a toolbar provides quick access to essential actio
1717

1818
* xref:hands-on/how-tos/model-management.adoc#create-model[Add a Model]: Enables the creation of a new model within the project.
1919
* xref:hands-on/how-tos/model-management.adoc#upload-model[Upload a Model]: Allows users to upload and integrate an external model into the project.
20-
* xref:hands-on/how-tos/explorer.adoc#sync-editor[Synchronize Editor] with Explorer: Ensures alignment between the explorer view and the editor, providing a seamless and up-to-date navigation experience.
20+
* xref:hands-on/how-tos/explorer.adoc#select[Select] element in Explorer: Selects in the explorer view what is already in the editor.
2121

2222
== Selection
2323

doc/content/modules/user-manual/pages/features/general-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ image::gv-overview.png[{gv} Overview]
1212

1313
== Create New General View Diagram
1414

15-
User can create {gv} diagram on any element provided it inherits from Namespace type.
15+
User can create {gv} diagram on any element provided it inherits from _Namespace_ type.
1616

1717
image::gv-diagram-creation.png[{gv} Diagram Creation]
1818

doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
11
= {explorer}
22

3-
[#sync-editor]
4-
== Synchronize {explorer} / {editor}
3+
[#select]
4+
== Select in {explorer}
55

66
include::user-manual:partial$before-you-start-experimental-all.adoc[]
77

8-
It's possible to turn-off and turn-on the synchronization between the {explorer} and the current selection in the {editor}.
9-
10-
When synchronization is enabled, if you selects an element inside a representation, the {explorer} view will ensure that the corresponding semantic element is visible and selected.
11-
This can require expanding new tree items which were previously not visible or scrolling the {explorer}’s view.
12-
13-
image::hands-on-synch-editor-result.png[Synchronize editor result]
14-
15-
When moving between elements in a representation, this can quickly result in an {explorer} view with many tree items expanded, which can be confusing.
16-
17-
The `Synchronize` toggle button in the {explorer} can be used to disable this synchronization.
18-
19-
image::hands-on-synch-editor.png[Synchronize editor]
20-
21-
When synchronization is disabled, tree items that are already expanded in the {explorer} are still selected, but no new tree items are automatically expanded.
8+
Allows to select in the {explorer} view what is selected in the main editor area (in the visible diagram/table).
229

2310
[#expand-all]
2411
== Expand all

doc/content/modules/user-manual/partials/manage-toolbar-diagram.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Diagram panel has global actions grouped in a horizontal toolbar underneath the diagram tabs.
44

5-
image::manage-toolbar-main.png[Main Toolbar]
5+
image::manage-toolbar-main.png[Main Toolbar, width=50%,height=50%]
66

77
This toolbar has the following actions:
88

@@ -16,4 +16,12 @@ This toolbar has the following actions:
1616
* Arrange all elements,
1717
* Reveal hidden elements,
1818
* Reveal faded elements,
19-
* Unpin all elements.
19+
* Unpin all elements,
20+
* Select element in the diagram,
21+
** from wht is selected in the {explorer}.
22+
* Filter elements
23+
** this menu allows to select elements represented in the diagram, and then apply an action on them (collapse, expand, show, hide, fade, reveal faded, pin, unpin).
24+
* SysML actions
25+
** show/hide icons on diagram elements,
26+
** show/hide inherited members,
27+
** show/hide inherited members from standard libraries.

doc/content/modules/user-manual/partials/view-unsynchronized.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
This view in {product} is implemented as an *unsynchronized* diagram.
44
This means that users need to manually add existing elements to the diagram to visualize them.
55
It doesn't display all the information stored in the model by default.
6+
It relies on the exposed elements of the _ViewUsages_, on which the diagrams are created.
67
====

0 commit comments

Comments
 (0)