-
Key: SYSML2-472
-
Status: closed
-
Source: Robert Bosch GmbH ( Florian Beer)
-
Summary:
Informal specification of requirements is realized as body of the documentation.
Informal requirement specification often contains text formatting and images as illustrations. To facilitate exchange of requirements between different organizations and proper rendering, the used formatting language, the relative root path for included images and their allowed formats have to be aligned.- add optional 'language' keyword to doc
- define the folder containing the sysml file as root for references made from documentation elements within this file
To provide guidance for users on common formatting
- reference jpg and png as suggested image formats
- reference markdown "md" or other low-complex language as suggested formatting language
example:
{ doc language="md" /* The imprint of the serial number shall be positioned as shown in the illustration  */ }
requirement def SomeRequirement -
Reported: SysML 2.0b1 — Mon, 2 Oct 2023 10:36 GMT
-
Disposition: Deferred — SysML 2.0b2
-
Disposition Summary:
Defer
This issue requests additional functionality in the language beyond what was included as submitted. As such, it is out of scope for an FTF, and it is deferred for possible consideration by a future RTF.
In addition, the comment and documentation syntax is adopted from KerML into SysML, so this issue needs to be considered by a KerML RTF before an update can be made to the SysML specification.
-
Updated: Tue, 1 Jul 2025 14:44 GMT
SYSML2 — Optional language for documentation
- Key: SYSML2-472
- OMG Task Force: Systems Modeling Language (SysML) 2.0 FTF