diff --git a/docs/examples/fmi_ls_ref_manifest_example.xml b/docs/examples/fmi_ls_ref_manifest_example.xml index db292e8..e11fcfc 100644 --- a/docs/examples/fmi_ls_ref_manifest_example.xml +++ b/docs/examples/fmi_ls_ref_manifest_example.xml @@ -7,7 +7,13 @@ fmi-ls:fmi-ls-version="1.0.0-alpha.1" fmi-ls:fmi-ls-description="Layered Standard providing information on related files included in an FMU."> - + + + + + + + diff --git a/docs/index.adoc b/docs/index.adoc index b1566d9..5e8d50d 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -103,6 +103,9 @@ Beside these attributes the root element `fmiReferences` contains the following |`` |Each element describes one additional related file present in the FMU archive. + +|`` +|Optional annotations as defined in the FMI standard. |==== An example of a manifest file for this layered standard is shown below: @@ -148,6 +151,18 @@ No base requirements on supported URI schemes are given in this layered standard |Brief description of the related file that is suitable for display to users. |==== +The `` element contains the following elements: + +.`` element details. +[[table-schema-fmi-ls-ref-related-elements]] +[cols="1,3"] +|==== +|Element |Description + +|`` +|Optional annotations as defined in the FMI standard. +|==== + The `role` attribute is used to indicate the purpose of the related file. A role can consist of a main role and optionally one or more sub-roles, separated by a forward slash (`/`), that indicate more specific purposes of the related file. For example, the role `experiment/smoke-test` indicates that the related file is an experiment file that can be used to perform a smoke test validation of the FMU, while the role `experiment/validation` indicates that the related file is an experiment file that can be used to perform a detailed validation of the FMU. @@ -315,6 +330,9 @@ Beside these attributes the root element `` contains the following |`` |Each element describes one experiment setup. + +|`` +|Optional annotations as defined in the FMI standard. |==== An example of an experiments file for this layered standard is shown below: @@ -369,5 +387,8 @@ The `` element contains the following elements: |`` |Reference results for the experiment setup. + +|`` +|Optional annotations as defined in the FMI standard. |==== diff --git a/schema/fmi3LayeredStandardReferenceExperiments.xsd b/schema/fmi3LayeredStandardReferenceExperiments.xsd index 1df1d35..ba078e9 100644 --- a/schema/fmi3LayeredStandardReferenceExperiments.xsd +++ b/schema/fmi3LayeredStandardReferenceExperiments.xsd @@ -1,5 +1,6 @@ + Copyright(c) 2023-2025 Modelica Association Project "FMI". @@ -42,6 +43,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + @@ -51,6 +53,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + @@ -58,6 +61,9 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + @@ -80,6 +86,9 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + diff --git a/schema/fmi3LayeredStandardReferenceManifest.xsd b/schema/fmi3LayeredStandardReferenceManifest.xsd index ee81e6f..c9fbcaf 100644 --- a/schema/fmi3LayeredStandardReferenceManifest.xsd +++ b/schema/fmi3LayeredStandardReferenceManifest.xsd @@ -1,6 +1,7 @@ + Copyright(c) 2023-2025 Modelica Association Project "FMI". @@ -38,6 +39,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + @@ -46,6 +48,9 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +