Template:InheritRef: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[unchecked revision][checked revision]
(Created for use in several IS, RS, TT element documentation sites)
 
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
* {{Attr| {{{attributeName|FIXME}}}}}: This is the reference to the {{Attr|id}} attribute of the {{{contextLink|FIXME}}} element. <br/> {{Ann| {{{notes_en|}}} }}<noinclude>[[Category:AttributeTemplate]]</noinclude>
<includeonly>* {{Attr|{{{attributeName|ref}}}}}: This refers to the {{Attr|id}} attribute of the associated {{{contextLink|FIXME}}} element. {{AddAnn|{{{notes_en|}}}|{{{notes_de|}}} }}</includeonly><noinclude>
==Usage==
This template displays an attribute with variable name and a standard comment. Optionally an English and a German comment can be added.
===Arguments===
The template has two obligatory and two optional arguments:
*obligatory:
**attributeName: An attribute
**contextLink: An Element
*optional:
**notes_en: An English comment
**notes_de: A German comment
===Dependencies===
The template depends on [[Template:Attr]] and [[Template:AddAnn]]. About halve a dozen of other templates build on it.
 
==Examples==
<pre>{{InheritRef
|attributeName=Some Attribute Name
|contextLink=Some Name
}}</pre>
 
delivers
 
{|border="1"
|
* {{Attr| Some Attribute Name}}: This refers to the {{Attr|id}} attribute of the associated Some Name element. {{AddAnn|| }}
|}
 
<pre>{{InheritRef
|attributeName=Some Attribute Name
|contextLink=Some Name
|notes_en=An English comment
|notes_de=Ein deutscher Kommentar
}}</pre>
 
delivers
 
{|border="1"
|
* {{Attr| Some Attribute Name}}: This refers to the {{Attr|id}} attribute of the associated Some Name element. {{AddAnn|An English comment|Ein deutscher Kommentar }}
|}
 
The template is employed e.g. by [[IS:signal]].
 
[[Category:AttributeTemplate]]</noinclude>

Latest revision as of 17:31, 3 April 2022

Usage

This template displays an attribute with variable name and a standard comment. Optionally an English and a German comment can be added.

Arguments

The template has two obligatory and two optional arguments:

  • obligatory:
    • attributeName: An attribute
    • contextLink: An Element
  • optional:
    • notes_en: An English comment
    • notes_de: A German comment

Dependencies

The template depends on Template:Attr and Template:AddAnn. About halve a dozen of other templates build on it.

Examples

{{InheritRef
|attributeName=Some Attribute Name
|contextLink=Some Name
}}

delivers

  • Some Attribute Name: This refers to the id attribute of the associated Some Name element.
{{InheritRef
|attributeName=Some Attribute Name
|contextLink=Some Name
|notes_en=An English comment
|notes_de=Ein deutscher Kommentar
}}

delivers

  • Some Attribute Name: This refers to the id attribute of the associated Some Name element.
    An English comment
    Ein deutscher Kommentar

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