diff --git a/doc/content/modules/ROOT/nav.adoc b/doc/content/modules/ROOT/nav.adoc index 9a2d445..dcaaedf 100644 --- a/doc/content/modules/ROOT/nav.adoc +++ b/doc/content/modules/ROOT/nav.adoc @@ -47,4 +47,6 @@ include::user-manual:partial$nav-updates.adoc[] -- + +* xref:user-manual:faq/faq.adoc[] + * xref:product-legal:index.adoc[] \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/faq.adoc b/doc/content/modules/ROOT/pages/faq.adoc new file mode 100644 index 0000000..f145028 --- /dev/null +++ b/doc/content/modules/ROOT/pages/faq.adoc @@ -0,0 +1,14 @@ += Frequently Asked Questions + +Find answers to questions we're frequently asked. + +[cols="1*^", %noheader, frame=none, grid=none] +|=== +a|image::travel_explore.svg[xref=user-manual:faq/faq.adoc] + +*FAQ* + +Explore answers to questions we're frequently asked. + +xref:user-manual:faq/faq.adoc[Explore] +|=== \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/features.adoc b/doc/content/modules/ROOT/pages/features.adoc index ffcb445..c98ba51 100644 --- a/doc/content/modules/ROOT/pages/features.adoc +++ b/doc/content/modules/ROOT/pages/features.adoc @@ -2,7 +2,7 @@ Uncover the capabilities of {product} through an exploration of its features and foundational concepts. -[cols="2*^", %noheader, frame=none, grid=none] +[cols="3*^", %noheader, frame=none, grid=none] |=== a|image::overview.svg[xref=user-manual:features/features.adoc] @@ -12,20 +12,20 @@ Explore the {product} features in details. xref:user-manual:features/features.adoc[Explore] -a|image::settings_heart.svg[xref:user-manual:concepts.adoc] +a|image::settings_heart.svg[xref=user-manual:concepts.adoc] *Key Concepts* Addressing pivotal inquiries and offering a comprehensive understanding of the platform's fundamentals -xref:user-manual:concepts.adoc[Learn essentials] +xref:user-manual:integration/interoperability.adoc[Learn essentials] -a| image::hub.svg[xref=user-manual:integration/interoperability.adoc] +a| image::hub.svg[xref=user-manual:features/sysmlv2-overview.adoc] **Overview of {sysmlv2}** Delve into the foundational concepts of {sysmlv2}. -xref:user-manual:sysmlv2-overview.adoc[Learn more] +xref:user-manual:features/sysmlv2-overview.adoc[Learn more] |=== \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/get-started.adoc b/doc/content/modules/ROOT/pages/get-started.adoc index ae8554d..b02a5a3 100644 --- a/doc/content/modules/ROOT/pages/get-started.adoc +++ b/doc/content/modules/ROOT/pages/get-started.adoc @@ -4,14 +4,6 @@ Discover essential entry points for installation procedures and a quick tour des [cols="3*^", %noheader, frame=none, grid=none] |=== -a|image::explore.svg[xref=installation-guide:index.adoc] - -*How to install {product} ?* - -Covers installation of {product} - -xref:installation-guide:index.adoc[Install {product}] - a|image::person_play.svg[xref=installation-guide:requirements.adoc] *Read the installation's prerequisites ?* @@ -20,6 +12,14 @@ Installation requirements to run {product} xref:installation-guide:requirements.adoc[Learn more] +a|image::explore.svg[xref=installation-guide:index.adoc] + +*How to install {product} ?* + +Covers installation of {product} + +xref:installation-guide:index.adoc[Install {product}] + a|image::sprint.svg[xref=user-manual:hands-on/tutorials/batmobile.adoc] *Follow a quick start guide for new users ?* diff --git a/doc/content/modules/ROOT/pages/index.adoc b/doc/content/modules/ROOT/pages/index.adoc index 0a859c9..fc505ad 100644 --- a/doc/content/modules/ROOT/pages/index.adoc +++ b/doc/content/modules/ROOT/pages/index.adoc @@ -16,4 +16,6 @@ include::ROOT:integration.adoc[leveloffset=+1] include::ROOT:help.adoc[leveloffset=+1] -include::ROOT:release-notes.adoc[leveloffset=+1] \ No newline at end of file +include::ROOT:release-notes.adoc[leveloffset=+1] + +include::ROOT:faq.adoc[leveloffset=+1] \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/scaling.adoc b/doc/content/modules/ROOT/pages/scaling.adoc deleted file mode 100644 index c14fa4f..0000000 --- a/doc/content/modules/ROOT/pages/scaling.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Scaling {product} - -// TODO \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/troubleshooting.adoc b/doc/content/modules/ROOT/pages/troubleshooting.adoc deleted file mode 100644 index 6bb7eff..0000000 --- a/doc/content/modules/ROOT/pages/troubleshooting.adoc +++ /dev/null @@ -1,4 +0,0 @@ -= Troubleshooting and FAQs - -Don't worry, we've got more options for you. - diff --git a/doc/content/modules/ROOT/pages/user-interface-overview.adoc b/doc/content/modules/ROOT/pages/user-interface-overview.adoc index 7260f23..b2c17ae 100644 --- a/doc/content/modules/ROOT/pages/user-interface-overview.adoc +++ b/doc/content/modules/ROOT/pages/user-interface-overview.adoc @@ -4,19 +4,20 @@ Uncover the {product}'s user interface through a guided-tour and access helpful [cols="2*^", %noheader, frame=none, grid=none] |=== -a|image::travel_explore.svg[xref=user-manual:features/features.adoc] +a|image::travel_explore.svg[xref=user-manual:tour.adoc] *Tour the interface* Embark on a comprehensive exploration of {product}'s interface as this guide navigates you through the key features and functionalities -xref:user-manual:tour.adoc[Explore now] a|image::footprint.svg[xref:user-manual:hands-on/hands-on.adoc] +xref:user-manual:tour.adoc[Explore now] + + a|image::footprint.svg[xref=user-manual:hands-on/hands-on.adoc] *How-Tos and Tutorials* Step-by-step guides, ensuring users can adeptly learn essential tasks and use the potential of {product} -xref:user-manual:hands-on/hands-on.adoc[Delve into] -a|image::developer_guide.svg[xref:user-manual:key-features.adoc] +xref:user-manual:hands-on/hands-on.adoc[Delve into] |=== \ No newline at end of file diff --git a/doc/content/modules/developer-guide/assets/images/environment-java-build-path.png b/doc/content/modules/developer-guide/assets/images/environment-java-build-path.png new file mode 100644 index 0000000..ee4c9de Binary files /dev/null and b/doc/content/modules/developer-guide/assets/images/environment-java-build-path.png differ diff --git a/doc/content/modules/developer-guide/assets/images/environment-m2e-version.png b/doc/content/modules/developer-guide/assets/images/environment-m2e-version.png new file mode 100644 index 0000000..f744d36 Binary files /dev/null and b/doc/content/modules/developer-guide/assets/images/environment-m2e-version.png differ diff --git a/doc/content/modules/developer-guide/assets/images/environment-settings.png b/doc/content/modules/developer-guide/assets/images/environment-settings.png new file mode 100644 index 0000000..d43a595 Binary files /dev/null and b/doc/content/modules/developer-guide/assets/images/environment-settings.png differ diff --git a/doc/content/modules/developer-guide/pages/index.adoc b/doc/content/modules/developer-guide/pages/index.adoc index 4efe759..b40e152 100644 --- a/doc/content/modules/developer-guide/pages/index.adoc +++ b/doc/content/modules/developer-guide/pages/index.adoc @@ -24,4 +24,23 @@ git clone https://github.com/eclipse-syson/syson.git == Setting Up your Development Environment -//TODO \ No newline at end of file +. Download your coding environment https://spring.io/tools[Spring Tools 4.22.0] +. Ensure that m2e version from your environment is 2.6.0 ++ +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_ + 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/assets/images/download.png b/doc/content/modules/installation-guide/assets/images/download.png index e0311ad..fd0b378 100644 Binary files a/doc/content/modules/installation-guide/assets/images/download.png and b/doc/content/modules/installation-guide/assets/images/download.png differ diff --git a/doc/content/modules/installation-guide/assets/images/latest-version.png b/doc/content/modules/installation-guide/assets/images/latest-version.png index 18501cc..6ba2e4b 100644 Binary files a/doc/content/modules/installation-guide/assets/images/latest-version.png and b/doc/content/modules/installation-guide/assets/images/latest-version.png differ diff --git a/doc/content/modules/installation-guide/pages/anti-virus.adoc b/doc/content/modules/installation-guide/pages/anti-virus.adoc index 42b620e..4514e32 100644 --- a/doc/content/modules/installation-guide/pages/anti-virus.adoc +++ b/doc/content/modules/installation-guide/pages/anti-virus.adoc @@ -1,6 +1,6 @@ = Configure Anti-virus software for use with {product} server -While we cannot directly recommend specific antivirus software for use with {product} applications, we would like to advise our customers that if you are experiencing slowness with your {product} application, try running it with virus checking disabled. +While we can't directly recommend specific antivirus software for use with {product} applications, we want to advise our customers that if you are experiencing slowness with your {product} application, try running it with virus checking disabled. Due to the high volume of temporary files generated by {product} applications, antivirus software can significantly impact performance by causing excessive disk I/O and resource contention. In some cases, even disabling antivirus software might not be sufficient to resolve performance issues. 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 30be06d..81e8ac6 100644 --- a/doc/content/modules/installation-guide/pages/how-tos/install.adoc +++ b/doc/content/modules/installation-guide/pages/how-tos/install.adoc @@ -54,7 +54,7 @@ docker run -p 5434:5432 --name syson-postgres \ This may take a while the first time you run this as Docker will first pull the PostgreSQL image. ==== -If you don't have Docker or prefer to utilize an existing PostgreSQL installation, modify the following command-line parameters and ensure the `POSTGRES_USER` possesses administrative rights on the database. +If you don't have Docker or prefer to use an existing PostgreSQL installation, modify the following command-line parameters and ensure the `POSTGRES_USER` possesses administrative rights on the database. These rights are necessary for the automatic creation of the database schema. == Start the application diff --git a/doc/content/modules/installation-guide/pages/requirements.adoc b/doc/content/modules/installation-guide/pages/requirements.adoc index 691aa3f..bb29337 100644 --- a/doc/content/modules/installation-guide/pages/requirements.adoc +++ b/doc/content/modules/installation-guide/pages/requirements.adoc @@ -65,9 +65,10 @@ It's recommended to use the Java runtime provided by the https://adoptium.net/fr === Supported browsers +Users can interact with the central server through following web browsers: + [%noheader] |=== -|*Browsers* a|*Desktop browsers:* * *Chrome* latest stable version diff --git a/doc/content/modules/installation-guide/pages/troubleshooting.adoc b/doc/content/modules/installation-guide/pages/troubleshooting.adoc index c1474c9..dd61d05 100644 --- a/doc/content/modules/installation-guide/pages/troubleshooting.adoc +++ b/doc/content/modules/installation-guide/pages/troubleshooting.adoc @@ -3,4 +3,4 @@ Even the most straightforward installation process can encounter unforeseen issues. This section offers comprehensive troubleshooting tips and solutions to common problems encountered during installation. -//TODO \ No newline at end of file +If you encounter any troubleshooting, please xref:ROOT:help.adoc[contact us] to have solution and to share your troubleshooting to this page. \ No newline at end of file diff --git a/doc/content/modules/sirius-web/README b/doc/content/modules/sirius-web/README deleted file mode 100644 index 421108f..0000000 --- a/doc/content/modules/sirius-web/README +++ /dev/null @@ -1,2 +0,0 @@ -This folder contains documentation about legal public information. -This documentation can be shared **publicly**. diff --git a/doc/content/modules/sirius-web/assets/README b/doc/content/modules/sirius-web/assets/README deleted file mode 100644 index 1fee311..0000000 --- a/doc/content/modules/sirius-web/assets/README +++ /dev/null @@ -1,3 +0,0 @@ -Optional; Reserved - -Directory where multimedia and supplemental files are organized by content type. diff --git a/doc/content/modules/sirius-web/assets/attachments/README b/doc/content/modules/sirius-web/assets/attachments/README deleted file mode 100644 index 65b6253..0000000 --- a/doc/content/modules/sirius-web/assets/attachments/README +++ /dev/null @@ -1,3 +0,0 @@ -Optional; Reserved - -Directory that contains supplemental materials, such as PDFs or ZIP files, that readers can download via a link created in a page using the AsciiDoc link macro. diff --git a/doc/content/modules/sirius-web/assets/images/README b/doc/content/modules/sirius-web/assets/images/README deleted file mode 100644 index 3657f44..0000000 --- a/doc/content/modules/sirius-web/assets/images/README +++ /dev/null @@ -1,3 +0,0 @@ -Optional; Reserved - -Directory that contains pictures, screenshots, diagrams, and other graphics files that are displayed in a page using the AsciiDoc image macro. diff --git a/doc/content/modules/sirius-web/examples/README b/doc/content/modules/sirius-web/examples/README deleted file mode 100644 index 817b0a0..0000000 --- a/doc/content/modules/sirius-web/examples/README +++ /dev/null @@ -1,3 +0,0 @@ -Optional; Reserved - -Directory that contains non-AsciiDoc file types, such as source code or data values. These files are often inserted into listing blocks using the AsciiDoc include directive. diff --git a/doc/content/modules/sirius-web/examples/eplv2-license.txt b/doc/content/modules/sirius-web/examples/eplv2-license.txt deleted file mode 100644 index 5986151..0000000 --- a/doc/content/modules/sirius-web/examples/eplv2-license.txt +++ /dev/null @@ -1,87 +0,0 @@ -Eclipse Public License version 2.0 -SPDX short identifier: EPL-2.0 - -Further resources on the Eclipse Public License version 2.0 - - -Eclipse Public License - v 2.0 - -THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE (“AGREEMENT”). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. - -1. DEFINITIONS -“Contribution” means: - -a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and -b) in the case of each subsequent Contributor: -i) changes to the Program, and -ii) additions to the Program; -where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution “originates” from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works. -“Contributor” means any person or entity that Distributes the Program. - -“Licensed Patents” mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program. - -“Program” means the Contributions Distributed in accordance with this Agreement. - -“Recipient” means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors. - -“Derivative Works” shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. - -“Modified Works” shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof. - -“Distribute” means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy. - -“Source Code” means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files. - -“Secondary License” means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor. - -2. GRANT OF RIGHTS -a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works. -b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder. -c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program. -d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement. -e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3). -3. REQUIREMENTS -3.1 If a Contributor Distributes the Program in any form, then: - -a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and -b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license: -i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose; -ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits; -iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and -iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3. -3.2 When the Program is Distributed as Source Code: - -a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and -b) a copy of this Agreement must be included with each copy of the Program. -3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability (‘notices’) contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices. - -4. COMMERCIAL DISTRIBUTION -Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor (“Commercial Contributor”) hereby agrees to defend and indemnify every other Contributor (“Indemnified Contributor”) against any losses, damages and costs (collectively “Losses”) arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense. - -For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages. - -5. NO WARRANTY -EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations. - -6. DISCLAIMER OF LIABILITY -EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -7. GENERAL -If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. - -If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed. - -All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive. - -Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version. - -Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement. - -Exhibit A – Form of Secondary Licenses Notice -“This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), version(s), and exceptions or additional permissions here}.” - -Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses. - -If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. - -You may add additional accurate notices of copyright ownership. \ No newline at end of file diff --git a/doc/content/modules/sirius-web/pages/README b/doc/content/modules/sirius-web/pages/README deleted file mode 100644 index 1a9c445..0000000 --- a/doc/content/modules/sirius-web/pages/README +++ /dev/null @@ -1,4 +0,0 @@ -Required; Reserved - -Directory that contains all of a module’s AsciiDoc files. -These files are automatically enlisted by Antora and converted to standalone HTML pages. diff --git a/doc/content/modules/sirius-web/pages/index.adoc b/doc/content/modules/sirius-web/pages/index.adoc deleted file mode 100644 index 5bd2938..0000000 --- a/doc/content/modules/sirius-web/pages/index.adoc +++ /dev/null @@ -1,2 +0,0 @@ -// TODO to delete - diff --git a/doc/content/modules/sirius-web/partials/README b/doc/content/modules/sirius-web/partials/README deleted file mode 100644 index 559a114..0000000 --- a/doc/content/modules/sirius-web/partials/README +++ /dev/null @@ -1,5 +0,0 @@ -Optional; Reserved - -Directory that contains AsciiDoc files that can be inserted into the files stored in pages. -These files aren’t converted to HTML by Antora directly. -Instead, they must be referenced by an include directive in a page in the pages directory. diff --git a/doc/content/modules/user-manual/assets/images/environment-java-build-path.png b/doc/content/modules/user-manual/assets/images/environment-java-build-path.png new file mode 100644 index 0000000..ee4c9de Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/environment-java-build-path.png differ diff --git a/doc/content/modules/user-manual/assets/images/environment-m2e-version.png b/doc/content/modules/user-manual/assets/images/environment-m2e-version.png new file mode 100644 index 0000000..f744d36 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/environment-m2e-version.png differ diff --git a/doc/content/modules/user-manual/assets/images/environment-settings.png b/doc/content/modules/user-manual/assets/images/environment-settings.png new file mode 100644 index 0000000..d43a595 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/environment-settings.png differ diff --git a/doc/content/modules/user-manual/assets/images/parametric-modeling-connected-port.png b/doc/content/modules/user-manual/assets/images/parametric-modeling-connected-port.png new file mode 100644 index 0000000..4b48966 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/parametric-modeling-connected-port.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-accept-action.png b/doc/content/modules/user-manual/assets/images/release-notes-accept-action.png new file mode 100644 index 0000000..a764713 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-accept-action.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-action-in-compartment.png b/doc/content/modules/user-manual/assets/images/release-notes-action-in-compartment.png new file mode 100644 index 0000000..907d04f Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-action-in-compartment.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-add-existing-element-on-state.png b/doc/content/modules/user-manual/assets/images/release-notes-add-existing-element-on-state.png new file mode 100644 index 0000000..adb5f60 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-add-existing-element-on-state.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-avoid-nestedPart-cycle.png b/doc/content/modules/user-manual/assets/images/release-notes-avoid-nestedPart-cycle.png new file mode 100644 index 0000000..1f19856 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-avoid-nestedPart-cycle.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-become-nested-attribute.png b/doc/content/modules/user-manual/assets/images/release-notes-become-nested-attribute.png index 0b56453..a9c705f 100644 Binary files a/doc/content/modules/user-manual/assets/images/release-notes-become-nested-attribute.png and b/doc/content/modules/user-manual/assets/images/release-notes-become-nested-attribute.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-composite-edges.png b/doc/content/modules/user-manual/assets/images/release-notes-composite-edges.png new file mode 100644 index 0000000..abfcb00 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-composite-edges.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-delete-containment-edge.png b/doc/content/modules/user-manual/assets/images/release-notes-delete-containment-edge.png new file mode 100644 index 0000000..c4d70f4 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-delete-containment-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-ends-compartment-AllocationDefinition.png b/doc/content/modules/user-manual/assets/images/release-notes-ends-compartment-AllocationDefinition.png new file mode 100644 index 0000000..c10f0fe Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-ends-compartment-AllocationDefinition.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-enumeration-definition.png b/doc/content/modules/user-manual/assets/images/release-notes-enumeration-definition.png index 767527b..2946317 100644 Binary files a/doc/content/modules/user-manual/assets/images/release-notes-enumeration-definition.png and b/doc/content/modules/user-manual/assets/images/release-notes-enumeration-definition.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-handle-allocation.png b/doc/content/modules/user-manual/assets/images/release-notes-handle-allocation.png index bcbb465..41f11d8 100644 Binary files a/doc/content/modules/user-manual/assets/images/release-notes-handle-allocation.png and b/doc/content/modules/user-manual/assets/images/release-notes-handle-allocation.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-handle-occurence.png b/doc/content/modules/user-manual/assets/images/release-notes-handle-occurence.png index 4bf2bc5..f07c29e 100644 Binary files a/doc/content/modules/user-manual/assets/images/release-notes-handle-occurence.png and b/doc/content/modules/user-manual/assets/images/release-notes-handle-occurence.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-handle-usecase.png b/doc/content/modules/user-manual/assets/images/release-notes-handle-usecase.png index b823b4c..3668a8d 100644 Binary files a/doc/content/modules/user-manual/assets/images/release-notes-handle-usecase.png and b/doc/content/modules/user-manual/assets/images/release-notes-handle-usecase.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-hide-capabilities.png b/doc/content/modules/user-manual/assets/images/release-notes-hide-capabilities.png new file mode 100644 index 0000000..5f92dab Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-hide-capabilities.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-inherited-feature-cpt.png b/doc/content/modules/user-manual/assets/images/release-notes-inherited-feature-cpt.png new file mode 100644 index 0000000..a8e4c1f Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-inherited-feature-cpt.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-inherited-feature.png b/doc/content/modules/user-manual/assets/images/release-notes-inherited-feature.png new file mode 100644 index 0000000..0aea1fb Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-inherited-feature.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-interface-usage.png b/doc/content/modules/user-manual/assets/images/release-notes-interface-usage.png new file mode 100644 index 0000000..fe3628e Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-interface-usage.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-reveal-compartments.png b/doc/content/modules/user-manual/assets/images/release-notes-reveal-compartments.png new file mode 100644 index 0000000..7b809b7 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-reveal-compartments.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-rotative-image.png b/doc/content/modules/user-manual/assets/images/release-notes-rotative-image.png new file mode 100644 index 0000000..e61608d Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-rotative-image.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-state-transition-cpt.png b/doc/content/modules/user-manual/assets/images/release-notes-state-transition-cpt.png new file mode 100644 index 0000000..5a2f005 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-state-transition-cpt.png differ diff --git a/doc/content/modules/user-manual/assets/images/release-notes-succession-edge.png b/doc/content/modules/user-manual/assets/images/release-notes-succession-edge.png new file mode 100644 index 0000000..3406b43 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/release-notes-succession-edge.png differ diff --git a/doc/content/modules/user-manual/assets/images/requirement-managment-fromBackground-creation.png b/doc/content/modules/user-manual/assets/images/requirement-managment-fromBackground-creation.png new file mode 100644 index 0000000..87b742c Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/requirement-managment-fromBackground-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/requirement-managment-fromRequirement-creation.png b/doc/content/modules/user-manual/assets/images/requirement-managment-fromRequirement-creation.png new file mode 100644 index 0000000..ce85412 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/requirement-managment-fromRequirement-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/requirement-managment-node-representation.png b/doc/content/modules/user-manual/assets/images/requirement-managment-node-representation.png new file mode 100644 index 0000000..a213f1a Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/requirement-managment-node-representation.png differ diff --git a/doc/content/modules/user-manual/pages/best-practices.adoc b/doc/content/modules/user-manual/pages/best-practices.adoc index b8f120b..b9daddc 100644 --- a/doc/content/modules/user-manual/pages/best-practices.adoc +++ b/doc/content/modules/user-manual/pages/best-practices.adoc @@ -1,13 +1,18 @@ = {product} Best Practices -Explore in depth or quickly grasp best Practices and tips. +Explore in-depth or quickly grasp best Practices and tips. == Best practices A compilation of in-depth guides to help you make the most of {product}. -// TODO contribute best practices +{product} invites contributions of best practices from end user on system engineering subjects for example but also from the specifier/developer on the design of DSL view for example. + +Please xref:ROOT:help.adoc[contact us] to share your best practices. + == Tips and tricks -// TODO contribute tips and tricks \ No newline at end of file +We encourage everyone to participate and contribute its tips and tricks to this page. + +Please xref:ROOT:help.adoc[contact us] to share your tips and tricks. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/contribute.adoc b/doc/content/modules/user-manual/pages/contribute.adoc index ff0b8df..5c190df 100644 --- a/doc/content/modules/user-manual/pages/contribute.adoc +++ b/doc/content/modules/user-manual/pages/contribute.adoc @@ -42,7 +42,7 @@ We welcome your contributions! {product}’s documentation resides 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. +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. == Contributing to the Code 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 922c74a..2dcf2f8 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,3 +1,7 @@ = {afv} -The {afv} is used to ... \ No newline at end of file +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/cm.adoc b/doc/content/modules/user-manual/pages/features/cm.adoc index e3e91bc..283ca4b 100644 --- a/doc/content/modules/user-manual/pages/features/cm.adoc +++ b/doc/content/modules/user-manual/pages/features/cm.adoc @@ -1 +1,9 @@ -= Version Control and change management \ No newline at end of file += Version Control and change management + +No built-in versioning tools exists in SysOn for now. + +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. + +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/details.adoc b/doc/content/modules/user-manual/pages/features/details.adoc index 2aa4581..d848275 100644 --- a/doc/content/modules/user-manual/pages/features/details.adoc +++ b/doc/content/modules/user-manual/pages/features/details.adoc @@ -4,4 +4,7 @@ The {details} view provides a comprehensive overview of the selected element, pr image::details-right-sidebar-details.png[{details}] -CAUTION : It's important to note that any changes made in the {details} view have a direct and immediate effect on the underlying model, making these modifications instantly available to everyone accessing the model. \ No newline at end of file +[WARNING] +==== +It's important to note that any changes made in the {details} view have a direct and immediate effect on the underlying model, making these modifications instantly available to everyone accessing the model. +==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/editor.adoc b/doc/content/modules/user-manual/pages/features/editor.adoc index 21a8a78..559d54c 100644 --- a/doc/content/modules/user-manual/pages/features/editor.adoc +++ b/doc/content/modules/user-manual/pages/features/editor.adoc @@ -13,14 +13,14 @@ include::user-manual:partial$feature-status-stable.adoc[] include::user-manual:partial$feature-usage-all.adoc[] ==== -== What is the {editor} ? +== What's' the {editor} ? The **{editor}** page serves as the primary workspace for editing project content. == Find your way around For those new to {product}, the initial experience with the application may 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. +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 <>. The layout has been simplified to ensure a clear understanding of the content within each section. @@ -70,6 +70,7 @@ The {editor} area contains one or more editors. image::editor-editor.png[{editor} Main Editor] Discover the diverse range of representation options available and find the most suitable ones for your specific modeling needs. + xref:features/features.adoc#sysmlv2-views[Explore various types of representations...] === Right Sidebar diff --git a/doc/content/modules/user-manual/pages/features/features.adoc b/doc/content/modules/user-manual/pages/features/features.adoc index 29953c6..6c6b6fb 100644 --- a/doc/content/modules/user-manual/pages/features/features.adoc +++ b/doc/content/modules/user-manual/pages/features/features.adoc @@ -1,4 +1,3 @@ = Features and capabilities -* xref:user-manual:key-features.adoc[] include::user-manual:partial$nav-features.adoc[] 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 d8277d2..e6ed5a7 100644 --- a/doc/content/modules/user-manual/pages/features/general-view.adoc +++ b/doc/content/modules/user-manual/pages/features/general-view.adoc @@ -47,6 +47,7 @@ image::gv-partDef-node.png[{gv} Part Def Node] The following _Usage_ elements can be displayed in the {gv} diagram: + * Accept Action usage, * Action Usage, * Allocation Usage, * Attribute Usage, diff --git a/doc/content/modules/user-manual/pages/features/homepage.adoc b/doc/content/modules/user-manual/pages/features/homepage.adoc index 01926c2..cdacdbb 100644 --- a/doc/content/modules/user-manual/pages/features/homepage.adoc +++ b/doc/content/modules/user-manual/pages/features/homepage.adoc @@ -14,7 +14,7 @@ include::user-manual:partial$feature-status-stable.adoc[] include::user-manual:partial$feature-usage-all.adoc[] ==== -== What is 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. @@ -49,7 +49,7 @@ Within the platform, initiating a new project is a user-friendly process that ac * **Create a Blank Project**: Users can start their modeling journey with a clean slate, building a project from the ground up. With blank project, there is no model and no representation at creation. * **Create a Project from Existing Templates**: For efficiency and consistency, users can select from predefined templates that streamline project initiation, aligning with common modeling scenarios. -The 3 first possible templates are displayed unitary at the beginning of Project sections and they are also available in "Show all templates" section. +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). _SysMLv2_ is an empty SysML project with only the root model, a _Package_ and a {gv} representation. 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 18b9ef9..bfbb730 100644 --- a/doc/content/modules/user-manual/pages/features/interconnection-view.adoc +++ b/doc/content/modules/user-manual/pages/features/interconnection-view.adoc @@ -9,7 +9,7 @@ image::interconnection-view-overview.png[{iv} Overview] == Create New {iv} Diagram -User can create {iv} diagram on _Usage_ element_. +User can create {iv} diagram on any _Usage_ or _Definition_ element. image::interconnection-view-diagram-creation.png[{iv} Diagram Creation] 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 bc88046..eedda64 100644 --- a/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc +++ b/doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc @@ -12,7 +12,7 @@ Explore further by referring to the following how-tos for xref:user-manual:featu == Multi-selection -There are two way to select many elements. +Two ways to select many elements exist: === CTRL key @@ -21,7 +21,8 @@ This keyboard shortcut is available from representation editor but also from th === Shift key -To select many element in one action from representation editor, user can press `Shift` key and draw a rectangular area around elements that he wants to select.After releasing the click, all element in the area are selected. +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. +After releasing the click, all element in the area are selected. == Search 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 2af3f4b..eef7faf 100644 --- a/doc/content/modules/user-manual/pages/features/other-views.adoc +++ b/doc/content/modules/user-manual/pages/features/other-views.adoc @@ -1 +1,16 @@ -= Other views \ No newline at end of file += Other views + +Following views are planned to be available in SysON 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. + +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_. + +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 c13d18a..1d45038 100644 --- a/doc/content/modules/user-manual/pages/features/parametric-modeling.adoc +++ b/doc/content/modules/user-manual/pages/features/parametric-modeling.adoc @@ -1 +1,22 @@ -= Parametric modeling and constraints \ No newline at end of file += 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. +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. + +From the {iv} diagram, user can easily create a new part from a simple click o the root node that displays 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. + +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 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 f08b620..8d3ddbd 100644 --- a/doc/content/modules/user-manual/pages/features/requirement-management.adoc +++ b/doc/content/modules/user-manual/pages/features/requirement-management.adoc @@ -2,4 +2,30 @@ == 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. + +image::requirement-managment-fromBackground-creation.png[Requirement creation from Diagram Background] + +User can also create requirement **in other element** such as a requirement. + +image::requirement-managment-fromRequirement-creation.png[Requirement creation from Requirement] + +A Requirement Definition is represented by rectangular node style whereas a Requirement Usage is represented by rectangular node style with rounded corner. + +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. + +Work around requirements are among the topics to be processed soon. + +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 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 28c6f79..ab27520 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,3 @@ = Scaling limits -//TODO \ No newline at end of file +// TODO for example, explain the size of the models that can be supported \ 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 3cdb6ad..e755b45 100644 --- a/doc/content/modules/user-manual/pages/features/simulation.adoc +++ b/doc/content/modules/user-manual/pages/features/simulation.adoc @@ -1 +1,10 @@ -= Simulation and validation tools \ No newline at end of file += Simulation and validation tools + +Validation view is disable 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. + +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. + 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 27d473e..ec10e4f 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,3 +1,8 @@ = State transition view -The {stv} is used to ... \ No newline at end of file +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 diff --git a/doc/content/modules/user-manual/pages/features/sysmlv2-elements.adoc b/doc/content/modules/user-manual/pages/features/sysmlv2-elements.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/doc/content/modules/user-manual/pages/features/validation.adoc b/doc/content/modules/user-manual/pages/features/validation.adoc index bff6c81..ee0fdc6 100644 --- a/doc/content/modules/user-manual/pages/features/validation.adoc +++ b/doc/content/modules/user-manual/pages/features/validation.adoc @@ -3,4 +3,6 @@ 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. -Validation view is disable for now and no diagnostic are available. \ No newline at end of file +Validation view is disable 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/forum.adoc b/doc/content/modules/user-manual/pages/forum.adoc index 21adc5c..0c2ab48 100644 --- a/doc/content/modules/user-manual/pages/forum.adoc +++ b/doc/content/modules/user-manual/pages/forum.adoc @@ -4,7 +4,7 @@ Find relevant posts/answers. No solution yet to your concern? Come and ask your question. -Connect with the {product} community by participating in our forum: {forum-url} +Connect to the {product} community by participating in our forum: {forum-url} Share insights, seek help, and engage in discussions with fellow users. Join the forum to be a part of our growing community and stay informed about the latest updates and best practices. \ 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 dcecf52..68b22ef 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 @@ -46,17 +46,17 @@ To filter elements in the {explorer} using the filter bar: . Choose a tree item in the {explorer}. . Press `Ctrl+f` (Windows/Linux) or `Cmd+f` (MacOS) to enable the filter bar. . Enter a value in the filter bar. - ++ image::hands-on-filter-name-shortcut.png[Filter name shortcut] - ++ . All visible tree items containing the typed value will be highlighted. -. Use the filter button inside the filter bar to hide all visible tree items that do not contain the entered value. +. 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. [NOTE] ==== -The filter bar can only highlight items in the expanded state; it does not search within unexpanded children. +The filter bar can only highlight items in the expanded state; it doesn't search within unexpanded children. Ensure the desired tree items are expanded to effectively use the filter and highlight capability. ==== 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 b93c9df..de27c48 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 @@ -3,11 +3,11 @@ [#create-model] == Create a New Model -To create a model, follow these steps from the explorer tool bar: +To create a model, follow these steps from the explorer toolbar: . Open the Project Editor. -. Click on the `New model` action in the explorer tool bar. -. Fill in the model name. +. Click on the `New model` action in the explorer toolbar. +. Complete the model name. . Choose the model type. . Click the `Create` button. @@ -42,12 +42,12 @@ To upload a model from a file previously exported, follow these steps: . Go to the {editor}. . Open the {explorer} view. -. Click on the `Upload` button at the top of the {explorer} in the tool bar. +. Click on the `Upload` button at the top of the {explorer} in the toolbar. . It will open the `Upload Model` modal. . Select a model from your file system. - ++ image::hands-on-upload-model.png[Upload model] - ++ . The uploaded model will be automatically created and opened. [#rename-model] @@ -67,7 +67,7 @@ You can update the model name from the {explorer}: ==== Deleting a model and its content is a significant action, and it's important to note that the entire model, along with its contents, will be permanently removed. This includes all associated semantic elements, representations, and any other data within the model. -Exercise caution when performing this operation, as it cannot be reversed. +Exercise caution when performing this operation, as it can't be reversed. ==== [NOTE] @@ -84,7 +84,7 @@ To delete a model, follow these steps: image::hands-on-delete-model.png[Delete model] A confirmation dialog appears when the model is deleted via the Model Explorer. -This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. +This behavior can be disabled by checking the "Disable this confirmation dialog" checkbox in the dialog. image::manage-elements-semantic-deletion.png[Semantic Deletion] @@ -138,7 +138,7 @@ Upon completion, the newly created element is automatically selected in the {exp == Read an Element -. To navigate through the details of a semantic element, utilize the {explorer} to navigate through the model and locate the desired element. +. To navigate through the details of a semantic element, use the {explorer} to navigate through the model and locate the desired element. . Select the element in the {explorer}. . On the right sidebar, access the {details} view. This view presents all the available properties for the selected element, providing a comprehensive overview of its characteristics. @@ -187,7 +187,7 @@ Alternatively, cancel the operation by pressing the `ESC` key. [NOTE] ==== -Instead of using the tool in the tool bar, you can press `F2` key or start typing the new value directly to efficiently update the element name. +Instead of using the tool in the toolbar, you can press `F2` key or start typing the new value directly to efficiently update the element name. ==== [#update-element] @@ -215,7 +215,7 @@ You can update the element name from a representation (diagram...): [TIP] ==== -Instead of using the tool in the tool bar, you can press `F2` key or start typing the new value directly to efficiently update the element name. +Instead of using the tool in the toolbar, you can press `F2` key or start typing the new value directly to efficiently update the element name. ==== [TIP] @@ -253,10 +253,10 @@ image::hands-on-delete-element-from-explorer.png[Delete element from explorer] image::hands-on-delete-element-from-representation.png[Delete element from representation] -CAUTION: Use the `DEL` key cautiously, as it is a direct shortcut for the delete operation. +CAUTION: Use the `DEL` key cautiously, as it's a direct shortcut for the delete operation. A confirmation dialog appears when an element is deleted via the _Delete from model_ tool in the palette or via the {explorer-menu}. -This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. +This behavior can be disabled by checking the "Disable this confirmation dialog" checkbox in the dialog. image::manage-elements-semantic-deletion.png[Semantic Deletion] @@ -280,7 +280,7 @@ Here are some shortcuts for efficiently editing {product} models: * Typing `someName` will update the name of the selected element. * Typing `:SomeTypeName`, will set the type of the selected element to _SomeTypeName_. -If _SomeTypeName_ does not exist, it will be created as an appropriate type element (e.g., Item Definition, Part Definition, etc.) within the same parent container as the selected element. +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..*_. diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc index 80372f9..a11875d 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc @@ -22,19 +22,26 @@ Refer to the xref:features/editor.adoc[{editor} page] to understand how to use i To create a new project from a `Template`: -. Click in the corresponding template card at the top of the homepage. - +1. Click in the corresponding template card at the top of the homepage. ++ +-- The first three templates are directly visible in the {homepage} top region. If more templates are available, you can click the `Show all templates` card to open a dialog displaying all the available templates, possibly on multiple pages. image::hands-on-new-template.png[Create New Template] +-- ++ -. The new project is automatically created and opened. -Depending on the template, an initial representation (e.g., a diagram) might also be automatically opened. +2. The new project is automatically created and opened. ++ +-- +Depending on the template, an initial representation (for example a diagram) might also be automatically opened. The following example shows the result project _Batmobile_ create from _Batmobile_ template: image::hands-on-new-template_batmobile.png[Batmobile Template] +-- ++ [NOTE] ==== @@ -68,14 +75,14 @@ To upload a project from an archive exported, follow these steps: . Go to the {homepage}. . Click the _Upload Project_ card. - -image::hands-on-upload.png[Upload project] - ++ +image::hands-on-upload.png[Upload project] ++ . It opens the _Upload Project_ page. -. Select a ZIP from your file system. - +. Select a ZIP from your file system. ++ image::hands-on-upload-select-file.png[Select file to upload] - ++ . The uploaded project is automatically created and opened. Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/model-management.adoc#create-model[creating your own models] and xref:hands-on/how-tos/representation-operations.adoc#create-representation[representations]. @@ -99,9 +106,9 @@ You can delete a project from the {homepage}: . Click the {projects-list-menu} next to the project in the {projects-list}. . Select the `Delete` option. - ++ image::hands-on-delete-project-homepage.png[Delete Project from Homepage] - ++ . Confirm the deletion by clicking on the `Delete` button in the modal. === From the {editor} @@ -110,9 +117,9 @@ You can delete a project from the {editor}: . Click the {projects-list-menu} next to the project name in the project toolbar. . Select the `Delete` option. - ++ image::hands-on-delete-project-editor.png[Delete Project from editor] - ++ . Confirm the deletion by clicking on the `Delete` button in the modal. [#rename-project] @@ -136,9 +143,9 @@ You can update the project name from the {homepage}: . Click the {projects-list-menu} next to the project in the {projects-list}. . Select the `Rename` option. - ++ image::hands-on-rename-project-homepage.png[Rename Project from Homepage] - ++ . Update the name in the editable field. . Click on `Rename`. @@ -148,9 +155,9 @@ You can update the project name from the {editor}: . Click the {projects-list-menu} next to the project name in the toolbar. . Select the `Rename` option. - ++ image::hands-on-rename-project-editor.png[Rename Project from editor] - ++ . Update the name in the editable field. . Click on `Rename`. 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 b5443b6..32f0280 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 @@ -8,7 +8,7 @@ To create a representation, follow these steps: . Open the Project Editor. . Open the {explorer-menu} next to an element in the explorer. . Select the `New representation` action. -. Fill in the representation name. +. Complete the representation name. . Choose the representation type. . Click the `Create` button. @@ -28,7 +28,7 @@ This operation is irreversible, once done there is no mean to get the representa [NOTE] ==== -The semantic elements visible in a representation will not be deleted. +The semantic elements visible in a representation won't be deleted. ==== === From the {explorer} @@ -52,7 +52,7 @@ image::hands-on-delete-representation-from-representation-view.png[Delete repres A confirmation dialog appears when a representation is deleted. -This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. +This behavior can be disabled by checking the "Disable this confirmation dialog" checkbox in the dialog. image::manage-elements-semantic-deletion.png[Semantic Deletion] @@ -87,7 +87,7 @@ This simplicity in sharing promotes efficient collaboration and simplifies the c To share a representation in {product}, follow these steps: . Open the a representation from the explorer. -. Click the `Share` button in the general tool bar at the top of the representation area. +. Click the `Share` button in the general toolbar at the top of the representation area. . Copy the link to your clipboard. image::hands-on-share-representation.png[Share representation] diff --git a/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc b/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc index 7a4fd0a..73ec78a 100644 --- a/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc @@ -17,12 +17,12 @@ A default `{gv}` representation associated with the package is opened in the mai . In the main editor area, click on the diagram background to open the {diag-toolbar}. . Click on the `New Part Definition` tool to create a new part definition. - ++ [NOTE] ==== The new elements created from the {diag-toolbar} are visible either from the {explorer} or the {editor} main central area. ==== - ++ . Rename the part definition to `Vehicle` using the xref:hands-on/how-tos/model-management.adoc#representation[direct-edit action] or the xref:hands-on/how-tos/model-management.adoc#update-element#details[{details} view]. . Select the `Vehicle` part definition and click on the `New Item` tool to create an item usage. . Rename the item usage to `driver`. diff --git a/doc/content/modules/user-manual/pages/integration/developer-guide.adoc b/doc/content/modules/user-manual/pages/integration/developer-guide.adoc new file mode 100644 index 0000000..b40e152 --- /dev/null +++ b/doc/content/modules/user-manual/pages/integration/developer-guide.adoc @@ -0,0 +1,46 @@ += Developer guide + +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 + +{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} + +To get the source code, clone the repository using either SSH: + +[source, bash] +---- +git clone git@github.com:eclipse-syson/syson.git +---- + +or HTTPS: + +[source, bash] +---- +git clone https://github.com/eclipse-syson/syson.git +---- + +== 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 ++ +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_ + 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/user-manual/pages/integration/extend.adoc b/doc/content/modules/user-manual/pages/integration/extend.adoc new file mode 100644 index 0000000..dc7ef5e --- /dev/null +++ b/doc/content/modules/user-manual/pages/integration/extend.adoc @@ -0,0 +1,6 @@ += Customization and extensions + +{product} is extendable, making use of an open source low-code platform called {sw}. +The platform enables the contribution of new specific views and the specific methodologies implementation. +With {sw}, users can seamlessly extend {product}'s capability to meet their specific requirements, such as creating dedicated libraries or contributing specific metadata by adding new representations. +Extensibility is a key strength of {product}, offering organizations the potential to enhance their System Engineering `SE` processes within the tool, ensuring consistency in modeling practices throughout their SE practitioners. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/integration/interoperability.adoc b/doc/content/modules/user-manual/pages/integration/interoperability.adoc index 5473a1b..e0c9120 100644 --- a/doc/content/modules/user-manual/pages/integration/interoperability.adoc +++ b/doc/content/modules/user-manual/pages/integration/interoperability.adoc @@ -26,7 +26,7 @@ In essence, {product} stands as an open source enabler, promoting collaboration, {product} extends its utility by introducing the capability to import and export projects in JSON format. This feature enhances interoperability, allowing users to seamlessly exchange project data and collaborate with external tools or platforms. -WARNING: {product} does not support the {sysmlv2} Standard JSON format for import/export. +WARNING: {product} doesn't support the {sysmlv2} Standard JSON format for import/export. For detailed instructions on xref:hands-on/how-tos/project-management.adoc#download-project[downloading projects], xref:hands-on/how-tos/model-management.adoc#download-model[downloading models], xref:hands-on/how-tos/project-management.adoc#upload-project[uploading projects], and xref:hands-on/how-tos/model-management.adoc#upload-model[uploading models], please refer to the respective sections in the documentation. These sections provide step-by-step guidance on how to perform these actions within the {product} environment. diff --git a/doc/content/modules/user-manual/pages/key-features.adoc b/doc/content/modules/user-manual/pages/key-features.adoc index 768aee3..c9c62a3 100644 --- a/doc/content/modules/user-manual/pages/key-features.adoc +++ b/doc/content/modules/user-manual/pages/key-features.adoc @@ -15,115 +15,95 @@ This dual categorization allows users to choose features based on their comfort == Features Overview -[cols="4*^",width="100%"] +[cols="3*^",width="100%"] |=== -| Feature| {sysmlv2} Standard| Open source ({product})|Enterprise Add-ons ({ocp}) +| Feature| Open source ({product})|Enterprise Add-ons ({ocp}) -4+h|Projects Management +3+h|Projects Management |xref:features/homepage.adoc[Projects Browser] -a|icon:times[role=Red] a|icon:check[role=Green] a|icon:check[role=Green] |xref:features/editor.adoc[Project Editor] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:features/editor.adoc#project-actions[Manage Project] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:user-manual:support.adoc[Teams] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] -4+h|{sysmlv2} Views +3+h|{sysmlv2} Views |xref:user-manual:features/general-view.adoc[{gv}] -a|icon:check[role=green] a|icon:check[role=gray] partial a|icon:check[role=gray] partial |xref:user-manual:features/interconnection-view.adoc[{iv}] -a|icon:check[role=green] a|icon:check[role=gray] partial a|icon:check[role=gray] partial |xref:user-manual:features/sysmlv2-overview.adoc[{afv}] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[{stv}] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Sequence View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Geometry View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Grid View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Browser View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] -4+h|Collaboration & Interoperability +3+h|Collaboration & Interoperability |xref:features/collaboration.adoc[Share Projects] -a|icon:times[role=red] a|icon:times[role=gray] (All the projects are Public) a|icon:times[role=gray] (All the projects are Public) |xref:features/collaboration.adoc[Share Diagram] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:integration/interoperability.adoc[Download / Upload JSON format] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:integration/interoperability.adoc[Download / Upload Standard {sysmlv2} JSON format] a|icon:times[role=red] a|icon:times[role=red] -a|icon:times[role=red] |xref:integration/interoperability.adoc[Download / Upload {sysmlv2} textual format] -a|icon:times[role=green] a|icon:check[role=gray] Experimental a|icon:check[role=gray] Experimental |xref:user-manual:support.adoc[Live Collaboration] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] -4+h|Advanced +3+h|Advanced |xref:user-manual:support.adoc[Authentication (SSO, LDAP, AD)] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] |xref:user-manual:support.adoc[Accounts Administration] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] |=== 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 24aa5a6..313d15b 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 @@ -62,8 +62,8 @@ image::release-notes-feature-typing-tool.png[Feature typing tool] == New features -- A new filter `Hide Memberships` has been added in Explorer view tool bar to hide membership elements in the Explorer view. -- A new filter `Hide KerML Standard Libraries` has been added in Explorer view tool bar to hide KerML/SysML libraries in the Explorer view. +- A new filter `Hide Memberships` has been added in Explorer view toolbar to hide membership elements in the Explorer view. +- A new filter `Hide KerML Standard Libraries` has been added in Explorer view toolbar to hide KerML/SysML libraries in the Explorer view. image::release-notes-filters.png[Explorer filters] - `{afv}` diagrams are now available on Package elements. 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 0038222..c2fff6a 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 @@ -3,13 +3,14 @@ == Breaking changes - The `requirement-view` diagram has been introduced by error in the last release. -This diagram is not defined in the SysMLv2 specification. +This diagram isn't defined in the SysMLv2 specification. It has been deleted in this release. == Dependencies update -- Switch to https://github.com/eclipse-sirius/sirius-web/releases/tag/v2024.3.3[Sirius Web v2024.3.3] +- Switch to https://github.com/eclipse-sirius/sirius-web/releases/tag/v2024.5.0[Sirius Web v2024.5.0] - Switch to @ObeoNetwork/gantt-task-react 0.4.9 +- Add dependency to org.apache.commons.commons-text 1.10.0 == Bug fixes @@ -19,31 +20,45 @@ It has been deleted in this release. image::release-notes-attribut-compartmen-interconnection-view.png[Attribute compartment from {iv}] - No error is raised anymore when setting a valid new value (with primitive type) in the Details view. -- The body feature of a `Comment` remove now the "/*" and "*/" characters while importing a model from Sysml textual format. +- The body feature of a `Comment` remove now the "/\*" and "*/" characters while importing a model from Sysml textual format. - All `Memberships` are now contained in their parent through `ownedRelatedElement` instead of `ownedRelationship` reference. - Rename action from explorer is now renaming tree items as expected. - `EnumerationDefinition` is now created with a default name. image::release-notes-enumeration-definition.png[Enumeration definition node] -== Improvements +- "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). -- "Become nested" edge creation tools has been added for `AttributeUsage`, `ItemUsage`, `PartUsage` and `PortUsage` nodes. +image::release-notes-hide-capabilities.png[Restore and Improve hide capabilities] -image::release-notes-become-nested-attribute.png[Become nested attribute edge tool] +- `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. -- Composite usages are now forbidden inside `PortDefinition`/`PortUsage`. -- Composite usages are now forbidden inside `AttributeDefinition`/`AttributeUsage`. -- TODO https://github.com/eclipse-syson/syson/issues/154[#154] [diagrams] Add missing node tools inside existing usage 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-ends-compartment-AllocationDefinition.png[Ends compartment from AllocationDefinition] -image::release-notes-nested-composite-edge.png[Nested composite edge] +- Circular containment of nested parts including self containment are now forbidden. -- `OccurrenceDefinition` and `OccurrenceUsage` elements are now handled in General View diagram. +image::release-notes-avoid-nestedPart-cycle.png[Avoid nested part cycle] -image::release-notes-handle-occurence.png[Handle occurrence elements] +- 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. -- Explicit usage of node to call syside javascript file has been added. +image::release-notes-state-transition-cpt.png[State transition compatment] + +- Inherited features in compartments don't display itself anymore. + +image::release-notes-inherited-feature-cpt.png[Inherited features in compartments] + +- `Add existing element (recursive)` behavior has been modified to be more robust and avoid potential exception, mainly the display of nested domain-based edge on State transition view diagram. + +== Improvements + +- 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. - `Membership`#visibility attribute has been added to Core properties in the Details view. @@ -53,17 +68,8 @@ image::release-notes-membership-visibility.png[Membership visibility in Details image::release-notes-port-direction.png[Port direction in Details view] -- `UseCaseDefinition` and `UseCaseUsage` elements are now handled in General View diagram. - -image::release-notes-handle-usecase.png[Handle usecase elements] - -- Reconnection tools have been added for composition edges. - `Definition`/`Usage` node are now collapsed by default in general-view & actionflow-view diagrams. - `Definition`/`Usage` nodes are expanded in all diagrams when a compartment item is created. -- `AllocationDefinition` and `AllocationUsage` elements are now handled in General View diagram. - -image::release-notes-handle-allocation.png[Handle allocation elements] - - All elements are now represented with their icon. - Label is now positioned from inside to outside for `Ports` (Border Nodes). @@ -71,12 +77,76 @@ image::release-notes-port-label.png[Port label] - General-view 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. + +image::release-notes-action-in-compartment.png[Action in compartment] + +- Remove button is now available on containment edges. + +image::release-notes-delete-containment-edge.png[Remove containment edge] + +- "Add existing elements" tools have been added on State & StateDefinition graphical elements. + +image::release-notes-add-existing-element-on-state.png[Add existing elements on state] + == New features - Compartments of `RequirementDefinition` and `RequirementUsage` have been redesigned to better fit the specification and examples. image::release-notes-requirements.png[Requirements] +- "Become nested" edge creation tools has been added for `AttributeUsage`, `ItemUsage`, `PartUsage` and `PortUsage` nodes. + +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. + +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. + +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. + +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. -- `ConjugatedPortDefinition` is now handled in diagrams, Explorer and Details View. \ No newline at end of file +- `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] + +- `State Transition view` 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. + +image::release-notes-accept-action.png[Accept action usage] + +- `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). + +image::release-notes-succession-edge.png[Succession] + diff --git a/doc/content/modules/user-manual/pages/tour.adoc b/doc/content/modules/user-manual/pages/tour.adoc index 90e60d2..6eaf8e0 100644 --- a/doc/content/modules/user-manual/pages/tour.adoc +++ b/doc/content/modules/user-manual/pages/tour.adoc @@ -2,24 +2,13 @@ Embark on a comprehensive exploration of {product}'s interface as we guide you through the key features and functionalities. -//TODO Navigate the models in the left sidebar -//TODO Explore the details view in the right side bar -//TODO Explore the diagram -//TODO Access modeling tools from the toolbar - [cols="2*^", %noheader, frame=none, grid=none] |=== a|image::homepage.png[xref=user-manual:features/homepage.adoc] -**{homepage}** - -Manage projects. - -xref:user-manual:features/homepage.adoc[Explore the {homepage}...] a|image::editor.png[xref=user-manual:features/editor.adoc] - -**{editor}** +xref:user-manual:features/homepage.adoc[Explore the {homepage}...] -Edit models. +a|image::editor.png[xref=user-manual:features/editor.adoc] xref:user-manual:features/editor.adoc[Explore the {editor}...] |=== \ 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 6591e35..90a7ad0 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,2 @@ 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 should not be used in production. \ No newline at end of file +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 diff --git a/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc b/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc index 5633ac2..9a07e1b 100644 --- a/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc +++ b/doc/content/modules/user-manual/partials/manage-elements-diagram.adoc @@ -2,25 +2,25 @@ === Create element -User can create element **from the background** of the diagram from a simple click that displays tool bar. -In this tool bar, element creation tool are grouped by type in tool section according to their type. -User can expand the tool section and then he can click on the desired creation tool +User can create element **from the background** of the diagram from a simple click that displays toolbar. +In this toolbar, element creation tool are grouped by type in tool section according to their type. +User can expand the tool section and then user can click on the desired creation tool image::manage-elements-fromBackground-creation.png[Creation from Diagram Background] User can also create element **in other element**. -User just clicks on the element to display the tool bar and then click on the desired creation tool. +User just clicks on the element to display the toolbar and then click on the desired creation tool. image::manage-elements-fromElement-creation.png[Creation from Diagram Element] All created element are collapsed by default, it means that if a node with compartment is created, compartment are hidden. -If node contains **compartment**, user can add element in the desired compartment by clicking in the compartment and display the tool bar. +If node contains **compartment**, user can add element in the desired compartment by clicking in the compartment and display the toolbar. image::manage-elements-fromCompartment-creation.png[Creation from Compartment] An other way is to click on the parent node header of the compartment. -A tool bar will be display and the user can click on the desired creation tool, new element will be created in the appropriate compartment. +A toolbar will be display and the user can click on the desired creation tool, new element will be created in the appropriate compartment. image::manage-elements-fromParentCompartment-creation.png[Creation from Parent Compartment] @@ -36,7 +36,7 @@ User can also remove element from model (and so from diagram) by clicking on _De image::manage-elements-delete-from-model.png[Delete from model] A confirmation dialog appears when an element is deleted via the _Delete from model_ tool in the palette or via the Model Explorer. -This behavior can be disabled by checking the "Disable this confirmation dialog" check box in the dialog. +This behavior can be disabled by checking the "Disable this confirmation dialog" checkbox in the dialog. image::manage-elements-semantic-deletion.png[Semantic Deletion] diff --git a/doc/content/modules/user-manual/partials/manage-existing-elements.adoc b/doc/content/modules/user-manual/partials/manage-existing-elements.adoc index 45b1ac5..2356ab9 100644 --- a/doc/content/modules/user-manual/partials/manage-existing-elements.adoc +++ b/doc/content/modules/user-manual/partials/manage-existing-elements.adoc @@ -1,6 +1,6 @@ == Manage existing elements -From the diagram background or from a given node, it is possible to display all exisiting elements contained by the initial selection. +From the diagram background or from a given node, it's possible to display all exisiting elements contained by the initial selection. User just need to display the palette and unfold _Existing elements_ section. image::manage-exisiting-elements-add.png[Add exisiting elements] diff --git a/doc/content/modules/user-manual/partials/manage-group-elements.adoc b/doc/content/modules/user-manual/partials/manage-group-elements.adoc index 37d875d..3288ced 100644 --- a/doc/content/modules/user-manual/partials/manage-group-elements.adoc +++ b/doc/content/modules/user-manual/partials/manage-group-elements.adoc @@ -2,11 +2,11 @@ When user select multiple elements, many actions are available to manage all selected element. -=== From tool bar +=== From toolbar -After user selected some elements, a simplified tool bar is displayed. +After user selected some elements, a simplified toolbar is displayed. -image::manage-group-element-toolbar.png[Group element tool bar] +image::manage-group-element-toolbar.png[Group element toolbar] User can still used basic tools such as : @@ -14,7 +14,7 @@ User can still used basic tools such as : * Fade elements, * Pin elements. -A new tool section appears in this tool bar. +A new tool section appears in this toolbar. Many tools acting on selected elements layout can be found in this tool section : * Align left, @@ -34,7 +34,7 @@ Many tools acting on selected elements layout can be found in this tool section === From mouse and shortcuts -In addition to tool bar actions, some actions can be execute with shortcuts. +In addition to toolbar actions, some actions can be execute with shortcuts. Indeed, after user selected some elements, user can press the key "Del" to remove all selected elements. diff --git a/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc b/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc index 5e4e976..01fbd3e 100644 --- a/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc +++ b/doc/content/modules/user-manual/partials/manage-labels-diagram.adoc @@ -40,11 +40,11 @@ Element labels can be edited in the following ways: * Press F2, * Type directly the new name. -With direct edit, user cannot change the keyword but he can change the name. +With direct edit, user can't change the keyword but user can change the name. If it's a simple label, he can rename the element. If user modify the multiplicity defined in the label then the multiplicity of the relationship is changed in the model. User can alos set/change the specialization of a given element. Explore further by referring to the following how-tos for xref:hands-on/how-tos/model-management.adoc#direct-edit[direct edit action] -Label of edges and compartments node cannot be edited. \ No newline at end of file +Label of edges and compartments node can't be edited. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc b/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc index 805bd1f..863b0ff 100644 --- a/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc +++ b/doc/content/modules/user-manual/partials/manage-relationships-diagram.adoc @@ -6,17 +6,17 @@ Relationship Edges can be created between Nodes whose types match the Edge’s s If no edge creation is authorized with a given target, the target node appears faded. -When user try to create an edge, he clicks first on the source element to display arrow border. +When user try to create an edge, user clicks first on the source element to display arrow border. image::manage-relationships-createEdge-arrow.png[Arrow to create Edge] -Then he clicks on one of these arrows and stay click until the target. +Then user clicks on one of these arrows and stay click until the target. User can see the feedback of the edge and the target node is highlighted. image::manage-relationships-createEdge-feedback.png[Feedback to create Edge] -After releasing the click, a popup appears and displays all possible kind of edge to create. -If only one kind of edge is possible, the edge is directly create without opening the popup. +After releasing the click, a pop-up appears and displays all possible kind of edge to create. +If only one kind of edge is possible, the edge is directly create without opening the pop-up. image::manage-relationships-createEdge-popup.png[Popup to create Edge] @@ -26,13 +26,13 @@ it's not possible for now to create an Edge between two Edges or between an Edge Users can reconnect Edges by clicking on the source or target end of the Edge to reconnect, and drag and drop it on a new element. -If the new source or the new target is not allowed for reconnection, these one will be faded. +If the new source or the new target isn't allowed for reconnection, these one will be faded. === Delete relationship To delete relationship from model, user should click on the edge and click on the delete button. -Remember that relationship edge are always synchronized, it is not possible to only delete relationship edge from diagram. +Remember that relationship edge are always synchronized, it's not possible to only delete relationship edge from diagram. -Containment relationShip is not deletable from the diagram. +Containment relationShip isn't deletable from the diagram. Other relationship can be deletable from the diagram. \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/nav-features.adoc b/doc/content/modules/user-manual/partials/nav-features.adoc index 46149b9..d80d840 100644 --- a/doc/content/modules/user-manual/partials/nav-features.adoc +++ b/doc/content/modules/user-manual/partials/nav-features.adoc @@ -1,4 +1,6 @@ // Reference all the files defined in the features folder +* xref:user-manual:key-features.adoc[] + * xref:user-manual:features/sysmlv2-overview.adoc[] * xref:user-manual:concepts.adoc[] diff --git a/doc/content/modules/user-manual/partials/nav-integration.adoc b/doc/content/modules/user-manual/partials/nav-integration.adoc index 91d0f86..67999b0 100644 --- a/doc/content/modules/user-manual/partials/nav-integration.adoc +++ b/doc/content/modules/user-manual/partials/nav-integration.adoc @@ -1,4 +1,5 @@ -* xref:user-manual:features/collaboration.adoc[] +* xref:user-manual:integration/developer-guide.adoc[] +* xref:user-manual:integration/extend.adoc[] * xref:user-manual:integration/interoperability.adoc[] * xref:user-manual:integration/capella.adoc[] * xref:user-manual:integration/api.adoc[] \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/nav-ui.adoc b/doc/content/modules/user-manual/partials/nav-ui.adoc index 342a692..2d66de4 100644 --- a/doc/content/modules/user-manual/partials/nav-ui.adoc +++ b/doc/content/modules/user-manual/partials/nav-ui.adoc @@ -1,2 +1,11 @@ * xref:user-manual:tour.adoc[] -* xref:user-manual:hands-on/hands-on.adoc[] \ No newline at end of file +* xref:user-manual:hands-on/hands-on.adoc[] +** How-Tos +*** xref:user-manual:hands-on/how-tos/project-management.adoc[] +*** xref:user-manual:hands-on/how-tos/model-management.adoc[] +*** xref:user-manual:hands-on/how-tos/representation-operations.adoc[] +*** xref:user-manual:hands-on/how-tos/user-interface-navigation.adoc[] +*** xref:user-manual:hands-on/how-tos/explorer.adoc[] +*** xref:user-manual:hands-on/how-tos/representations-view.adoc[] +** xref:user-manual:hands-on/tutorials/tutorials.adoc[] +*** xref:user-manual:hands-on/tutorials/batmobile.adoc[] \ No newline at end of file diff --git a/doc/content/modules/user-manual/partials/view-unsynchronized.adoc b/doc/content/modules/user-manual/partials/view-unsynchronized.adoc index 02cfbbb..fb84dbf 100644 --- a/doc/content/modules/user-manual/partials/view-unsynchronized.adoc +++ b/doc/content/modules/user-manual/partials/view-unsynchronized.adoc @@ -2,5 +2,5 @@ ==== This view in {product} is implemented as an *unsynchronized* diagram. This means that users need to manually add existing elements to the diagram to visualize them. -It does not display all the information stored in the model by default. +It doesn't display all the information stored in the model by default. ==== \ No newline at end of file