Template:InheritIdName: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(Changed explanation according to suggestions by Mr. Tanner)
No edit summary
Line 11: Line 11:


{{InheritLang
{{InheritLang
|notes_en = This is used for defining {{Attr|name}} and {{Attr|description}}.
|notes_en = This is used for defining {{Attr|name}} and {{Attr|description}}.}}<!--
}}
<!--
{{InheritAnyAttribute
{{InheritAnyAttribute
|anyAttribute = {{{anyAttribute|}}}
|anyAttribute = {{{anyAttribute|}}}
|anyAttribute_de = {{{anyAttribute_de|}}}
|anyAttribute_de = {{{anyAttribute_de|}}}}}--></includeonly><noinclude>
}}--></includeonly><noinclude>
==Usage==
==Usage==
This template displays the commented attributes ''id'', ''code'', ''name'', ''description'' and ''xml:lang''.
This template displays the commented attributes ''id'', ''code'', ''name'', ''description'' and ''xml:lang''.

Revision as of 11:37, 17 August 2018

Usage

This template displays the commented attributes id, code, name, description and xml:lang.

Arguments

This template has ten optional arguments for English and German Comments on five of the six attributes:

  • id and id_de
  • code and code_de
  • name and name_de
  • description and description_de
  • anyAttribute and anyAttribute_de

Dependencies

This template depends on Template:InheritId, Template:Attr, Template:AddAnn, Template:InheritLang and Template:InheritAnyAttribute. There are about a dozen templates building on it.

Examples

{{InheritIdName}}

delivers (in a box)

  • 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.
    Maschineninterpretierbare Zeichenkette (z.B. Abkürzung), die zur Identifizierung des Objekts auch bei Austauschpartnern verwendet wird, wobei spezifische Eindeutigkeitsbeschränkungen gelten können.
  • name: Established, human-readable short string, giving the object a name. Usually not intended for machine interpretation.
    Etablierte, menschenlesbare kurze Zeichenkette, die das Objekt benennt. In der Regel nicht zur maschinellen Interpretation bestimmt.
  • description: Human-readable, more detailed description as addition to the name. It should give additional explanations or hints to the contents of this data set. Usually not intended for machine interpretation.
    Menschenlesbare, detailliertere Beschreibung als Ergänzung zu name. Sie soll zusätzliche Erläuterungen oder Hinweise auf den Inhalt dieses Datensatzes geben. In der Regel nicht zur maschinellen Interpretation bestimmt.


  • 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 is used for defining name and description.

{{InheritIdName |id=English comment on id |id_de=Deutscher Kommentar zur id |code=English comment on code |code_de=Deutscher Kommentar zu code |name=English comment on name |name_de=Deutscher Kommentar zu name |description=English comment on description |description_de=Deutscher Kommentar zu description |anyAttribute=English comment on anyAttribute |anyAttribute_de=Deutscher Kommentar zu anyAttribute }}

delivers (in a box)

  • 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.
    English comment on id
    Deutscher Kommentar zur id
  • 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.
    Maschineninterpretierbare Zeichenkette (z.B. Abkürzung), die zur Identifizierung des Objekts auch bei Austauschpartnern verwendet wird, wobei spezifische Eindeutigkeitsbeschränkungen gelten können.
    English comment on code
    Deutscher Kommentar zu code
  • name: Established, human-readable short string, giving the object a name. Usually not intended for machine interpretation.
    Etablierte, menschenlesbare kurze Zeichenkette, die das Objekt benennt. In der Regel nicht zur maschinellen Interpretation bestimmt.
    English comment on name
    Deutscher Kommentar zu name
  • description: Human-readable, more detailed description as addition to the name. It should give additional explanations or hints to the contents of this data set. Usually not intended for machine interpretation.
    Menschenlesbare, detailliertere Beschreibung als Ergänzung zu name. Sie soll zusätzliche Erläuterungen oder Hinweise auf den Inhalt dieses Datensatzes geben. In der Regel nicht zur maschinellen Interpretation bestimmt.
    English comment on description
    Deutscher Kommentar zu description


  • 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 is used for defining name and description.

The template is emploed e.g. by IS:derailer.