Miscellaneous documentation fixes from review

pmai · pmai · commit f25d24c83f7e · 2025-06-30T14:01:41.000+02:00
Signed-off-by: Pierre R. Mai &lt;pmai@pmsf.de&gt;
diff --git a/specification/5___stc.adoc b/specification/5___stc.adoc
@@ -412,7 +412,7 @@ The ParticleType element is structured by the following subordinated elements.
 The ParticleType element is associated with the following attributes.
 
 [#tb-particletypeattributes]
-.ParticleType aelement ttributes
+.ParticleType element attributes
 [width="100%",options="header"]
 |===
 | Attribute name | Optional / Mandatory | Attribute description
diff --git a/specification/6___dtmd.adoc b/specification/6___dtmd.adoc
@@ -87,7 +87,7 @@ The AnalysisPhase element is associated with the following attributes.
 .AnalysisPhase element attributes
 [width="100%",options="header"]
 |===
-| Attribute name | Optional / Mandatory | Attribut description
+| Attribute name | Optional / Mandatory | Attribute description
 | id             | Optional             | This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
 | description    | Optional             | This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.
 |===
@@ -123,7 +123,7 @@ The DefinitionPhase element is associated with the following attributes.
 .DefinitionPhase element attributes
 [width="100%",options="header"]
 |===
-| Attribute name | Optional / Mandatory | Attribut description
+| Attribute name | Optional / Mandatory | Attribute description
 | id             | Optional             | This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
 | description    | Optional             | This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.
 |===
@@ -201,7 +201,7 @@ The EvaluationPhase element is associated with the following attributes.
 
 In the fulfillment phase, it is checked and decided whether the entire decision task, including all sub-tasks performed, fulfills the requirements placed on the decision task by the commissioning higher-level processes.
 
-The FulfillmentPhasePhase element documents all relevant information.
+The FulfillmentPhase element documents all relevant information.
 
 [#im-dtmdfulfillmentphaseschema]
 .FulfillmentPhase elements structure and attributes
diff --git a/specification/7___stmd.adoc b/specification/7___stmd.adoc
@@ -89,7 +89,7 @@ The AnalysisPhase element is associated with the following attributes.
 .AnalysisPhase element attributes
 [width="100%",options="header"]
 |===
-| Attribute name | Optional / Mandatory | Attribut description
+| Attribute name | Optional / Mandatory | Attribute description
 | id             | Optional             | This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
 | description    | Optional             | This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.
 |===
@@ -106,7 +106,7 @@ The RequirementsPhase element documents all relevant information.
 .RequirementsPhase element structure and attributes
 image::RequirementsPhaseSchema.png[]
 
-The RequirememtsPhase element is structured by the followuing subordinated element.
+The RequirementsPhase element is structured by the followuing subordinated element.
 
 [#tb-requirementsphasesubelements]
 .RequirementsPhase element structure
@@ -154,7 +154,7 @@ The DesignPhase element is structured by the following subordinated element.
 |===
 | Sub element name                               | Optional / Mandatory | Details
 | DefineModelDesignSpecification                 | Optional             | <<sec-steptype>>
-| DefineParaneterDesignSpecification             | Optional             | <<sec-steptype>>
+| DefineParameterDesignSpecification             | Optional             | <<sec-steptype>>
 | DefineSimulationEnvironmentDesignSpecification | Optional             | <<sec-steptype>>
 | DefineSimulationIntegrationDesignSpecification | Optional             | <<sec-steptype>>
 | DefineTestCaseDesignSpecification              | Optional             | <<sec-steptype>>
@@ -290,7 +290,7 @@ The EvaluationPhase element is associated with the following attributes.
 
 In the fulfillment phase, it is checked and decided whether the entire simulation task, including the simulation results, fulfills the requirements placed on the simulation by the commissioning higher-level engineering task and whether the simulation tasks can be completed.
 
-The FulfillmentPhasePhase element documents all relevant information.
+The FulfillmentPhase element documents all relevant information.
 
 [#im-fulfillmentphaseschema]
 .FulfillmentPhase elements structure and attributes
diff --git a/specification/8___srmd.adoc b/specification/8___srmd.adoc
@@ -3,7 +3,7 @@
 
 Simulation resource meta data for components or other resources (e.g. parameter sets, etc.) can be provided using SRMD files. These files can be embedded into such resources, where possible, they can be placed outside the resources and reference the resources to which they apply, or they can be tied to the resources through the STMD meta-data mechanisms.
 
-=== SimulationRessourceMetaData
+=== SimulationResourceMetaData
 
 The SimulationResourceMetaData element is the all enclosing top level XML element of SRMD files.
 
@@ -14,13 +14,17 @@ image::SimulationResourceMetaDataSchema.png[]
 The SimulationTaskMetaData element is structured by following subordinated element.
 
 [#tb-simulationresourcemetadatasubelements]
-.SimulationResourcekMetaData element structure
+.SimulationResourceMetaData element structure
 [width="100%",options="header"]
 |===
 | Sub element name    | Optional / Mandatory | Details
-| GElementCommon      | Mandatory            | <<sec-gphasecommon>>
+| GElementCommon      | Mandatory            | <<sec-gelementcommon>>
 |===
 
+More specifically, the Classification and Annotation sub-elements of the SimulationResourceMetaData element, as specified in <<sec-gelementcommon>> apply classifications and further information to the resource that is being described by the SRMD file.
+
+Other than the referent, the usual rules for these elements apply.
+
 The SimulationResourceMetaData element is associated with the following attributes.
 
 [#tb-simulationresourcemetadataattributes]
diff --git a/specification/9___packaging.adoc b/specification/9___packaging.adoc
@@ -9,37 +9,78 @@ and other resources using the SSP packaging format.
 
 === Introduction
 
-The current standard specifies the packaging of simulation task
-meta-data files together with all referenced system descriptions,
+The current standard specifies the packaging of simulation or decision
+task meta-data files together with all referenced system descriptions,
 models, parameters, their meta-data, simulation results and other
 resources in SSP 2.0 package files as a layered standard based on SSP
 2.0.
 
 By basing the packaging on the SSP standard, it is possible to treat
-STMD containing SSP packages as normal SSP packages for use in tools
-that do not yet support STMD-based work flows. Furthermore this
-approach simplifies the definition of STMD-based packages by reusing
+DTMD/STMD containing SSP packages as normal SSP packages for use in tools
+that do not yet support DTMD/STMD-based work flows. Furthermore this
+approach simplifies the definition of DTMD/STMD-based packages by reusing
 the built-in functionality of the SSP standard.
 
 === SSP 2.0
 
-Any STMD-based package MUST be a valid _SSP 2.0_ <<SSP20>> or _SSP 1.0_ <<SSP10>> SSP archive.
+Any DTMD/STMD-based package MUST be a valid _SSP 2.0_ <<SSP20>> or
+_SSP 1.0_ <<SSP10>> SSP archive.
 Inter alia this means that it MUST contain at least one SSD file named
 `SystemStructure.ssd` in the root of the archive, which MUST be a valid
-system structure description file. In phases of the simulation task
-workflow where a proper system structure description has not yet been
+system structure description file. In phases of the decision or simulation
+task workflow where a proper system structure description has not yet been
 created, this CAN be a dummy file containing an otherwise empty system.
-Those cases will be recognizable by the content of the STMD file.
+Those cases will be recognizable by the content of the DTMD/STMD file.
+
+=== DTMD File
+
+Any DTMD-based package MUST include an DTMD XML file under the `extra/org.ssp-standard.ssp-traceability.stmd/DecisionTask.dtmd` name.
+The file MUST be a valid DTMD file according to the specification below.
+
+A Decision Task Meta Data file (DTMD, file extension .stmd, MIME type
+`application/x-dtmd-decisiontask`) MUST be a well-formed XML 1.0
+[XML10] file that conforms to the DTMD.xsd XML Schema distributed as
+part of this standard.  The file MUST use the UTF-8 encoding.
+
+All DTMD-specific elements live in the `\http://ssp-standard.org/SSPTraceability1/DecisionTaskMetaData` namespace, nicknamed `dtmd` in this document.
+
+The root element of an DTMD file MUST be a `DecisionTaskMetaData`
+element, which gives overall information about the decision task
+described in this DTMD file.
+
+The DTMD file CAN reference any system structure descriptions that the
+simulation task is intended to use through `Resource` elements with the
+attribute `source` providing the URI to the SSD file. The relative URI
+resolution mechanisms are the same as for SSP generally, so that the
+URI will be resolved against the URI of the DTMD file as a base URI.
+
+Hence a reference to the main SSD of an SSP package will be specified
+as
+
+`<stmd:Resource source="../../SystemStructure.ssd" type="application/x-ssp-definition" kind="system"/>`
+
+due to the relative location of the DTMD file.
+
+Simulation model meta data and parameter meta data is referenced inside
+the DTMD file using either `Resource` records directly if the meta data
+is directly relevant, or through `MetaData` elements inside `Resource`
+elements if the meta data is only used in a meta data role.
+
+If meta data is intended to be carried in the purely SSP subset of the
+SSP package, then the following sections apply.
+
+The MIME type of STMD files is `application/x-dtmd-decisiontask`, the
+file name extension is `.stmd`.
 
 === STMD File
 
 Any STMD-based package MUST include an STMD XML file under the `extra/org.ssp-standard.ssp-traceability.stmd/SimulationTask.stmd` name.
 The file MUST be a valid STMD file according to the specification below.
 
-A Simulation Task Meta Data file (STMD, file extension .stmd) MUST be a
-well-formed XML 1.0 [XML10] file that conforms to the SimulationTask XML
-Schema distributed as part of this standard.  The file MUST use the
-UTF-8 encoding.
+A Simulation Task Meta Data file (STMD, file extension .stmd, MIME type
+`application/x-stmd-simulationtask`) MUST be a well-formed XML 1.0
+[XML10] file that conforms to the STMD.xsd XML Schema distributed as
+part of this standard.  The file MUST use the UTF-8 encoding.
 
 All STMD-specific elements live in the `\http://ssp-standard.org/SSPTraceability1/SimulationTaskMetaData` namespace, nicknamed `stmd` in this document.
 
