diff --git a/doc/README b/doc/README index daa3e19..6347df1 100644 --- a/doc/README +++ b/doc/README @@ -4,4 +4,13 @@ One sentence per line. Use asciidoc attributes to reference elements of the application UI. Use asciidoc attributes to reference URL. For reference to menus, key on the keyboard... use `backticks`. -Use + on new line in table to force a new line \ No newline at end of file +Use + on new line in table to force a new line + +# Antora use +* Ensure that docker is launch +## on linux +* Launch the script SysON\doc\generate.bash in a terminal +## on Windows +* Lunch the script SysON\doc\generate.bash in a Windows Power shell console +## Result +* Generation result is available in SysON\doc\docs-site\build\site \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/index.adoc b/doc/content/modules/ROOT/pages/index.adoc index 5dcb9dc..67bcfbc 100644 --- a/doc/content/modules/ROOT/pages/index.adoc +++ b/doc/content/modules/ROOT/pages/index.adoc @@ -1,5 +1,7 @@ = Welcome to {product} +SysON represents an open-source web-based tooling to edit SysML v2 models. It includes a set of editors (graphical, textual, form-based, etc.) enabling users to build the various parts of system models. + Start your learning journey with {product}. include::overview.adoc[leveloffset=+1] diff --git a/doc/content/modules/installation-guide/pages/how-tos/install.adoc b/doc/content/modules/installation-guide/pages/how-tos/install.adoc index 8d38704..1496e94 100644 --- a/doc/content/modules/installation-guide/pages/how-tos/install.adoc +++ b/doc/content/modules/installation-guide/pages/how-tos/install.adoc @@ -15,7 +15,10 @@ Before you proceed with the installation, please ensure you have the following x {product} uses PostgreSQL as its database. -TIP: For development or local testing, the simplest approach is to initiate a PostgreSQL instance using Docker. +[TIP] +==== +For development or local testing, the simplest approach is to initiate a PostgreSQL instance using Docker. +==== [source, bash] ---- @@ -26,7 +29,10 @@ docker run -p 5434:5432 --name syson-postgres \ -d postgres ---- -NOTE: This may take a while the first time you run this as Docker will first pull the PostgreSQL image. +[NOTE] +==== +This may take a while the first time you run this as Docker will first pull the PostgreSQL image. +==== If you don't have Docker or prefer to utilize an existing PostgreSQL installation, modify the following command-line parameters and ensure the `POSTGRES_USER` possesses administrative rights on the database. These rights are necessary for the automatic creation of the database schema. diff --git a/doc/content/modules/installation-guide/pages/requirements.adoc b/doc/content/modules/installation-guide/pages/requirements.adoc index 12db174..4fe9d71 100644 --- a/doc/content/modules/installation-guide/pages/requirements.adoc +++ b/doc/content/modules/installation-guide/pages/requirements.adoc @@ -7,7 +7,10 @@ Before installing {product}, make sure you have the right software and infrastru These system prerequisites lay the foundation for optimal performance and functionality, guaranteeing that {product} operates efficiently on your environment. Take a moment to review and align your system with the recommended specifications outlined below to ensure a smooth installation and a robust user experience. -NOTE: If a platform and version is not listed on this page, it means we don't test it, fix bugs or provide assistance for it. +[NOTE] +==== +If a platform and version is not listed on this page, it means we don't test it, fix bugs or provide assistance for it. +==== [#server-req] == Server-side installation requirements @@ -74,7 +77,10 @@ Please note that {product} is currently not supported on mobile devices. WARNING: {product} does not support Internet Explorer. -NOTE: We support a minimum screen resolution of 1024 x 768 (when browsers are maximized). +[NOTE] +==== +We support a minimum screen resolution of 1024 x 768 (when browsers are maximized). +==== === Supported operating system @@ -85,7 +91,10 @@ The minimum operating system (OS) requirements are: * Any Linux OS that supports the browsers mentioned above * Any Chrome OS that supports the browsers mentioned above -NOTE: You can find out what browser and operating system version you’re using via https://www.whatsmybrowser.org/[What’s my Browser]. +[NOTE] +==== +You can find out what browser and operating system version you’re using via https://www.whatsmybrowser.org/[What’s my Browser]. +==== [CAUTION] ==== diff --git a/doc/content/modules/user-manual/assets/images/details-right-sidebar-details.png b/doc/content/modules/user-manual/assets/images/details-right-sidebar-details.png new file mode 100644 index 0000000..065611a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/details-right-sidebar-details.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-editor.png b/doc/content/modules/user-manual/assets/images/editor-editor.png new file mode 100644 index 0000000..a024722 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-editor.svg b/doc/content/modules/user-manual/assets/images/editor-editor.svg deleted file mode 100644 index 58c0187..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-editor.svg +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor-left-sidebar-explorer.png b/doc/content/modules/user-manual/assets/images/editor-left-sidebar-explorer.png new file mode 100644 index 0000000..de3b46a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-left-sidebar-explorer.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-left-sidebar-explorer.svg b/doc/content/modules/user-manual/assets/images/editor-left-sidebar-explorer.svg deleted file mode 100644 index 52bcf2a..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-left-sidebar-explorer.svg +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor-left-sidebar-validation.png b/doc/content/modules/user-manual/assets/images/editor-left-sidebar-validation.png new file mode 100644 index 0000000..d3e2c6e Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-left-sidebar-validation.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-left-sidebar-validation.svg b/doc/content/modules/user-manual/assets/images/editor-left-sidebar-validation.svg deleted file mode 100644 index 70fee17..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-left-sidebar-validation.svg +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor-projectActions.png b/doc/content/modules/user-manual/assets/images/editor-projectActions.png new file mode 100644 index 0000000..3b2dd6d Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-projectActions.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-details.png b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-details.png new file mode 100644 index 0000000..a0274e1 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-details.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-details.svg b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-details.svg deleted file mode 100644 index b4e7ff3..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-details.svg +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-related-elements.png b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-related-elements.png new file mode 100644 index 0000000..2b84818 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-related-elements.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-related-elements.svg b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-related-elements.svg deleted file mode 100644 index 9a3425a..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-related-elements.svg +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-representations.png b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-representations.png new file mode 100644 index 0000000..614ff3f Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-representations.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-representations.svg b/doc/content/modules/user-manual/assets/images/editor-right-sidebar-representations.svg deleted file mode 100644 index 3965a35..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-right-sidebar-representations.svg +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor-toolbar.png b/doc/content/modules/user-manual/assets/images/editor-toolbar.png new file mode 100644 index 0000000..27277c7 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor-toolbar.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor-toolbar.svg b/doc/content/modules/user-manual/assets/images/editor-toolbar.svg deleted file mode 100644 index d3c9960..0000000 --- a/doc/content/modules/user-manual/assets/images/editor-toolbar.svg +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/editor.png b/doc/content/modules/user-manual/assets/images/editor.png new file mode 100644 index 0000000..891b577 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/editor.svg b/doc/content/modules/user-manual/assets/images/editor.svg deleted file mode 100644 index ec50e1e..0000000 --- a/doc/content/modules/user-manual/assets/images/editor.svg +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/gv-allocation-edge.png b/doc/content/modules/user-manual/assets/images/gv-allocation-edge.png new file mode 100644 index 0000000..41e3a37 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-allocation-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-containment-edge.png b/doc/content/modules/user-manual/assets/images/gv-containment-edge.png new file mode 100644 index 0000000..0851623 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-containment-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-dependency-edge.png b/doc/content/modules/user-manual/assets/images/gv-dependency-edge.png new file mode 100644 index 0000000..9e1a91a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-dependency-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-diagram-creation.png b/doc/content/modules/user-manual/assets/images/gv-diagram-creation.png new file mode 100644 index 0000000..401fdce Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-diagram-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-featureTyping-edge.png b/doc/content/modules/user-manual/assets/images/gv-featureTyping-edge.png new file mode 100644 index 0000000..54ec8c7 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-featureTyping-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-overview.png b/doc/content/modules/user-manual/assets/images/gv-overview.png new file mode 100644 index 0000000..a2c3ebb Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-overview.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-package-node.png b/doc/content/modules/user-manual/assets/images/gv-package-node.png new file mode 100644 index 0000000..bf9424e Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-package-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-part-compartment-node.png b/doc/content/modules/user-manual/assets/images/gv-part-compartment-node.png new file mode 100644 index 0000000..89d918b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-part-compartment-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-part-node.png b/doc/content/modules/user-manual/assets/images/gv-part-node.png new file mode 100644 index 0000000..a9500a6 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-part-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-partDef-compartment-node.png b/doc/content/modules/user-manual/assets/images/gv-partDef-compartment-node.png new file mode 100644 index 0000000..d2aab56 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-partDef-compartment-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-partDef-node.png b/doc/content/modules/user-manual/assets/images/gv-partDef-node.png new file mode 100644 index 0000000..9a9caef Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-partDef-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-redefinition-edge.png b/doc/content/modules/user-manual/assets/images/gv-redefinition-edge.png new file mode 100644 index 0000000..78d36cd Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-redefinition-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-subclassification-edge.png b/doc/content/modules/user-manual/assets/images/gv-subclassification-edge.png new file mode 100644 index 0000000..ef207fe Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-subclassification-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/gv-subsetting-edge.png b/doc/content/modules/user-manual/assets/images/gv-subsetting-edge.png new file mode 100644 index 0000000..36796e5 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/gv-subsetting-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-element-from-explorer.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-element-from-explorer.png new file mode 100644 index 0000000..d4326ed Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-element-from-explorer.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-element-from-representation.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-element-from-representation.png new file mode 100644 index 0000000..fff3173 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-element-from-representation.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-model.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-model.png new file mode 100644 index 0000000..9a8c04d Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-model.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-project-editor.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-project-editor.png new file mode 100644 index 0000000..c8f6e26 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-project-editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-project-homepage.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-project-homepage.png new file mode 100644 index 0000000..44a8b88 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-project-homepage.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-representation-from-explorer.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-representation-from-explorer.png new file mode 100644 index 0000000..effdf79 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-representation-from-explorer.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-delete-representation-from-representation-view.png b/doc/content/modules/user-manual/assets/images/hands-on-delete-representation-from-representation-view.png new file mode 100644 index 0000000..a8f6ad7 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-delete-representation-from-representation-view.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-download-model.png b/doc/content/modules/user-manual/assets/images/hands-on-download-model.png new file mode 100644 index 0000000..a98ec0b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-download-model.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-download-project-editor.png b/doc/content/modules/user-manual/assets/images/hands-on-download-project-editor.png new file mode 100644 index 0000000..81cff67 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-download-project-editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-download-project-homepage.png b/doc/content/modules/user-manual/assets/images/hands-on-download-project-homepage.png new file mode 100644 index 0000000..05d474b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-download-project-homepage.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-expand-all.png b/doc/content/modules/user-manual/assets/images/hands-on-expand-all.png new file mode 100644 index 0000000..d0a24e5 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-expand-all.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-filter-element.png b/doc/content/modules/user-manual/assets/images/hands-on-filter-element.png new file mode 100644 index 0000000..6bc9367 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-filter-element.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-filter-name-shortcut.png b/doc/content/modules/user-manual/assets/images/hands-on-filter-name-shortcut.png new file mode 100644 index 0000000..165a2e3 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-filter-name-shortcut.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-element.png b/doc/content/modules/user-manual/assets/images/hands-on-new-element.png new file mode 100644 index 0000000..4c2837c Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-element.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-model-result.png b/doc/content/modules/user-manual/assets/images/hands-on-new-model-result.png new file mode 100644 index 0000000..7215380 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-model-result.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-model.png b/doc/content/modules/user-manual/assets/images/hands-on-new-model.png new file mode 100644 index 0000000..055482b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-model.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-project-conf.png b/doc/content/modules/user-manual/assets/images/hands-on-new-project-conf.png new file mode 100644 index 0000000..193393a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-project-conf.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-project-result.png b/doc/content/modules/user-manual/assets/images/hands-on-new-project-result.png new file mode 100644 index 0000000..d34d497 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-project-result.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-project.png b/doc/content/modules/user-manual/assets/images/hands-on-new-project.png new file mode 100644 index 0000000..31c9367 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-project.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-representation.png b/doc/content/modules/user-manual/assets/images/hands-on-new-representation.png new file mode 100644 index 0000000..827dbae Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-representation.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-template.png b/doc/content/modules/user-manual/assets/images/hands-on-new-template.png new file mode 100644 index 0000000..43af2cc Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-template.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-new-template_batmobile.png b/doc/content/modules/user-manual/assets/images/hands-on-new-template_batmobile.png new file mode 100644 index 0000000..335734d Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-new-template_batmobile.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-read-element.png b/doc/content/modules/user-manual/assets/images/hands-on-read-element.png new file mode 100644 index 0000000..6ab64dc Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-read-element.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-details.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-details.png new file mode 100644 index 0000000..cfea070 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-details.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-project-editor.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-project-editor.png new file mode 100644 index 0000000..5330d5b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-project-editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-representation.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-representation.png new file mode 100644 index 0000000..e759444 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-element-from-representation.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-model.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-model.png new file mode 100644 index 0000000..5c23cd6 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-model.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-project-editor.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-project-editor.png new file mode 100644 index 0000000..6ab1b28 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-project-editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-project-homepage.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-project-homepage.png new file mode 100644 index 0000000..41abe9d Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-project-homepage.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-rename-representation.png b/doc/content/modules/user-manual/assets/images/hands-on-rename-representation.png new file mode 100644 index 0000000..ab5e2c4 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-rename-representation.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-representations-view.png b/doc/content/modules/user-manual/assets/images/hands-on-representations-view.png new file mode 100644 index 0000000..56abc43 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-representations-view.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-share-representation.png b/doc/content/modules/user-manual/assets/images/hands-on-share-representation.png new file mode 100644 index 0000000..e04e9a6 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-share-representation.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-switch-left-side-bar.png b/doc/content/modules/user-manual/assets/images/hands-on-switch-left-side-bar.png new file mode 100644 index 0000000..eee972b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-switch-left-side-bar.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-switch-right-side-bar.png b/doc/content/modules/user-manual/assets/images/hands-on-switch-right-side-bar.png new file mode 100644 index 0000000..5797249 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-switch-right-side-bar.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-synch-editor-result.png b/doc/content/modules/user-manual/assets/images/hands-on-synch-editor-result.png new file mode 100644 index 0000000..d4892f0 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-synch-editor-result.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-synch-editor.png b/doc/content/modules/user-manual/assets/images/hands-on-synch-editor.png new file mode 100644 index 0000000..43a55ca Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-synch-editor.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-upload-model.png b/doc/content/modules/user-manual/assets/images/hands-on-upload-model.png new file mode 100644 index 0000000..7328564 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-upload-model.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-upload-select-file.png b/doc/content/modules/user-manual/assets/images/hands-on-upload-select-file.png new file mode 100644 index 0000000..d7be536 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-upload-select-file.png differ diff --git a/doc/content/modules/user-manual/assets/images/hands-on-upload.png b/doc/content/modules/user-manual/assets/images/hands-on-upload.png new file mode 100644 index 0000000..ff218b8 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/hands-on-upload.png differ diff --git a/doc/content/modules/user-manual/assets/images/homepage-existing-projects.png b/doc/content/modules/user-manual/assets/images/homepage-existing-projects.png new file mode 100644 index 0000000..ab7cf01 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/homepage-existing-projects.png differ diff --git a/doc/content/modules/user-manual/assets/images/homepage-existing-projects.svg b/doc/content/modules/user-manual/assets/images/homepage-existing-projects.svg deleted file mode 100644 index 25df80c..0000000 --- a/doc/content/modules/user-manual/assets/images/homepage-existing-projects.svg +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/homepage-new-project.png b/doc/content/modules/user-manual/assets/images/homepage-new-project.png new file mode 100644 index 0000000..281a672 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/homepage-new-project.png differ diff --git a/doc/content/modules/user-manual/assets/images/homepage-new-project.svg b/doc/content/modules/user-manual/assets/images/homepage-new-project.svg deleted file mode 100644 index 3fa5017..0000000 --- a/doc/content/modules/user-manual/assets/images/homepage-new-project.svg +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/homepage-toolbar.png b/doc/content/modules/user-manual/assets/images/homepage-toolbar.png new file mode 100644 index 0000000..e04970a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/homepage-toolbar.png differ diff --git a/doc/content/modules/user-manual/assets/images/homepage-toolbar.svg b/doc/content/modules/user-manual/assets/images/homepage-toolbar.svg deleted file mode 100644 index da4e1be..0000000 --- a/doc/content/modules/user-manual/assets/images/homepage-toolbar.svg +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/homepage.png b/doc/content/modules/user-manual/assets/images/homepage.png new file mode 100644 index 0000000..fd4c663 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/homepage.png differ diff --git a/doc/content/modules/user-manual/assets/images/homepage.svg b/doc/content/modules/user-manual/assets/images/homepage.svg deleted file mode 100644 index 63add7a..0000000 --- a/doc/content/modules/user-manual/assets/images/homepage.svg +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-allocation-edge.png b/doc/content/modules/user-manual/assets/images/interconnection-view-allocation-edge.png new file mode 100644 index 0000000..03d66d1 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-allocation-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-bind-edge.png b/doc/content/modules/user-manual/assets/images/interconnection-view-bind-edge.png new file mode 100644 index 0000000..eb396f6 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-bind-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-diagram-creation.png b/doc/content/modules/user-manual/assets/images/interconnection-view-diagram-creation.png new file mode 100644 index 0000000..0bb737d Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-diagram-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-overview.png b/doc/content/modules/user-manual/assets/images/interconnection-view-overview.png new file mode 100644 index 0000000..8603346 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-overview.png differ diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-part-compartment-node.png b/doc/content/modules/user-manual/assets/images/interconnection-view-part-compartment-node.png new file mode 100644 index 0000000..dcc9649 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-part-compartment-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-part-node.png b/doc/content/modules/user-manual/assets/images/interconnection-view-part-node.png new file mode 100644 index 0000000..419bbc0 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-part-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/interconnection-view-port-node.png b/doc/content/modules/user-manual/assets/images/interconnection-view-port-node.png new file mode 100644 index 0000000..17f5561 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/interconnection-view-port-node.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-drag-drop-graphical.png b/doc/content/modules/user-manual/assets/images/manage-drag-drop-graphical.png new file mode 100644 index 0000000..0ab2182 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-drag-drop-graphical.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-delete-from-diagram.png b/doc/content/modules/user-manual/assets/images/manage-elements-delete-from-diagram.png new file mode 100644 index 0000000..6144338 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-delete-from-diagram.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-delete-from-model.png b/doc/content/modules/user-manual/assets/images/manage-elements-delete-from-model.png new file mode 100644 index 0000000..54f1058 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-delete-from-model.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-fromBackground-creation.png b/doc/content/modules/user-manual/assets/images/manage-elements-fromBackground-creation.png new file mode 100644 index 0000000..ab4131e Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-fromBackground-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-fromCompartment-creation.png b/doc/content/modules/user-manual/assets/images/manage-elements-fromCompartment-creation.png new file mode 100644 index 0000000..88b72c9 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-fromCompartment-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-fromElement-creation.png b/doc/content/modules/user-manual/assets/images/manage-elements-fromElement-creation.png new file mode 100644 index 0000000..ef0878a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-fromElement-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-fromParentCompartment-creation.png b/doc/content/modules/user-manual/assets/images/manage-elements-fromParentCompartment-creation.png new file mode 100644 index 0000000..454aa86 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-fromParentCompartment-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-elements-semantic-deletion.png b/doc/content/modules/user-manual/assets/images/manage-elements-semantic-deletion.png new file mode 100644 index 0000000..4a5538b Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-elements-semantic-deletion.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-exisiting-elements-add.png b/doc/content/modules/user-manual/assets/images/manage-exisiting-elements-add.png new file mode 100644 index 0000000..9817740 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-exisiting-elements-add.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-group-element-toolbar.png b/doc/content/modules/user-manual/assets/images/manage-group-element-toolbar.png new file mode 100644 index 0000000..1449dca Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-group-element-toolbar.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-labels-compartment.png b/doc/content/modules/user-manual/assets/images/manage-labels-compartment.png new file mode 100644 index 0000000..66528cd Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-labels-compartment.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-labels-keywords.png b/doc/content/modules/user-manual/assets/images/manage-labels-keywords.png new file mode 100644 index 0000000..aa55485 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-labels-keywords.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-labels-multiplicity.png b/doc/content/modules/user-manual/assets/images/manage-labels-multiplicity.png new file mode 100644 index 0000000..0ad883c Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-labels-multiplicity.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-labels-specialization.png b/doc/content/modules/user-manual/assets/images/manage-labels-specialization.png new file mode 100644 index 0000000..5866b57 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-labels-specialization.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-arrow.png b/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-arrow.png new file mode 100644 index 0000000..2274921 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-arrow.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-feedback.png b/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-feedback.png new file mode 100644 index 0000000..b81cdf5 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-feedback.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-popup.png b/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-popup.png new file mode 100644 index 0000000..d56e616 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-relationships-createEdge-popup.png differ diff --git a/doc/content/modules/user-manual/assets/images/manage-toolbar-main.png b/doc/content/modules/user-manual/assets/images/manage-toolbar-main.png new file mode 100644 index 0000000..ea88410 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/manage-toolbar-main.png differ diff --git a/doc/content/modules/user-manual/assets/images/relatedElements-right-sidebar-related-elements.png b/doc/content/modules/user-manual/assets/images/relatedElements-right-sidebar-related-elements.png new file mode 100644 index 0000000..2ec5908 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/relatedElements-right-sidebar-related-elements.png differ diff --git a/doc/content/modules/user-manual/assets/images/representations-right-sidebar-representations.png b/doc/content/modules/user-manual/assets/images/representations-right-sidebar-representations.png new file mode 100644 index 0000000..18f61d8 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/representations-right-sidebar-representations.png differ diff --git a/doc/content/modules/user-manual/assets/images/tutorial-result.png b/doc/content/modules/user-manual/assets/images/tutorial-result.png new file mode 100644 index 0000000..a7df66e Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/tutorial-result.png differ diff --git a/doc/content/modules/user-manual/pages/concepts.adoc b/doc/content/modules/user-manual/pages/concepts.adoc index 9749342..4e13487 100644 --- a/doc/content/modules/user-manual/pages/concepts.adoc +++ b/doc/content/modules/user-manual/pages/concepts.adoc @@ -7,9 +7,15 @@ This section provides a comprehensive exploration of the fundamental principles In {product}, a *Project* serves as a high-level container that organizes <>. You can utilize projects to group models, providing a structured and efficient way to manage your content. -NOTE: It is important to note that creating sub-projects within a project is not supported. +[NOTE] +==== +It is important to note that creating sub-projects within a project is not supported. +==== -NOTE: All models exist at the same level within a project. +[NOTE] +==== +All models exist at the same level within a project. +==== This design ensures simplicity and clarity in organizing and accessing your models, fostering a straightforward and intuitive project management experience. 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/details.adoc b/doc/content/modules/user-manual/pages/features/details.adoc index ee1118b..2aa4581 100644 --- a/doc/content/modules/user-manual/pages/features/details.adoc +++ b/doc/content/modules/user-manual/pages/features/details.adoc @@ -2,6 +2,6 @@ The {details} view provides a comprehensive overview of the selected element, presenting distinct _Property_ sections for each _characteristic_ of the semantic object. -image::editor-right-sidebar-details.svg[{details}] +image::details-right-sidebar-details.png[{details}] CAUTION : It's important to note that any changes made in the {details} view have a direct and immediate effect on the underlying model, making these modifications instantly available to everyone accessing the model. \ 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 3f03391..21a8a78 100644 --- a/doc/content/modules/user-manual/pages/features/editor.adoc +++ b/doc/content/modules/user-manual/pages/features/editor.adoc @@ -7,7 +7,7 @@ include::user-manual:partial$feature-edition-os.adoc[] // Status -include::user-manual:partial$feature-status-experimental.adoc[] +include::user-manual:partial$feature-status-stable.adoc[] // Usage include::user-manual:partial$feature-usage-all.adoc[] @@ -25,36 +25,41 @@ To help you navigate seamlessly and kickstart collaboration with your team, we p The {editor} features four distinct regions: a <>, a <>, a main <>, and a <>. The layout has been simplified to ensure a clear understanding of the content within each section. -image::editor.svg[{editor}] +image::editor.png[{editor}] === Toolbar -The toolbar houses a selection of actions categorized into three groups: ': _Homepage_, _Project Actions_ and _Help_. +The toolbar houses a selection of actions categorized into three groups: ': _Homepage_, _Project Actions_ (with the name of the project) and _Help_. -image::editor-toolbar.svg[{editor} Toolbar] +image::editor-toolbar.png[{editor} Toolbar] -include::partial$homepage-action.adoc[leveloffset=+2] +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] For further actions, refer to: xref:hands-on/hands-on.adoc[] -include::partial$help-action.adoc[leveloffset=+2] +include::user-manual:partial$help-action.adoc[leveloffset=+3] === Left Sidebar The left sidebar contains different views like the xref:features/explorer.adoc[{explorer}] and the xref:features/validation.adoc[{validation}] to assist you working on your project. -NOTE: The left sidebar provides information related to the project. +[NOTE] +==== +The left sidebar provides information related to the project. +==== [%noheader] |=== -a|image::editor-left-sidebar-explorer.svg[{editor} Left sidebar Explorer] a|image::editor-left-sidebar-explorer.svg[{editor} Left sidebar Validation] +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 @@ -62,7 +67,7 @@ The main area to edit your models and representations. You can open as many editors as you like. The {editor} area contains one or more editors. -image::editor-editor.svg[{editor} Main Editor] +image::editor-editor.png[{editor} Main Editor] Discover the diverse range of representation options available and find the most suitable ones for your specific modeling needs. xref:features/features.adoc#sysmlv2-views[Explore various types of representations...] @@ -71,11 +76,14 @@ xref:features/features.adoc#sysmlv2-views[Explore various types of representatio The right sidebar contains different views like the xref:features/details.adoc[{details}], the xref:features/representations-view.adoc[{representations-view}] and the xref:features/related-elements.adoc[{related-elements}] views to ... -NOTE: The content of the right sidebar depends on the current selection. +[NOTE] +==== +The content of the right sidebar depends on the current selection. +==== [%noheader] |=== -a|image::editor-right-sidebar-details.svg[{editor} Right sidebar Details] a|image::editor-right-sidebar-representations.svg[{editor} Right sidebar Representations] a|image::editor-right-sidebar-related-elements.svg[{editor} Right sidebar Related Elements] +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 ccb3ac5..6bfef07 100644 --- a/doc/content/modules/user-manual/pages/features/explorer.adoc +++ b/doc/content/modules/user-manual/pages/features/explorer.adoc @@ -15,7 +15,7 @@ include::user-manual:partial$feature-usage-all.adoc[] 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. -image::editor-left-sidebar-explorer.svg[{editor} Left sidebar Explorer] +image::editor-left-sidebar-explorer.png[{editor} Left sidebar Explorer] * *Models*: Represented by the models existing in the specific project. * *Semantic Elements*: Located within the models, these are instances of your business domain concepts, each with its own set of children. @@ -25,9 +25,9 @@ image::editor-left-sidebar-explorer.svg[{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/general-view.adoc b/doc/content/modules/user-manual/pages/features/general-view.adoc index 1920ed5..518ae02 100644 --- a/doc/content/modules/user-manual/pages/features/general-view.adoc +++ b/doc/content/modules/user-manual/pages/features/general-view.adoc @@ -6,57 +6,152 @@ It is the most general view, enabling presentation of any model element. // Unsynchronized include::user-manual:partial$view-unsynchronized.adoc[] -The following elements can be displayed in the {gv}: +image::gv-overview.png[{gv} Overview] -* Attribute Definition -* Attribute Usage -* Enumeration Definition -* Interface Definition -* Interface Usage -* Item Definition -* Item Usage -* Metadata Definition -* Package -* Part Definition -* Part Usage -* Port Definition -* Port Usage +== Create New General View Diagram -Compartments -* Definition -** Attributes -** Items -** Ports -* Usage -** Attributes -** Ports -* Enumeration -** Items +User can create {gv} diagram on any element provided it inherits from Namespace type. -Relationship -* +image::gv-diagram-creation.png[{gv} Diagram Creation] +include::user-manual:partial$manage-toolbar-diagram.adoc[] -== Manage elements +== Element representation -=== Create element +Six categories of elements can be represented on {gv} diagram. -=== Delete element +=== _Definition_ elements -== Manage features +The following _Definition_ elements can be displayed in the {gv} diagram: -== Manage relationships + * Action Definition, + * Allocation Definition, + * Attribute Definition, + * Constraint Definition, + * Enumeration Definition, + * Interface Definition, + * Item Definition, + * Metadata Definition, + * Occurrence Definition, + * Part Definition, + * Port Definition, + * Requirement Definition, + * UseCase Definition. -=== Create relationship +_Definition_ elements are represented by rectangular node style. Keyword with "Def" specification is defined in the label of the node. -=== Reconnect relationship +image::gv-partDef-node.png[{gv} Part Def Node] -=== Delete relationship +=== _Usage_ elements -== Manage existing elements +The following _Usage_ elements can be displayed in the {gv} diagram: + + * Action Usage, + * Allocation Usage, + * Attribute Usage, + * Constraint Usage, + * Interface Usage, + * Item Usage, + * Occurrence Usage, + * Part Usage, + * Port Usage, + * Requirement Usage, + * UseCase Usage. + +_Usage_ elements are represented by rectangular node style with rounded corner. + +image::gv-part-node.png[{gv} Part Node] + +=== Elements in _Definition_ elements + +The following element in _Definition_ compartiments can be displayed in the {gv} diagram: + + * Action in _Action Definition_, + * Attribute in _Attribute Definition_/_Interface Definition_/_Item Definition_/_Metadata Definition_/_Occurrence Definition_/_Part Definition_/_Port Definition_/_Requirement Definition_, + * Constraint in _Constraint Definition_, + * Enumerated Value in _Enumeration Definition_, + * Interface in _Interface Definition_, + * Port in _Interface Definition_/_Part Definition_, + * Reference in _Metadata Definition_/_Port Definition_, + * Occurence in _Occurrence Definition_, + * Assumed Constraint in _Requirement Definition_, + * Required Constraint in _Requirement Definition_. + +Each element in _Definition_ nodes are represented in dedicated compartment. A _Definition_ node can have several compartiments if _Definition_ element can contain multiple kind of element. Each compartment is distinguished by a specific identifier. + +image::gv-partDef-compartment-node.png[{gv} Part Def Compartment Node] + +=== Elements in _Usage_ elements + +The following element in _Usage_ compartiments can be displayed in the {gv} diagram: + + * Action in _Action Usage_, + * Item in _Action Usage_, + * Allocation in _Allocation Usage_, + * Attribute in _Attribute Usage_/_Interface Usage_/_Item Usage_/_Part Usage_/_Port Usage_/_Requirement Usage_, + * Reference in _Attribute Usage_/_Item Usage_/_Port Usage_, + * Constraint in _Constrint Usage_, + * Port in _Interface Usage_/_Part Usage_, + * Occurence in _Occurence Usage_, + * Assumed Constraint in _Requirement Usage_, + * Required cinstraint in _Requirement Usage_. + +Each element in _Definition_ nodes are represented in dedicated compartment. A _Definition_ node can have several compartiments if _Definition_ element can contain multiple kind of element. Each compartment is distinguished by a specific identifier. + +image::gv-part-compartment-node.png[{gv} Part Compartment Node] + +=== _Package_ element + +_Package_ element can be represented on {gv} diagram. It is represented by a folder and its label contains the keyword "package". + +image::gv-package-node.png[{gv} Package Node] + +=== Relationship + +The following Relationship can be displayed in the {gv} diagram: + +* Dependency, + +image::gv-dependency-edge.png[{gv} Dependency Edge] + + +* Subclassification, + +image::gv-subclassification-edge.png[{gv} Subclassification Edge] + +* Redefinition, + +image::gv-redefinition-edge.png[{gv} Redefinition Edge] + +* Subsetting, + +image::gv-subsetting-edge.png[{gv} Subsetting Edge] + +* Feature Typing, + +image::gv-featureTyping-edge.png[{gv} FeatureTyping Edge] + +* Allocation, + +image::gv-allocation-edge.png[{gv} Allocation Edge] + +* Containement relation. + +image::gv-containment-edge.png[{gv} Containment Edge] + + +include::user-manual:partial$manage-elements-diagram.adoc[] + +include::user-manual:partial$manage-relationships-diagram.adoc[] + +include::user-manual:partial$manage-labels-diagram.adoc[] + +include::user-manual:partial$manage-drag-drop.adoc[] + +include::user-manual:partial$manage-existing-elements.adoc[] + +include::user-manual:partial$manage-group-elements.adoc[] -== Add related elements -== Edit labels diff --git a/doc/content/modules/user-manual/pages/features/homepage.adoc b/doc/content/modules/user-manual/pages/features/homepage.adoc index f4eec6e..fb830e4 100644 --- a/doc/content/modules/user-manual/pages/features/homepage.adoc +++ b/doc/content/modules/user-manual/pages/features/homepage.adoc @@ -8,7 +8,7 @@ include::user-manual:partial$feature-edition-os.adoc[] // Status -include::user-manual:partial$feature-status-experimental.adoc[] +include::user-manual:partial$feature-status-stable.adoc[] // Usage include::user-manual:partial$feature-usage-all.adoc[] @@ -26,37 +26,43 @@ To assist you in navigating effectively and initiating collaboration with your t The homepage features three distinct regions: a <>, a <> section, and an <> section. We've streamlined the layout to provide a clear understanding of the content housed in each location. -image::homepage.svg[{homepage}] +image::homepage.png[{homepage}] === Toolbar The toolbar consists of two groups, each featuring a single action: _Homepage_ and _Help_. -image::homepage-toolbar.svg[{homepage} Toolbar] +image::homepage-toolbar.png[{homepage} Toolbar] -include:partials$homepage-action.adoc[leveloffset=+2] -include:partials$help-action.adoc[leveloffset=+2] +include::user-manual:partial$homepage-action.adoc[leveloffset=+3] + +include::user-manual:partial$help-action.adoc[leveloffset=+3] === Create a New Project The _Create New Project_ section is designed to allow users to easily initiate the creation of a new project. -image::homepage-new-project.svg[Create a New Project] +image::homepage-new-project.png[Create a New Project] Within the platform, initiating a new project is a user-friendly process that accommodates various preferences: -* **Create a Blank Project**: Users can start their modeling journey with a clean slate, building a project from the ground up. -* **Create a Project from Existing Templates**: For efficiency and consistency, users can select from predefined templates that streamline project initiation, aligning with common modeling scenarios. +* **Create a Blank Project**: Users can start their modeling journey with a clean slate, building a project from the ground up. With blank project, there is no model and no representation at creation. +* **Create a Project from Existing Templates**: For efficiency and consistency, users can select from predefined templates that streamline project initiation, aligning with common modeling scenarios. The 3 first possible templates are displayed unitary at the beginning of Project sections and they are also available in "Show all templates" section. For now, there exist two available templates : _Batmobile_ and _SysMLv2_. +_Batmobile- template is a complete SysML project with many concepts of each SysML type (many kind of _Definitions_ and _Usages_ with relationships). +_SysMLv2_ is an empty SysML project with only the root model, a _Package_ and a {gv} representation. * **Upload a Previously Exported Project**: Facilitating collaboration and workflow continuity, users can effortlessly upload a project previously exported, ensuring seamless transitions and flexibility in collaboration. -NOTE: Every project you create will have its own xref:features/editor.adoc[Project Editor]. +[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 The _Existing Projects_ section streamlines project navigation, allowing users to effortlessly browse through their available projects. -image::homepage-existing-projects.svg[Existing Projects] +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/interconnection-view.adoc b/doc/content/modules/user-manual/pages/features/interconnection-view.adoc index 3367070..c2b7cb1 100644 --- a/doc/content/modules/user-manual/pages/features/interconnection-view.adoc +++ b/doc/content/modules/user-manual/pages/features/interconnection-view.adoc @@ -1,3 +1,62 @@ = Interconnection View -//TODO \ No newline at end of file +The {Interconnection View} is employed to show encapsulated structural contents of _Usage- element: Parts, Properties, Connectors, Ports, and Interfaces. + +// Unsynchronized +include::user-manual:partial$view-unsynchronized.adoc[] + +image::interconnection-view-overview.png[{Interconnection view Overview] + +== Create New Interconnection View Diagram + +User can create Interconnection view diagram on _Usage_ element_. + +image::interconnection-view-diagram-creation.png[Interconnection view Diagram Creation] + +include::user-manual:partial$manage-toolbar-diagram.adoc[] + +== Element representation + +=== _Usage_ elements + +From the root _Usage_, two elements can be displayed in the Interconnection view diagram: + +* _Usage_ part, + +image::interconnection-view-part-node.png[Interconnection view Part] + +* port. + +image::interconnection-view-port-node.png[Interconnection view Port] + +From compartment of _Usage_ part, three elements can be displayed in the Interconnection view diagram: + +* attribute +* part +* port + +image::interconnection-view-part-compartment-node.png[Interconnection view Compartment part] + +=== Relationship + +The following Relationship can be displayed in the {gv} diagram: + +* Binding connector as _Usage_, + +image::interconnection-view-bind-edge.png[Interconnection view Bind Edge] + +* Allocation, + +image::interconnection-view-allocation-edge.png[Interconnection view Allocation Edge] + +include::user-manual:partial$manage-elements-diagram.adoc[] + +include::user-manual:partial$manage-relationships-diagram.adoc[] + +include::user-manual:partial$manage-labels-diagram.adoc[] + +include::user-manual:partial$manage-drag-drop.adoc[] + +include::user-manual:partial$manage-existing-elements.adoc[] + +include::user-manual:partial$manage-group-elements.adoc[] diff --git a/doc/content/modules/user-manual/pages/features/interoperability.adoc b/doc/content/modules/user-manual/pages/features/interoperability.adoc index 655ffdb..f800af8 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 @@ -23,7 +23,10 @@ Stay tuned for updates on its availability in the project. == {sysmlv2} Standard API -NOTE: Currently, the SysML v2 API is unavailable. For interoperability with SysON, utilize the provided file exchange format. +[NOTE] +==== +Currently, the SysML v2 API is unavailable. For interoperability with SysON, utilize the provided file exchange format. +==== {product}'s vision includes a dedicated commitment to interoperability, with a future-oriented perspective on supporting standard APIs for seamless connections with a diverse array of modeling resources. While the implementation of standard APIs is an aspect under consideration for future development, {product} aims to provide a foundation for fluid collaboration between different tools within the Model-Based Systems Engineering (MBSE) landscape. diff --git a/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc b/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc index 43544dd..bdc8ac0 100644 --- a/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc +++ b/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc @@ -2,10 +2,29 @@ == General +To delete a given element, user can select the element and the press the `Del` key from representation editor. + == Basic editing -== Selection +User can press `F2` key or start typing the new value directly to efficiently update an element name from representation editor. + +Explore further by referring to the following how-tos for xref:partial/manage-labels-diagram.adoc#edit-label[Edit Label action]. + +== Multi-selection + +There are two way to select many elements. + +=== CTRL key + +User can select on element by clicking on it and then select an other one by pressing `Ctrl` key and clicking on this other element. +This keyboard shortcut is available from representation editor but also from the {explorer} view. + +=== Shift key + +To select many element in one action from representation editor, user can press `Shift` key and draw a rectangular area around elements that he wants to select. After releasing the click, all element in the area are selected. == Search -//TODO \ No newline at end of file +User can display the filter bar by pressing `Ctrl+f` (Windows/Linux) or `Cmd+f` (MacOS) from the {explorer} view. + +Explore further by referring to the following how-tos for xref:hands-on/how-tos/explorer.adoc#explorer-filter[Filter elements]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/related-elements.adoc b/doc/content/modules/user-manual/pages/features/related-elements.adoc index 928a153..7194acb 100644 --- a/doc/content/modules/user-manual/pages/features/related-elements.adoc +++ b/doc/content/modules/user-manual/pages/features/related-elements.adoc @@ -2,7 +2,7 @@ For a more focused exploration, delve into the {related-elements} view. -image::editor-right-sidebar-related-elements.svg[{related-elements}] +image::relatedElements-right-sidebar-related-elements.png[{related-elements}] This feature offers a contextual perspective on the currently selected element. diff --git a/doc/content/modules/user-manual/pages/features/representations-view.adoc b/doc/content/modules/user-manual/pages/features/representations-view.adoc index e19d687..3d54e94 100644 --- a/doc/content/modules/user-manual/pages/features/representations-view.adoc +++ b/doc/content/modules/user-manual/pages/features/representations-view.adoc @@ -2,6 +2,6 @@ Explore the {representations-view} view to gain insights into the available representations associated with the currently selected element. -image::editor-right-sidebar-representations.svg[{representations-view} view] +image::representations-right-sidebar-representations.png[{representations-view} view] This view provides a comprehensive list of all existing representations, offering a convenient overview of the various ways the element is visually represented within the project. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/validation.adoc b/doc/content/modules/user-manual/pages/features/validation.adoc index 4b28b2e..bff6c81 100644 --- a/doc/content/modules/user-manual/pages/features/validation.adoc +++ b/doc/content/modules/user-manual/pages/features/validation.adoc @@ -1,4 +1,6 @@ = {validation} The {validation} view displays diagnostics for the entire project, organized by their kind (such as `ERROR`, `WARNING`, or `INFO`). -Users can conveniently toggle the visibility of diagnostics using an accordion widget. \ No newline at end of file +Users can conveniently toggle the visibility of diagnostics using an accordion widget. + +Validation view is disable for now and no diagnostic are available. \ No newline at end of file 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 5e3dc71..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-blank-project.adoc +++ /dev/null @@ -1,4 +0,0 @@ -= Create a Blank Project - -You will be redirected to the newly created project, which will be initially empty. -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 90b2f24..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-element.adoc +++ /dev/null @@ -1,10 +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`. - -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 2f9396d..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-model.adoc +++ /dev/null @@ -1,22 +0,0 @@ -= Create a New Model - -To create a model, follow these steps: - -== From the project toolbar - -. Open the Project Editor. -. Open the {explorer-menu} next to the project name in the toolbar. -. Select the `New model` action. -. Fill in the model name. -. Choose the model type. -. Click the `Create` button. - -== From the explorer toolbar - -. Open the Project Editor. -. Click on the `New model` action in the explorer toolbar. -. Fill in the model name. -. Choose the model type. -. Click the `Create` button. - -Once completed, the newly created model will be listed in the {explorer}. \ No newline at end of file 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 97a49ae..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-representation.adoc +++ /dev/null @@ -1,12 +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. - -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 a81e138..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/create-template-project.adoc +++ /dev/null @@ -1,14 +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 page. -. 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. - -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. - -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). - -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 89c507e..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-element.adoc +++ /dev/null @@ -1,24 +0,0 @@ -= Delete an Element - -[WARNING] -==== -There is no confirmation dialog to delete an element. -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`. - -== 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. - -CAUTION: Use the `DEL` key cautiously, as it is a direct shortcut for the delete operation. \ 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 db17894..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-model.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Delete a Model - -[WARNING] -==== -There is no confirmation dialog to delete a model. -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`. \ 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 9d2b2b6..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-project.adoc +++ /dev/null @@ -1,27 +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. -. 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 toolbar. -. Select the `Delete` option. -. 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 e3d0ee6..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/delete-representation.adoc +++ /dev/null @@ -1,26 +0,0 @@ -= Delete a Representation - -It is possible to delete a representation either from the {explorer} or the {representations-view}. - -[WARNING] -==== -There is no confirmation dialog to delete a representation. -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`. - -== 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. \ 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 fab8da9..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 a 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 1e28618..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/download-model.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= Download a Model - -You can download a model from the {explorer}: - -. Click on the {explorer-menu} next to the model in the {explorer}. -. Select the `Download` option. - -[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 ad05868..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/download-project.adoc +++ /dev/null @@ -1,23 +0,0 @@ -= Download a Project - -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. - -== 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 toolbar. -. Select the `Download` option. \ 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 1ec56f4..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/expand-all.adoc +++ /dev/null @@ -1,14 +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`. - -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 new file mode 100644 index 0000000..e4c8bec --- /dev/null +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc @@ -0,0 +1,78 @@ += {explorer} + +[#sync-editor] +== 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. + +[#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. + +[#explorer-filter] +== 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 ff9038a..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/filter-explorer.adoc +++ /dev/null @@ -1,16 +0,0 @@ -= Filter elements in the {explorer} - -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. -. 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. -==== \ 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 new file mode 100644 index 0000000..f6777b7 --- /dev/null +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc @@ -0,0 +1,282 @@ += Model Management + +[#create-model] +== 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] + +[#upload-model] +== 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/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[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[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/project-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc new file mode 100644 index 0000000..578736e --- /dev/null +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc @@ -0,0 +1,214 @@ += Project Management + +[#create-blank-project] +== 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/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 44840a9..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 0ec9ed1..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/read-element.adoc +++ /dev/null @@ -1,6 +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 left sidebar, access the {details} view. -This view presents all the available properties for the selected element, providing a comprehensive overview of its characteristics. \ 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 430769c..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-element.adoc +++ /dev/null @@ -1,32 +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`. - -== 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. -.. Alternatively, cancel the operation by pressing the `ESC` key. - -== 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. -.. Alternatively, cancel the operation by pressing the `ESC` key. - -NOTE: Instead of using the tool in the toolbar, 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 39590bc..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-model.adoc +++ /dev/null @@ -1,8 +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`. \ 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 6bcd85d..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-project.adoc +++ /dev/null @@ -1,24 +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. -. 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 toolbar. -. Select the `Rename` option. -. 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 21f0d0e..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/rename-representation.adoc +++ /dev/null @@ -1,8 +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`. \ 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 new file mode 100644 index 0000000..4e7ac6e --- /dev/null +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc @@ -0,0 +1,93 @@ += Representation Operations + +[#create-representation] +== 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. + +[#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::manage-elements-semantic-deletion.png[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/navigate-representations.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/representations-view.adoc similarity index 75% rename from doc/content/modules/user-manual/pages/hands-on/how-tos/navigate-representations.adoc rename to doc/content/modules/user-manual/pages/hands-on/how-tos/representations-view.adoc index 9ffe038..27d2a96 100644 --- 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/representations-view.adoc @@ -1,9 +1,13 @@ -= Navigate thanks to the {representations-view} view += {representations-view} + +== 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. 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 fec23bd..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 f835123..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/share-representation.adoc +++ /dev/null @@ -1,16 +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 toolbar at the top of the representation area. -. Copy the link to your clipboard. - -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 c73c4dc..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-left-sidebar.adoc +++ /dev/null @@ -1,11 +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. - -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 32f840e..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/switch-right-sidebar.adoc +++ /dev/null @@ -1,11 +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. - -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 96ad71a..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/sync-editor.adoc +++ /dev/null @@ -1,11 +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. - -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. -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 e284ce4..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/update-element.adoc +++ /dev/null @@ -1,27 +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. -.. Alternatively, cancel the operation by pressing the `ESC` key. - -[#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. -.. Alternatively, cancel the operation by pressing the `ESC` key. - -TIP: Instead of using the tool in the toolbar, 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 2830154..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-model.adoc +++ /dev/null @@ -1,16 +0,0 @@ -= Upload a Model - -[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 toolbar. -. It will open the `Upload Model` modal. -. Select a model from your file system. -. 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 10b3479..0000000 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/upload-project.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Upload a Project - -[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. -. It will open the _Upload Project_ page. -. Select a zip from your file system. -. 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 new file mode 100644 index 0000000..86b251e --- /dev/null +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/user-interface-navigation.adoc @@ -0,0 +1,43 @@ += User Interface Navigation + +[#switch-left-sidebar] +== 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. +==== + +[#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..a0bdeab 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 @@ -17,22 +17,26 @@ 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]. -. Select the `Vehicle` part definition and click on the `Nested Item Usage` tool to create an item usage. + +[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/model-management.adoc#update-element#details[{details} view]. +. Select the `Vehicle` part definition and click on the `New Item` 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. +. Select the `Vehicle` part definition and click on the `New Part` tool to create a new part usage. . Rename the part usage to `engine`. === Setting Multiplicity -. Select the `Vehicle` part definition and click on the `Nested Part Usage` tool in the {diag-toolbar} to create a new part usage +. Select the `Vehicle` part definition and click on the `New Part` tool in the {diag-toolbar} to create a new part usage . Rename the part usage to `wheels`. -. Select the relationship between `Vehicle` and `wheels`, set the multiplicity label to `[4]`. === Using Drag and Drop -. Select the `wheels` part usage, rename it `wheels[4]:Wheel`. +. Select the `wheels` part usage, type "F2" and rename it `wheels[4] : Wheel`. . A new `Wheel` part definition is created in the model. . Drag and drop the `Wheel` element from the {explorer} onto the diagram background. . The `Wheel` part definition appears on the diagram within the `Typed By` relationship between the `Wheel` and the `wheels` part usage. @@ -41,10 +45,10 @@ NOTE: The new elements created from the {diag-toolbar} are visible either from t === Adding Attributes -. Select the `attributes` compartment in the `Vehicle` part definition and click on the `New Attribute Usage` tool in the {diag-toolbar}. +. Select the `Vehicle` part definition and click on the `New Attribute` tool in the {diag-toolbar}. . A new attribute usage is created. . Select the attribute and use the direct-edit tool to rename it to `actualSpeed : SpeedUnit` -. A new attribute definition named `SpeedUnit` is created automatically +. A new import element appears in model which refers to the library `ISQSpaceTime` that contains `SpeedUnit` . The attribute usage `actualSpeed` is typed with the new attribute definition. === Creating Specialization @@ -56,16 +60,46 @@ NOTE: The new elements created from the {diag-toolbar} are visible either from t === Creating Subsetting -. Click on the diagram background and select the `New Part Usage` tool. +. Click on the diagram background and select the `New Part` tool. . A new part usage is created. . Rename it to `frontRightWheel :> wheels`. . A new `subsetting` relationship appears between the two parts usages `frontRightWheel` and `wheels`. +. Redo same actions by creating new part `frontLeftWheel :> wheels`. === Creating Redefinition -. Click on the diagram background and click on the `New Part Definition` tool. -. A new part definition is created. +. Click on the diagram background and click on the `New Part` tool. +. A new part usage is created. . Rename it to `bulletProofWheels[4]:>>wheels`. . A new `redefines` relationship appears between the `bulletProofWheels` part definition and the`wheels` part usage. -NOTE: To explore a more complete Batmobile example, use the Batmobile template available on the {homepage}. \ No newline at end of file +== Step 4: Create Relationship + +=== Creating specialization relationship + +. Click on the diagram background and click on the `New Part Definition` tool. +. A new part definition is created. +. Rename it `BatmobileNG` +. Click on node `BatmobileNG`. +. Click on arrow border and hold down until `Batmobile:> Vehicle` node. +. Select the `Subclassification` tool. + + +=== Creating containment relationships + +. Click on node `frontRightWheel :> wheels`. +. Click on arrow border and hold down until `Batmobile:> Vehicle` node. +. Select the `Become nested part` tool. +. A new containment edge is created and element `frontRightWheel` is moved under `Batmobile` in model +. Redo same actions with `frontLeftWheel :> wheels`. +. Click on node `bulletProofWheels[4] :>> wheels`. +. Click on arrow border and hold down until `BatmobileNG:> Batmobile` node. +. Select the `Become nested part` tool. +. A new containment edge is created and element `bulletProofWheels` is moved under `BatmobileNG` in model + +[NOTE] +==== +To explore a more complete Batmobile example, use the Batmobile template available on the {homepage}. +==== + +image::tutorial-result.png[Tutorial result] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/key-features.adoc b/doc/content/modules/user-manual/pages/key-features.adoc index 6eed2c5..d7f29a0 100644 --- a/doc/content/modules/user-manual/pages/key-features.adoc +++ b/doc/content/modules/user-manual/pages/key-features.adoc @@ -22,109 +22,109 @@ This dual categorization allows users to choose features based on their comfort 4+h|Projects Management |xref:features/homepage.adoc[Projects Browser] -a|icon:times[role=red] -a|icon:check[role=green] -a| +a|icon:times[role=Red] +a|icon:check[2x,role=Green] +a|icon:check[2x,role=Green] |xref:features/editor.adoc[Project Editor] a|icon:times[role=red] -a|icon:check[role=green] -a| +a|icon:check[2x,role=green] +a|icon:check[2x,role=green] |xref:features/editor.adoc#project-actions[Manage Project] a|icon:times[role=red] -a|icon:check[role=green] -a| +a|icon:check[2x,role=green] +a|icon:check[2x,role=green] |xref:user-manual:support.adoc[Teams] a|icon:times[role=red] a|icon:times[role=red] -a|icon:check[role=green] +a|icon:check[2x,role=green] 4+h|{sysmlv2} Views |xref:user-manual:features/general-view.adoc[{gv}] a|icon:check[role=green] a|icon:check[role=gray] partial -a| +a|icon:check[role=gray] partial |xref:user-manual:features/interconnection-view.adoc[Interconnection View] -a|icon:check[role=green] -a|icon:check[role=gray] partial -a| +a|icon:check[2x,role=green] +a|icon:check[2x,role=gray] partial +a|icon:check[2x,role=gray] partial |xref:user-manual:sysmlv2-overview.adoc[Action Flow View] -a|icon:check[role=green] +a|icon:check[2x,role=green] +a|icon:times[role=red] a|icon:times[role=red] -a| |xref:user-manual:sysmlv2-overview.adoc[State Transition View] -a|icon:check[role=green] +a|icon:check[2x,role=green] +a|icon:times[role=red] a|icon:times[role=red] -a| |xref:user-manual:sysmlv2-overview.adoc[Sequence View] -a|icon:check[role=green] +a|icon:check[2x,role=green] +a|icon:times[role=red] a|icon:times[role=red] -a| |xref:user-manual:sysmlv2-overview.adoc[Geometry View] -a|icon:check[role=green] +a|icon:check[2x,role=green] +a|icon:times[role=red] a|icon:times[role=red] -a| |xref:user-manual:sysmlv2-overview.adoc[Grid View] -a|icon:check[role=green] +a|icon:check[2x,role=green] +a|icon:times[role=red] a|icon:times[role=red] -a| |xref:user-manual:sysmlv2-overview.adoc[Browser View] -a|icon:check[role=green] +a|icon:check[2x,role=green] +a|icon:times[role=red] a|icon:times[role=red] -a| 4+h|Collaboration & Interoperability |xref:features/collaboration.adoc[Share Projects] a|icon:times[role=red] -a|icon:times[role=gray] (All the projects are Public) -a| +a|icon:times[2x,role=gray] (All the projects are Public) +a|icon:times[2x,role=gray] (All the projects are Public) |xref:features/collaboration.adoc[Share Diagram] a|icon:times[role=red] -a|icon:check[role=green] -a| +a|icon:check[2x,role=green] +a|icon:check[2x,role=green] |xref:features/interoperability.adoc[Download / Upload JSON format] a|icon:times[role=red] -a|icon:check[role=green] -a| +a|icon:check[2x,role=green] +a|icon:check[2x,role=green] |xref:features/interoperability.adoc[Download / Upload Standard {sysmlv2} JSON format] -a|icon:times[role=green] a|icon:times[role=red] -a| +a|icon:times[role=red] +a|icon:times[role=red] |xref:features/interoperability.adoc[Download / Upload {sysmlv2} textual format] a|icon:times[role=green] -a|icon:check[role=gray] Experimental -a| +a|icon:check[2x,role=gray] Experimental +a|icon:check[2x,role=gray] Experimental |xref:user-manual:support.adoc[Live Collaboration] a|icon:times[role=red] a|icon:times[role=red] -a|icon:check[role=green] +a|icon:check[2x,role=green] 4+h|Advanced |xref:user-manual:support.adoc[Authentication (SSO, LDAP, AD)] a|icon:times[role=red] a|icon:times[role=red] -a|icon:check[role=green] +a|icon:check[2x,role=green] |xref:user-manual:support.adoc[Accounts Administration] a|icon:times[role=red] a|icon:times[role=red] -a|icon:check[role=green] +a|icon:check[2x,role=green] |=== diff --git a/doc/content/modules/user-manual/pages/release-notes.adoc b/doc/content/modules/user-manual/pages/release-notes.adoc index e51ee46..292e9ce 100644 --- a/doc/content/modules/user-manual/pages/release-notes.adoc +++ b/doc/content/modules/user-manual/pages/release-notes.adoc @@ -1,5 +1,64 @@ = Release notes +== 2024.3.0 + +=== Breaking changes + +- Refactor Node Descriptions Providers in General View with rename of these providers to match with all Definitions and Usages Node Descriptions. +- After switch to https://github.com/eclipse-sirius/sirius-web/releases/tag/v2024.3.0[Sirius Web v2024.3.0], `GeneralViewRegistryConfigurer` has been renamed to `GeneralViewDescriptionProvider`. +`SysMLv2ObjectService` has been renamed into `SysMLv2LabelService` as it now implements `ILabelServiceDelegate` instead of `IObjectServiceDelegate`. +- Refactor diagrams code with creation of the diagram-common-view module to gather all cross diagram tools and there is now one name generator per diagram owning the diagram prefix used to prefix all descriptions for this diagram. + +=== Dependency update + +- `commons-io 2.11.0` dependency has been explicitly added in `syson-application-configuration`. +- Switch to https://github.com/eclipse-sirius/sirius-web/releases/tag/v2024.3.0[Sirius Web v2024.3.0] + +=== Improvements + +- By activating direct Edit, User can now change the name/type/value/range of an element without any lost. The direct edit of labels in diagrams now handles partial edition. +- When user wants to create new elements under a selected element, only provides candidates that will make sense are proposed among new objects candidates in Explorer view context menu. The creation of elements with their containing Membership is now done in one click. +- A recursive version of the "Add existing elements" tool is now available to display all the cluster of objects contained in a selected node, +- Package headers' width has been improved to better handle longer labels. +- It is now impossible to have Package children overlapping the Package body's west border. +- All KerML and SysML standard libraries have been added in project definition. These libraries are not visible in the Explorer. Users can reference these libraries elements from the Details view or through the direct edit of elements in diagrams. +- Tools names have been renamed by adding spaces between type words and removing "Usage" from tool names. +- User can now create elements inside list compartments via the containing node's palette and the new element is created inside the correct compartment. +- General View diagram palette has been reorganized. New tool sections have been added to group semantically node tools by creation concept. +- In the Details view, standard libraries are now displayed in Reference Widget's model browser dialog. +- `getAllReachable()` util service used to retrieve the elements of a given type has been improved to reduce its time execution. +- FeatureTyping Edge creation tool has been added to set the type of a Usage. +- Add kind property from RequirementConstraintMembership on Constraint core properties. + +=== New features + +- A new filter `Hide Memberships` has been added in Explorer view tool bar to hide membership elements in the Explorer view. +- A new filter `Hide KerML Standard Libraries` has been added in Explorer view tool bar to hide KerML/SysML libraries in the Explorer view. +- `Action Flow view` diagrams are now available on Package elements. +- `Requirement view` diagrams are now available on Package elements. +- It is now possible to import SysMLv2 textual files into SysON, through the existing document upload modal. + +== 2024.1.0 + +=== Breaking changes + +- All `findUsageByName` and `findDefinitionByName` method have been replaced by the new `findByNameAndType` in `org.eclipse.syson.services.UtilService`. +- Delete useless fork of `UploadDocumentEventHandler` & `DocumentController` from Sirius Web. + +=== Dependency update + +- Switch to https://github.com/eclipse-sirius/sirius-web/releases/tag/v2024.1.1[Sirius Web v2024.1.1] +- SysON SysMLv2 metamodel module now depends on `org.eclipse.emf.ecore.xmi` and `java-uuid-generator`. +- Switch to vite 4.5.2 + +=== New features + +- Display help background message on empty general-view diagram. +- Add support for SysMLv2 standard libraries. Only some KerML libraries have been added: +Base, BooleanFunctions, Clocks, CollectionFunctions, Collections, ComplexFunctions, ControlFunctions, DataFunctions, IntegerFunctions, KerML, Links, NaturalFunctions, NumericalFunctions, RationalFunctions, RealFunctions, ScalarFunctions, ScalarValues, SequenceFunctions, StringFunctions, TrigFunctions, VectorFunctions, VectorValues. +Some of these libraries may have partial content. Other libraries and complete existing libraries will be added in future releases. +- Add support for automatic imports. + == 2023.12.0 icon:trophy[] Initial release! diff --git a/doc/content/modules/user-manual/partials/manage-drag-drop.adoc b/doc/content/modules/user-manual/partials/manage-drag-drop.adoc new file mode 100644 index 0000000..379f48b --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-drag-drop.adoc @@ -0,0 +1,12 @@ +== Semantic Drag&Drop + +Users can select elements in the Explorer view and drag and drop them into their container Nodes in the diagram. This drag and drop doesn’t perform any semantic modification. Diagrams also allow semantic drag and drop of any element from the Explorer view (in the same resourceSet as the diagram) on the background of the diagram. + +Note that it is not possible to Drag and drop an element represented as an Edge on the diagram. + + +== Graphical Drag&Drop + +User can select a node on the diagram and drag and drop it in an other container node. Only authorized containers are revealed on the diagram, forbidden targets are faded. When user try to drag and drop a node, the target container node is highlighted. + +image::manage-drag-drop-graphical.png[Graphical Drag and Drop] \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc b/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc new file mode 100644 index 0000000..022b548 --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc @@ -0,0 +1,41 @@ +== Manage elements + +=== Create element + +User can create element **from the background** of the diagram from a simple click that displays tool bar. +In this tool bar, element creation tool are grouped by type in tool section according to their type. User can expand the tool section and then he can click on the desired creation tool + +image::manage-elements-fromBackground-creation.png[Creation from Diagram Background] + +User can also create element **in other element**. User just clicks on the element to display the tool bar and then click on the desired creation tool. + +image::manage-elements-fromElement-creation.png[Creation from Diagram Element] + +All created element are collapsed by default, it means that if a node with compartment is created, compartment are hidden. + +If node contains **compartment**, user can add element in the desired compartment by clicking in the compartment and display the tool bar. + +image::manage-elements-fromCompartment-creation.png[Creation from Compartment] + +An other way is to click on the parent node header of the compartment. A tool bar will be display and the user can click on the desired creation tool, new element will be created in the appropriate compartment. + +image::manage-elements-fromParentCompartment-creation.png[Creation from Parent Compartment] + +=== Delete element + +User can only delete a graphical element from the diagram without removing it from the model. User should just click on _Delete from diagram_ button in the palette. + +image::manage-elements-delete-from-diagram.png[Delete from diagram] + +User can also remove element from model (and so from diagram) by clicking on _Delete from model_ button in the palette. + +image::manage-elements-delete-from-model.png[Delete from model] + +A confirmation dialog appears when an element is deleted via the _Delete from model_ tool in the palette or 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[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/partials/manage-existing-elements.adoc b/doc/content/modules/user-manual/partials/manage-existing-elements.adoc new file mode 100644 index 0000000..cfa4f83 --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-existing-elements.adoc @@ -0,0 +1,8 @@ +== Manage existing elements + +From the diagram background or from a given node, it is possible to display all exisiting elements contained by the initial selection. User just need to display the palette and unfold _Existing elements_ section. + +image::manage-exisiting-elements-add.png[Add exisiting elements] + +User can click on _Add existing elements_ to display elements directly contained by the selection. +User can also click on _Add existing elements (recursive)_ to display elements directly contained by the selection and elements contained by these elements and so on. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/manage-group-elements.adoc b/doc/content/modules/user-manual/partials/manage-group-elements.adoc new file mode 100644 index 0000000..f9211d6 --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-group-elements.adoc @@ -0,0 +1,42 @@ +== Manage multi-elements + +When user select multiple elements, many actions are available to manage all selected element. + +=== From tool bar + +After user selected some elements, a simplified tool bar is displayed. + +image::manage-group-element-toolbar.png[Group element tool bar] + +User can still used basic tools such as : + +* Hide elements, +* Fade elements, +* Pin elements. + +A new tool section appears in this tool bar. Many tools acting on selected elements layout can be found in this tool section : + +* Align left, +* Align center, +* Align right, +* Align top, +* Align middle, +* Align bottom, +* Arrange in row, +* Arrange in column, +* Arrange in grid, +* Distribute horizontal spacing, +* Distribute vertical spacing, +* Justify horizontally, +* Justify vertically, +* Make same size. + +=== From mouse and shortcuts + +In addition to tool bar actions, some actions can be execute with shortcuts. + +Indeed, after user selected some elements, user can press the key "Del" to remove all selected elements. + +User can also move all selected element on the diagram without changing its graphical or semantic parent. + + diff --git a/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc b/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc new file mode 100644 index 0000000..bd303a1 --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc @@ -0,0 +1,44 @@ +== Manage Labels + +=== Element Label + +**Keywords** on Nodes and Edges are displayed on the first separate line of the label. For example _Definition_ nodes will be prefixed with "part def" and _Usage_ node with "part". + +image::manage-labels-keywords.png[Label with keyword] + +After the keyword, the label can be the **simple name of the element, or more complex** in some specific cases. Indeed, For example, subset of the {sysmlv2} textual syntax is supported to describe some element. For simple _Definition_ element, the label will display the keyword "part def" and its declared name. +For elements using _specialization_, the label will display the kind of the _specilalization_. For example, if a _Batmobile_ is a subclassification of _Vehicle_, its label will display the key word "part def" and then "Batmobile :> Vehicle" to show its specalization toward _Vehicle_. + +image::manage-labels-specialization.png[Label with specialization] + +If _Usage_ element is given by relationship with **multiplicity**, the multiplicity value (upper and lower bound) is specified between bracket in the label, just before the specialization. +For example, for a _Batmobile_ which contained 4 _Wheel_ by using the _Usage_ _wheels_ then the label will be composed of the keyword "part" followed by the name _wheels[4] : Wheel_ which described the _Usage_ _wheels_ with multiplicity 4 defined by the _Definition_ _Wheel_. + +image::manage-labels-multiplicity.png[Label with multiplicity] + +For element with compartment node (with list layout), the label of compartment node will be displayed in _italic_ and it will only contained a simple name. + +image::manage-labels-compartment.png[Label for compartment] + +=== Edge Label + +No label is defined on edges except in two cases : + +* allocation edge label is specified with its keyword _allocate_, +* edge which represent relationship with multiplicity have their multiplicity defined in their label (ex.: containment edge). + +[#edit-label] +=== Edit Labels + +Element labels can be edited in the following ways: + +* Edit action of the Palette, +* Press F2, +* Type directly the new name. + +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/model-management.adoc#direct-edit[direct edit action] + +Label of edges and compartments node cannot be edited. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc b/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc new file mode 100644 index 0000000..628d164 --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc @@ -0,0 +1,36 @@ +== Manage relationships + +=== Create relationship + +Relationship Edges can be created between Nodes whose types match the Edge’s source and target types. + +If no edge creation is authorized with a given target, the target node appears faded. + +When user try to create an edge, he clicks first on the source element to display arrow border. + +image::manage-relationships-createEdge-arrow.png[Arrow to create Edge] + +Then he clicks on one of these arrows and stay click until the target. User can see the feedback of the edge and the target node is highlighted. + +image::manage-relationships-createEdge-feedback.png[Feedback to create Edge] + +After releasing the click, a popup appears and displays all possible kind of edge to create. If only one kind of edge is possible, the edge is directly create without opening the popup. + +image::manage-relationships-createEdge-popup.png[Popup to create Edge] + +It is not possible for now to create an Edge between two Edges or between an Edge and a Node. + +=== Reconnect relationship + +Users can reconnect Edges by clicking on the source or target end of the Edge to reconnect, and drag and drop it on a new element. + +If the new source or the new target is not allowed for reconnection, these one will be faded. + +=== Delete relationship + +To delete relationship from model, user should click on the edge and click on the delete button. + +Remember that relationship edge are always synchronized, it is not possible to only delete relationship edge from diagram. + +Containment relationShip is not deletable from the diagram. +Other relationship can be deletable from the diagram. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/manage-toolbar-diagram.adoc b/doc/content/modules/user-manual/partials/manage-toolbar-diagram.adoc new file mode 100644 index 0000000..43ea568 --- /dev/null +++ b/doc/content/modules/user-manual/partials/manage-toolbar-diagram.adoc @@ -0,0 +1,19 @@ +== Toolbar + +The Diagram panel has global actions grouped in a horizontal tool bar underneath the diagram tabs. + +image::manage-toolbar-main.png[Main Tool bar] + +This tool bar contains the following actions: + +* Display full screen, +* Fit selection to screen, +* Zoom group (Zoom In, Zoom Out), +* Share the diagram link, +* Export diagram as SVG, +* Toggle snap to grid, +* Show helper line to align elements, +* Arrange all elements, +* Reveal hidden elements, +* Reveal faded elements, +* Unpin all elements. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/nav-howtos.adoc b/doc/content/modules/user-manual/partials/nav-howtos.adoc index 6661439..47636e2 100644 --- a/doc/content/modules/user-manual/partials/nav-howtos.adoc +++ b/doc/content/modules/user-manual/partials/nav-howtos.adoc @@ -1,37 +1,8 @@ // Reference all the files defined in the how-tos folder * How-Tos -** Project Management -*** xref:user-manual:hands-on/how-tos/create-blank-project.adoc[] -*** xref:user-manual:hands-on/how-tos/create-template-project.adoc[] -*** xref:user-manual:hands-on/how-tos/upload-project.adoc[] -*** xref:user-manual:hands-on/how-tos/delete-project.adoc[] -*** xref:user-manual:hands-on/how-tos/rename-project.adoc[] -*** xref:user-manual:hands-on/how-tos/download-project.adoc[] -*** xref:user-manual:hands-on/how-tos/share-project.adoc[] -*** xref:user-manual:hands-on/how-tos/project-settings.adoc[] -** Model Management -*** xref:user-manual:hands-on/how-tos/create-model.adoc[] -*** xref:user-manual:hands-on/how-tos/upload-model.adoc[] -*** xref:user-manual:hands-on/how-tos/rename-model.adoc[] -*** xref:user-manual:hands-on/how-tos/delete-model.adoc[] -*** xref:user-manual:hands-on/how-tos/download-model.adoc[] -*** xref:user-manual:hands-on/how-tos/create-element.adoc[] -*** xref:user-manual:hands-on/how-tos/read-element.adoc[] -*** xref:user-manual:hands-on/how-tos/rename-element.adoc[] -*** xref:user-manual:hands-on/how-tos/update-element.adoc[] -*** xref:user-manual:hands-on/how-tos/delete-element.adoc[] -*** xref:user-manual:hands-on/how-tos/direct-edit.adoc[] -** Representation Operations -*** xref:user-manual:hands-on/how-tos/create-representation.adoc[] -*** xref:user-manual:hands-on/how-tos/delete-representation.adoc[] -*** xref:user-manual:hands-on/how-tos/rename-representation.adoc[] -*** xref:user-manual:hands-on/how-tos/share-representation.adoc[] -** User Interface Navigation -*** xref:user-manual:hands-on/how-tos/switch-left-sidebar.adoc[] -*** xref:user-manual:hands-on/how-tos/switch-right-sidebar.adoc[] -** {explorer} -*** xref:user-manual:hands-on/how-tos/sync-editor.adoc[] -*** xref:user-manual:hands-on/how-tos/expand-all.adoc[] -*** xref:user-manual:hands-on/how-tos/filter-explorer.adoc[] -** {representations-view} -*** xref:user-manual:hands-on/how-tos/navigate-representations.adoc[] \ No newline at end of file +** xref:user-manual:hands-on/how-tos/project-management.adoc[] +** xref:user-manual:hands-on/how-tos/model-management.adoc[] +** xref:user-manual:hands-on/how-tos/representation-operations.adoc[] +** xref:user-manual:hands-on/how-tos/user-interface-navigation.adoc[] +** xref:user-manual:hands-on/how-tos/explorer.adoc[] +** xref:user-manual:hands-on/how-tos/representations-view.adoc[] \ No newline at end of file diff --git a/doc/local-generation.ps1 b/doc/local-generation.ps1 new file mode 100644 index 0000000..af7ca91 --- /dev/null +++ b/doc/local-generation.ps1 @@ -0,0 +1,8 @@ +# version : 0.1.0 + +$Script = $MyInvocation.MyCommand.Definition +$ScriptPath = Split-Path $Script -Parent + +docker build ${ScriptPath} -t syson_doc_generator:local + +docker run -v "$ScriptPath\..:/usr/app:z" syson_doc_generator:local