Template:InheritDCidentifier: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
m (1 revision imported: http→https)
(railML→{{rml}})
 
Line 11: Line 11:
|DCdescription = Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.
|DCdescription = Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.


|railSemantics = This may be used for identifying the data set (railML file) independently from the XML file internal {{Attr|id}} attribute in the {{{contextLink|FIXME}}} element.
|railSemantics = This may be used for identifying the data set ({{rml}} file) independently from the XML file internal {{Attr|id}} attribute in the {{{contextLink|FIXME}}} element.


The element {{{selfLink|FIXME}}} is intended to contain a compatibility number as a simple integer value. This number only changes if the interpretation of an already existing value (attribute or element) changes after its first release (mostly following of an error correction). A reading software should check this value against a certain expected value - otherwise it risks that the data fields do no more contain the expected contents.
The element {{{selfLink|FIXME}}} is intended to contain a compatibility number as a simple integer value. This number only changes if the interpretation of an already existing value (attribute or element) changes after its first release (mostly following of an error correction). A reading software should check this value against a certain expected value - otherwise it risks that the data fields do no more contain the expected contents.


For an example, an attribute for speed values could contain speeds in km per hour. This confesses to be not conform to railML. To provide railML conformity, this attribute would have to be changed to meters per second - without to be renamed. In this case {{{selfLink|FIXME}}} would be increased by one to avoid that reading software reading it as kph not knowing this change.
For an example, an attribute for speed values could contain speeds in km per hour. This confesses to be not conform to {{rml}}. To provide {{rml}} conformity, this attribute would have to be changed to meters per second - without to be renamed. In this case {{{selfLink|FIXME}}} would be increased by one to avoid that reading software reading it as kph not knowing this change.


The element {{{selfLink|FIXME}}} will not be changed if new data are added to a scheme. This is the main difference to {{CO:Doc|dc:format}}. It is expected that {{{selfLink|FIXME}}} changes very seldom compared to {{CO:Doc|dc:format}}.
The element {{{selfLink|FIXME}}} will not be changed if new data are added to a scheme. This is the main difference to {{CO:Doc|dc:format}}. It is expected that {{{selfLink|FIXME}}} changes very seldom compared to {{CO:Doc|dc:format}}.
Line 22: Line 22:
Das Element {{{selfLink|FIXME}}} soll eine Kompatibilitätsnummer als einfachen Integer-Wert enthalten. Diese Nummer wird nur dann geändert, wenn ein bestehender Datenwert (Attribut oder Element) nachträglich uminterpretiert wird (z. B. in Folge einer Fehlerkorrektur). Ein lesendes Programm sollte dieses Attribut auf exakt den erwarteten Wert prüfen – sonst läuft es Gefahr, dass die auszuwertenden Datenfelder nicht mehr den erwarteten Inhalt enthalten.}}
Das Element {{{selfLink|FIXME}}} soll eine Kompatibilitätsnummer als einfachen Integer-Wert enthalten. Diese Nummer wird nur dann geändert, wenn ein bestehender Datenwert (Attribut oder Element) nachträglich uminterpretiert wird (z. B. in Folge einer Fehlerkorrektur). Ein lesendes Programm sollte dieses Attribut auf exakt den erwarteten Wert prüfen – sonst läuft es Gefahr, dass die auszuwertenden Datenfelder nicht mehr den erwarteten Inhalt enthalten.}}


{{deu|Beispielsweise könnte ein Geschwindigkeitsfeld bis zu einem bestimmten Zeitpunkt die Geschwindigkeit in km/h enthalten. Es sei angenommen, dass sich das nachträglich als nicht railML-konform herausstellte. Um die railML-Konformität wiederherzustellen, müsste des Geschwindigkeitsfeld nachträglich – ohne umbenannt zu werden – auf die Einheit m/s umgestellt werden. In diesem Falle würde {{{selfLink|FIXME}}} um eins weitergezählt werden, um lesende, nicht aktualisierte Programme davon abzuhalten, den neuen Wert als km/h einzulesen.}}
{{deu|Beispielsweise könnte ein Geschwindigkeitsfeld bis zu einem bestimmten Zeitpunkt die Geschwindigkeit in km/h enthalten. Es sei angenommen, dass sich das nachträglich als nicht {{rml}}-konform herausstellte. Um die {{rml}}-Konformität wiederherzustellen, müsste des Geschwindigkeitsfeld nachträglich – ohne umbenannt zu werden – auf die Einheit m/s umgestellt werden. In diesem Falle würde {{{selfLink|FIXME}}} um eins weitergezählt werden, um lesende, nicht aktualisierte Programme davon abzuhalten, den neuen Wert als km/h einzulesen.}}


{{deu|Das Element {{{selfLink|FIXME}}} wird nicht aktualisiert, wenn neue Daten hinzukommen, was es von {{CO:Tag|dc:format}} unterscheidet. Es wird erwartet, dass sich {{{selfLink|FIXME}}} im Gegensatz zu {{CO:Tag|dc:format}} nur sehr selten ändert.
{{deu|Das Element {{{selfLink|FIXME}}} wird nicht aktualisiert, wenn neue Daten hinzukommen, was es von {{CO:Tag|dc:format}} unterscheidet. Es wird erwartet, dass sich {{{selfLink|FIXME}}} im Gegensatz zu {{CO:Tag|dc:format}} nur sehr selten ändert.

Latest revision as of 21:50, 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.