Template:InheritIdName

From railML 2 Wiki
Revision as of 12:13, 11 August 2017 by RailML Coord Documentation (talk | contribs) (Undo revision 6765 by Ferri Leberl (talk))
Jump to navigation Jump to search

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): This is a short string for typical, specific abbreviations, used in different systems with the same understanding.
  • name: This is a short name for the current item.
  • description: This is a more detailed description as addition to the short name. It shall allow a short overview or hints to the contents of this data set.


  • 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.
  • xs:anyAttribute: This provides an extension point for non-railML® attributes in a foreign namespace. How to use it?

{{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): This is a short string for typical, specific abbreviations, used in different systems with the same understanding.
    English comment on code
    Deutscher Kommentar zu code
  • name: This is a short name for the current item.
    English comment on name
    Deutscher Kommentar zu name
  • description: This is a more detailed description as addition to the short name. It shall allow a short overview or hints to the contents of this data set.
    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.
  • xs:anyAttribute: This provides an extension point for non-railML® attributes in a foreign namespace. How to use it?
    English comment on anyAttribute
    Deutscher Kommentar zu anyAttribute

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