CO:dc:format

From wiki.railML.org
Jump to: navigation, search

dc:format
 


Scheme description / Schemenbeschreibung / Description du schéma

Position of dc:format in the XML-Tree / Position von dc:format im XML-Baum / position de dc:format dans l’aborescence XML

  • Children: <any>

Multiplicity / Anzahl / Multiplicité

[1..1]

Semantics / Bedeutung / Sémantique

Dublin Core definition
"The file format, physical medium, or dimensions of the resource."
Dublin Core description
"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]."
railML semantics
This may be used for some internal software revision number that represents a special level of railML interface implementation.

Attributes of dc:format / Attribute von dc:format / Attributs de dc:format

  • xml:lang (introduced with version 2.1): This is a unique identifier of language. It uses basically the language standard IETF BCP 47 (external link) which may be different to ISO 639-1 (external link) or ISO 639-2 (external link). For mapping hints see relation to other standards (external link).
    The usage of xml:lang does not make any sense in the context of a software file format.

Syntactic Constraints / Syntaktische Beschränkungen / Contraintes syntactiques

The Element <dc:format> may occur once.

Best practice & Examples / Empfohlene Anwendung & Beispiele / Bonnes pratiques & exemples

  <dc:format>1.0.7-13452</dc:format>

see also railML® recommendation and example for usage of DC elements (external link, 2015-05-8, pdf, German and English, visited on 2018-03-27; by Dirk Bräuer, iRFP Dresden)

Notes / Anmerkungen / Notes

The element <dc:format> 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

  • necessary for the reading software,
  • optional in RailML,
  • obligatory in the specific schema instance.

It is a matter of the writing software to assign the values for <dc:format>. Therefore, these values can only be interpreted correctly together with 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 <dc:format> and dc:source.
Das Attribut <dc:format> 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

  • notwendig sind für das lesende Programm,
  • in RailML als optional gekennzeichnet sind,
  • in der konkreten Schemeninstanz obligatorisch sind.

Es ist Sache der Programmierung der schreibenden Software, die Werte für <dc:format> festzulegen. Diese Werte sind daher nur im Zusammenhang mit 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 <dc:format> innerhalb eines Wertes dc:source zuzulassen.

Open issues / Offene Punkte/Pedenzen / Questions ouvertes

Not yet described. / Noch nicht beschrieben. / Pas encore décrit.