Template:InheritIdName: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{InheritId
<includeonly>{{#ifeq:{{{noid}}}|1||{{InheritId
|id = {{{id|}}}
|id = {{{id|}}}
|id_de = {{{id_de|}}}
|id_de = {{{id_de|}}}
}}
}}}}{{#ifeq:{{{nocode}}}|1||
* {{Attr|code}} {{Intro|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 [[Dev:identities#Differentiation_from_other_indications|description of the differences between id, code and human-readable identifiers]].<br>{{deu|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 [[Dev:identities#Differentiation_from_other_indications|Erläuterung zu den Unterschieden zwischen id, code and menschenlesbaren Kennzeichnungen]].}}{{AddAnn|{{{code|}}}|{{{code_de|}}} }}  
* {{Attr|code}} {{Intro|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 [[Dev:identities#Differentiation_from_other_indications|description of the differences between id, code and human-readable identifiers]].<br>{{deu|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 [[Dev:identities#Differentiation_from_other_indications|Erläuterung zu den Unterschieden zwischen id, code and menschenlesbaren Kennzeichnungen]].}}{{AddAnn|{{{code|}}}|{{{code_de|}}} }} }}
* {{Attr|name}}: Established, human-readable short string, giving the object a name. Not intended for machine interpretation, please see our [[Dev:identities#Differentiation_from_other_indications|notice on human interpretable data fields]].<br>{{deu|Etablierte, menschenlesbare kurze Zeichenkette, die das Objekt benennt. Nicht zur maschinellen Interpretation bestimmt, siehe [[Dev:identities#Differentiation_from_other_indications|Hinweise zu menschenlesbaren Datenfeldern]].}}{{AddAnn|{{{name|}}}|{{{name_de|}}} }}
* {{Attr|name}}: Established, human-readable short string, giving the object a name. Not intended for machine interpretation, please see our [[Dev:identities#Differentiation_from_other_indications|notice on human interpretable data fields]].<br>{{deu|Etablierte, menschenlesbare kurze Zeichenkette, die das Objekt benennt. Nicht zur maschinellen Interpretation bestimmt, siehe [[Dev:identities#Differentiation_from_other_indications|Hinweise zu menschenlesbaren Datenfeldern]].}}{{AddAnn|{{{name|}}}|{{{name_de|}}} }}
* {{Attr|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 [[Dev:identities#Differentiation_from_other_indications|notice on human interpretable data fields]].<br>{{deu|Menschenlesbare, detailliertere Beschreibung als Ergänzung zu {{Attr|name}}. Sie soll zusätzliche Erläuterungen oder Hinweise auf den Inhalt dieses Elements geben. Nicht zur maschinellen Interpretation bestimmt, siehe [[Dev:identities#Differentiation_from_other_indications|Hinweise zu menschenlesbaren Datenfeldern]].}}{{AddAnn|{{{description|}}}|{{{description_de|}}}}}
* {{Attr|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 [[Dev:identities#Differentiation_from_other_indications|notice on human interpretable data fields]].<br>{{deu|Menschenlesbare, detailliertere Beschreibung als Ergänzung zu {{Attr|name}}. Sie soll zusätzliche Erläuterungen oder Hinweise auf den Inhalt dieses Elements geben. Nicht zur maschinellen Interpretation bestimmt, siehe [[Dev:identities#Differentiation_from_other_indications|Hinweise zu menschenlesbaren Datenfeldern]].}}{{AddAnn|{{{description|}}}|{{{description_de|}}}}}
{{InheritLang
{{#ifeq:{{{nolang}}}|1||{{InheritLang
|notes_en = This defines the language used for {{Attr|name}} and {{Attr|description}}. Use {{{{#sub:{{PAGENAME}}|0|2}}:Tag|additionalName|{{#sub:{{PAGENAME}}|3}}}} to provide a {{Attr|name}} and/or {{Attr|description}} in other languages.}}<!--
|notes_en = This defines the language used for {{Attr|name}} and {{Attr|description}}. Use {{{{#sub:{{PAGENAME}}|0|2}}:Tag|additionalName|{{#sub:{{PAGENAME}}|3}}}} to provide a {{Attr|name}} and/or {{Attr|description}} in other languages.}}}}<!--
{{InheritAnyAttribute
{{InheritAnyAttribute
|anyAttribute = {{{anyAttribute|}}}
|anyAttribute = {{{anyAttribute|}}}
Line 14: Line 14:
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''.
===Arguments===
===Arguments===
This template has ten optional arguments for English and German Comments on five of the six attributes:
This template has 13 optional arguments for English and German Comments on five of the six attributes:
*id and id_de
*id and id_de '''or: noid=1''' (as to display only code, name and description)
*code and code_de
*code and code_de '''or: nocode=1''' (as to display only id, name and description)
*name and name_de
*name and name_de
*description and description_de
*description and description_de
*anyAttribute and anyAttribute_de
*anyAttribute and anyAttribute_de
*nolang: suppress {{@|lang}}
===Dependencies===
===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.
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==
==Examples==
<nowiki>{{InheritIdName}}</nowiki>
<pre>{{InheritIdName}}</pre>


delivers (in a box)
delivers


{|border="1"
{{InheritIdName}}
|{{InheritIdName}}
|}


<nowiki>{{InheritIdName
<pre>{{InheritIdName
|id=English comment on id
|id=English comment on id
|id_de=Deutscher Kommentar zur id
|id_de=Deutscher Kommentar zur id
Line 43: Line 43:
|anyAttribute=English comment on anyAttribute
|anyAttribute=English comment on anyAttribute
|anyAttribute_de=Deutscher Kommentar zu anyAttribute
|anyAttribute_de=Deutscher Kommentar zu anyAttribute
}}</nowiki>
}}</pre>


delivers (in a box)
delivers


{|border="1"
{{InheritIdName
|{{InheritIdName
|id=English comment on id
|id=English comment on id
|id_de=Deutscher Kommentar zur id
|id_de=Deutscher Kommentar zur id
Line 60: Line 59:
|anyAttribute_de=Deutscher Kommentar zu anyAttribute
|anyAttribute_de=Deutscher Kommentar zu anyAttribute
}}
}}
|}


The template is emploed e.g. by [[IS:derailer]].
<pre>{{InheritIdName|nocode=1}}</pre>
 
delivers
 
{{InheritIdName|nocode=1}}
 
The template is employed e.g. by [[IS:derailer]].
 
<pre>{{InheritIdName|noid=1}}</pre>
 
delivers
 
{{InheritIdName|noid=1}}
 
<pre>{{InheritIdName|noid=1|nocode=1|nolang=1}}</pre>
 
delivers
 
{{InheritIdName|noid=1|nocode=1|nolang=1}}


[[Category:AttributeTemplate]]</noinclude>
[[Category:AttributeTemplate]]</noinclude>

Latest revision as of 16:38, 9 February 2022

Usage

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

Arguments

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

  • id and id_de or: noid=1 (as to display only code, name and description)
  • code and code_de or: nocode=1 (as to display only id, name and description)
  • name and name_de
  • description and description_de
  • anyAttribute and anyAttribute_de
  • nolang: suppress @lang

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


  • 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 Template:In:Tag to provide a name and/or description in other languages.
{{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


  • 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. 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.
    English comment on code
    Deutscher Kommentar zu code
  • 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.
    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 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.
    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 defines the language used for name and description. Use Template:In:Tag to provide a name and/or description in other languages.
{{InheritIdName|nocode=1}}

delivers


  • 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.
  • 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 Template:In:Tag to provide a name and/or description in other languages.

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

{{InheritIdName|noid=1}}

delivers


{{InheritIdName|noid=1|nocode=1|nolang=1}}

delivers


  • 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.