Skip to content

Commit 064bc1f

Browse files
NikolaiFaNikolaiFa
authored andcommitted
Add links to literature
1 parent 0670326 commit 064bc1f

File tree

10 files changed

+14
-14
lines changed

10 files changed

+14
-14
lines changed

docs/0___preamble.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,5 @@ The standard is comprised of a set of XML-based formats to describe a network of
8080

8181
*Conventions used in this Document*
8282

83-
* The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in RFC 2119 [RFC2119].
83+
* The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in RFC 2119 [<<RFC2119>>].
8484
* Non-normative text is given in square brackets in italic font: [ _especially examples are defined in this style._ ].

docs/1___overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ SSP is a tool-independent format for the description, packaging and exchange of
44
The standard is comprised of a set of XML-based formats to describe a network of component models with their signal flow and parameterization, as well as a ZIP-based packaging format for efficient distribution of entire systems, including any referenced models and other resources.
55
This description is tool neutral and is intended to be used primarily as an exchange format of simulation system descriptions between different tools.
66

7-
SSP can be seen as an extension to the FMI (Functional Mockup Interface) standard [FMI30].
7+
SSP can be seen as an extension to the FMI (Functional Mockup Interface) standard [<<FMI30>>].
88
FMI describes a tool independent standard to exchange single simulation models.
99
Using SSP, complete systems consisting of multiple interconnected simulation models can be defined with the desired signal flow and also with the wanted parameterization of each single model as well as the parameters for the complete system.
1010
This system topology can include hierarchies of sub-systems for proper structuring of the overall system.

docs/2___common_concepts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ In this fashion extension of SSP to support pre-existing, new or domain-specific
3939

4040
=== Versioning and Layered Standards
4141

42-
The SSP standard uses semantic version numbers, as defined in [SV200], where the standard version consists of a triple of version numbers, consisting of major version, minor version, and patch version numbers [ _e.g. 1.2.3 for major version 1, minor version 2 and patch version 3_ ].
42+
The SSP standard uses semantic version numbers, as defined in [<<SV200>>], where the standard version consists of a triple of version numbers, consisting of major version, minor version, and patch version numbers [ _e.g. 1.2.3 for major version 1, minor version 2 and patch version 3_ ].
4343

4444
* Major versions will introduce changes that are neither backward nor forward-compatible, including changes to the XML schemas to include new non-ignorable content.
4545
* Minor versions will only contain clarifications and include new layered standards, which may add new ignorable XML content, as defined below, into the core standard document, indicating that the standard needs to be supported by all conforming implementations.

docs/3___packaging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
System Structure Package (file extension .ssp) files are specified to allow the packaging of System Structure Description (`*.ssd`) files together with related resources, like referenced FMUs, parameter files, etc.
44

5-
System Structure Package files *MUST* be valid ZIP archives as specified in [ZIP635] with the following restrictions:
5+
System Structure Package files *MUST* be valid ZIP archives as specified in [<<ZIP635>>] with the following restrictions:
66

77
* All file entries *MUST* use either compression method 0 (stored) or 8 (deflated).
88
* Encryption *MUST NOT* be used.

docs/4___common_content.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The following XML child elements are specified for the Unit element:
136136
===== BaseUnit
137137

138138
This element defines the base unit of the given unit in SI units.
139-
This is completely aligned with the specification of base units in section 2.4.3 of the FMI 3.0 standard [FMI30] and section 2.2.2 of the FMI 2.0 standard [FMI20].
139+
This is completely aligned with the specification of base units in section 2.4.3 of the FMI 3.0 standard [<<FMI30>>] and section 2.2.2 of the FMI 2.0 standard [<<FMI20>>].
140140

141141
image:images/image10.png[image,width=263,height=771]
142142

@@ -325,7 +325,7 @@ The name *MUST* match the name of an Enumeration entry in the Enumerations XML e
325325

326326
image:images/image17.png[image,width=319,height=114]
327327

328-
This type specifies that the connector in question represents a length-terminated binary data type, like the binary type defined for the FMI 3.0 standard, or substitute types like the binary type defined via the OSI Sensor Model Packaging specification [OSMP150].
328+
This type specifies that the connector in question represents a length-terminated binary data type, like the binary type defined for the FMI 3.0 standard, or substitute types like the binary type defined via the OSI Sensor Model Packaging specification [<<OSMP150>>].
329329

330330
[width="100%",cols="28%,72%",options="header",]
331331
|===

docs/5___ssd.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A System Structure Description describes a nested hierarchy of interconnected (sub-)systems and atomic components.
44

5-
A System Structure Description file (SSD, file extension .ssd) *MUST* be a well-formed XML 1.0 [XML10] file that conforms to the SystemStructureDescription XML Schema distributed as part of this standard.
5+
A System Structure Description file (SSD, file extension .ssd) *MUST* be a well-formed XML 1.0 [<<XML10>>] file that conforms to the SystemStructureDescription XML Schema distributed as part of this standard.
66
The file *MUST* use the UTF-8 encoding.
77
All SSD-specific elements live in the `http://ssp-standard.org/SSP1/SystemStructureDescription` namespace, nicknamed `ssd`.
88

docs/6___ssv.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The XML element can be inlined with its parent element or referenced from the pa
55

66
For information on hierarchical naming structure and precedence rules, see <<ParameterBindings>>.
77

8-
An SSV file *MUST* be a well-formed XML 1.0 [XML10] file that conforms to the SystemStructureParameterValues XML Schema that is distributed as part of this standard.
8+
An SSV file *MUST* be a well-formed XML 1.0 [<<XML10>>] file that conforms to the SystemStructureParameterValues XML Schema that is distributed as part of this standard.
99
The file *MUST* use the UTF-8 encoding.
1010
All SSV-specific elements live in the `http://ssp-standard.org/SSP1/SystemStructureParameterValues` namespace, nicknamed `ssv`.
1111

docs/7___ssm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It can also optionally provide for transformations that are to be applied on the
66

77
A parameter mapping can be provided either as a stand-alone XML file (an SSM file), which can be referenced from SSD files, or it can be embedded in an ssd:ParameterMapping element of the SSD directly (see <<ParameterMapping>>).
88

9-
An SSM file *MUST* be a well-formed XML 1.0 [XML10] file that conforms to the SystemStructureParameterMapping XML Schema that is distributed as part of this standard.
9+
An SSM file *MUST* be a well-formed XML 1.0 [<<XML10>>] file that conforms to the SystemStructureParameterMapping XML Schema that is distributed as part of this standard.
1010
The file *MUST* use the UTF-8 encoding.
1111
All SSM-specific elements live in the `http://ssp-standard.org/SSP1/SystemStructureParameterMapping` namespace, nicknamed `ssm`.
1212

docs/8___ssb.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A signal dictionary is a collection of signals defined through its DictionaryEnt
44

55
A signal dictionary can be provided either as a stand-alone XML file (an SSB file), which can be referenced from SSD files, or it can be embedded in an ssd:SignalDictionary element of the SSD directly (see <<SignalDictionaries>>).
66

7-
An SSB file *MUST* be a well-formed XML 1.0 [XML10] file that conforms to the SystemStructureSignalDictionary XML Schema that is distributed as part of this standard.
7+
An SSB file *MUST* be a well-formed XML 1.0 [<<XML10>>] file that conforms to the SystemStructureSignalDictionary XML Schema that is distributed as part of this standard.
88
The file *MUST* use the UTF-8 encoding.
99
All SSB-specific elements live in the `http://ssp-standard.org/SSP1/SystemStructureSignalDictionary` namespace, nicknamed `ssb`.
1010

docs/A___literature.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ https://semver.org/spec/v2.0.0.html
1212
[XML10] World Wide Web Consortium: *Extensible Markup Language (XML) 1.0 (Fifth Edition).* W3C Recommendation. 2008. +
1313
http://www.w3.org/TR/2008/REC-xml-20081126/
1414

15-
[FMI20] Modelica Association: *Functional Mock-up Interface for Model Exchange and Co-Simulation, Version 2.0.4.* 2022. +
16-
https://github.com/modelica/fmi-standard/releases/download/v2.0.4/FMI-Specification-2.0.4.pdf
15+
[FMI20] Modelica Association: *Functional Mock-up Interface for Model Exchange and Co-Simulation, Version 2.0.5.* 2024. +
16+
https://github.com/modelica/fmi-standard/releases/download/v2.0.5/FMI-Specification-2.0.5.pdf
1717

18-
[FMI30] Modelica Association: *Functional Mock-up Interface Specification, Version 3.0.1.* 2023. +
19-
https://fmi-standard.org/docs/3.0.1/
18+
[FMI30] Modelica Association: *Functional Mock-up Interface Specification, Version 3.0.2.* 2024. +
19+
https://fmi-standard.org/docs/3.0.2/
2020

2121
[OSMP150] ASAM e.V.: *OSI Sensor Model Packaging Version 1.5.0.* 2024. +
2222
https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/releases/tag/v1.5.0

0 commit comments

Comments
 (0)