TT:annotation: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
(expansion)
Line 19: Line 19:
|name =
|name =
|description =
|description =
}}{{unlock|2.4|
}}{{#ifeq:2.4|{{current|{{{wiki}}}}}|{{#if:{{#var:show}}|
*{{attr|type}} {{intro|2.5}}: Enumeration of:
**{{enum|text}} annotation encodes textual information
**{{enum|symbol}} annotation encodes a symbol, e.g. bicycle symbol for trains allowing transport of bicycles or restaurant symbol for trains that include a restaurant car.
**{{enum|image}}|}}|
*{{attr|type}} {{intro|2.5}}: Enumeration of:
*{{attr|type}} {{intro|2.5}}: Enumeration of:
**{{enum|text}} annotation encodes textual information
**{{enum|text}} annotation encodes textual information

Revision as of 19:09, 13 December 2021


annotation
 


Scheme description / Schemenbeschreibung

Position of annotation in the XML-Tree / Position von annotation im XML-Baum

Multiplicity / Anzahl

[1..∞]

Semantics / Bedeutung

(introduced with version 2.2) The Element <annotation> element contains texts and messages dedicated for a passenger information system.
(introduced with version 2.5) Extended with version 2.5: annotation may also encode images and symbols. Additionally meta-information regarding the annotation may be provided, allowing apart from categorization to distinguish between the different use cases that can be supported by this element.

(introduced with version 2.2) Das Element <annotation> enthält Texte und Nachrichten, zur Übermittlung an ein Fahrgastinformationssystem.
(introduced with version 2.5) Erweitert mit Version 2.5: auch Bilder und Symbole können mit annotation kodiert werden. Zusätzlich können Meta-Informationen angegeben werden, die neben einer Klassifizierung auch eine Unterscheidung der Informationen für die verschiedenen Use Cases die durch dieses Element unterstützt werden, erlauben.

Attributes of annotation / Attribute von annotation

  • id: XML-file-wide unique, machine-interpretable identity, required for later referencing that element internally. For a detailed explanation see Dev:identities.
    XML-Datei-weit eindeutige, maschineninterpretierbare Identität, die für die spätere interne Referenzierung dieses Elements erforderlich ist. Für eine detaillierte Erklärung siehe Dev:identities.
  • code (introduced with version 2.1): Machine-interpretable string (e.g. an abbreviation) used for identification of the object across exchange partners, usecase specific uniqueness constraints may apply. Please see our description of the differences between id, code and human-readable identifiers.
    Maschineninterpretierbare Zeichenkette (z.B. Abkürzung), die zur Identifizierung des Objekts auch bei Austauschpartnern verwendet wird, wobei spezifische Eindeutigkeitsbeschränkungen gelten können. Bitte beachten Sie unsere Erläuterung zu den Unterschieden zwischen id, code and menschenlesbaren Kennzeichnungen.
  • name: Established, human-readable short string, giving the object a name. Not intended for machine interpretation, please see our notice on human interpretable data fields.
    Etablierte, menschenlesbare kurze Zeichenkette, die das Objekt benennt. Nicht zur maschinellen Interpretation bestimmt, siehe Hinweise zu menschenlesbaren Datenfeldern.
  • description: Human-readable, more detailed description as addition to the name. It should give additional explanations or hints to the contents of this element. Not intended for machine interpretation, please see our notice on human interpretable data fields.
    Menschenlesbare, detailliertere Beschreibung als Ergänzung zu name. Sie soll zusätzliche Erläuterungen oder Hinweise auf den Inhalt dieses Elements geben. Nicht zur maschinellen Interpretation bestimmt, siehe Hinweise zu menschenlesbaren Datenfeldern.
  • 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).
    This defines the language used for name and description. Use <additionalName> to provide a name and/or description in other languages.
  • type (introduced with version 2.5): Enumeration of:
    • text annotation encodes textual information
    • symbol annotation encodes a symbol, e.g. bicycle symbol for trains allowing transport of bicycles or restaurant symbol for trains that include a restaurant car.
    • image annotation encodes an image, e.g. a logo for the train of some kind

Syntactic Constraints / Syntaktische Beschränkungen

  • id: xs:ID, required
    a string, starting with a letter (a..zA..Z) or an underscore (_),
    followed by a non-colonized and non-spaced string consisting of letters, digits, points (.), dashes (-) or underscores (_)
  • code: xs:string, optional
  • name: xs:string, optional
  • description: xs:string, optional
  • xml:lang: xs:language, language identification, optional
  • type: xs:string, generic type for annotation types: enumeration text, symbol, image, optional, default: text

Best practice & Examples / Empfohlene Anwendung & Beispiele

Not yet described. / Noch nicht beschrieben.

Notes / Anmerkungen

Not yet described. / Noch nicht beschrieben.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.