Template:InheritDCformat: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(changed capitalization)
(railML→{{rml}})
 
Line 11: Line 11:
|DCdescription = Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME].
|DCdescription = Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME].


|railSemantics = This may be used for some internal software revision number that represents a special level of railML interface implementation.
|railSemantics = This may be used for some internal software revision number that represents a special level of {{rml}} interface implementation.


|notes = The element {{{selfLink|FIXME}}} contains the internal version number of the schema occurrence (also called railML profile). This version number changes if the interpretation of the schema by the writing software changes. A reading software should check whether this version number is equal or higher than the version number it was tested with. A reading software also can easily check with this number whether will be some special values which are<br>
|notes = The element {{{selfLink|FIXME}}} contains the internal version number of the schema occurrence (also called {{rml}} profile). This version number changes if the interpretation of the schema by the writing software changes. A reading software should check whether this version number is equal or higher than the version number it was tested with. A reading software also can easily check with this number whether will be some special values which are<br>
* necessary for the reading software,
* necessary for the reading software,
* optional in railML,
* optional in {{rml}},
* obligatory in the specific schema instance.<br>
* obligatory in the specific schema instance.<br>
It is a matter of the writing software to assign the values for {{{selfLink|FIXME}}}. Therefore, these values can only be interpreted correctly together with {{CO:Doc|dc:source}}. It is recommended to align them at the official railML schema version this implementation is based on. (In the example: Instance no. #7 of railML 1.0.) It is also a matter of the writing software to secure that there are only unique combinations of {{{selfLink|FIXME}}} and {{CO:Doc|dc:source}}.
It is a matter of the writing software to assign the values for {{{selfLink|FIXME}}}. Therefore, these values can only be interpreted correctly together with {{CO:Doc|dc:source}}. It is recommended to align them at the official {{rml}} schema version this implementation is based on. (In the example: Instance no. #7 of {{rml|1.0}}.) It is also a matter of the writing software to secure that there are only unique combinations of {{{selfLink|FIXME}}} and {{CO:Doc|dc:source}}.


|notes_de =
|notes_de =
Das Attribut {{{selfLink|FIXME}}} enthält die interne Versionsnummer der Schemeninstanz. Diese Versionsnummer ändert sich dann, wenn sich die Interpretation oder die Vollständigkeit der Umsetzung des railML-Schemas durch die schreibende Software ändert. Ein lesendes Programm sollte prüfen, dass diese Versionsnummer nicht niedriger ist als die Version, mit der das Programm frühestens getestet wurde. Insbesondere kann hiermit vom lesenden Programm einfach geprüft werden, ob bestimmte Daten vorhanden sein werden, die
Das Attribut {{{selfLink|FIXME}}} enthält die interne Versionsnummer der Schemeninstanz. Diese Versionsnummer ändert sich dann, wenn sich die Interpretation oder die Vollständigkeit der Umsetzung des {{rml}}-Schemas durch die schreibende Software ändert. Ein lesendes Programm sollte prüfen, dass diese Versionsnummer nicht niedriger ist als die Version, mit der das Programm frühestens getestet wurde. Insbesondere kann hiermit vom lesenden Programm einfach geprüft werden, ob bestimmte Daten vorhanden sein werden, die
* {{Deu|notwendig sind für das lesende Programm,}}
* {{Deu|notwendig sind für das lesende Programm,}}
* {{Deu|in railML als optional gekennzeichnet sind,}}
* {{Deu|in {{rml}} als optional gekennzeichnet sind,}}
* {{Deu|in der konkreten Schemeninstanz obligatorisch sind.}}
* {{Deu|in der konkreten Schemeninstanz obligatorisch sind.}}
{{Deu|Es ist Sache der Programmierung der schreibenden Software, die Werte für {{{selfLink|FIXME}}} festzulegen. Diese Werte sind daher nur im Zusammenhang mit {{CO:Doc|dc:source}} interpretierbar. Es wird empfohlen, sich dabei an der zugrunde liegenden railML-Schemenversion zu orientieren. (Im Beispiel: Instanz Nr. 7 von railML 1.0.) Außerdem ist es Aufgabe der schreibenden Programmierung, nur eindeutige Werte von {{{selfLink|FIXME}}} innerhalb eines Wertes {{CO:Doc|dc:source}} zuzulassen.}}
{{Deu|Es ist Sache der Programmierung der schreibenden Software, die Werte für {{{selfLink|FIXME}}} festzulegen. Diese Werte sind daher nur im Zusammenhang mit {{CO:Doc|dc:source}} interpretierbar. Es wird empfohlen, sich dabei an der zugrunde liegenden {{rml}}-Schemenversion zu orientieren. (Im Beispiel: Instanz Nr. 7 von {{rml|1.0}}.) Außerdem ist es Aufgabe der schreibenden Programmierung, nur eindeutige Werte von {{{selfLink|FIXME}}} innerhalb eines Wertes {{CO:Doc|dc:source}} zuzulassen.}}


|semantics = {{{semantics|}}}
|semantics = {{{semantics|}}}

Latest revision as of 21:49, 22 January 2024


Usage

This is an Element Template. Element templates are intended to avoid routine work in railML® element documentation. These templates are very specific and are therefore documented uniformely by Template:TemplateDocu. They are collected in Category:Element Template and are based on Template:ElementDocu. They represent Template:ElementDoku with specific values and hand all other parameters through to Template:ElementDoku. If you want to use or handle an Element Template, you have to examine the code to find out, which arguments are set, and you have to be careful, because occationally arguments will be renamed, so that the use of argument names of Template ElementDoku may cause errors.

Arguments

As this is a bulk documentation, we do not explain the specific arguments of element templates.

Dependencies

As this is a bulk documentation, we do not explain the specific dependencies of element templates. You can find out, which other templates the current template supports by following this link. You can find out easily, which other templates the current template employs, as templates are included via {{doubble braces}}.

Example

As this is a bulk documentation, we do not offer specific examples of element templates. You can find in the field examples by following this link.