From dd4354477d94f24d5e1c3e386242ed75674bd57d Mon Sep 17 00:00:00 2001 From: Jessy Mallet Date: Wed, 24 Apr 2024 16:07:52 +0200 Subject: [PATCH] [doc] Update how-tos documentation Signed-off-by: Jessy Mallet --- .../modules/user-manual/pages/faq/faq.adoc | 2 +- .../pages/features/collaboration.adoc | 2 +- .../user-manual/pages/features/editor.adoc | 6 +- .../user-manual/pages/features/explorer.adoc | 34 +-- .../user-manual/pages/features/homepage.adoc | 4 +- .../pages/features/interoperability.adoc | 2 +- .../how-tos/create-blank-project.adoc | 15 - .../how-tos/create-diag-from-sysml.adoc | 3 - .../hands-on/how-tos/create-element.adoc | 12 - .../pages/hands-on/how-tos/create-model.adoc | 15 - .../how-tos/create-representation.adoc | 14 - .../how-tos/create-template-project.adoc | 21 -- .../hands-on/how-tos/delete-element.adoc | 36 --- .../pages/hands-on/how-tos/delete-model.adoc | 27 -- .../hands-on/how-tos/delete-project.adoc | 33 --- .../how-tos/delete-representation.adoc | 39 --- .../pages/hands-on/how-tos/direct-edit.adoc | 21 -- .../hands-on/how-tos/download-model.adoc | 26 -- .../hands-on/how-tos/download-project.adoc | 39 --- .../pages/hands-on/how-tos/expand-all.adoc | 16 -- .../pages/hands-on/how-tos/explorer.adoc | 76 ++++- .../hands-on/how-tos/filter-explorer.adoc | 38 --- .../hands-on/how-tos/model-management.adoc | 266 +++++++++++++++++- .../how-tos/navigate-representations.adoc | 13 - .../hands-on/how-tos/project-management.adoc | 199 ++++++++++++- .../hands-on/how-tos/project-settings.adoc | 6 - .../pages/hands-on/how-tos/read-element.adoc | 8 - .../hands-on/how-tos/rename-element.adoc | 36 --- .../pages/hands-on/how-tos/rename-model.adoc | 10 - .../hands-on/how-tos/rename-project.adoc | 30 -- .../how-tos/rename-representation.adoc | 10 - .../how-tos/representation-operations.adoc | 89 +++++- .../how-tos/representations-view.adoc | 14 +- .../pages/hands-on/how-tos/share-project.adoc | 5 - .../how-tos/share-representation.adoc | 18 -- .../hands-on/how-tos/switch-left-sidebar.adoc | 13 - .../how-tos/switch-right-sidebar.adoc | 13 - .../pages/hands-on/how-tos/sync-editor.adoc | 16 -- .../hands-on/how-tos/update-element.adoc | 25 -- .../pages/hands-on/how-tos/upload-model.adoc | 31 -- .../hands-on/how-tos/upload-project.adoc | 35 --- .../how-tos/user-interface-navigation.adoc | 30 +- .../pages/hands-on/tutorials/batmobile.adoc | 8 +- .../partials/manage-labels-diagram.adoc | 2 +- 44 files changed, 675 insertions(+), 683 deletions(-) delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/create-blank-project.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/create-diag-from-sysml.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/create-element.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/create-model.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/create-representation.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/create-template-project.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/delete-element.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/delete-model.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/delete-project.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/delete-representation.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/direct-edit.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/download-model.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/download-project.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/expand-all.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/filter-explorer.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/navigate-representations.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/project-settings.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/read-element.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/rename-element.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/rename-model.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/rename-project.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/rename-representation.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/share-project.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/share-representation.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/switch-left-sidebar.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/switch-right-sidebar.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/sync-editor.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/update-element.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/upload-model.adoc delete mode 100644 doc/content/modules/user-manual/pages/hands-on/how-tos/upload-project.adoc diff --git a/doc/content/modules/user-manual/pages/faq/faq.adoc b/doc/content/modules/user-manual/pages/faq/faq.adoc index ffd0d0b..27e4284 100644 --- a/doc/content/modules/user-manual/pages/faq/faq.adoc +++ b/doc/content/modules/user-manual/pages/faq/faq.adoc @@ -32,7 +32,7 @@ To explore the supported {sysmlv2} views, refer to the xref:user-manual:features .How do I create a new model? [%collapsible] ==== -To create a new model, refer to the xref:user-manual:hands-on/how-tos/create-model.adoc[[Create a new model] section in the user manual. +To create a new model, refer to the xref:user-manual:hands-on/how-tos/model-management.adoc#create-model[[Create a new model] section in the user manual. ==== .How do I import and export models? diff --git a/doc/content/modules/user-manual/pages/features/collaboration.adoc b/doc/content/modules/user-manual/pages/features/collaboration.adoc index 66bcd95..8e54606 100644 --- a/doc/content/modules/user-manual/pages/features/collaboration.adoc +++ b/doc/content/modules/user-manual/pages/features/collaboration.adoc @@ -3,6 +3,6 @@ There are various solutions available for collaborating with {product}. Explore different collaboration methods to enhance your teamwork and communication within {product}. -* *Share Projects, Models, Diagrams*: Collaborating in {product} is a breeze with the ability to xref:hands-on/how-tos/share-project.adoc[share projects], models, and xref:hands-on/how-tos/share-representation.adoc[diagrams] using straightforward methods. +* *Share Projects, Models, Diagrams*: Collaborating in {product} is a breeze with the ability to xref:hands-on/how-tos/project-management.adoc#share-project[share projects], models, and xref:hands-on/how-tos/representation-operations.adoc#share-representation[diagrams] using straightforward methods. Sharing projects and models is as simple as providing a link, similar to the process of sharing diagrams. * xref:features/interoperability.adoc[*Exchange* Projects or Models]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/editor.adoc b/doc/content/modules/user-manual/pages/features/editor.adoc index c1adc65..46e7d62 100644 --- a/doc/content/modules/user-manual/pages/features/editor.adoc +++ b/doc/content/modules/user-manual/pages/features/editor.adoc @@ -37,7 +37,7 @@ include::user-manual:partial$homepage-action.adoc[leveloffset=+3] [#project-actions] ==== Projects Actions -Access project-level actions like _xref:hands-on/how-tos/rename-project.adoc[rename]_, _xref:hands-on/how-tos/download-project.adoc[download]_, access project _xref:hands-on/how-tos/project-settings.adoc[settings]_, _xref:hands-on/how-tos/delete-project.adoc[delete]_. +Access project-level actions like _xref:hands-on/how-tos/project-management.adoc#rename-project[rename]_, _xref:hands-on/how-tos/project-management.adoc#download-project[download]_, access project _xref:hands-on/how-tos/project-management.adoc#project-settings[settings]_, _xref:hands-on/how-tos/project-management.adoc#delete-project[delete]_. image::editor-projectActions.png[{editor} Project Actions] @@ -56,7 +56,7 @@ NOTE: The left sidebar provides information related to the project. a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer] a|image::editor-left-sidebar-explorer.png[{editor} Left sidebar Validation] |=== -xref:hands-on/how-tos/switch-left-sidebar.adoc[Explore the left sidebar...] +xref:hands-on/how-tos/user-interface-navigation.adoc#switch-left-sidebar[Explore the left sidebar...] === Editor @@ -80,4 +80,4 @@ NOTE: The content of the right sidebar depends on the current selection. a|image::editor-right-sidebar-details.png[{editor} Right sidebar Details] a|image::editor-right-sidebar-representations.png[{editor} Right sidebar Representations] a|image::editor-right-sidebar-related-elements.png[{editor} Right sidebar Related Elements] |=== -xref:hands-on/how-tos/switch-right-sidebar.adoc[Explore the right sidebar...] \ No newline at end of file +xref:hands-on/how-tos/user-interface-navigation.adoc#switch-right-sidebar[Explore the right sidebar...] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/explorer.adoc b/doc/content/modules/user-manual/pages/features/explorer.adoc index d721eb0..6bfef07 100644 --- a/doc/content/modules/user-manual/pages/features/explorer.adoc +++ b/doc/content/modules/user-manual/pages/features/explorer.adoc @@ -25,9 +25,9 @@ image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer] At the top of the {explorer}, a toolbar provides quick access to essential actions: -* xref:hands-on/how-tos/create-model.adoc[Add a Model]: Enables the creation of a new model within the project. -* xref:hands-on/how-tos/upload-model.adoc[Upload a Model]: Allows users to upload and integrate an external model into the project. -* xref:hands-on/how-tos/sync-editor.adoc[Synchronize Editor] with Explorer: Ensures alignment between the explorer view and the editor, providing a seamless and up-to-date navigation experience. +* xref:hands-on/how-tos/model-management.adoc#create-model[Add a Model]: Enables the creation of a new model within the project. +* 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. +* 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. == Selection @@ -43,22 +43,22 @@ The *{explorer-menu}* (three-dots More menu) offers a set of relevant actions de This menu provides functionalities based on the selected item: * For Models (Root Elements), users can: -** xref:hands-on/how-tos/create-model.adoc[Create a new model]. -** xref:hands-on/how-tos/create-element.adoc[Create a new child element]. -** xref:hands-on/how-tos/download-model.adoc[Download the model]. -** xref:hands-on/how-tos/expand-all.adoc[Expand all the model]. -** xref:hands-on/how-tos/rename-model.adoc[Rename the model]. -** xref:hands-on/how-tos/delete-model.adoc[Delete the model]. +** xref:hands-on/how-tos/model-management.adoc#create-model[Create a new model]. +** xref:hands-on/how-tos/model-management.adoc#create-element[Create a new child element]. +** xref:hands-on/how-tos/model-management.adoc#download-model[Download the model]. +** xref:hands-on/how-tos/explorer.adoc#expand-all[Expand all the model]. +** xref:hands-on/how-tos/model-management.adoc#rename-model[Rename the model]. +** xref:hands-on/how-tos/model-management.adoc#delete-model[Delete the model]. * For Semantic Elements, users can: -** xref:hands-on/how-tos/create-element.adoc[Create a new child element]. -** xref:hands-on/how-tos/create-representation.adoc[Create a new representation]. -** xref:hands-on/how-tos/expand-all.adoc[Expand all the children]. -** xref:hands-on/how-tos/rename-element.adoc[Rename the element]. -** xref:hands-on/how-tos/delete-element.adoc[Delete the element]. +** xref:hands-on/how-tos/model-management.adoc#create-element[Create a new child element]. +** xref:hands-on/how-tos/representation-operations.adoc#create-representation[Create a new representation]. +** xref:hands-on/how-tos/explorer.adoc#expand-all[Expand all the children]. +** xref:hands-on/how-tos/model-management.adoc#rename-element[Rename the element]. +** xref:hands-on/how-tos/model-management.adoc#delete-element[Delete the element]. * For Representations, users can: -** xref:hands-on/how-tos/rename-representation.adoc[Rename the representation]. -** xref:hands-on/how-tos/delete-representation.adoc[Delete the representation]. +** xref:hands-on/how-tos/representation-operations.adoc#rename-representation[Rename the representation]. +** xref:hands-on/how-tos/representation-operations.adoc#delete-representation[Delete the representation]. == {explorer-filter-bar} -The *{explorer-filter-bar}* in the {explorer} view provides the capability to highlight and xref:hands-on/how-tos/filter-explorer.adoc[filter tree items]. \ No newline at end of file +The *{explorer-filter-bar}* in the {explorer} view provides the capability to highlight and xref:hands-on/how-tos/explorer.adoc#filter-explorer[filter tree items]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/homepage.adoc b/doc/content/modules/user-manual/pages/features/homepage.adoc index 795d49c..7d319f4 100644 --- a/doc/content/modules/user-manual/pages/features/homepage.adoc +++ b/doc/content/modules/user-manual/pages/features/homepage.adoc @@ -54,7 +54,7 @@ _SysMLv2_ is an empty SysML project with only the root model, a _Package_ and a NOTE: Every project you create will have its own xref:features/editor.adoc[Project Editor]. -Explore further by referring to the following how-tos for xref:hands-on/how-tos/create-blank-project.adoc[creating blank projects], generating xref:hands-on/how-tos/create-template-project.adoc[projects from templates], or xref:hands-on/how-tos/upload-project.adoc[uploading] existing ones. +Explore further by referring to the following how-tos for xref:hands-on/how-tos/project-management.adoc#create-blank-project[creating blank projects], generating xref:hands-on/how-tos/project-management.adoc#create-template-project[projects from templates], or xref:hands-on/how-tos/project-management.adoc#upload-project[uploading] existing ones. === Existing Projects @@ -62,4 +62,4 @@ The _Existing Projects_ section streamlines project navigation, allowing users t image::homepage-existing-projects.png[Existing Projects] -It facilitates the opening of pre-existing projects and provides essential actions for project management, including options to _xref:hands-on/how-tos/rename-project.adoc[rename]_, _xref:hands-on/how-tos/download-project.adoc[download]_, and _xref:hands-on/how-tos/delete-project.adoc[delete]_ projects. \ No newline at end of file +It facilitates the opening of pre-existing projects and provides essential actions for project management, including options to _xref:hands-on/how-tos/project-management.adoc#rename-project[rename]_, _xref:hands-on/how-tos/project-management.adoc#download-project[download]_, and _xref:hands-on/how-tos/project-management.adoc#delete-project[delete]_ projects. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/interoperability.adoc b/doc/content/modules/user-manual/pages/features/interoperability.adoc index 655ffdb..bf1be13 100644 --- a/doc/content/modules/user-manual/pages/features/interoperability.adoc +++ b/doc/content/modules/user-manual/pages/features/interoperability.adoc @@ -9,7 +9,7 @@ This feature enhances interoperability, allowing users to seamlessly exchange pr WARNING: {product} does not currently support the {sysmlv2} Standard JSON format for import/export. -For detailed instructions on xref:hands-on/how-tos/download-project.adoc[downloading projects], xref:hands-on/how-tos/download-model.adoc[downloading models], xref:hands-on/how-tos/upload-project.adoc[uploading projects], and xref:hands-on/how-tos/upload-model.adoc[uploading models], please refer to the respective sections in the documentation. +For detailed instructions on xref:hands-on/how-tos/project-management.adoc#download-project[downloading projects], xref:hands-on/how-tos/model-management.adoc#download-model[downloading models], xref:hands-on/how-tos/project-management.adoc#upload-project[uploading projects], and xref:hands-on/how-tos/model-management.adoc#upload-model[uploading models], please refer to the respective sections in the documentation. These sections provide step-by-step guidance on how to perform these actions within the {product} environment. === {sysmlv2} textual format diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-blank-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/create-blank-project.adoc deleted file mode 100644 index 6a55ace..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-blank-project.adoc +++ /dev/null @@ -1,15 +0,0 @@ -== Create a Blank Project - -To create a new Blank project, user has to click on _Blank project_ card at the top of the homepage. - -image::hands-on-new-project.png[Create New Project] - -Then a popup will appear to set the name of the new project. - -image::hands-on-new-project-conf.png[New Project Configuration] - -User will be finally redirected to the newly created project, which will be initially empty. - -image::hands-on-new-project-result.png[New Project Result] - -Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/create-model.adoc[creating your own models] and xref:hands-on/how-tos/create-representation.adoc[representations]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-diag-from-sysml.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/create-diag-from-sysml.adoc deleted file mode 100644 index 0b3dc5a..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-diag-from-sysml.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Creating diagrams from an existing {sysmlv2} file - -//TODO \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-element.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/create-element.adoc deleted file mode 100644 index daef3a7..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-element.adoc +++ /dev/null @@ -1,12 +0,0 @@ -== Create a New Element - -The process to create a new element in a model involves the following steps: - -. Open the {explorer-menu} next to the parent element. -. Click on `New object`. -. Select the desired type of object to create. -. Click on `Create`. - -image::hands-on-new-element.png[Create New Element] - -Upon completion, the newly created element is automatically selected in the {explorer}. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-model.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/create-model.adoc deleted file mode 100644 index 8a89640..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-model.adoc +++ /dev/null @@ -1,15 +0,0 @@ -== Create a New Model - -To create a model, follow these steps from the explorer tool bar: - -. Open the Project Editor. -. Click on the `New model` action in the explorer tool bar. -. Fill in the model name. -. Choose the model type. -. Click the `Create` button. - -image::hands-on-new-model.png[Create New Model] - -Once completed, the newly created model will be listed in the {explorer}. - -image::hands-on-new-model-result.png[New Model result] diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-representation.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/create-representation.adoc deleted file mode 100644 index 2982783..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-representation.adoc +++ /dev/null @@ -1,14 +0,0 @@ -== Create a New Representation - -To create a representation, follow these steps: - -. Open the Project Editor. -. Open the {explorer-menu} next to an element in the explorer. -. Select the `New representation` action. -. Fill in the representation name. -. Choose the representation type. -. Click the `Create` button. - -image::hands-on-new-representation.png[Create representation] - -Once completed, the newly created representation will be open automatically and listed in the {explorer} under the element. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-template-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/create-template-project.adoc deleted file mode 100644 index c56df2f..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-template-project.adoc +++ /dev/null @@ -1,21 +0,0 @@ -== Create a Project based on a Template - -To create a new project from a `Template`: - -. Simply click on the corresponding template card at the top of the homepage. - -Only the first three templates are directly visible in the {homepage} top region. -If more templates are available, you can click on the `Show all templates` card to open a dialog displaying all the available templates (possibly on multiple pages). - -image::hands-on-new-template.png[Create New Template] - -. The new project will be automatically created and opened. -Depending on the template, an initial representation (e.g., a diagram) may also be automatically opened. - -The following example shows the result project _Batmobile_ create from _Batmobile_ template: - -image::hands-on-new-template_batmobile.png[Batmobile Template] - -NOTE: The newly created project will have the same name as the template, so it is a good practice to xref:hands-on/how-tos/rename-project.adoc[rename] it to avoid confusion. - -Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/create-model.adoc[creating your own models] and xref:hands-on/how-tos/create-representation.adoc[representations]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-element.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-element.adoc deleted file mode 100644 index 5843519..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-element.adoc +++ /dev/null @@ -1,36 +0,0 @@ -== Delete an Element - -[WARNING] -==== -This operation is irreversible, once done there is no mean to get the element back. -The element and its children - semantic element and representations - will be deleted. -==== - -NOTE: The deletion will affect everyone. - -To delete an element, follow these steps: - -=== From the {explorer} - -. Open the {explorer-menu} next to the element. -. Click on `Delete`. - -image::hands-on-delete-element-from-explorer.png[Delete element from explorer] - -=== From a representation - -. Select the element in the representation. -. Click on the `Delete` tool in the {diag-toolbar} or press the `DEL` key on your keyboard. - -image::hands-on-delete-element-from-representation.png[Delete element from representation] - -CAUTION: Use the `DEL` key cautiously, as it is a direct shortcut for the delete operation. - -A confirmation dialog appears when an element is deleted via the _Delete from model_ tool in the palette or via the {explorer-menu}. This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. - -image::gv-semantic-deltion.png[{gv} Semantic Deletion] - -[TIP] -==== -This preference is stored in the local storage of the browser. You can reset it by deleting the SysON data in cache of your browser. -==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-model.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-model.adoc deleted file mode 100644 index 89a48d8..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-model.adoc +++ /dev/null @@ -1,27 +0,0 @@ -== Delete a Model - -[WARNING] -==== -Deleting a model and its content is a significant action, and it's important to note that the entire model, along with its contents, will be permanently removed. -This includes all associated semantic elements, representations, and any other data within the model. -Exercise caution when performing this operation, as it cannot be reversed. -==== - -NOTE: The deletion will affect everyone. - -To delete a model, follow these steps: - -. Select the model in the {explorer}. -. Open the {explorer-menu} next to the model. -. Click on `Delete`. - -image::hands-on-delete-model.png[Delete model] - -A confirmation dialog appears when the model is deleted via the Model Explorer. This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. - -image::gv-semantic-deltion.png[{gv} Semantic Deletion] - -[TIP] -==== -This preference is stored in the local storage of the browser. You can reset it by deleting the SysON data in cache of your browser. -==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-project.adoc deleted file mode 100644 index 184cb62..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-project.adoc +++ /dev/null @@ -1,33 +0,0 @@ -== Delete a Project - -It is possible to delete a project either from the {homepage} or the {editor}. - -[WARNING] -==== -When you delete a project, you will lose all the data. -Deleting a project and its content is a significant action, and it's important to note that the entire project, along with its contents, will be permanently removed. -This includes all associated models, representations, and any other data within the project. -Exercise caution when performing this operation, as it cannot be reversed. -==== - -=== From the {homepage} - -You can delete a project from the {homepage}: - -. Click on the {projects-list-menu} next to the project in the {projects-list}. -. Select the `Delete` option. - -image::hands-on-delete-project-homepage.png[Delete Project from Homepage] - -. Confirm the deletion by clicking on the `Delete` button in the modal. - -=== From the {editor} - -You can delete a project from the {editor}: - -. Click on the {projects-list-menu} next to the project name in the project tool bar. -. Select the `Delete` option. - -image::hands-on-delete-project-editor.png[Delete Project from editor] - -. Confirm the deletion by clicking on the `Delete` button in the modal. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-representation.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-representation.adoc deleted file mode 100644 index 146fdd2..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-representation.adoc +++ /dev/null @@ -1,39 +0,0 @@ -== Delete a Representation - -It is possible to delete a representation either from the {explorer} or the {representations-view}. - -[WARNING] -==== -This operation is irreversible, once done there is no mean to get the representation back. -==== - -NOTE: The semantic elements visible in a representation will not be deleted. - -=== From the {explorer} - -You can delete a representation from the {explorer}: - -. Open the {explorer-menu} next to the representation. -. Click on `Delete`. - -image::hands-on-delete-representation-from-explorer.png[Delete representation from the {explorer}] - -=== From the {representations-view} - -You can delete a representation from the {representations-view}: - -. Open the {representations-view}. -. Select the representation you want to delete. -. Click on the `Delete` button. - -image::hands-on-delete-representation-from-representation-view.png[Delete representation from the {representations-view}] - - -A confirmation dialog appears when a representation is deleted. This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. - -image::gv-semantic-deltion.png[{gv} Semantic Deletion] - -[TIP] -==== -This preference is stored in the local storage of the browser. You can reset it by deleting the SysON data in cache of your browser. -==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/direct-edit.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/direct-edit.adoc deleted file mode 100644 index fb65c2e..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/direct-edit.adoc +++ /dev/null @@ -1,21 +0,0 @@ -== Direct Edit Tool and Shortcuts - -The {product} supports a subset of the {sysmlv2} textual syntax, which allows you to update multiple elements simultaneously. This makes it more efficient to edit models. - -In general, you can edit the label of a shape in a diagram, and the diagram editor will try to interpret your input and update the corresponding element properties. - -WARNING: If an element has a complex name like `someElementName[x]:someTypeName:>someElement`, when editing, you must retain all the written parts; otherwise, you risk unsetting some values. - -Here are some shortcuts for efficiently editing {product} models: - -* Typing `someName` will update the name of the selected element. -* Typing `:SomeTypeName`, will set the type of the selected element to _SomeTypeName_. -If _SomeTypeName_ does not exist, it will be created as an appropriate type element (e.g., Item Definition, Part Definition, etc.) within the same parent container as the selected element. -* Typing `[x]` on an element or a relationship will set its cardinality to _x_. -* Typing `[1..x]` on an element or a relationship will set its cardinality to _1..x_. -* Typing `[x..*]` on an element or a relationship will set its cardinality to _x..*_. -* Typing `someElement:>otherElement` on a element will set _someElement_ as a `subsetting` of the _otherElement_ if both element are of the same type. -Otherwise, it will create a `specialization` relationship between _someElement_ and _otherElement_. -* Typing `someElement:>>otherElement` on an element will set _someElement_ as a `redefinition` of _otherElement_. - -These shortcuts provide a convenient way to update model elements quickly and efficiently. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/download-model.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/download-model.adoc deleted file mode 100644 index 60d7928..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/download-model.adoc +++ /dev/null @@ -1,26 +0,0 @@ -== Download a Model - -[caption=] -==== -// Edition -include::user-manual:partial$feature-edition-os.adoc[] - -// Status -include::user-manual:partial$feature-status-experimental.adoc[] - -// Usage -include::user-manual:partial$feature-usage-all.adoc[] -==== - -You can download a model from the {explorer}: - -. Click on the {explorer-menu} next to the model in the {explorer}. -. Select the `Download` option. - -image::hands-on-download-model.png[Download model] - -[NOTE] -==== -The model will be downloaded in JSON format. -The JSON format used by {product} is specific to the tool. -==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/download-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/download-project.adoc deleted file mode 100644 index 7a2b29d..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/download-project.adoc +++ /dev/null @@ -1,39 +0,0 @@ -== Download a Project - -[caption=] -==== -// Edition -include::user-manual:partial$feature-edition-os.adoc[] - -// Status -include::user-manual:partial$feature-status-experimental.adoc[] - -// Usage -include::user-manual:partial$feature-usage-all.adoc[] -==== - -It is possible to download a project either from the {homepage} or the {editor}. - -[NOTE] -==== -The project will be downloaded as an archive containing models and representations in JSON format. -The JSON format used by {product} is specific to the tool. -==== - -=== From the {homepage} - -You can download a project from the {homepage}: - -. Click on the {projects-list-menu} next to the project in the {projects-list}. -. Select the `Download` option. - -image::hands-on-download-project-homepage.png[Download Project from Homepage] - -=== From the {editor} - -You can download a project from the {editor}: - -. Click on the {projects-list-menu} next to the project name in the project tool bar. -. Select the `Download` option. - -image::hands-on-download-project-editor.png[Download Project from editor] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/expand-all.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/expand-all.adoc deleted file mode 100644 index 8549522..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/expand-all.adoc +++ /dev/null @@ -1,16 +0,0 @@ -= Expand all - -[WARNING] -==== -This operation may take a considerable amount of time for projects with a massive hierarchy and a high number of children. -Exercise caution when performing this action in such scenarios. -==== - -Explore the hierarchy of children for any element in the {explorer}: - -. Open the {explorer-menu} of any element with children. -. Click on `Expand all`. - -image::hands-on-expand-all.png[Expand all] - -This action expands the selected element and all its children recursively, offering a detailed view of the hierarchical structure. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc index a5f751d..91c691b 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc @@ -1,7 +1,77 @@ = {explorer} -include::user-manual:hands-on/how-tos$sync-editor.adoc[] +[#sync-editor] += Synchronize {explorer} / {editor} -include::user-manual:hands-on/how-tos$expand-all.adoc[] +It is possible to disable (and of course re-enable) the synchronization between the {explorer} and the current selection in the {editor}. -include::user-manual:hands-on/how-tos$filter-explorer.adoc[] \ No newline at end of file +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. +This can require expanding new tree items which were previously not visible or scrolling the {explorer}’s view. + +image::hands-on-synch-editor-result.png[Synchronize editor result] + +When moving between elements in a representation, this can quickly result in an {explorer} view with many tree items expanded, which can be confusing. + +The `Synchronize` toggle button in the {explorer} can be used to disable this synchronization. + +image::hands-on-synch-editor.png[Synchronize editor] + +When synchronization is disabled, tree items that are already expanded in the {explorer} will still be selected, but no new tree items will be automatically expanded. + +[#expand-all] += Expand all + +[WARNING] +==== +This operation may take a considerable amount of time for projects with a massive hierarchy and a high number of children. +Exercise caution when performing this action in such scenarios. +==== + +Explore the hierarchy of children for any element in the {explorer}: + +. Open the {explorer-menu} of any element with children. +. Click on `Expand all`. + +image::hands-on-expand-all.png[Expand all] + +This action expands the selected element and all its children recursively, offering a detailed view of the hierarchical structure. + += Filter elements in the {explorer} + +== Filter from name + +To filter elements in the {explorer} using the filter bar: + +. Choose a tree item in the {explorer}. +. Press `Ctrl+f` (Windows/Linux) or `Cmd+f` (MacOS) to enable the filter bar. +. Enter a value in the filter bar. + +image::hands-on-filter-name-shortcut.png[Filter name shortcut] + +. All visible tree items containing the typed value will be highlighted. +. Use the filter button inside the filter bar to hide all visible tree items that do not contain the entered value. + +This functionality allows for precise filtering and highlighting of elements based on specified criteria. + +[NOTE] +==== +The filter bar can only highlight items in the expanded state; it does not search within unexpanded children. Ensure the desired tree items are expanded to effectively use the filter and highlight functionality. +==== + +[#filter-explorer] +== Filter from kind + +Three filters are available in the {explorer} to filter element by kind: + +* Hide Memberships, +* Hide KerML Standard Libraries, +* Hide SysML Standard Libraries. + +These filters allow to clear the {explorer} view. By hiding the very technical elements, only the data directly exploited by the user are displayed which make the model more readable in the {explorer} view + +To filter elements in the {explorer} by their kind using the filter tool: + +. Click on filter button, +. Select filters to activate. + +image::hands-on-filter-element.png[Filter kind] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/filter-explorer.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/filter-explorer.adoc deleted file mode 100644 index 7f0a38c..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/filter-explorer.adoc +++ /dev/null @@ -1,38 +0,0 @@ -= Filter elements in the {explorer} - -== Filter from name - -To filter elements in the {explorer} using the filter bar: - -. Choose a tree item in the {explorer}. -. Press `Ctrl+f` (Windows/Linux) or `Cmd+f` (MacOS) to enable the filter bar. -. Enter a value in the filter bar. - -image::hands-on-filter-name-shortcut.png[Filter name shortcut] - -. All visible tree items containing the typed value will be highlighted. -. Use the filter button inside the filter bar to hide all visible tree items that do not contain the entered value. - -This functionality allows for precise filtering and highlighting of elements based on specified criteria. - -[NOTE] -==== -The filter bar can only highlight items in the expanded state; it does not search within unexpanded children. Ensure the desired tree items are expanded to effectively use the filter and highlight functionality. -==== - -== Filter from kind - -Three filters are available in the {explorer} to filter element by kind: - -* Hide Memberships, -* Hide KerML Standard Libraries, -* Hide SysML Standard Libraries. - -These filters allow to clear the {explorer} view. By hiding the very technical elements, only the data directly exploited by the user are displayed which make the model more readable in the {explorer} view - -To filter elements in the {explorer} by their kind using the filter tool: - -. Click on filter button, -. Select filters to activate. - -image::hands-on-filter-element.png[Filter kind] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc index f65d136..53ce496 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc @@ -1,23 +1,267 @@ = Model Management -include::user-manual:hands-on/how-tos$create-model.adoc[] +[#create-model] +== Create a New Model -include::user-manual:hands-on/how-tos$upload-model.adoc[] +To create a model, follow these steps from the explorer tool bar: -include::user-manual:hands-on/how-tos$rename-model.adoc[] +. Open the Project Editor. +. Click on the `New model` action in the explorer tool bar. +. Fill in the model name. +. Choose the model type. +. Click the `Create` button. -include::user-manual:hands-on/how-tos$delete-model.adoc[] +image::hands-on-new-model.png[Create New Model] -include::user-manual:hands-on/how-tos$download-model.adoc[] +Once completed, the newly created model will be listed in the {explorer}. -include::user-manual:hands-on/how-tos$create-element.adoc[] +image::hands-on-new-model-result.png[New Model result] -include::user-manual:hands-on/how-tos$read-element.adoc[] +[#upload-model] +== Upload a Model -include::user-manual:hands-on/how-tos$rename-element.adoc[] +[caption=] +==== +// Edition +include::user-manual:partial$feature-edition-os.adoc[] -include::user-manual:hands-on/how-tos$update-element.adoc[] +// Status +include::user-manual:partial$feature-status-experimental.adoc[] -include::user-manual:hands-on/how-tos$delete-element.adoc[] +// Usage +include::user-manual:partial$feature-usage-all.adoc[] +==== -include::user-manual:hands-on/how-tos$direct-edit.adoc[] +[NOTE] +==== +Only models exported in the specific JSON format recognized by {product} can be re-uploaded using the upload action. +Ensure that your models are exported using the xref:hands-on/how-tos/model-management.adoc#download-model[Download Model] action to enable successful re-uploading to {product}. +==== + +To upload a model from a file previously exported, follow these steps: + +. Go to the {editor}. +. Open the {explorer} view. +. Click on the `Upload` button at the top of the {explorer} in the tool bar. +. It will open the `Upload Model` modal. +. Select a model from your file system. + +image::hands-on-upload-model.png[Upload model] + +. The uploaded model will be automatically created and opened. + +[#rename-model] +== Rename a Model + +You can update the model name from the {explorer}: + +. Click on the {explorer-menu} next to the model in the {explorer}. +. Select the `Rename` option. +. Update the name in the editable field. +. Click on `Rename`. + +[##delete-model] +== Delete a Model + +[WARNING] +==== +Deleting a model and its content is a significant action, and it's important to note that the entire model, along with its contents, will be permanently removed. +This includes all associated semantic elements, representations, and any other data within the model. +Exercise caution when performing this operation, as it cannot be reversed. +==== + +NOTE: The deletion will affect everyone. + +To delete a model, follow these steps: + +. Select the model in the {explorer}. +. Open the {explorer-menu} next to the model. +. Click on `Delete`. + +image::hands-on-delete-model.png[Delete model] + +A confirmation dialog appears when the model is deleted via the Model Explorer. This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. + +image::manage-elements-semantic-deletion.png[{gv} Semantic Deletion] + +[TIP] +==== +This preference is stored in the local storage of the browser. You can reset it by deleting the SysON data in cache of your browser. +==== + +[#download-model] +== Download a Model + +[caption=] +==== +// Edition +include::user-manual:partial$feature-edition-os.adoc[] + +// Status +include::user-manual:partial$feature-status-experimental.adoc[] + +// Usage +include::user-manual:partial$feature-usage-all.adoc[] +==== + +You can download a model from the {explorer}: + +. Click on the {explorer-menu} next to the model in the {explorer}. +. Select the `Download` option. + +image::hands-on-download-model.png[Download model] + +[NOTE] +==== +The model will be downloaded in JSON format. +The JSON format used by {product} is specific to the tool. +==== + +[#create-element] +== Create a New Element + +The process to create a new element in a model involves the following steps: + +. Open the {explorer-menu} next to the parent element. +. Click on `New object`. +. Select the desired type of object to create. +. Click on `Create`. + +image::hands-on-new-element.png[Create New Element] + +Upon completion, the newly created element is automatically selected in the {explorer}. + +== Read an Element + +. To navigate through the details of a semantic element, utilize the {explorer} to navigate through the model and locate the desired element. +. Select the element in the {explorer}. +. On the right sidebar, access the {details} view. +This view presents all the available properties for the selected element, providing a comprehensive overview of its characteristics. + +image::hands-on-read-element.png[Read element] + +[#rename-element] +== Rename an Element + +It is possible to rename an element either from the {explorer}, the {details} view or a representation. + +=== From the {explorer} + +You can update the element name from the {explorer}: + +. Click on the {explorer-menu} next to the element in the {explorer}. +. Select the `Rename` option. +. Update the name in the editable field. +. Click on `Rename`. + +image::hands-on-rename-element-from-project-editor.png[Rename element from project explorer] + +=== From the {details} view + +You can update the element properties from the {details} view: + +. Select the property in the {details} view. +. Update the value in the editable field. +. Validate the changes by pressing the `RETURN` key or clicking anywhere. + +image::hands-on-rename-element-from-details.png[Rename element from Details] + +=== From a representation + +You can update the element name from a representation (diagram...): + +. Select the element in the representation. +. Select the `Edit` tool in the {diag-toolbar}. +. Validate the changes by pressing the `RETURN` key or clicking anywhere. + +image::hands-on-rename-element-from-representation.png[Rename element from representation] + +NOTE: Instead of using the tool in the tool bar, you can press `F2` key or start typing the new value directly to efficiently update the element name. + +[#update-element] +== Update an Element + +It is possible to update element properties either from the {details} view or a representation. + +[#details] +=== From the {details} view + +You can update the element properties from the {details} view: + +. Select the property in the {details} view. +. Update the value in the editable field. +. Validate the changes by pressing the `RETURN` key or clicking anywhere. + +[#representation] +=== From a representation + +You can update the element name from a representation (diagram...): + +. Select the element in the representation. +. Select the `Edit` tool in the {diag-toolbar}. +. Validate the changes by pressing the `RETURN` key or clicking anywhere. + +TIP: Instead of using the tool in the tool bar, you can press `F2` key or start typing the new value directly to efficiently update the element name. + +TIP: A powerful syntax exists for editing element properties directly through the direct edit tool; refer to xref:hands-on/how-tos/model-management.adoc#direct-edit[Direct Edit Tool and Shortcuts] for details. + +[#delete-element] +== Delete an Element + +[WARNING] +==== +This operation is irreversible, once done there is no mean to get the element back. +The element and its children - semantic element and representations - will be deleted. +==== + +NOTE: The deletion will affect everyone. + +To delete an element, follow these steps: + +=== From the {explorer} + +. Open the {explorer-menu} next to the element. +. Click on `Delete`. + +image::hands-on-delete-element-from-explorer.png[Delete element from explorer] + +=== From a representation + +. Select the element in the representation. +. Click on the `Delete` tool in the {diag-toolbar} or press the `DEL` key on your keyboard. + +image::hands-on-delete-element-from-representation.png[Delete element from representation] + +CAUTION: Use the `DEL` key cautiously, as it is a direct shortcut for the delete operation. + +A confirmation dialog appears when an element is deleted via the _Delete from model_ tool in the palette or via the {explorer-menu}. This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. + +image::manage-elements-semantic-deletion.png[{gv} Semantic Deletion] + +[TIP] +==== +This preference is stored in the local storage of the browser. You can reset it by deleting the SysON data in cache of your browser. +==== + +[#direct-edit] +== Direct Edit Tool and Shortcuts + +The {product} supports a subset of the {sysmlv2} textual syntax, which allows you to update multiple elements simultaneously. This makes it more efficient to edit models. + +In general, you can edit the label of a shape in a diagram, and the diagram editor will try to interpret your input and update the corresponding element properties. + +WARNING: If an element has a complex name like `someElementName[x]:someTypeName:>someElement`, when editing, you must retain all the written parts; otherwise, you risk unsetting some values. + +Here are some shortcuts for efficiently editing {product} models: + +* Typing `someName` will update the name of the selected element. +* Typing `:SomeTypeName`, will set the type of the selected element to _SomeTypeName_. +If _SomeTypeName_ does not exist, it will be created as an appropriate type element (e.g., Item Definition, Part Definition, etc.) within the same parent container as the selected element. +* Typing `[x]` on an element or a relationship will set its cardinality to _x_. +* Typing `[1..x]` on an element or a relationship will set its cardinality to _1..x_. +* Typing `[x..*]` on an element or a relationship will set its cardinality to _x..*_. +* Typing `someElement:>otherElement` on a element will set _someElement_ as a `subsetting` of the _otherElement_ if both element are of the same type. +Otherwise, it will create a `specialization` relationship between _someElement_ and _otherElement_. +* Typing `someElement:>>otherElement` on an element will set _someElement_ as a `redefinition` of _otherElement_. + +These shortcuts provide a convenient way to update model elements quickly and efficiently. diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/navigate-representations.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/navigate-representations.adoc deleted file mode 100644 index 570529f..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/navigate-representations.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Navigate thanks to the {representations-view} view - -. Open the {representations-view} view from the right sidebar. -. In the view, you'll find a comprehensive list of all existing representations associated with the selected semantic object. -. To access a representation, simply click on the respective entry in the list. - -image::hands-on-representations-view.png[Representations view] - -[NOTE] -==== -Efficiently manage your representations by deleting them directly from the list. -Click the Delete icon next to the representation name to remove it. -==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc index c9b0539..0e6a2e9 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc @@ -1,21 +1,204 @@ = Project Management -include::user-manual:pages/hands-on/how-tos$create-blank-project.adoc[] +[#create-blank-project] +== Create a Blank Project -include::user-manual:hands-on/how-tos$create-template-project.adoc[] +To create a new Blank project, user has to click on _Blank project_ card at the top of the homepage. -include::user-manual:how-tos$upload-project.adoc[] +image::hands-on-new-project.png[Create New Project] -include::user-manual:hands-on/how-tos$delete-project.adoc[] +Then a popup will appear to set the name of the new project. -include::user-manual:hands-on/how-tos$rename-project.adoc[] +image::hands-on-new-project-conf.png[New Project Configuration] -include::user-manual:hands-on/how-tos$download-project.adoc[] +User will be finally redirected to the newly created project, which will be initially empty. -include::user-manual:hands-on/how-tos$share-project.adoc[] +image::hands-on-new-project-result.png[New Project Result] -include::user-manual:hands-on/how-tos$project-settings.adoc[] +Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/model-management.adoc#create-model[creating your own models] and xref:hands-on/how-tos/representation-operations.adoc#create-representation[representations]. +[#create-template-project] +== Create a Project based on a Template + +To create a new project from a `Template`: + +. Simply click on the corresponding template card at the top of the homepage. + +Only the first three templates are directly visible in the {homepage} top region. +If more templates are available, you can click on the `Show all templates` card to open a dialog displaying all the available templates (possibly on multiple pages). + +image::hands-on-new-template.png[Create New Template] + +. The new project will be automatically created and opened. +Depending on the template, an initial representation (e.g., a diagram) may also be automatically opened. + +The following example shows the result project _Batmobile_ create from _Batmobile_ template: + +image::hands-on-new-template_batmobile.png[Batmobile Template] + +NOTE: The newly created project will have the same name as the template, so it is a good practice to xref:hands-on/how-tos/project-management.adoc#rename-project[rename] it to avoid confusion. + +Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/model-management.adoc#create-model[creating your own models] and xref:hands-on/how-tos/representation-operations.adoc#create-representation[representations]. + +[#upload-project] +== Upload a Project + +[caption=] +==== +// Edition +include::user-manual:partial$feature-edition-os.adoc[] + +// Status +include::user-manual:partial$feature-status-experimental.adoc[] + +// Usage +include::user-manual:partial$feature-usage-all.adoc[] +==== + +[NOTE] +==== +Only projects exported in the specific JSON format recognized by {product} can be re-uploaded using the upload action. +Ensure that your projects are exported using the xref:hands-on/how-tos/project-management.adoc#download-project[Download Project] action to enable successful re-uploading to {product}. +==== + +To upload a project from an archive previously exported, follow these steps: + +. Go to the {homepage}. +. Click on the _Upload Project_ card. + +image::hands-on-upload.png[Upload project] + +. It will open the _Upload Project_ page. +. Select a zip from your file system. + +image::hands-on-upload-select-file.png[Select file to upload] + +. The uploaded project will be automatically created and opened. + +Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/model-management.adoc#create-model[creating your own models] and xref:hands-on/how-tos/representation-operations.adoc#create-representation[representations]. + +[#delete-project] +== Delete a Project + +It is possible to delete a project either from the {homepage} or the {editor}. + +[WARNING] +==== +When you delete a project, you will lose all the data. +Deleting a project and its content is a significant action, and it's important to note that the entire project, along with its contents, will be permanently removed. +This includes all associated models, representations, and any other data within the project. +Exercise caution when performing this operation, as it cannot be reversed. +==== + +=== From the {homepage} + +You can delete a project from the {homepage}: + +. Click on the {projects-list-menu} next to the project in the {projects-list}. +. Select the `Delete` option. + +image::hands-on-delete-project-homepage.png[Delete Project from Homepage] + +. Confirm the deletion by clicking on the `Delete` button in the modal. + +=== From the {editor} + +You can delete a project from the {editor}: + +. Click on the {projects-list-menu} next to the project name in the project tool bar. +. Select the `Delete` option. + +image::hands-on-delete-project-editor.png[Delete Project from editor] + +. Confirm the deletion by clicking on the `Delete` button in the modal. + +[#rename-project] +== Rename a Project + +It is possible to rename a project either from the {homepage} or the {editor}. + +NOTE: Project names don't need to be unique, although unique names do facilitate finding the correct project more easily. +NOTE: The name must contain between 3 and 1024 characters. + +=== From the {homepage} + +You can update the project name from the {homepage}: + +. Click on the {projects-list-menu} next to the project in the {projects-list}. +. Select the `Rename` option. + +image::hands-on-rename-project-homepage.png[Rename Project from Homepage] + +. Update the name in the editable field. +. Click on `Rename`. + +=== From the {editor} + +You can update the project name from the {editor}: + +. Click on the {projects-list-menu} next to the project name in the tool bar. +. Select the `Rename` option. + +image::hands-on-rename-project-editor.png[Rename Project from editor] + +. Update the name in the editable field. +. Click on `Rename`. + +[#download-project] +== Download a Project + +[caption=] +==== +// Edition +include::user-manual:partial$feature-edition-os.adoc[] + +// Status +include::user-manual:partial$feature-status-experimental.adoc[] + +// Usage +include::user-manual:partial$feature-usage-all.adoc[] +==== + +It is possible to download a project either from the {homepage} or the {editor}. + +[NOTE] +==== +The project will be downloaded as an archive containing models and representations in JSON format. +The JSON format used by {product} is specific to the tool. +==== + +=== From the {homepage} + +You can download a project from the {homepage}: + +. Click on the {projects-list-menu} next to the project in the {projects-list}. +. Select the `Download` option. + +image::hands-on-download-project-homepage.png[Download Project from Homepage] + +=== From the {editor} + +You can download a project from the {editor}: + +. Click on the {projects-list-menu} next to the project name in the project tool bar. +. Select the `Download` option. + +image::hands-on-download-project-editor.png[Download Project from editor] + +[##share-project] +== Share a Project + +Sharing a project is as straightforward as providing the project URL to someone because everything within {product} is public. +Once the project URL is shared, the recipient can access and view the project directly. +This simplicity in sharing allows for seamless collaboration and easy communication of project details without the need for complex sharing processes. + +[#project-settings] +== Manage Project Settings + +The purpose of this page is to present the various settings manageable by the administrator of a project. +Currently, there are limited capabilities, such as uploading images, but additional features for project management will be introduced in future updates. +This page will be revisited in future updates, bringing new features and enhanced capabilities for project management. +Stay tuned for the next version to explore additional functionalities and improvements. diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-settings.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-settings.adoc deleted file mode 100644 index 9eb36b3..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-settings.adoc +++ /dev/null @@ -1,6 +0,0 @@ -== Manage Project Settings - -The purpose of this page is to present the various settings manageable by the administrator of a project. -Currently, there are limited capabilities, such as uploading images, but additional features for project management will be introduced in future updates. -This page will be revisited in future updates, bringing new features and enhanced capabilities for project management. -Stay tuned for the next version to explore additional functionalities and improvements. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/read-element.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/read-element.adoc deleted file mode 100644 index 25894a3..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/read-element.adoc +++ /dev/null @@ -1,8 +0,0 @@ -== Read an Element - -. To navigate through the details of a semantic element, utilize the {explorer} to navigate through the model and locate the desired element. -. Select the element in the {explorer}. -. On the right sidebar, access the {details} view. -This view presents all the available properties for the selected element, providing a comprehensive overview of its characteristics. - -image::hands-on-read-element.png[Read element] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-element.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-element.adoc deleted file mode 100644 index 88a3f52..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-element.adoc +++ /dev/null @@ -1,36 +0,0 @@ -== Rename an Element - -It is possible to rename an element either from the {explorer}, the {details} view or a representation. - -=== From the {explorer} - -You can update the element name from the {explorer}: - -. Click on the {explorer-menu} next to the element in the {explorer}. -. Select the `Rename` option. -. Update the name in the editable field. -. Click on `Rename`. - -image::hands-on-rename-element-from-project-explorer.png[Rename element from project explorer] - -=== From the {details} view - -You can update the element properties from the {details} view: - -. Select the property in the {details} view. -. Update the value in the editable field. -. Validate the changes by pressing the `RETURN` key or clicking anywhere. - -image::hands-on-rename-element-from-details.png[Rename element from Details] - -=== From a representation - -You can update the element name from a representation (diagram...): - -. Select the element in the representation. -. Select the `Edit` tool in the {diag-toolbar}. -. Validate the changes by pressing the `RETURN` key or clicking anywhere. - -image::hands-on-rename-element-from-representation.png[Rename element from representation] - -NOTE: Instead of using the tool in the tool bar, you can press `F2` key or start typing the new value directly to efficiently update the element name. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-model.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-model.adoc deleted file mode 100644 index 5639047..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-model.adoc +++ /dev/null @@ -1,10 +0,0 @@ -== Rename a Model - -You can update the model name from the {explorer}: - -. Click on the {explorer-menu} next to the model in the {explorer}. -. Select the `Rename` option. -. Update the name in the editable field. -. Click on `Rename`. - -image::hands-on-rename-model.png[Renam model] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-project.adoc deleted file mode 100644 index 1debdf1..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-project.adoc +++ /dev/null @@ -1,30 +0,0 @@ -== Rename a Project - -It is possible to rename a project either from the {homepage} or the {editor}. - -NOTE: Project names don't need to be unique, although unique names do facilitate finding the correct project more easily. -NOTE: The name must contain between 3 and 1024 characters. - -=== From the {homepage} - -You can update the project name from the {homepage}: - -. Click on the {projects-list-menu} next to the project in the {projects-list}. -. Select the `Rename` option. - -image::hands-on-rename-project-homepage.png[Rename Project from Homepage] - -. Update the name in the editable field. -. Click on `Rename`. - -=== From the {editor} - -You can update the project name from the {editor}: - -. Click on the {projects-list-menu} next to the project name in the tool bar. -. Select the `Rename` option. - -image::hands-on-rename-project-editor.png[Rename Project from editor] - -. Update the name in the editable field. -. Click on `Rename`. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-representation.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-representation.adoc deleted file mode 100644 index 0a15c3c..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-representation.adoc +++ /dev/null @@ -1,10 +0,0 @@ -== Rename a Representation - -You can update the representation name from the {explorer}: - -. Click on the {explorer-menu} next to the representation in the {explorer}. -. Select the `Rename` option. -. Update the name in the editable field. -. Click on `Rename`. - -image::hands-on-rename-representation.png[Rename representation] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc index 4e55fda..5a94074 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc @@ -1,9 +1,90 @@ = Representation Operations -include::user-manual:hands-on/how-tos$create-representation.adoc[] +[#create-representation] +== Create a New Representation -include::user-manual:hands-on/how-tos$delete-representation.adoc[] +To create a representation, follow these steps: -include::user-manual:hands-on/how-tos$rename-representation.adoc[] +. Open the Project Editor. +. Open the {explorer-menu} next to an element in the explorer. +. Select the `New representation` action. +. Fill in the representation name. +. Choose the representation type. +. Click the `Create` button. -include::user-manual:hands-on/how-tos$share-representation.adoc[] \ No newline at end of file +image::hands-on-new-representation.png[Create representation] + +Once completed, the newly created representation will be open automatically and listed in the {explorer} under the element. + +[#delete-representation] +== Delete a Representation + +It is possible to delete a representation either from the {explorer} or the {representations-view}. + +[WARNING] +==== +This operation is irreversible, once done there is no mean to get the representation back. +==== + +NOTE: The semantic elements visible in a representation will not be deleted. + +=== From the {explorer} + +You can delete a representation from the {explorer}: + +. Open the {explorer-menu} next to the representation. +. Click on `Delete`. + +image::hands-on-delete-representation-from-explorer.png[Delete representation from the {explorer}] + +=== From the {representations-view} + +You can delete a representation from the {representations-view}: + +. Open the {representations-view}. +. Select the representation you want to delete. +. Click on the `Delete` button. + +image::hands-on-delete-representation-from-representation-view.png[Delete representation from the {representations-view}] + + +A confirmation dialog appears when a representation is deleted. This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. + +image::gv-semantic-deltion.png[{gv} Semantic Deletion] + +[TIP] +==== +This preference is stored in the local storage of the browser. You can reset it by deleting the SysON data in cache of your browser. +==== + +[#rename-representation] +== Rename a Representation + +You can update the representation name from the {explorer}: + +. Click on the {explorer-menu} next to the representation in the {explorer}. +. Select the `Rename` option. +. Update the name in the editable field. +. Click on `Rename`. + +image::hands-on-rename-representation.png[Rename representation] + +[#share-representation] += Share a Representation + +Facilitating collaboration through representation sharing within {product} is a straightforward process. +Users can effortlessly share a representation by providing its URL to collaborators. +Given that everything within {product} is inherently public, recipients can seamlessly access and view the representation once the URL is shared. +This simplicity in sharing promotes efficient collaboration and simplifies the communication of representation details, eliminating the need for complex sharing procedures. + +== From the {editor} + +To share a representation in {product}, follow these steps: + +. Open the a representation from the explorer. +. Click the `Share` button in the general tool bar at the top of the representation area. +. Copy the link to your clipboard. + +image::hands-on-share-representation.png[Share representation] + +Anyone can use the shared link to directly access this specific representation. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/representations-view.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/representations-view.adoc index 37c45ae..b0574ec 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/representations-view.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/representations-view.adoc @@ -1,3 +1,15 @@ = {representations-view} -include::user-manual:hands-on/how-tos$navigate-representations.adoc[] \ No newline at end of file += Navigate thanks to the {representations-view} view + +. Open the {representations-view} view from the right sidebar. +. In the view, you'll find a comprehensive list of all existing representations associated with the selected semantic object. +. To access a representation, simply click on the respective entry in the list. + +image::hands-on-representations-view.png[Representations view] + +[NOTE] +==== +Efficiently manage your representations by deleting them directly from the list. +Click the Delete icon next to the representation name to remove it. +==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/share-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/share-project.adoc deleted file mode 100644 index 820d5b1..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/share-project.adoc +++ /dev/null @@ -1,5 +0,0 @@ -== Share a Project - -Sharing a project is as straightforward as providing the project URL to someone because everything within {product} is public. -Once the project URL is shared, the recipient can access and view the project directly. -This simplicity in sharing allows for seamless collaboration and easy communication of project details without the need for complex sharing processes. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/share-representation.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/share-representation.adoc deleted file mode 100644 index 0e096e1..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/share-representation.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= Share a Representation - -Facilitating collaboration through representation sharing within {product} is a straightforward process. -Users can effortlessly share a representation by providing its URL to collaborators. -Given that everything within {product} is inherently public, recipients can seamlessly access and view the representation once the URL is shared. -This simplicity in sharing promotes efficient collaboration and simplifies the communication of representation details, eliminating the need for complex sharing procedures. - -== From the {editor} - -To share a representation in {product}, follow these steps: - -. Open the a representation from the explorer. -. Click the `Share` button in the general tool bar at the top of the representation area. -. Copy the link to your clipboard. - -image::hands-on-share-representation.png[Share representation] - -Anyone can use the shared link to directly access this specific representation. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-left-sidebar.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-left-sidebar.adoc deleted file mode 100644 index 7e1bb3d..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-left-sidebar.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Access {explorer} / {validation} views from the left sidebar - -To seamlessly switch between the Explorer view and the Validation view in the left sidebar of {product}, use the following steps: - -. Locate the vertical bar with icons on the left side of the interface. -. Identify the icons corresponding to the `Explorer` and `Validation` views. -. Click on the `Explorer` icon to switch to the Explorer view or click on the `Validation` icon to switch to the Validation view. - -image::hands-on-switch-left-side-bar.png[Switch left side bar] - -NOTE: By clicking on the respective icons, you can easily toggle between the Explorer and Validation views, allowing you to navigate through project elements and examine validation results with convenience. - -NOTE: The sidebar can be toggled by clicking on the icon of the active view. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-right-sidebar.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-right-sidebar.adoc deleted file mode 100644 index a252b9e..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-right-sidebar.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Access {details} / {representations-view} / {related-elements} views from the right sidebar - -To seamlessly switch between the Details, the Representations and the Related Elements views in the right sidebar of {product}, use the following steps: - -. Locate the vertical bar with icons on the right side of the interface. -. Identify the icons corresponding to the desired view. -. Click on the icon to switch to the view. - -image::hands-on-switch-right-side-bar.png[Switch right side bar] - -NOTE: By clicking on the respective icons, you can easily toggle between the views, allowing you to navigate through element properties, representations attached to the element or related semantic elements with convenience. - -NOTE: The sidebar can be toggled by clicking on the icon of the active view. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/sync-editor.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/sync-editor.adoc deleted file mode 100644 index 3c91224..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/sync-editor.adoc +++ /dev/null @@ -1,16 +0,0 @@ -= Synchronize {explorer} / {editor} - -It is possible to disable (and of course re-enable) the synchronization between the {explorer} and the current selection in the {editor}. - -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. -This can require expanding new tree items which were previously not visible or scrolling the {explorer}’s view. - -image::hands-on-synch-editor-result.png[Synchronize editor result] - -When moving between elements in a representation, this can quickly result in an {explorer} view with many tree items expanded, which can be confusing. - -The `Synchronize` toggle button in the {explorer} can be used to disable this synchronization. - -image::hands-on-synch-editor.png[Synchronize editor] - -When synchronization is disabled, tree items that are already expanded in the {explorer} will still be selected, but no new tree items will be automatically expanded. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/update-element.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/update-element.adoc deleted file mode 100644 index a79a7a5..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/update-element.adoc +++ /dev/null @@ -1,25 +0,0 @@ -== Update an Element - -It is possible to update element properties either from the {details} view or a representation. - -[#details] -=== From the {details} view - -You can update the element properties from the {details} view: - -. Select the property in the {details} view. -. Update the value in the editable field. -. Validate the changes by pressing the `RETURN` key or clicking anywhere. - -[#representation] -=== From a representation - -You can update the element name from a representation (diagram...): - -. Select the element in the representation. -. Select the `Edit` tool in the {diag-toolbar}. -. Validate the changes by pressing the `RETURN` key or clicking anywhere. - -TIP: Instead of using the tool in the tool bar, you can press `F2` key or start typing the new value directly to efficiently update the element name. - -TIP: A powerful syntax exists for editing element properties directly through the direct edit tool; refer to xref:hands-on/how-tos/direct-edit.adoc[Direct Edit Tool and Shortcuts] for details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-model.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-model.adoc deleted file mode 100644 index ded4a78..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-model.adoc +++ /dev/null @@ -1,31 +0,0 @@ -== Upload a Model - -[caption=] -==== -// Edition -include::user-manual:partial$feature-edition-os.adoc[] - -// Status -include::user-manual:partial$feature-status-experimental.adoc[] - -// Usage -include::user-manual:partial$feature-usage-all.adoc[] -==== - -[NOTE] -==== -Only models exported in the specific JSON format recognized by {product} can be re-uploaded using the upload action. -Ensure that your models are exported using the xref:hands-on/how-tos/download-model.adoc[Download Model] action to enable successful re-uploading to {product}. -==== - -To upload a model from a file previously exported, follow these steps: - -. Go to the {editor}. -. Open the {explorer} view. -. Click on the `Upload` button at the top of the {explorer} in the tool bar. -. It will open the `Upload Model` modal. -. Select a model from your file system. - -image::hands-on-upload-model.png[Upload model] - -. The uploaded model will be automatically created and opened. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-project.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-project.adoc deleted file mode 100644 index c33518b..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-project.adoc +++ /dev/null @@ -1,35 +0,0 @@ -== Upload a Project - -[caption=] -==== -// Edition -include::user-manual:partial$feature-edition-os.adoc[] - -// Status -include::user-manual:partial$feature-status-experimental.adoc[] - -// Usage -include::user-manual:partial$feature-usage-all.adoc[] -==== - -[NOTE] -==== -Only projects exported in the specific JSON format recognized by {product} can be re-uploaded using the upload action. -Ensure that your projects are exported using the xref:hands-on/how-tos/download-project.adoc[Download Project] action to enable successful re-uploading to {product}. -==== - -To upload a project from an archive previously exported, follow these steps: - -. Go to the {homepage}. -. Click on the _Upload Project_ card. - -image::hands-on-upload.png[Upload project] - -. It will open the _Upload Project_ page. -. Select a zip from your file system. - -image::hands-on-upload-select-file.png[Select file to upload] - -. The uploaded project will be automatically created and opened. - -Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/create-model.adoc[creating your own models] and xref:hands-on/how-tos/create-representation.adoc[representations]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/user-interface-navigation.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/user-interface-navigation.adoc index aaa8093..5771ebd 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/user-interface-navigation.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/user-interface-navigation.adoc @@ -1,5 +1,31 @@ = User Interface Navigation -include::user-manual:hands-on/how-tos$switch-left-sidebar.adoc[] +[#switch-left-sidebar] += Access {explorer} / {validation} views from the left sidebar -include::user-manual:hands-on/how-tos$switch-right-sidebar.adoc[] +To seamlessly switch between the Explorer view and the Validation view in the left sidebar of {product}, use the following steps: + +. Locate the vertical bar with icons on the left side of the interface. +. Identify the icons corresponding to the `Explorer` and `Validation` views. +. Click on the `Explorer` icon to switch to the Explorer view or click on the `Validation` icon to switch to the Validation view. + +image::hands-on-switch-left-side-bar.png[Switch left side bar] + +NOTE: By clicking on the respective icons, you can easily toggle between the Explorer and Validation views, allowing you to navigate through project elements and examine validation results with convenience. + +NOTE: The sidebar can be toggled by clicking on the icon of the active view. + +[#switch-right-sidebar] += Access {details} / {representations-view} / {related-elements} views from the right sidebar + +To seamlessly switch between the Details, the Representations and the Related Elements views in the right sidebar of {product}, use the following steps: + +. Locate the vertical bar with icons on the right side of the interface. +. Identify the icons corresponding to the desired view. +. Click on the icon to switch to the view. + +image::hands-on-switch-right-side-bar.png[Switch right side bar] + +NOTE: By clicking on the respective icons, you can easily toggle between the views, allowing you to navigate through element properties, representations attached to the element or related semantic elements with convenience. + +NOTE: The sidebar can be toggled by clicking on the icon of the active view. diff --git a/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc b/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc index 743ac33..fa97646 100644 --- a/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc @@ -5,11 +5,11 @@ The focus is on representing the Batmobile system, the iconic car of Batman. == Step 1: Create a Project -. Open the {homepage} and xref:hands-on/how-tos/create-template-project.adoc[create a new {sysmlv2} project] by clicking on the {sysmlv2} card. +. Open the {homepage} and xref:hands-on/how-tos/project-management.adoc#create-template-project[create a new {sysmlv2} project] by clicking on the {sysmlv2} card. . The {editor} automatically opens, creating a new project named `{sysmlv2}` with a package `Package1`. A default `{gv}` representation associated with the package is opened in the main editor area. -. From the project toolbar, xref:hands-on/how-tos/rename-project.adoc[rename the project] to `Batmobile`. -. From the {explorer}, xref:hands-on/how-tos/rename-model.adoc[rename the model] to `Batmobile` and the xref:hands-on/how-tos/rename-element.adoc[package] to `User Model`. +. From the project toolbar, xref:hands-on/how-tos/project-management.adoc#rename-project[rename the project] to `Batmobile`. +. From the {explorer}, xref:hands-on/how-tos/model-management.adoc#rename-model[rename the model] to `Batmobile` and the xref:hands-on/how-tos/model-management.adoc#rename-element[package] to `User Model`. == Step 2: Create Elements from a Diagram @@ -18,7 +18,7 @@ A default `{gv}` representation associated with the package is opened in the mai . In the main editor area, click on the diagram background to open the {diag-toolbar}. . Click on the `New Part Definition` tool to create a new part definition. NOTE: The new elements created from the {diag-toolbar} are visible either from the {explorer} or the {editor} main central area. -. Rename the part definition to `Vehicle` using the xref:hands-on/how-tos/update-element.adoc#representation[direct-edit action] or the xref:hands-on/how-tos/update-element.adoc#details[{details} view]. +. Rename the part definition to `Vehicle` using the xref:hands-on/how-tos/update-element.adoc#representation[direct-edit action] or the xref:hands-on/how-tos/model-management.adoc#update-element#details[{details} view]. . Select the `Vehicle` part definition and click on the `Nested Item Usage` tool to create an item usage. . Rename the item usage to `driver`. . Select the `Vehicle` part definition and click on the `Nested Part Usage` tool to create a new part usage. diff --git a/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc b/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc index d012d2f..d694575 100644 --- a/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc +++ b/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc @@ -38,6 +38,6 @@ Element labels can be edited in the following ways: With direct edit, user cannot change the keyword but he can change the name. If it is a simple label, he can rename the element. If user modify the multiplicity defined in the label then the multiplicity of the relationship is changed in the model. User can alos set/change the specialization of a given element. -Explore further by referring to the following how-tos for xref:hands-on/how-tos/direct-edit.adoc[direct edit action] +Explore further by referring to the following how-tos for xref:hands-on/how-tos/model-management.adoc#direct-edit[direct edit action] Label of edges and compartments node cannot be edited. \ No newline at end of file