Template:InheritElectrification: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(moved references inside include tag)
(railML→{{rml}})
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>* {{Attr|type}} Possible values are:
<includeonly>* {{Attr|type}} Possible values are:
:* {{Enum|none}}: Non-electrified track requiring vehicles with independent self-contained propulsion <ref name="Norway">{{external|https://www.jernbanedirektoratet.no/globalassets/documenter/railml/20220617_railml2.4norismodel_v1.5.xlsx|Jernbanedirektoratet railML 2.4 glossary}}</ref>
:* {{Enum|none}}: Non-electrified track requiring vehicles with independent self-contained propulsion <ref name="Norway">{{external|https://www.jernbanedirektoratet.no/globalassets/documenter/railml/20220617_railml2.4norismodel_v1.5.xlsx|Jernbanedirektoratet {{rml|2.4}} glossary}}</ref>
:* {{Enum|overhead}}: This is a catenary.
:* {{Enum|overhead}}: This is a catenary.
:* {{Enum|3rdRail}}: {{wikipedia|Third rail}}; this is a conductor placed along or between the rails. For example, it is used by {{wikipedia|Network Rail}}.
:* {{Enum|3rdRail}}: {{wikipedia|Third rail}}; this is a conductor placed along or between the rails. For example, it is used by {{wikipedia|Network Rail}}.
Line 9: Line 9:
}} {{AddAnn|{{{type|}}}|{{{type_de|}}} }}
}} {{AddAnn|{{{type|}}}|{{{type_de|}}} }}


* {{Attr|voltage}} Contact line voltage in volts <ref name="FBS">{{external|https://www.irfp.de/files/iRFP/Downloads/fbs_railml2_dokumentation.pdf|Description of the FBS-RailML® interface}}</ref> {{AddAnn|{{{voltage|}}}|{{{voltage_de|}}} }}
* {{Attr|voltage}} Contact line voltage in volts <ref name="FBS">{{external|https://www.irfp.de/files/iRFP/Downloads/fbs_railml2_dokumentation.pdf|Description of the FBS {{rml}} interface}}</ref> {{AddAnn|{{{voltage|}}}|{{{voltage_de|}}} }}


* {{Attr|frequency}}: This is the frequency in Hertz of a track circuit. For DC track circuits this shall be set to zero. Omitting this value shall be interpreted as not applicable <ref name="Tutorial">{{external|https://wiki3.railml.org/wiki/CO:electrificationSystem|railML® 3.1 Tutorial Simple Example Step-by-Step Part 2: Interlocking}}</ref>. {{AddAnn|{{{frequency|}}}|{{{frequency_de|}}} }}
* {{Attr|frequency}}: This is the frequency in Hertz of a track circuit. For DC track circuits this shall be set to zero. Omitting this value shall be interpreted as not applicable <ref name="Tutorial">{{external|https://wiki3.railml.org/wiki/CO:electrificationSystem|{{rml|3.1}} Tutorial Simple Example Step-by-Step Part 2: Interlocking}}</ref>. {{AddAnn|{{{frequency|}}}|{{{frequency_de|}}} }}
==References==
<references />
</includeonly>
</includeonly>


Line 19: Line 17:
==Usage==
==Usage==
This template displayes the attributes ''type'', voltage'' and ''frequency''. For ''type'' it displayes the list of possible values, including ''other:anything'' — with a standard comment on the least, and optional comments in English and German. Moreover it allows for English and German comments on voltage and frequency.
This template displayes the attributes ''type'', voltage'' and ''frequency''. For ''type'' it displayes the list of possible values, including ''other:anything'' — with a standard comment on the least, and optional comments in English and German. Moreover it allows for English and German comments on voltage and frequency.
{{note|1=Please, set ''ref=1'' within [[template:elementDocu]] in all articles calling this template.|2=reminder}}
===Attributes===
===Attributes===
The template has six optional arguments:
The template has six optional arguments:
Line 29: Line 28:
===Dependencies===
===Dependencies===
This template builds on [[Template:Attr]], [[Template:Enum]] and [[Template:AddAnn]]. No other templates depend on it.
This template builds on [[Template:Attr]], [[Template:Enum]] and [[Template:AddAnn]]. No other templates depend on it.
==Examples==
==Examples==
<pre>{{InheritElectrification}}</pre>
<pre>{{InheritElectrification}}</pre>
Line 57: Line 57:


The template is employed by [[IS:electrification]] and [[IS:electrificationChange]].
The template is employed by [[IS:electrification]] and [[IS:electrificationChange]].
==References==
<references />


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

Latest revision as of 21:58, 22 January 2024


Usage

This template displayes the attributes type, voltage and frequency. For type it displayes the list of possible values, including other:anything — with a standard comment on the least, and optional comments in English and German. Moreover it allows for English and German comments on voltage and frequency.

💡 Please, set ref=1 within template:elementDocu in all articles calling this template.

Attributes

The template has six optional arguments:

  • type: English Comment on value other:anything of attribute type
  • type_de: German Comment on value other:anything of attribute type
  • voltage: English comment on attribute voltage
  • voltage_de: German comment on attribute voltage
  • frequency: English comment on attribute frequency
  • frequency_de: German comment on attribute frequency

Dependencies

This template builds on Template:Attr, Template:Enum and Template:AddAnn. No other templates depend on it.

Examples

{{InheritElectrification}}

delivers

  • type Possible values are:
  • none: Non-electrified track requiring vehicles with independent self-contained propulsion [1]
  • overhead: This is a catenary.
  • 3rdRail: Third rail (Wiki banner.png); this is a conductor placed along or between the rails. For example, it is used by Network Rail (Wiki banner.png).
  • sideRail: This is a rail for power supply conducted by pick-up shoe. For example, it is used by Berlin S-Bahn (Wiki banner.png).
  • other:anything: Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed. Please, apply Dev:usingAny accordingly.
  • voltage Contact line voltage in volts [2]
  • frequency: This is the frequency in Hertz of a track circuit. For DC track circuits this shall be set to zero. Omitting this value shall be interpreted as not applicable [3].



{{InheritElectrification
|type=English Comment on value other:anything of attribute type
|type_de=German Comment on value other:anything of attribute type
|voltage=English comment on attribute voltage
|voltage_de=German comment on attribute voltage
|frequency=English comment on attribute frequency
|frequency_de=German comment on attribute frequency
}}

delivers

  • type Possible values are:
  • none: Non-electrified track requiring vehicles with independent self-contained propulsion [1]
  • overhead: This is a catenary.
  • 3rdRail: Third rail (Wiki banner.png); this is a conductor placed along or between the rails. For example, it is used by Network Rail (Wiki banner.png).
  • sideRail: This is a rail for power supply conducted by pick-up shoe. For example, it is used by Berlin S-Bahn (Wiki banner.png).
  • other:anything: Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed. Please, apply Dev:usingAny accordingly.
    English Comment on value other:anything of attribute type
    German Comment on value other:anything of attribute type
  • voltage Contact line voltage in volts [2]
    English comment on attribute voltage
    German comment on attribute voltage
  • frequency: This is the frequency in Hertz of a track circuit. For DC track circuits this shall be set to zero. Omitting this value shall be interpreted as not applicable [3].
    English comment on attribute frequency
    German comment on attribute frequency



The template is employed by IS:electrification and IS:electrificationChange.

References

  1. ↑ 1.0 1.1 Jernbanedirektoratet railML® 2.4 glossary (external link)
  2. ↑ 2.0 2.1 Description of the FBS railML® interface (external link)
  3. ↑ 3.0 3.1 [https://wiki3.railml.org railML® 3.1 Tutorial Simple Example Step-by-Step Part 2: Interlocking] (external link)
Retrieved from "https://wiki2.railml.org/index.php?title=Template:InheritElectrification&oldid=15337"