From 26f91bc8adab194da1111d94bb6fcda4b7148950 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9lanie=20Bats?= Date: Fri, 14 Jun 2024 08:58:25 +0200 Subject: [PATCH] Fix Doc content --- doc/content/antora.yml | 13 ++- .../modules/developer-guide/pages/index.adoc | 8 +- .../pages/how-tos/install.adoc | 10 +- .../modules/user-manual/pages/contribute.adoc | 46 ++++----- .../modules/user-manual/pages/faq/faq.adoc | 14 +-- .../modules/user-manual/pages/faq/ocp.adoc | 27 ------ .../pages/features/action-flow-view.adoc | 10 +- .../user-manual/pages/features/admin.adoc | 2 + .../user-manual/pages/features/cm.adoc | 13 +-- .../pages/features/collaboration.adoc | 2 +- .../user-manual/pages/features/details.adoc | 2 + .../user-manual/pages/features/editor.adoc | 33 +++---- .../user-manual/pages/features/explorer.adoc | 15 +-- .../pages/features/general-view.adoc | 20 ++-- .../user-manual/pages/features/homepage.adoc | 34 +++---- .../pages/features/interconnection-view.adoc | 10 +- .../pages/features/keyboard-shortcuts.adoc | 14 +-- .../pages/features/other-views.adoc | 8 +- .../pages/features/parametric-modeling.adoc | 25 +++-- .../pages/features/related-elements.adoc | 2 + .../pages/features/representations-view.adoc | 2 + .../features/requirement-management.adoc | 20 ++-- .../pages/features/scaling-limits.adoc | 76 ++++++++++++++- .../user-manual/pages/features/security.adoc | 27 +++++- .../pages/features/simulation.adoc | 9 +- .../pages/features/state-transition-view.adoc | 8 +- .../pages/features/sysmlv2-overview.adoc | 16 ++-- .../pages/features/validation.adoc | 10 +- .../pages/hands-on/how-tos/explorer.adoc | 14 +-- .../hands-on/how-tos/model-management.adoc | 94 +++++++++---------- .../how-tos/representation-operations.adoc | 20 ++-- .../user-manual/pages/integration/api.adoc | 2 +- .../pages/integration/developer-guide.adoc | 18 ++-- .../user-manual/pages/key-features.adoc | 87 ++++++----------- .../pages/release-notes/2023.12.0.adoc | 4 +- .../pages/release-notes/2024.1.0.adoc | 14 ++- .../pages/release-notes/2024.3.0.adoc | 15 ++- .../pages/release-notes/2024.5.0.adoc | 69 ++++++++------ .../before-you-start-os-experimental-all.adoc | 12 +++ .../partials/feature-edition-os.adoc | 1 - .../user-manual/partials/feature-os.adoc | 1 + .../partials/feature-status-experimental.adoc | 5 +- .../partials/feature-usage-all.adoc | 2 +- 43 files changed, 451 insertions(+), 383 deletions(-) delete mode 100644 doc/content/modules/user-manual/pages/faq/ocp.adoc create mode 100644 doc/content/modules/user-manual/partials/before-you-start-os-experimental-all.adoc delete mode 100644 doc/content/modules/user-manual/partials/feature-edition-os.adoc create mode 100644 doc/content/modules/user-manual/partials/feature-os.adoc diff --git a/doc/content/antora.yml b/doc/content/antora.yml index 591eef9..a251cdc 100644 --- a/doc/content/antora.yml +++ b/doc/content/antora.yml @@ -16,11 +16,9 @@ asciidoc: explorer-menu: "Element Options Menu" explorer: "Project Explorer" forum-url: "https://github.com/eclipse-syson/syson/discussions" - fromsyson: "Included in Community version" - fromocp: "Included in Enterprise version" - gv: "General View" + gv: "General view" homepage: "Projects Browser" - iv: "Interconnection View" + iv: "Interconnection view" kerml: "KerML" mbse: "Model-Based Systems Engineering" obeo-url: "" @@ -35,9 +33,10 @@ asciidoc: source-code-url: "https://github.com/eclipse-syson/syson" status-exp: "Status: Experimental" status-stable: "Status: Stable" - stv: "State Transition View" - sysmlv1: "SysML v1" - sysmlv2: "SysML v2" + stv: "State Transition view" + sysml: "SysML" + sysmlv1: "{sysml} v1" + sysmlv2: "{sysml} v2" sw: "Sirius Web" validation: "Validation" website-url: "https://eclipse.dev/syson/" diff --git a/doc/content/modules/developer-guide/pages/index.adoc b/doc/content/modules/developer-guide/pages/index.adoc index b40e152..8384d58 100644 --- a/doc/content/modules/developer-guide/pages/index.adoc +++ b/doc/content/modules/developer-guide/pages/index.adoc @@ -30,17 +30,17 @@ git clone https://github.com/eclipse-syson/syson.git image::environment-m2e-version.png[m2e version] + . Retrieve the source code or fork it if you want to make contribution -. Import _backend_ plugins from syson repository in your workspace -. Update _settings.xml_ file from your _.m2_ folder to give access to other repositories during the build +. Import _backend_ plugins from {product} repository in your workspace +. Update _settings.xml_ file from your _.m2_ folder to give access to other repositories during the build In order to see dependance with access to add in _settings.xml_, have a look on _backend\application\syson-application\pom.xml_ You need to create https://github.com/settings/tokens[access tokens] on Github to complete _settings.xml_. + image::environment-settings.png[settings file] -+ ++ . Right click on _syson-services_ module and then _Properties>JavaBuildPath>Source_ Add _main/generated_ folder and remove _excluded_ content and former _antlr/grammar_ You should retrieve the following _Java build path_ + image::environment-java-build-path.png[Java build path] -+ ++ . Update Maven project by launching "ALT+F5" shortcut on all modules of your workspace 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 81e8ac6..8fb1939 100644 --- a/doc/content/modules/installation-guide/pages/how-tos/install.adoc +++ b/doc/content/modules/installation-guide/pages/how-tos/install.adoc @@ -1,7 +1,7 @@ = How to install {product}? This section delves into the detailed step-by-step instructions for installing {product}. -Each step is clearly explained to guide you through the process. +Detailed explanations walk you through each step. [INFO] ==== @@ -11,7 +11,7 @@ Before you proceed with the installation, please ensure you have the following x * https://www.docker.com/[Docker] installed, or an existing xref:requirements.adoc[supported database] installation with a user that has administrator privileges. ==== -== Get SysON +== Get {product} [#download] {product} is distributed as a single _executable Java Archive_ (JAR) which contains the complete {product} application along with all its dependencies. @@ -23,13 +23,13 @@ To download the latest pre-built JAR for {product}, follow these steps: . Identify the {product} latest available version for download. + image::latest-version.png[Latest version] -. Click on the latest version to open its specific page. +. Click the latest version to open its specific page. . In the `Assets` section, locate the JAR file named `{product-jar}`. + image::download.png[Download JAR file] -. Click on the JAR file to initiate the download to your local machine. +. Click the JAR file to start the download to your local machine. -This process ensures that you obtain the most recent version of the {product} application in the form of a pre-built JAR file. +This process ensures that you get the most recent version of the {product} application in the form of a pre-built JAR file. == Start the database instance diff --git a/doc/content/modules/user-manual/pages/contribute.adoc b/doc/content/modules/user-manual/pages/contribute.adoc index 5c190df..6b1619f 100644 --- a/doc/content/modules/user-manual/pages/contribute.adoc +++ b/doc/content/modules/user-manual/pages/contribute.adoc @@ -1,11 +1,11 @@ = Contribute -== Make a Difference! +== Make a difference -{product} is an open source project and, we encourage everyone to participate and contribute to its development! -There are numerous ways to contribute, including: +{product}, being an open source project, encourages everyone to contribute to its development. +You can contribute to {product} in different ways, including: -* Joining our active community forum, +* Joining the active community forum, * Identifying and reporting bugs, * Proposing new features, * Enhancing the documentation, @@ -14,42 +14,42 @@ There are numerous ways to contribute, including: == Get involved -=== Joining the Forum +=== Joining the forum -For any questions or inquiries, don't hesitate to participate in our xref:user-manual:forum.adoc[forum] on GitHub. +For any questions or inquiries, don't hesitate to contribute in the xref:user-manual:forum.adoc[forum] on GitHub. -=== Sharing your Feedback +=== Sharing your feedback Your feedback is crucial to the continuous improvement of {product}. -If you believe something is missing, encounter strange behavior, or simply want to express your satisfaction with the current state, feel free to share your thoughts. +If you believe something is missing, meet strange behavior, or want to express your satisfaction with the current state, feel free to share your thoughts. [#reporting-issues] === Reporting issues -Bug reports are essential, so please report any issues you encounter. -When reporting bugs, provide detailed descriptions, reproducible tests, example code, or any other relevant information that can aid in resolving the issue. +Bug reports are essential, so report any issues you meet. +When reporting bugs, offer detailed descriptions, reproducible tests, example code, or any other relevant information that can aid in resolving the issue. -Our issue tracker is hosted on GitHub: {bug-url}. +The issue tracker is hosted on GitHub: {bug-url}. To submit a new issue, you'll need a GitHub account. -For guidance on searching for issues, refer to GitHub's help page. +For guidance on searching for issues, see GitHub's help page. -=== Enriching the Documentation +=== Enriching the documentation -Have you found errors or inconsistencies in our documentation? -We welcome your contributions! +Have you found errors or inconsistencies in the documentation? +We welcome your contributions. -{product}’s documentation resides on GitHub: {source-code-url}/tree/main/doc. +{product}’s documentation can be found on GitHub: {source-code-url}/tree/main/doc. -Clone our repository, update the documentation, and trigger a pull request. -Our documentation is written in AsciiDoc syntax, making it straightforward to contribute. -Refer to the developer guide's Documentation section for insights into our documentation building process. +Clone the repository, update the documentation, and trigger a pull request. +The documentation is written in AsciiDoc syntax, making it straightforward to contribute. +Refer to the developer guide's Documentation section for insights into the documentation building process. -== Contributing to the Code +== Contributing to the code -{product}'s code is hosted on GitHub, making it simple to retrieve and build from source. -Simply clone our repository, make your modifications, align them with our requirements, and initiate a pull request. +{Product} leverages GitHub for code hosting, enabling straightforward retrieval and source-code builds. +Clone the repository, make your modifications, align them with {product} requirements, and start a pull request. Follow the xref:developer-guide:index.adoc[developer guide] to gain insights into setting up your development environment and get started with contributing to the {product} codebase. -Embark on your {product} contribution journey today! \ No newline at end of file +Embark on your {product} contribution journey today. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/faq/faq.adoc b/doc/content/modules/user-manual/pages/faq/faq.adoc index c8fc58a..7ba0178 100644 --- a/doc/content/modules/user-manual/pages/faq/faq.adoc +++ b/doc/content/modules/user-manual/pages/faq/faq.adoc @@ -1,14 +1,14 @@ = Frequently Asked Questions -Here are answers to questions we are frequently asked. +Here are answers to questions we're often asked. If you have a question not addressed here, please xref:ROOT:help.adoc[contact us]. -== General Questions +== General questions -.What is {product}? +.What's {product}? [%collapsible] ==== -To understand the intent of {product}, refer to the xref:user-manual:what-is.adoc[What is?] section in the user manual. +To understand the intent of {product}, refer to the xref:user-manual:what-is.adoc[What's?] section in the user manual. ==== .What are the key features of {product}? @@ -42,14 +42,14 @@ To import /export models, read the xref:user-manual:integration/interoperability ==== * xref:user-manual:features/collaboration.adoc[How do I collaborate with others on models?] -* xref:user-manual:what-is.adoc[What is the difference between {product} and other SysML modeling tools?] +* xref:user-manual:what-is.adoc[What is the difference between {product} and other {sysml} modeling tools?] == Troubleshooting * xref:installation-guide:requirements.adoc[What are the recommended system requirements for {product}?] * xref:user-manual:contribute.adoc#reporting-issues[How do I report bugs or submit feature requests?] -== Advanced Questions +== Advanced questions .How do I customize the user interface of {product}? [%collapsible] @@ -76,7 +76,7 @@ Does {product} provides a method? Model 2 Doc ? -== Additional Resources +== Additional resources * xref:ROOT:index.adoc[{product} documentation] // * xref:ROOT:help.adoc[Community forums and support channels] diff --git a/doc/content/modules/user-manual/pages/faq/ocp.adoc b/doc/content/modules/user-manual/pages/faq/ocp.adoc deleted file mode 100644 index 2544ff6..0000000 --- a/doc/content/modules/user-manual/pages/faq/ocp.adoc +++ /dev/null @@ -1,27 +0,0 @@ -= What is {ocp} vs {product}? - -== {product}: An Open Source Project - -{product} stands proudly as an open-source project, embodying a commitment to transparency, collaboration, and community-driven development. -As an open-source initiative, {product} invites contributions, feedback, and participation from a diverse community of users and developers, fostering an environment of shared innovation and continuous improvement. - -== {ocp}: An Enterprise Ready Product - -The https://www.obeosoft.com/en/products/obeo-cloud-platform[{ocp}] product follows an open-core product model, where the core of the product is available as open source (under the {product} project), inviting collaboration and community engagement. -Beyond the open-source foundation, Obeo offers an extended version enriched with Enterprise features. -This extended build product encompasses a spectrum of Enterprise features, catering to the advanced needs of organizations operating in dynamic and diverse IT landscapes. -These features are curated to enhance the platform's capabilities, providing robust solutions for deployment scenarios ranging from public and private clouds to on-premise environments. - -== Support and Upgrade Guarantees - -Recognizing the importance of reliability and continuous improvement, {ocp} includes comprehensive support and upgrade guarantees. -This ensures that organizations leveraging {ocp} can benefit from a secure, well-supported, and evolving platform. -The commitment to support and upgrades underscores {ocp}'s dedication to providing a stable and dependable solution for its users. - -xref:user-manual:support.adoc[Contact us!] - -== Early Adopter Program - -Become part of the https://www.obeosoft.com/en/early-adopters-program[Early Adopter Program]. -Joining the program provides you with the opportunity to explore new features, provide feedback, and actively contribute to the development of {product}. -Your insights and engagement are valued as we shape the future of {product} together. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/action-flow-view.adoc b/doc/content/modules/user-manual/pages/features/action-flow-view.adoc index 2dcf2f8..7fc25c5 100644 --- a/doc/content/modules/user-manual/pages/features/action-flow-view.adoc +++ b/doc/content/modules/user-manual/pages/features/action-flow-view.adoc @@ -1,7 +1,11 @@ = {afv} -The {afv} describes input and output flows between different actions within a system. This type of diagram is useful for understanding and analyzing the dynamic behavior of a system, focusing on action sequences and interaction between system elements. +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] -This view is under development and will be available soon. We encourage users to wait next releases to enjoy all functionalities and concepts on this view. -Feel free to xref:ROOT:help.adoc[contact us] for more details. +The {afv} describes input and output flows between different actions within a system. +This type of diagram is useful for understanding and analyzing the dynamic behavior of a system, focusing on action sequences and interaction between system elements. + +This view is under development and will be available soon. +We encourage users to wait next releases to enjoy all functionalities and concepts on this view. +Feel free to xref:ROOT:help.adoc[contact us] for more details. diff --git a/doc/content/modules/user-manual/pages/features/admin.adoc b/doc/content/modules/user-manual/pages/features/admin.adoc index e1ad69c..46cc189 100644 --- a/doc/content/modules/user-manual/pages/features/admin.adoc +++ b/doc/content/modules/user-manual/pages/features/admin.adoc @@ -1,2 +1,4 @@ = Administration +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + diff --git a/doc/content/modules/user-manual/pages/features/cm.adoc b/doc/content/modules/user-manual/pages/features/cm.adoc index 283ca4b..8181e7c 100644 --- a/doc/content/modules/user-manual/pages/features/cm.adoc +++ b/doc/content/modules/user-manual/pages/features/cm.adoc @@ -1,9 +1,10 @@ -= Version Control and change management += Version control and change management -No built-in versioning tools exists in SysOn for now. +{product} doesn't include built-in version control tools. -If user want to control version of its project, user can use an external Git repository. -Indeed, for each version/iteration of its project, user can xref:hands-on/how-tos/project-management.adoc#download-project[download] its project. -Then user merges the zip archive result on the Git repository. +If you want to manage different versions of your project, you can use an external Git repository. +Here's how: +* For each version or iteration of your project, you can download it as a zip archive by following these instructions: xref:hands-on/how-tos/project-management.adoc#download-project[download project]. +* Then you can integrate the downloaded zip archive into your Git repository. -Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file +Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/collaboration.adoc b/doc/content/modules/user-manual/pages/features/collaboration.adoc index 402959a..e10ac78 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 @@ Various solutions exist 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/project-management.adoc#share-project[share projects], models, and xref:hands-on/how-tos/representation-operations.adoc#share-representation[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]. Sharing projects and models is as simple as providing a link, similar to the process of sharing diagrams. * xref:integration/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 d848275..6834806 100644 --- a/doc/content/modules/user-manual/pages/features/details.adoc +++ b/doc/content/modules/user-manual/pages/features/details.adoc @@ -1,5 +1,7 @@ = {details} +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + The {details} view provides a comprehensive overview of the selected element, presenting distinct _Property_ sections for each _characteristic_ of the semantic object. image::details-right-sidebar-details.png[{details}] diff --git a/doc/content/modules/user-manual/pages/features/editor.adoc b/doc/content/modules/user-manual/pages/features/editor.adoc index 559d54c..945057f 100644 --- a/doc/content/modules/user-manual/pages/features/editor.adoc +++ b/doc/content/modules/user-manual/pages/features/editor.adoc @@ -1,17 +1,6 @@ = {editor} -.Before you Start -[caption=] -==== -// Edition -include::user-manual:partial$feature-edition-os.adoc[] - -// Status -include::user-manual:partial$feature-status-stable.adoc[] - -// Usage -include::user-manual:partial$feature-usage-all.adoc[] -==== +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] == What's' the {editor} ? @@ -19,7 +8,7 @@ The **{editor}** page serves as the primary workspace for editing project conten == Find your way around -For those new to {product}, the initial experience with the application may feel a bit challenging. +For those new to {product}, the initial experience with the application might feel a bit challenging. To help you navigate seamlessly and Kickstart collaboration with your team, we provide a guided tour for you to familiarize yourself with the platform. The {editor} features four distinct regions: a <>, a <>, a main <>, and a <>. @@ -28,26 +17,26 @@ The layout has been simplified to ensure a clear understanding of the content wi image::editor.png[{editor}] === Toolbar -The toolbar houses a selection of actions categorized into three groups: ': _Homepage_, _Project Actions_ (with the name of the project) 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.png[{editor} Toolbar] include::user-manual:partial$homepage-action.adoc[leveloffset=+3] [#project-actions] -==== Projects Actions +==== Projects actions -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]_. +Access project-level actions such as _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[] +For further actions, see: xref:hands-on/hands-on.adoc[] include::user-manual:partial$help-action.adoc[leveloffset=+3] -=== Left Sidebar +=== 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. +The left sidebar has different views such as the xref:features/explorer.adoc[{explorer}] and the xref:features/validation.adoc[{validation}] to assist you working on your project. [NOTE] ==== @@ -65,7 +54,7 @@ xref:hands-on/how-tos/user-interface-navigation.adoc#switch-left-sidebar[Explore 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. +The {editor} area has one or more editors. image::editor-editor.png[{editor} Main Editor] @@ -73,9 +62,9 @@ Discover the diverse range of representation options available and find the most xref:features/features.adoc#sysmlv2-views[Explore various types of representations...] -=== Right Sidebar +=== Right sidebar -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 ... +The right sidebar contains different views such as 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] ==== diff --git a/doc/content/modules/user-manual/pages/features/explorer.adoc b/doc/content/modules/user-manual/pages/features/explorer.adoc index 4c31510..07614b7 100644 --- a/doc/content/modules/user-manual/pages/features/explorer.adoc +++ b/doc/content/modules/user-manual/pages/features/explorer.adoc @@ -1,17 +1,6 @@ = {explorer} -.Before you Start -[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[] -==== +include::user-manual:partial$before-you-start-os-experimental-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. @@ -19,7 +8,7 @@ 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. -* *Representations*: If a particular semantic element has an associated representation, such as a diagram, it will appear as a child of the semantic element. +* *Representations*: If a particular semantic element has an associated representation, such as a diagram, it appears as a child of the semantic element. == {explorer} Toolbar 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 e6ed5a7..0e8b14f 100644 --- a/doc/content/modules/user-manual/pages/features/general-view.adoc +++ b/doc/content/modules/user-manual/pages/features/general-view.adoc @@ -1,5 +1,7 @@ = {gv} +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + The {gv} is employed to display any members of exposed model elements. it's the most general view, enabling presentation of any model element. @@ -66,7 +68,7 @@ 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: +The following element in _Definition_ compartments 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_, @@ -80,28 +82,28 @@ The following element in _Definition_ compartiments can be displayed in the {gv} * 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. +A _Definition_ node can have several compartments if _Definition_ element can contain many 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: +The following element in _Usage_ compartments 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_, + * Constraint in _Constraint Usage_, * Port in _Interface Usage_/_Part Usage_, - * Occurence in _Occurence Usage_, + * Occurrence in _Occurrence Usage_, * Assumed Constraint in _Requirement Usage_, - * Required cinstraint in _Requirement Usage_. + * Required constraint 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. +A _Definition_ node can have several compartments if _Definition_ element can contain many kind of element. Each compartment is distinguished by a specific identifier. image::gv-part-compartment-node.png[{gv} Part Compartment Node] @@ -109,7 +111,7 @@ image::gv-part-compartment-node.png[{gv} Part Compartment Node] === _Package_ element _Package_ element can be represented on {gv} diagram. -Its represented by a folder and its label contains the keyword "package". +Its represented by a folder and its label has the keyword `package`. image::gv-package-node.png[{gv} Package Node] @@ -142,7 +144,7 @@ image::gv-featureTyping-edge.png[{gv} FeatureTyping Edge] image::gv-allocation-edge.png[{gv} Allocation Edge] -* Containement relation. +* Containment relation. image::gv-containment-edge.png[{gv} Containment Edge] diff --git a/doc/content/modules/user-manual/pages/features/homepage.adoc b/doc/content/modules/user-manual/pages/features/homepage.adoc index cdacdbb..9d2be62 100644 --- a/doc/content/modules/user-manual/pages/features/homepage.adoc +++ b/doc/content/modules/user-manual/pages/features/homepage.adoc @@ -1,30 +1,20 @@ -:homepage: Projects Browser +:homepage: Projects browser = {homepage} -.Before you Start -[caption=] -==== -// Edition -include::user-manual:partial$feature-edition-os.adoc[] - -// Status -include::user-manual:partial$feature-status-stable.adoc[] - -// Usage -include::user-manual:partial$feature-usage-all.adoc[] -==== +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] -== What's the {homepage} ? +== What's the {homepage}? -The **{homepage}** page serves as the pivotal starting point for your modeling endeavors and is the homepage of the {product} application, offering a central hub where users can seamlessly initiate new projects or manage existing ones. +The **{homepage}** page serves as the pivotal starting point for your modeling endeavors and is the homepage of the {product} application. +It offers a central hub where users can seamlessly create new projects or manage existing ones. == Find your way around -For newcomers to {product}, the initial experience of opening the application may seem a bit overwhelming. -To assist you in navigating effectively and initiating collaboration with your team, we offer a guided tour to help you acclimate to the platform. +For newcomers to {product}, the initial experience of opening the application might seem a bit overwhelming. +To assist you in navigating and initiating collaboration with your team, we offer a guided tour to help you acclimate to the platform. 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. +We've streamlined the layout to offer a clear understanding of the content housed in each location. image::homepage.png[{homepage}] @@ -40,24 +30,24 @@ 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. +The _Create New Project_ section is designed to allow users to initiate the creation of 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 Blank Project**: Users can start their modeling journey with an empty project, 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're 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). +_Batmobile- template is a complete SysML project with several concepts of each SysML type (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]. +Every project you create have its own xref:features/editor.adoc[Project Editor]. ==== 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. 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 bfbb730..6d52cae 100644 --- a/doc/content/modules/user-manual/pages/features/interconnection-view.adoc +++ b/doc/content/modules/user-manual/pages/features/interconnection-view.adoc @@ -1,15 +1,17 @@ = {iv} -The {iv} is employed to show encapsulated structural contents of _Usage- element: Parts, Properties, Connectors, Ports, and Interfaces. +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + +The {iv} is used 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[{iv} Overview] -== Create New {iv} Diagram +== Create new {iv} -User can create {iv} diagram on any _Usage_ or _Definition_ element. +User can create {iv} on any _Usage_ or _Definition_ element. image::interconnection-view-diagram-creation.png[{iv} Diagram Creation] @@ -59,4 +61,4 @@ include::user-manual:partial$manage-drag-drop.adoc[] include::user-manual:partial$manage-existing-elements.adoc[] -include::user-manual:partial$manage-group-elements.adoc[] +include::user-manual:partial$manage-group-elements.adoc[] \ No newline at end of file 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 eedda64..fb6f197 100644 --- a/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc +++ b/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc @@ -1,5 +1,7 @@ = Keyboard shortcuts +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + == General To delete a given element, user can select the element and the press the `Del` key from representation editor. @@ -12,20 +14,20 @@ Explore further by referring to the following how-tos for xref:user-manual:featu == Multi-selection -Two ways to select many elements exist: +Two ways to select several elements exist: -=== CTRL key +=== 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. +A user can select an element by clicking on it and then select another one by holding `Ctrl` key and clicking on the other element. +This keyboard shortcut is available in the representation editor and in 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 user wants to select. +To select several element in one action from representation editor, user can press `Shift` key and draw a rectangular area around elements that user wants to select. After releasing the click, all element in the area are selected. == Search -User can display the filter bar by pressing `Ctrl+f` (Windows/Linux) or `Cmd+f` (MacOS) from the {explorer} view. +User can display the filter bar by holding `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/other-views.adoc b/doc/content/modules/user-manual/pages/features/other-views.adoc index eef7faf..b046929 100644 --- a/doc/content/modules/user-manual/pages/features/other-views.adoc +++ b/doc/content/modules/user-manual/pages/features/other-views.adoc @@ -1,16 +1,16 @@ = Other views -Following views are planned to be available in SysON as soon as possible: +Following views are planned to be available in {product} as soon as possible: * _Sequence View_, * _Geometry View_, * _Grid View_, * _Browser View_. -To understand the purpose of each views, refer to the xref:user-manual:features/sysmlv2-overview.adoc[{sysmlv2} in practice] section in the user manual. +To understand the purpose of each views, see the xref:user-manual:features/sysmlv2-overview.adoc[{sysmlv2} in practice] section in the user manual. Wait until the next release to enjoy these views. -_Case view_ isn't available in {product} since its concepts and functionnalities have been integrated inside _General View_. +_Case view_ isn't available in {product} since its concepts and features are available inside _General View_. -Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file +Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/parametric-modeling.adoc b/doc/content/modules/user-manual/pages/features/parametric-modeling.adoc index 1d45038..5fd5964 100644 --- a/doc/content/modules/user-manual/pages/features/parametric-modeling.adoc +++ b/doc/content/modules/user-manual/pages/features/parametric-modeling.adoc @@ -1,22 +1,21 @@ = Parametric modeling and constraints -In SysML v1, managing block input parameters is an important aspect for modeling complex systems. -Blocks in SysML v1 are used to represent the structural elements of a system, and input parameters define the interfaces between these elements. -Ports are connection points on a block, allowing you to specify the interfaces through wich blocks interact with each other. -Parametric diagrams are used in SysML v1 to define and link input parameters, thus allowing precise modeling of the interactions and behaviors of system components. +In {sysmlv1}, managing block input parameters is an important aspect for modeling complex systems. +{sysmlv1} uses blocks to represent a system's structural elements, and input parameters define the interfaces between them. +Ports are connection points on a block, allowing you to specify the interfaces through that blocks interact with each other. +{sysmlv1} leverages parametric diagrams to define and link input parameters. +This enables precise modeling of interactions and behaviors between system components. They capture constraints and relationships between parameters within and between blocks. -We find the whole process of this management with SysML v2 with some differences. -SysML v2 continues to use ports to define connection points on blocks. -However parametric diagrams have been replaced by Interconnexion view diagram. +{sysmlv2} introduces a different approach to managing block input parameters. +{sysmlv2} continues to use ports to define connection points on blocks. +{sysmlv2} swaps parametric diagrams for Interconnection View diagrams in managing block input parameters. -From the {iv} diagram, user can easily create a new part from a simple click o the root node that displays toolbar. +In the {iv} diagram, users can create a new part by clicking on the root node's displayed toolbar. Then by displaying toolbar on this new node, user can also create port ont the new part. -To represent data flux between ports, user can create `InterfaceUsage` or `BindingConnector as usage`. -These data flux show how parameter values are related, allowing values to propagate through the model. +To represent data flow between ports, user can create either `InterfaceUsage` or `BindingConnector as usage`. +These data flows visually represent how parameter values relate to each other, allowing their propagation through the model. image::parametric-modeling-connected-port.png[{Connected ports}] -Work around Parametric modeling and constraints are among the topics to be processed soon. - -Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file +Feel free to xref:ROOT:help.adoc[contact us] for more details. \ 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 16e1207..c43a17c 100644 --- a/doc/content/modules/user-manual/pages/features/related-elements.adoc +++ b/doc/content/modules/user-manual/pages/features/related-elements.adoc @@ -1,5 +1,7 @@ = {related-elements} +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + For a more focused exploration, delve into the {related-elements} view. image::relatedElements-right-sidebar-related-elements.png[{related-elements}] 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 f15f81e..811be6c 100644 --- a/doc/content/modules/user-manual/pages/features/representations-view.adoc +++ b/doc/content/modules/user-manual/pages/features/representations-view.adoc @@ -1,5 +1,7 @@ = {representations-view} +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + Explore the {representations-view} view to gain insights into the available representations associated with the selected element. image::representations-right-sidebar-representations.png[{representations-view} view] diff --git a/doc/content/modules/user-manual/pages/features/requirement-management.adoc b/doc/content/modules/user-manual/pages/features/requirement-management.adoc index 8d3ddbd..2cc6cc7 100644 --- a/doc/content/modules/user-manual/pages/features/requirement-management.adoc +++ b/doc/content/modules/user-manual/pages/features/requirement-management.adoc @@ -2,11 +2,10 @@ == Creating and linking requirements -By using SysON, requirements can be well integrated and defined with the {gv}. - -Remember that a requirement is a kind of constraint representing the constraints given by stakeholders that a solution must satisfy. For example, the requirement of a maximum speed of a vehicle. - -From the {gv} diagram, user can easily create a new requirement **from the background** of the diagram from a simple click that displays toolbar. +By using {product}, requirements can be well integrated and defined with the {gv}. +Remember that a requirement is a kind of constraint representing the constraints given by stakeholders that a solution must satisfy. +For example, the requirement of a maximum speed of a vehicle. +From the {gv} diagram, user can create a new requirement **from the background** of the diagram from a click that displays toolbar. image::requirement-managment-fromBackground-creation.png[Requirement creation from Diagram Background] @@ -18,14 +17,11 @@ A Requirement Definition is represented by rectangular node style whereas a Requ image::requirement-managment-node-representation.png[Requirement creation from Requirement] -For now, {gv} diagram authorize only to create requirement Definition and Usage. _Satisfy_ relationship to define connection between requirements aren't available. +For now, {gv} diagram authorize only to create requirement Definition and Usage. _Satisfy_ relationship to define connection between requirements aren't available. +Work around requirements are among the topics to be processed soon. -Work around requirements are among the topics to be processed soon. - -Feel free to xref:ROOT:help.adoc[contact us] for more details. +Feel free to xref:ROOT:help.adoc[contact us] for more details. == Traceability features -//TODO - -Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file +Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/scaling-limits.adoc b/doc/content/modules/user-manual/pages/features/scaling-limits.adoc index ab27520..78cd6b5 100644 --- a/doc/content/modules/user-manual/pages/features/scaling-limits.adoc +++ b/doc/content/modules/user-manual/pages/features/scaling-limits.adoc @@ -1,3 +1,77 @@ = Scaling limits -// TODO for example, explain the size of the models that can be supported \ No newline at end of file +{product} is designed to handle a wide range of modeling tasks and accommodate various scales of usage. +However, understanding the scaling limits of the system is essential for planning and optimizing your usage to ensure performance and efficiency. +Below, we outline the primary scaling factors and limitations related to model size, semantic elements, representations, project management, and user concurrency. + +== Model size + + * Maximum Model Size: + {product} is built to manage large models, but there are practical limits to its capacity. + The system can efficiently handle models up to about 10 GB in size. + Models larger than this might experience performance degradation, especially in terms of loading times and responsiveness. + * Impact on Performance: + As model size increases, users might meet longer loading times and slower response rates when performing operations such as editing or navigating the model. + It's recommended to break down exceptionally large models into smaller, manageable sub-models where feasible. + +== Number of semantic elements + + * Element Capacity: + {product} can manage models containing up to 150,000 semantic elements. + These elements include elements, relationships, and attributes that define the structure and behavior of the model. + * Performance Considerations: + Exceeding this number might lead to increased memory usage and slower query responses. + For optimal performance, it's advisable to maintain a balance and avoid overly complex models that push the upper limit of this capacity. + +== Number of representations + + * Representation Limits: + The system supports up to 2,000 distinct representations per project. + * Complexity and Usability: + While the system can handle a high number of representations, maintaining a clear and organized structure is crucial. + Overloading a project with too many representations can complicate navigation and reduce usability. + +== Number of elements on a representation + + * Element Density: + A single representation can display up to 1,000 elements. + Beyond this, the representation might become cluttered, making it difficult to interpret and work with the visual data. + * Performance and Visualization: + High-density representations may slow down rendering times and interaction speed. + It's beneficial to segment large visualizations into smaller, more focused views to maintain clarity and performance. + +== Number of projects + + * Project Management: + {product} can support up to 1,000 concurrent projects per server. + This allows organizations to manage multiple initiatives simultaneously without significant performance degradation. + * Server Load: + The number of projects impacts server load and resource allocation. + While the system can support a high number of projects, each project adds to the computational and storage demands, so server capacity should be scaled so. + +== Number of concurrent users + + * User Capacity: + The system is designed to support up to 200 concurrent users on a single server. + This capacity ensures that people can collaborate in real-time without encountering significant slowdowns or access issues. + * Collaboration Dynamics: + The performance of collaborative features, such as live editing and real-time updates, might vary depending on the number of users and the complexity of the operations being performed. + For larger teams, it's important to monitor server load and possibly segment users across multiple servers if necessary. + +== Recommendations for optimal use + + * Model Partitioning: + To manage large models, consider breaking them down into smaller, modular sub-models. + This can help maintain performance and make it easier to manage and navigate complex data. + * Efficient Representations: + Limit the number of elements displayed in each representation to avoid clutter and maintain responsiveness. + Use multiple, focused representations instead of one overloaded view. + * Scalable Infrastructure: + Ensure that your server infrastructure is scalable to handle increases in project load and user concurrency. + This might involve using cloud-based solutions that can dynamically allocate resources as needed. + * Regular Monitoring: + Implement regular monitoring of system performance and user activity to identify and address potential bottlenecks. + This can help maintain smooth operation even as the scale of use increases. + * Contact us for custom solutions: + If your needs exceed the outlined limits or you require specific performance optimizations, please xref:ROOT:help.adoc[contact us]. + Our team can provide tailored solutions and advice to ensure that {product} meets your scaling requirements effectively. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/security.adoc b/doc/content/modules/user-manual/pages/features/security.adoc index 069d2ee..d1be96c 100644 --- a/doc/content/modules/user-manual/pages/features/security.adoc +++ b/doc/content/modules/user-manual/pages/features/security.adoc @@ -1,5 +1,26 @@ = Security and compliance -TODO -What are the security features of the product? -How does the product comply with industry standards and regulations? \ No newline at end of file +== Security +{product} does'nt inherently implement any security features or compliance measures directly within the product. +However, we understand that security and regulatory compliance are critical concerns for our users. +If you are interested in how these topics can be addressed or have specific security and compliance requirements, please feel free to xref:ROOT:help.adoc[contact us] for further discussion and tailored solutions. + +* Authentication and Authorization: While {product} does'nt include built-in mechanisms for authentication or authorization, we recognize the importance of secure user management. +We can offer guidance on integrating {product} with external authentication systems, including Single Sign-On (SSO). +* Data Encryption: {product} itself does'nt offer encryption for data at rest or in transit. +We can discuss potential approaches to secure data handling, including leveraging external encryption services or tools to protect sensitive information. +* Audit Logging and Monitoring: Although {product} does'nt feature built-in logging or monitoring capabilities, we can assist you in setting up external tools to track user activities, monitor system performance, and support logs for security audits. +* Data Integrity and Backup: {product} does'nt offer specific mechanisms for ensuring data integrity or performing backups. +If these are critical for your use case, we're available to help you explore and integrate appropriate third-party solutions for data integrity checks and backup processes. +* Secure Development Practices: While {product} does'nt enforce secure coding standards or vulnerability management practices, we can offer advice and recommendations on best practices for secure software development and maintenance. + +== Compliance + +{product} is dedicated to aligning with industry standards to ensure interoperability, flexibility, and future-proofing for our users. +A key aspect of this commitment is our focus on compliance with the {sysmlv2} standard from the Object Management Group (OMG). + +The Systems Modeling Language ({sysml}) is a widely recognized standard used for modeling complex systems. +{sysmlv2} represents the next evolution of this standard, aiming to offer enhanced capabilities for systems engineering and {mbse} (MBSE). + +{product} is committed to being compliant with the {sysmlv2} standard as soon as it's officially defined and released by the OMG. +Our development team is closely monitoring the progress of the {sysmlv2} standardization process. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/simulation.adoc b/doc/content/modules/user-manual/pages/features/simulation.adoc index e755b45..ab56599 100644 --- a/doc/content/modules/user-manual/pages/features/simulation.adoc +++ b/doc/content/modules/user-manual/pages/features/simulation.adoc @@ -1,10 +1,9 @@ = Simulation and validation tools -Validation view is disable for now, more details are explained on xref:features/validation.adoc[Validation] page. +Validation view is disabled for now, more details are explained on xref:features/validation.adoc[Validation] page. -SysON plans the ability to export data in sysMlv2 to connect to a simulation tools such as Matlab or others. +{product} plans the ability to export data in sysMlv2 to connect to a simulation tools such as Matlab or others. -Work around simulation and validation tools are among the topics to be processed soon. - -Feel free to xref:ROOT:help.adoc[contact us] for more details. +Interested in integrating simulation and validation tools with {product}? +Feel free to xref:ROOT:help.adoc[contact us] for more details. diff --git a/doc/content/modules/user-manual/pages/features/state-transition-view.adoc b/doc/content/modules/user-manual/pages/features/state-transition-view.adoc index ec10e4f..9fcb121 100644 --- a/doc/content/modules/user-manual/pages/features/state-transition-view.adoc +++ b/doc/content/modules/user-manual/pages/features/state-transition-view.adoc @@ -1,8 +1,10 @@ = State transition view -The {stv} is describes the logical transition of a system through various states of a system and the transitions between those states. -This view shows the behavior of complex system, for example how it evolves over time in response to specific events/stimuli. +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] + +The {stv} is describes the logical transition of a system through various states of a system and the transitions between those states. +This view shows the behavior of complex system, for example how it evolves over time in response to specific events/stimuli. This view is under development and will be available soon. We encourage users to wait next releases to enjoy all functionalities and concepts on this view. -Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file +Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/sysmlv2-overview.adoc b/doc/content/modules/user-manual/pages/features/sysmlv2-overview.adoc index d956d44..f8327fd 100644 --- a/doc/content/modules/user-manual/pages/features/sysmlv2-overview.adoc +++ b/doc/content/modules/user-manual/pages/features/sysmlv2-overview.adoc @@ -10,8 +10,8 @@ Developed by the OMG, {sysmlv2} builds upon its predecessor, {sysmlv1}, aiming t == Key aspects of {sysmlv2} * **Enhanced Flexibility**: {sysmlv2} offers enhanced flexibility in representing complex systems through refined constructs and improved semantics, accommodating a wide array of system engineering scenarios. -* **KerML as the Foundation**: {sysmlv2} is uniquely based on the Kernel Modeling Language (KerML), further emphasizing its status as a DSL (Domain Specific Language) tailored for systems engineering. -KerML serves as the foundational layer, providing core modeling constructs and principles. +* **{kerml} as the Foundation**: {sysmlv2} is uniquely based on the `Kernel Modeling Language` - {kerml}, further emphasizing its status as a DSL - Domain Specific Language tailored for systems engineering. +{kerml} serves as the foundational layer, providing core modeling constructs and principles. * **Graphical and Textual Syntax**: {sysmlv2} combines both graphical and textual syntax, allowing system engineers to select the representation that best suits their modeling preferences and the intricacies of the system being analyzed. * **Extensibility and Modularity**: The language is designed to be extendable, enabling the incorporation of domain-specific modeling elements and the creation of modular representations that align with the structure of complex systems. @@ -51,26 +51,26 @@ This view is instrumental in capturing and visualizing the flow of actions, show The {stv} provides a concise representation of the different states a system can occupy and the transitions between these states. This view offers a visual depiction of the system's behavioral aspects, illustrating how it evolves and responds to various stimuli. -=== Sequence View +=== Sequence view The Sequence View presents the chronological order of event occurrences on lifelines, offering a clear temporal representation of system dynamics. -=== Geometry View +=== Geometry view The Geometry View is designed to present a visualization of exposed spatial items in two or three dimensions. This view is particularly tailored for system engineers and designers working on systems that involve spatial components, allowing them to gain insights into the spatial relationships, configurations, and layouts of elements within a model. -=== Grid View +=== Grid view The Grid View is designed to present exposed model elements and their relationships in a structured and intuitive manner, arranged within a rectangular grid. -This view acts as the generalization of specialized views : the Tabular View, Data Value Tabular View, and Relationship Matrix View. +This view acts as the generalization of specialized views: the Tabular View, Data Value Tabular View, and Relationship Matrix View. -=== Browser View +=== Browser view The Browser View is designed to present the hierarchical membership structure of model elements, starting from an exposed root element. This view provides a systematic and organized representation of the relationships between various model elements, offering a navigational tool for system engineers to explore and understand the composition of their models. -=== Textual Syntax +=== Textual syntax Future plans include the integration of a text editor into {product}, leveraging the `SysIDE` project's capabilities. SysIDE provides {sysmlv2} language support in Visual Studio Code. diff --git a/doc/content/modules/user-manual/pages/features/validation.adoc b/doc/content/modules/user-manual/pages/features/validation.adoc index ee0fdc6..723c1ca 100644 --- a/doc/content/modules/user-manual/pages/features/validation.adoc +++ b/doc/content/modules/user-manual/pages/features/validation.adoc @@ -1,8 +1,10 @@ = {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. +include::user-manual:partial$before-you-start-os-experimental-all.adoc[] -Validation view is disable for now and no diagnostic are available. +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 by using an accordion widget. -Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file +Validation view is turn-off for now and no diagnostic are available. + +Feel free to xref:ROOT:help.adoc[contact us] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc index 68b22ef..0eb964c 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc @@ -3,7 +3,7 @@ [#sync-editor] == Synchronize {explorer} / {editor} -It's possible to disable (and of course re-enable) the synchronization between the {explorer} and the current selection in the {editor}. +It's possible to turn-off and turn-on 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. @@ -16,7 +16,7 @@ The `Synchronize` toggle button in the {explorer} can be used to disable this sy 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. +When synchronization is disabled, tree items that are already expanded in the {explorer} are still selected, but no new tree items are automatically expanded. [#expand-all] == Expand all @@ -30,7 +30,7 @@ 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`. +. Click `Expand all`. image::hands-on-expand-all.png[Expand all] @@ -49,7 +49,7 @@ To filter elements in the {explorer} using the filter bar: + image::hands-on-filter-name-shortcut.png[Filter name shortcut] + -. All visible tree items containing the typed value will be highlighted. +. All visible tree items containing the typed value are highlighted. . Use the filter button inside the filter bar to hide all visible tree items that don't contain the entered value. This capability allows for precise filtering and highlighting of elements based on specified criteria. @@ -66,15 +66,15 @@ Ensure the desired tree items are expanded to effectively use the filter and hig Three filters are available in the {explorer} to filter element by kind: * Hide Memberships, -* Hide KerML Standard Libraries, +* 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 +By hiding the 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, +. Click filter button, . Select filters to activate. image::hands-on-filter-element.png[Filter kind] \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc index de27c48..5ffbefa 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc @@ -1,24 +1,24 @@ -= Model Management += Model management [#create-model] -== Create a New Model +== Create a new model To create a model, follow these steps from the explorer toolbar: . Open the Project Editor. -. Click on the `New model` action in the explorer toolbar. +. Click the `New model` action in the explorer toolbar. . Complete 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}. +Upon creation, the new model appears in the {explorer}. image::hands-on-new-model-result.png[New Model result] [#upload-model] -== Upload a Model +== Upload a model [caption=] ==== @@ -34,7 +34,7 @@ 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. +Only models exported in the specific JSON format recognized by {product} can be re-uploaded by 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}. ==== @@ -42,37 +42,37 @@ 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. +. Click the `Upload` button at the top of the {explorer} in the toolbar. +. It opens 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. +. The uploaded model is automatically created and opened. [#rename-model] -== Rename a 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}. +. Click the {explorer-menu} next to the model in the {explorer}. . Select the `Rename` option. . Update the name in the editable field. -. Click on `Rename`. +. Click `Rename`. [#delete-model] -== Delete a 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. +Deleting a model and its content is a significant action, and it's important to note that the entire model, along with its contents, is permanently removed. This includes all associated semantic elements, representations, and any other data within the model. Exercise caution when performing this operation, as it can't be reversed. ==== [NOTE] ==== -The deletion will affect everyone. +The deletion affects everyone. ==== To delete a model, follow these steps: @@ -91,11 +91,11 @@ 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. +You can reset it by deleting the {product} data in cache of your browser. ==== [#download-model] -== Download a Model +== Download a model [caption=] ==== @@ -111,34 +111,34 @@ 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}. +. Click 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 model is downloaded in JSON format. The JSON format used by {product} is specific to the tool. ==== [#create-element] -== Create a New 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`. +. Click `New object`. . Select the desired type of object to create. -. Click on `Create`. +. Click `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 +== Read an element -. To navigate through the details of a semantic element, use the {explorer} to navigate through the model and locate the desired element. +. To navigate through the details of a semantic element, use the {explorer} to navigate through the model and locate the needed 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. @@ -146,7 +146,7 @@ This view presents all the available properties for the selected element, provid image::hands-on-read-element.png[Read element] [#rename-element] -== Rename an Element +== Rename an element It's possible to rename an element either from the {explorer}, the {details} view or a representation. @@ -154,10 +154,10 @@ It's possible to rename an element either from the {explorer}, the {details} vie You can update the element name from the {explorer}: -. Click on the {explorer-menu} next to the element in the {explorer}. +. Click the {explorer-menu} next to the element in the {explorer}. . Select the `Rename` option. . Update the name in the editable field. -. Click on `Rename`. +. Click `Rename`. image::hands-on-rename-element-from-project-editor.png[Rename element from project explorer] @@ -191,7 +191,7 @@ Instead of using the tool in the toolbar, you can press `F2` key or start typing ==== [#update-element] -== Update an Element +== Update an element It's possible to update element properties either from the {details} view or a representation. @@ -224,17 +224,17 @@ A powerful syntax exists for editing element properties directly through the dir ==== [#delete-element] -== Delete an 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. +The element and its children - semantic element and representations - are deleted. ==== [NOTE] ==== -The deletion will affect everyone. +The deletion affects everyone. ==== To delete an element, follow these steps: @@ -242,14 +242,14 @@ To delete an element, follow these steps: === From the {explorer} . Open the {explorer-menu} next to the element. -. Click on `Delete`. +. Click `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. +. Click 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] @@ -263,29 +263,29 @@ 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. +You can reset it by deleting the {product} data in cache of your browser. ==== [#direct-edit] -== Direct Edit Tool and Shortcuts +== 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. +In general, you can edit the label of a shape in a diagram, and the diagram editor tries 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_ doesn't exist, it will be created as an appropriate type element (for example 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. +* Typing `someName` updates the name of the selected element. +* Typing `:SomeTypeName`, sets the type of the selected element to _SomeTypeName_. +If _SomeTypeName_ doesn't exist, it's created as an appropriate type element (for example Item Definition, Part Definition, etc.) within the same parent container as the selected element. +* Typing `[x]` on an element or a relationship sets its cardinality to _x_. +* Typing `[1..x]` on an element or a relationship sets its cardinality to _1..x_. +* Typing `[x..*]` on an element or a relationship sets its cardinality to _x..*_. +* Typing `someElement:>otherElement` on a element sets _someElement_ as a `subsetting` of the _otherElement_ if both element are of the same type. +Otherwise, it creates a `specialization` relationship between _someElement_ and _otherElement_. +* Typing `someElement:>>otherElement` on an element sets _someElement_ as a `redefinition` of _otherElement_. + +These shortcuts offer a convenient way to update model elements efficiently. diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc index 32f0280..e684e03 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/representation-operations.adoc @@ -1,7 +1,7 @@ -= Representation Operations += Representation operations [#create-representation] -== Create a New Representation +== Create a new representation To create a representation, follow these steps: @@ -14,10 +14,10 @@ To create a representation, follow these steps: 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. +Upon creation, the new representation automatically opens and appears in the {explorer} under the element. [#delete-representation] -== Delete a Representation +== Delete a representation It's possible to delete a representation either from the {explorer} or the {representations-view}. @@ -46,7 +46,7 @@ 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. +. Click the `Delete` button. image::hands-on-delete-representation-from-representation-view.png[Delete representation from the {representations-view}] @@ -59,23 +59,23 @@ 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. +You can reset it by deleting the {product} data in cache of your browser. ==== [#rename-representation] -== Rename a 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}. +. Click the {explorer-menu} next to the representation in the {explorer}. . Select the `Rename` option. . Update the name in the editable field. -. Click on `Rename`. +. Click `Rename`. image::hands-on-rename-representation.png[Rename representation] [#share-representation] -== Share a 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. diff --git a/doc/content/modules/user-manual/pages/integration/api.adoc b/doc/content/modules/user-manual/pages/integration/api.adoc index 0f91e8e..055e40e 100644 --- a/doc/content/modules/user-manual/pages/integration/api.adoc +++ b/doc/content/modules/user-manual/pages/integration/api.adoc @@ -5,7 +5,7 @@ [NOTE] ==== The SysML v2 API is unavailable. -For interoperability with SysON, use the provided file exchange format. +For interoperability with {product}, use 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. diff --git a/doc/content/modules/user-manual/pages/integration/developer-guide.adoc b/doc/content/modules/user-manual/pages/integration/developer-guide.adoc index b40e152..9f8a51e 100644 --- a/doc/content/modules/user-manual/pages/integration/developer-guide.adoc +++ b/doc/content/modules/user-manual/pages/integration/developer-guide.adoc @@ -2,13 +2,13 @@ This developer guide provides step-by-step instructions on how to set up your developer environment, contribute to the codebase, and enhance the capability of {product}. -== Retrieving the Source Code +== Retrieving the source code {product} is built upon the https://eclipse.dev/sirius/sirius-web.html[Eclipse Sirius Web] project. {product} is licensed under the xref:product-legal:index.adoc[(EPL v2)] Open Source license -The source code is openly accessible on GitHub:{source-code-url} +The source code is openly available on GitHub:{source-code-url} -To get the source code, clone the repository using either SSH: +To get the source code, clone the repository by using either SSH: [source, bash] ---- @@ -22,7 +22,7 @@ or HTTPS: git clone https://github.com/eclipse-syson/syson.git ---- -== Setting Up your Development Environment +== Setting up your development environment . Download your coding environment https://spring.io/tools[Spring Tools 4.22.0] . Ensure that m2e version from your environment is 2.6.0 @@ -31,16 +31,16 @@ image::environment-m2e-version.png[m2e version] + . Retrieve the source code or fork it if you want to make contribution . Import _backend_ plugins from syson repository in your workspace -. Update _settings.xml_ file from your _.m2_ folder to give access to other repositories during the build - In order to see dependance with access to add in _settings.xml_, have a look on _backend\application\syson-application\pom.xml_ +. Update _settings.xml_ file from your _.m2_ folder to give access to other repositories during the build + To see dependance with access to add in _settings.xml_, have a look on _backend\application\syson-application\pom.xml_ You need to create https://github.com/settings/tokens[access tokens] on Github to complete _settings.xml_. + image::environment-settings.png[settings file] -+ -. Right click on _syson-services_ module and then _Properties>JavaBuildPath>Source_ ++ +. Right click _syson-services_ module and then _Properties>JavaBuildPath>Source_ Add _main/generated_ folder and remove _excluded_ content and former _antlr/grammar_ You should retrieve the following _Java build path_ + image::environment-java-build-path.png[Java build path] -+ ++ . Update Maven project by launching "ALT+F5" shortcut on all modules of your workspace diff --git a/doc/content/modules/user-manual/pages/key-features.adoc b/doc/content/modules/user-manual/pages/key-features.adoc index c9c62a3..b57f4f2 100644 --- a/doc/content/modules/user-manual/pages/key-features.adoc +++ b/doc/content/modules/user-manual/pages/key-features.adoc @@ -1,7 +1,7 @@ = Key features in {product} {product} encompasses a set of key features aimed at enhancing the modeling experience within the {sysmlv2} framework. -The primary functionalities of {product} are centered around project management and model creation, aligning with the classical views recommended by the {sysmlv2} standard. +The primary functionalities of {product} are centered around project management and model creation, aligning with the classical views recommended by the {sysmlv2} standard. [NOTE] ==== @@ -10,111 +10,84 @@ In {product}, features are categorized into two distinct levels of maturity: * **Experimental**: Features in the early stages of development or testing, subject to potential changes and improvements based on user feedback. * **Stable**: Features that have completed rigorous testing, are deemed reliable, and are ready for production use with a high level of confidence in their stability and capability. -This dual categorization allows users to choose features based on their comfort level with the maturity of each, providing flexibility and transparency in the utilization of our product. +This dual categorization allows users to select features based on their comfort level with the maturity of each, providing flexibility and transparency in the usage of {product}. ==== -== Features Overview +== Features overview -[cols="3*^",width="100%"] +[cols="2*^",width="100%"] |=== -| Feature| Open source ({product})|Enterprise Add-ons ({ocp}) +| Feature| Open source ({product}) -3+h|Projects Management +2+h|Projects Management |xref:features/homepage.adoc[Projects Browser] -a|icon:check[role=Green] -a|icon:check[role=Green] - -|xref:features/editor.adoc[Project Editor] -a|icon:check[role=green] -a|icon:check[role=green] - -|xref:features/editor.adoc#project-actions[Manage Project] -a|icon:check[role=green] a|icon:check[role=green] -|xref:user-manual:support.adoc[Teams] -a|icon:times[role=red] +|xref:features/editor.adoc[Project Editor] a|icon:check[role=green] -3+h|{sysmlv2} Views +2+h|{sysmlv2} Views |xref:user-manual:features/general-view.adoc[{gv}] -a|icon:check[role=gray] partial -a|icon:check[role=gray] partial +a|icon:check[role=green] partial |xref:user-manual:features/interconnection-view.adoc[{iv}] -a|icon:check[role=gray] partial -a|icon:check[role=gray] partial +a|icon:check[role=green] partial |xref:user-manual:features/sysmlv2-overview.adoc[{afv}] -a|icon:times[role=red] -a|icon:times[role=red] +a|icon:times[role=green]partial |xref:user-manual:features/sysmlv2-overview.adoc[{stv}] -a|icon:times[role=red] -a|icon:times[role=red] +a|icon:times[role=green]partial |xref:user-manual:features/sysmlv2-overview.adoc[Sequence View] a|icon:times[role=red] -a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Geometry View] a|icon:times[role=red] -a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Grid View] a|icon:times[role=red] -a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Browser View] a|icon:times[role=red] -a|icon:times[role=red] -3+h|Collaboration & Interoperability +|xref:user-manual:features/sysmlv2-overview.adoc[{kerml}/{sysml} Libraries] +a|icon:times[role=red] -|xref:features/collaboration.adoc[Share Projects] -a|icon:times[role=gray] (All the projects are Public) -a|icon:times[role=gray] (All the projects are Public) +2+h|Diagram Management -|xref:features/collaboration.adoc[Share Diagram] -a|icon:check[role=green] -a|icon:check[role=green] - -|xref:integration/interoperability.adoc[Download / Upload JSON format] -a|icon:check[role=green] -a|icon:check[role=green] +|xref:user-manual:support.adoc[Contextual Palette, Direct Edit, Multi-Selection, Reconnect, Hide/Fade, Collapse/Expand, Drag &Drop, Compartments, Custom Shapes, Assisted Layout (Auto layout, Ruler, Grid, Align, Distribute...)] +a|icon:times[role=green] -|xref:integration/interoperability.adoc[Download / Upload Standard {sysmlv2} JSON format] -a|icon:times[role=red] +|xref:user-manual:support.adoc[Edit Graphical Properties, Undo/Redo, Copy/Paste] a|icon:times[role=red] -|xref:integration/interoperability.adoc[Download / Upload {sysmlv2} textual format] -a|icon:check[role=gray] Experimental -a|icon:check[role=gray] Experimental +2+h|Collaboration & Interoperability -|xref:user-manual:support.adoc[Live Collaboration] -a|icon:times[role=red] -a|icon:check[role=green] +|xref:features/collaboration.adoc[Share Links (Projects, Diagrams...)] +a|icon:times[role=green] -3+h|Advanced +|xref:features/collaboration.adoc[Concurrent authoring] +a|icon:times[role=green] -|xref:user-manual:support.adoc[Authentication (SSO, LDAP, AD)] -a|icon:times[role=red] +|xref:integration/interoperability.adoc[Download / Upload JSON] a|icon:check[role=green] -|xref:user-manual:support.adoc[Accounts Administration] +|xref:integration/interoperability.adoc[Download / Upload Standard {sysmlv2} JSON] a|icon:times[role=red] -a|icon:check[role=green] +|xref:integration/interoperability.adoc[Download / Upload {sysmlv2} textual format] +a|icon:check[role=green] Partial |=== A comprehensive list of all {product} features is available in the xref:features/features.adoc[Features] section. -== Ongoing Development +== Ongoing development {product} is continually evolving, with a commitment to expanding its repertoire of views in alignment with the {sysmlv2} standard. Future releases will introduce additional features, ensuring {product} remains a comprehensive and adaptable tool for system engineering. -== Enterprise Add-ons +== Others -For enterprise-specific add-ons and tailored solutions, please reach out to Obeo and explore the options available for xref:user-manual:support.adoc[professional support]. \ No newline at end of file +For other features, please xref:user-manual:support.adoc[contact us]. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/release-notes/2023.12.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2023.12.0.adoc index b1cc04b..58c242d 100644 --- a/doc/content/modules/user-manual/pages/release-notes/2023.12.0.adoc +++ b/doc/content/modules/user-manual/pages/release-notes/2023.12.0.adoc @@ -1,6 +1,8 @@ = 2023.12.0 -icon:trophy[] Initial release! +== Key highlights + +- icon:trophy[] Initial release! == Dependencies update diff --git a/doc/content/modules/user-manual/pages/release-notes/2024.1.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2024.1.0.adoc index c345da5..158f298 100644 --- a/doc/content/modules/user-manual/pages/release-notes/2024.1.0.adoc +++ b/doc/content/modules/user-manual/pages/release-notes/2024.1.0.adoc @@ -1,5 +1,10 @@ = 2024.1.0 +== Key highlights + +- Expanded Library Access: We now support a wider range of standard libraries. +- User-Friendly Diagrams: We've introduced helpful background messages for empty diagrams, making it easier for users to understand and use the tool right from the start. + == Breaking changes - All `findUsageByName` and `findDefinitionByName` method have been replaced by the new `findByNameAndType` in `org.eclipse.syson.services.UtilService`. @@ -8,7 +13,7 @@ == Dependencies 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`. +- {product} SysMLv2 metamodel module now depends on `org.eclipse.emf.ecore.xmi` and `java-uuid-generator`. - Switch to vite 4.5.2 == New features @@ -18,8 +23,7 @@ image::release-notes-help-background.png[Diagram help background] - 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. +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 might have partial content. - Add support for automatic imports. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/release-notes/2024.3.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2024.3.0.adoc index 313d15b..01e2e27 100644 --- a/doc/content/modules/user-manual/pages/release-notes/2024.3.0.adoc +++ b/doc/content/modules/user-manual/pages/release-notes/2024.3.0.adoc @@ -1,5 +1,16 @@ = 2024.3.0 +== Key highlights + +- *Improved User Interactivity*: New features such as direct editing allow users to change element details seamlessly, without data loss. +This enhances the overall user experience by making it more intuitive and reducing the time required to make changes. +- *Expanded Library and Standard Support*: All {kerml} and {sysmlv2} standard libraries are now included by default. +This expands the tool's capabilities and ensures compatibility with industry standards, making it easier to integrate and reference standard elements in projects. +- *Advanced Filtering*: New filters have been added to the Explorer view, allowing users to hide specific elements and libraries, which simplifies the interface and focuses on relevant data. +- *Import Capabilities*: Additionally, {sysmlv2} textual files can now be imported directly, enhancing data integration and compatibility with other tools. +- *Enhanced Diagram Development*: We've restructured and streamlined our diagrams implementation, including the introduction of specific modules and tools for better cross-diagram functionality. +This ensures that all graphical representations are more cohesive and easier to maintain. + == Breaking changes - Node Descriptions Providers in General View has been modified with mainly rename of these providers to match with all `Definitions` and `Usages` Node Descriptions. @@ -33,7 +44,7 @@ image::release-notes-add-existing-elements.png[Add existing elements (recursive) image::release-notes-package-header.png[Package header] - It's now impossible to have Package children overlapping the `Package` node body's west border. -- All KerML and SysML standard libraries have been added in project definition. +- All {kerml} and {sysml} standard libraries have been added in project definition. These libraries aren't 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. @@ -68,4 +79,4 @@ image::release-notes-feature-typing-tool.png[Feature typing tool] image::release-notes-filters.png[Explorer filters] - `{afv}` diagrams are now available on Package elements. - `Requirement view` diagrams are now available on Package elements. -- It's now possible to import SysMLv2 textual files into SysON, through the existing document upload modal. +- It's now possible to import SysMLv2 textual files into {product}, through the existing document upload modal. diff --git a/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc index c2fff6a..3a1f737 100644 --- a/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc +++ b/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc @@ -1,5 +1,18 @@ = 2024.5.0 +== Key highlights + +- *Expanded Diagram and Model Support*: We've significantly expanded our support for various views, including the addition of representations for use cases, occurrences, and allocations. +This enhancement provides more comprehensive tools to visualize and manage {sysmlv2} models. +This includes the addition of diagrams for use cases, occurrences, and allocations. +- *Improved User Experience*: We've improved how elements are displayed, particularly in terms of ports and compartments. +These enhancements ensure a clearer and more intuitive user interface. +- *Increased Stability and Reliability*: We've addressed several key bugs and stability issues including fixing problems with diagrams and import capabilities. +These improvements help maintain the integrity and accuracy of semantic data. +- *First Export Capability*: Our enhanced integration of SysIDE now supports better integration of the {sysmlv2} format. +We're now able to export projects in the standard textual format, facilitating easier data sharing and compatibility with other industry-standard tools. +This promotes better data exchange and collaboration. + == Breaking changes - The `requirement-view` diagram has been introduced by error in the last release. @@ -28,14 +41,14 @@ image::release-notes-attribut-compartmen-interconnection-view.png[Attribute comp image::release-notes-enumeration-definition.png[Enumeration definition node] - "Add existing element (recursive)" action has been updated to create child nodes for nested and owned usages at the root of the diagram. -- While importing some of the standard examples, there are no more Exception mainly when some of examples are linked to non resolved elements. -- Hide capabilities have been restored and improved in the palette. -It's now possible to hide a node but also all of its content (recursive) or symply direct content (Shhow valued content action). +- While importing some of the standard examples, there are no more exception mainly when some of examples are linked to non resolved elements. +- Hide capabilities have been restored and improved in the palette. +It's now possible to hide a node but also all its content (recursive) or symply direct content (Shhow valued content action). image::release-notes-hide-capabilities.png[Restore and Improve hide capabilities] -- `Namespace.getImportedMemberships` method now prevents name collisions as stated in the specification (KerML 7.2.5.4 Imports). -- Non end `Usages` have been removed from AllocationDefinition ends compartment. +- `Namespace.getImportedMemberships` method now prevents name collisions as stated in the specification ({kerml} 7.2.5.4 Imports). +- Non end Usages have been removed from AllocationDefinition ends compartment. image::release-notes-ends-compartment-AllocationDefinition.png[Ends compartment from AllocationDefinition] @@ -43,8 +56,8 @@ image::release-notes-ends-compartment-AllocationDefinition.png[Ends compartment image::release-notes-avoid-nestedPart-cycle.png[Avoid nested part cycle] -- Time performance has been improved when using "Become nested part" edge creation tool. -- "state transition" and "actions" compartments are now available on `StateDefinition` and `StateUsage` node. +- Time performance has been improved when using `Become nested part` edge creation tool. +- `state transition` and `actions` compartments are now available on `StateDefinition` and `StateUsage` node. image::release-notes-state-transition-cpt.png[State transition compatment] @@ -58,33 +71,33 @@ image::release-notes-inherited-feature-cpt.png[Inherited features in compartment - Composite usages are now forbidden inside `PortDefinition`/`PortUsage`. - Composite usages are now forbidden inside `AttributeDefinition`/`AttributeUsage`. -- Explicit usage of node to call syside JavaScript file has been added. +- Explicit usage of `node` to call SysIDE JavaScript file has been added. -- `Membership`#visibility attribute has been added to Core properties in the Details view. +- `Membership`#visibility attribute has been added to `Core` properties in the Details view. image::release-notes-membership-visibility.png[Membership visibility in Details view] -- `PortUsage`#direction attribute has been added to Core properties in the Details view. +- `PortUsage`#direction attribute has been added to `Core` properties in the Details view. image::release-notes-port-direction.png[Port direction in Details view] -- `Definition`/`Usage` node are now collapsed by default in general-view & actionflow-view diagrams. +- `Definition`/`Usage` node are now collapsed by default in {gv} & {afv} diagrams. - `Definition`/`Usage` nodes are expanded in all diagrams when a compartment item is created. - All elements are now represented with their icon. - Label is now positioned from inside to outside for `Ports` (Border Nodes). image::release-notes-port-label.png[Port label] -- General-view diagrams can now be created on any `Namespace` element. +- {gv} diagrams can now be created on any `Namespace` element. - Instead of revealing all compartments of a node when user creates a child in one compartment, only the compartment parent of the child to create is revealed. Other compartments visibility doesn't change. image::release-notes-reveal-compartments.png[Reveal compartment] -- It's now possible to create interconnection-view diagrams on any `Usage`/`Definition` element. -- A new compartiment with a free-form layout inside the ActionUsage and ActionDefinition nodes is now available. -Thanks to this compartment, user can separate action node and connect them using edges. +- It's now possible to create {iv} diagrams on any `Usage`/`Definition` element. +- A new compartment with a free-form layout inside the `ActionUsage` and `ActionDefinition` nodes is now available. +Thanks to this compartment, user can separate `Action` nodes and connect them by using edges. image::release-notes-action-in-compartment.png[Action in compartment] @@ -92,7 +105,7 @@ image::release-notes-action-in-compartment.png[Action in compartment] image::release-notes-delete-containment-edge.png[Remove containment edge] -- "Add existing elements" tools have been added on State & StateDefinition graphical elements. +- "Add existing elements" tools have been added on `State` and `StateDefinition` graphical elements. image::release-notes-add-existing-element-on-state.png[Add existing elements on state] @@ -107,46 +120,46 @@ image::release-notes-requirements.png[Requirements] image::release-notes-become-nested-attribute.png[Become nested attribute edge tool] - Creation tools (mainly `AttributeUsage`, `PartUsage`, `PortUsage` `ItemUsage`) have been addded in `ActionUsage`, `ConstraintUsage`, `InterfaceDefinition`, `RequirementDefinition` and `PortUsage`. -- `UseCaseDefinition` and `UseCaseUsage` elements are now handled in General View diagram. +- `UseCaseDefinition` and `UseCaseUsage` elements are now handled in {gv}. -image::release-notes-handle-usecase.png[Handle usecase elements] +image::release-notes-handle-usecase.png[Handle Usecase elements] - Composite edges between `Usage` and compartment content have been added to link nested `Actions` with its `Action`, nested `Constraints` with its `Constraints` and nested `Constraints` with its `Requirement`. image::release-notes-nested-composite-edge.png[Nested composite edge] -- `OccurrenceDefinition` and `OccurrenceUsage` elements are now handled in General View diagram. +- `OccurrenceDefinition` and `OccurrenceUsage` elements are now handled in {gv}. image::release-notes-handle-occurence.png[Handle occurrence elements] - Reconnection tools have been added for composition edges. -- `AllocationDefinition` and `AllocationUsage` elements are now handled in General View diagram. +- `AllocationDefinition` and `AllocationUsage` elements are now handled in {gv}. image::release-notes-handle-allocation.png[Handle allocation elements] -- A service that serializes a SysML element to its textual representation defined by the OMG Standard is now available and used in export capability. +- A service that serializes a {sysml} element to its textual representation defined by the OMG Standard is now available and used in export capability. -- `ConjugatedPortDefinition` is now handled in diagrams, Explorer and Details View. +- `ConjugatedPortDefinition` is now handled in diagrams, `Explorer` and Details View. - It's now possible to create and manipulate Interface edges in {iv} diagram. -image::release-notes-interface-usage.png[Interface usage] +image::release-notes-interface-usage.png[Interface Usage] -- `State Transition view` diagrams are now available on Package elements. +- {stv} diagrams are now available on `Package` elements. - Inherited features are now taken into account in features compartments. image::release-notes-inherited-feature.png[Inherited feature] -- `AcceptAction` elements are now handled in General View diagram. +- `AcceptAction` elements are now handled in {gv} diagram. -image::release-notes-accept-action.png[Accept action usage] +image::release-notes-accept-action.png[Accept Action Usage] -- `PortUsage` in Interconnection View are now represented with rotative image. +- `PortUsage` in Interconnection View are now represented with rotative image. Whatever its border support, the `PortUsage` node is always represented by an arrow pointing inside the parent node. image::release-notes-rotative-image.png[Rotative image] -- It's now possible to represent and handle `Succession` edges between `Actions` in General View diagram (from background diagram but also from action flow compartment). +- It's now possible to represent and handle `Succession` edges between `Actions` in {gv} diagram, from background diagram but also from action flow compartment. image::release-notes-succession-edge.png[Succession] diff --git a/doc/content/modules/user-manual/partials/before-you-start-os-experimental-all.adoc b/doc/content/modules/user-manual/partials/before-you-start-os-experimental-all.adoc new file mode 100644 index 0000000..f3ee30b --- /dev/null +++ b/doc/content/modules/user-manual/partials/before-you-start-os-experimental-all.adoc @@ -0,0 +1,12 @@ +.Before you Start +[caption=] +==== +// Edition +include::user-manual:partial$feature-os.adoc[] + +// Status +include::user-manual:partial$feature-status-experimental.adoc[] + +// Usage +include::user-manual:partial$feature-usage-all.adoc[] +==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/feature-edition-os.adoc b/doc/content/modules/user-manual/partials/feature-edition-os.adoc deleted file mode 100644 index 46ab516..0000000 --- a/doc/content/modules/user-manual/partials/feature-edition-os.adoc +++ /dev/null @@ -1 +0,0 @@ -icon:circle-info[] This feature is included in the Open Source Edition. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/feature-os.adoc b/doc/content/modules/user-manual/partials/feature-os.adoc new file mode 100644 index 0000000..d619332 --- /dev/null +++ b/doc/content/modules/user-manual/partials/feature-os.adoc @@ -0,0 +1 @@ +icon:lock-open[] The open source {product} project includes this feature. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/feature-status-experimental.adoc b/doc/content/modules/user-manual/partials/feature-status-experimental.adoc index 90a7ad0..b399298 100644 --- a/doc/content/modules/user-manual/partials/feature-status-experimental.adoc +++ b/doc/content/modules/user-manual/partials/feature-status-experimental.adoc @@ -1,2 +1,3 @@ -icon:fire[] This feature is considered experimental at the moment. -We encourage users to try it out and give us feedback by reporting bugs and feature requests/ideas, but this shouldn't be used in production. \ No newline at end of file +icon:fire[] This feature is currently considered experimental. +Try it out and provide feedback by reporting bugs and suggesting new features. +It's not recommended for production use. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/feature-usage-all.adoc b/doc/content/modules/user-manual/partials/feature-usage-all.adoc index f9dafe4..9b13a4d 100644 --- a/doc/content/modules/user-manual/partials/feature-usage-all.adoc +++ b/doc/content/modules/user-manual/partials/feature-usage-all.adoc @@ -1 +1 @@ -icon:circle-info[] This feature is accessible to all users. \ No newline at end of file +icon:users[] This feature is available to all users. \ No newline at end of file