Template:InheritElectrification: Difference between revisions
Jump to navigation
Jump to search
[unchecked revision] | [checked revision] |
(Created for use in several IS element documentation sites) |
(Link internalized) |
||
(17 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
* {{Attr|type}} < | <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 {{rml|2.4}} glossary}}</ref> | |||
:* {{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|sideRail}}: This is a rail for power supply conducted by pick-up shoe. For example, it is used by {{wikipedia|Berlin S-Bahn}}. | |||
:* {{OtherEnum | |||
|notes_en = | |||
|notes_de = | |||
}} {{AddAnn|{{{type|}}}|{{{type_de|}}} }} | |||
* {{Attr|voltage}} < | * {{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}} < | * {{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">{{wiki3|CO:electrificationSystem|2={{rml|3.1|link=no}} Tutorial Simple Example Step-by-Step Part 2: Interlocking}}</ref>. {{AddAnn|{{{frequency|}}}|{{{frequency_de|}}} }} | ||
</includeonly> | |||
<noinclude> | |||
==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. | |||
{{note|1=Please, set ''ref=1'' within [[template:elementDocu]] in all articles calling this template.|2=reminder}} | |||
===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== | |||
<pre>{{InheritElectrification}}</pre> | |||
delivers | |||
{{InheritElectrification}} | |||
<pre>{{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 | |||
}}</pre> | |||
delivers | |||
{{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 | |||
}} | |||
The template is employed by [[IS:electrification]] and [[IS:electrificationChange]]. | |||
==References== | |||
<references /> | |||
[[Category:AttributeTemplate]]</noinclude> |
Latest revision as of 16:38, 20 May 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.
|
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 (); this is a conductor placed along or between the rails. For example, it is used by Network Rail ().
- sideRail: This is a rail for power supply conducted by pick-up shoe. For example, it is used by Berlin S-Bahn ().
- 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 (); this is a conductor placed along or between the rails. For example, it is used by Network Rail ().
- sideRail: This is a rail for power supply conducted by pick-up shoe. For example, it is used by Berlin S-Bahn ().
- 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.0 1.1 Jernbanedirektoratet railML® 2.4 glossary (external link)
- ↑ 2.0 2.1 Description of the FBS railML® interface (external link)
- ↑ 3.0 3.1 railML® 3.1 Tutorial Simple Example Step-by-Step Part 2: Interlocking