Template:RailGauge

From Wikipedia, the free encyclopedia
(Redirected from Template:Track gauge)
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

This template accepts a RailGauge and returns that defined RailGauge well formatted, plus the converted size value by another unit:

  • {{RailGauge|1520 mm}}1,520 mm (4 ft 11 2732 in)
  • {{RailGauge|4 ft}}4 ft (1,219 mm)

Extra options are available:

  • {{RailGauge|1520 mm|lk=on}}1,520 mm (4 ft 11 2732 in)
  • {{RailGauge|1520 mm|al=on}}1,520 mm (4 ft 11 2732 in) Russian gauge
  • {{RailGauge|1520 mm|allk=on}}1,520 mm (4 ft 11 2732 in) Russian gauge

Input options[change source]

The first parameter specifies the gauge:

  • {{RailGauge|1435 mm}}1,435 mm (4 ft 8 12 in)
  • {{RailGauge|4 ft 8.5 in}}4 ft 8 12 in (1,435 mm)
  • {{RailGauge|4 ft 8 1/2 in}}4 ft 8 12 in (1,435 mm)
  • {{RailGauge|56.5 in}}4 ft 8 12 in (1,435 mm)
  • {{RailGauge|Standard gauge}}1,435 mm (4 ft 8 12 in)

Rail RailGauges can be entered as they are defined: in units mm or ft in. Also common accepted names can be used, see below.

The input value (a length, in metric or imperial units) must be a defined RailGauge. Currently 137 gauges are defined by metric units, and 136 by imperial units. Some are defined in both unit sytems, in both, such as the standard gauge.

  • When an input value is not recognised by the template, the template simply returns the input as it is: {{RailGauge|25in}} → 25in
The page with this unknown input is also listed in a maintenance category, in the background, that signals interested editors that there is a new rail gauge used in Wikipedia. More on this below.
  • Some gauges in metric are defined in metres: 1 m is recognised. However, it is not available for all metric defined gauges. Using mm is a safer bet.

List of defined RailGauges[change source]

Template:RailGauge/doc/input options

Formatting input[change source]

When entering a RailGauge (like {{RailGauge|1435mm}}, these are formatting options. Keep in mind that only defined gauges are recognised.

Spacing is free, and fractions can be used in imperial units. Primes (' and ") may be used for [foot, inch]. Any [foot, inch] size can be entered in all-inches (4 ft 8 1/2 in equals 56 1/2 in and 56.5 in).

Input options, examples
Parameter
input
Result Note
1435 mm 1,435 mm (4 ft 8 12 in) standard gauge
standard gauge 1,435 mm (4 ft 8 12 in) standard gauge, by name
4 ft 8.5 in 4 ft 8 12 in (1,435 mm) standard gauge, this way puts imperial units first
UK sg 4 ft 8 12 in (1,435 mm) standard gauge, this way puts imperial units first
56.5 in 4 ft 8 12 in (1,435 mm) standard gauge, by all-inches
56.5" 4 ft 8 12 in (1,435 mm) standard gauge, using primes
56 1/2 in 4 ft 8 12 in (1,435 mm) standard gauge, using slash for fraction
1 m 1,000 mm (3 ft 3 38 in) 1 m is recognised, but not many more in m. Better use mm
16.5 mm 16.5 mm (0.65 in) HO scale model railway
16.5 in 16 12 in (419 mm) Miniature railway
7 ft 0.25 in 7 ft 14 in (2,140 mm) Brunel
2140 mm 2140 mm Not recognised (so no converted value). This RailGauge, Brunel's, is not defined in mm.
65 in 65 in Input not recognised (so no converted value); output copies the input.
This is a good way to enter an uncovered rail gauge on a page: other editors will notice (and can add a new gauge to the template!).

Parameters[change source]

{{RailGauge
|
| lk=on
| first=imp, met
| disp= s, /, 1, br, [], <any literal text>
| al=on
| allk=on
| nowrap=off (default), on, all
| addcat=no
| unitlink=on
}}
Optional parameters
Parameter What it does Example (code) Example (output)
lk=on Links the defining measure (first measure)
"defined size" depends on input
{{RailGauge|3ft6in|lk=on}}

{{RailGauge|1067mm|lk=on}}

3 ft 6 in (1,067 mm)
1,067 mm (3 ft 6 in)
al=on Adds the alternate name after the gauge measurement values {{RailGauge|sg|al=on}} 1,435 mm (4 ft 8 12 in) standard gauge
allk=on Adds a wikilink to the alternate name where applicable {{RailGauge|sg|allk=on}} 1,435 mm (4 ft 8 12 in) standard gauge
first=imp
first=met
Puts the requested measure first (metric, imperial) {{RailGauge|1000mm|first=imp}} 3 ft 3 38 in (1,000 mm)
disp=any text The text will be written between the measurements, two spaces added. Brackets are omitted. Text must be 2 characters or more. (codes for |disp= are processed as described: 1, s, /, br). {{RailGauge|sg|disp=also defined as being}} 1,435 mm also defined as being 4 ft 8 12 in
disp=s or / Uses a slash as a separator rather than parentheses {{RailGauge|sg|disp=s}} 1,435 mm/​4 ft 8 12 in
disp=[] Uses a square brackets rather than parentheses {{RailGauge|sg|disp=[]}} 1,435 mm [4 ft 8 12 in]
disp=1 Only shows the first measure (may be used when repeated on a page
or in conjunction with first= to display the output only)
{{RailGauge|sg|disp=1}} 1,435 mm
disp=br Forces a line break after the first size (and also before any gauge name) {{RailGauge|sg|disp=br}} 1,435 mm
(4 ft 8 12 in)
nowrap=off (default), on, all Sets possible line break (line wrap): after between the measurements (off=defalt), not (on, all), or not at all when named gauge is present. (note: until May 2014, default behaviour was no break between the measurements. This has changed.) {{RailGauge|sg|nowrap=on}} 1,435 mm (4 ft 8 12 in)
addcat=no Will not add a maintenance category {{RailGauge|sg|addcat=no}} 1,435 mm (4 ft 8 12 in)
unitlink=on Adds wikilinks to the measurement unit labels {{RailGauge|sg|unitlink=on}} 1,435 mm (ft 8 12 in)
  • Names can be universal, being defined worldwide. For example: Iberian gauge, 1,668 mm (5 ft 5 2132 in) Iberian gauge. Other names can be localor culturally restricted, for example the name "Cape gauge" is used in South Africa for 3 ft 6 in (1,067 mm), but not in Japan (in Japan that same track gaugfe is not named).
  • Also, two sizes can lead to one gauge name.

Named gauges[change source]

Established gauge names can be entered. The word "gauge" can be omitted. Case-insensitive (A=a). See also the |al=, |allk= parameters (below), to show a gauge name in the outcome.

Input Result Note
{{RailGauge|Baltimore gauge|al=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge
{{RailGauge|Baltimore|al=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge Omitting " gauge", same effect
{{RailGauge|baltimore|al=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge Case-insensitive (A=a)
{{RailGauge|baltimore|al=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge |al=on shows the alternative (name)
{{RailGauge|baltimore|allk=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge |allk=on shows the alternative (name), linked
{{RailGauge|baltimore|lk=on|al=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge |lk=on links the size (as always)
{{RailGauge|Baltimore streetcar gauge|al=on}} 5 ft 4 12 in (1,638 mm) Baltimore streetcar gauge This one has more names
{{RailGauge|Bosnian|al=on}} 760 mm (2 ft 5 1516 in) Bosnian gauge
{{RailGauge|Brunel|al=on}} 7 ft (2,134 mm) Brunel gauge
{{RailGauge|Cape|al=on}} 3 ft 6 in (1,067 mm) Cape gauge
{{RailGauge|Iberian|al=on}} 1,668 mm (5 ft 5 2132 in) Iberian gauge
{{RailGauge|Indian|al=on}} 5 ft 6 in (1,676 mm) Indian gauge
{{RailGauge|Victorian|al=on}} 1,600 mm (5 ft 3 in) Victorian broad gauge
{{RailGauge|Irish|al=on}} 5 ft 3 in (1,600 mm) Irish gauge
{{RailGauge|metre|al=on}} 1,000 mm (3 ft 3 38 in) metre gauge
{{RailGauge|Ohio|al=on}} 4 ft 10 in (1,473 mm) Ohio gauge
{{RailGauge|Pennsylvania|al=on}} 5 ft 2 12 in (1,588 mm) Pennsylvania trolley gauge
{{RailGauge|Pennsylvania trolley|al=on}} 5 ft 2 12 in (1,588 mm) Pennsylvania trolley gauge
{{RailGauge|Russian|al=on}} 1,520 mm (4 ft 11 2732 in) Russian gauge
{{RailGauge|Scotch|al=on}} 4 ft 6 in (1,372 mm) Scotch gauge
{{RailGauge|standard gauge|al=on}} 1,435 mm (4 ft 8 12 in) standard gauge Also: "sg", "metsg" (metric units first)
{{RailGauge|US sg|al=on}} 4 ft 8 12 in (1,435 mm) standard gauge Also: "imp sg", "UK sg", "NA sg" (imperial units first)
{{RailGauge|Swedish three foot|al=on}} 891 mm (2 ft 11 332 in) Swedish three foot
{{RailGauge|Swedish|al=on}} 891 mm (2 ft 11 332 in) Swedish three foot
{{RailGauge|Toronto|al=on}} 4 ft 10 78 in (1,495 mm) Toronto gauge

English variant (ENGVAR)[change source]

For articles written in US-English, it is possible to set parameter |engvar=en-US. In this situation, the US-English spelling is shown (metER):

1,000 mm (3 ft 3 38 in) meter gauge

Why not use {{Convert}}?[change source]

To convert a RailGauge, using {{Convert}} comes to mind. For example, standard gauge:

  • {{Convert|1435|mm|ftin|abbr=on}} → 1,435 mm (4 ft 8.5 in)
However, this has some disadvantages. First of all, RailGauges are defined by an institute, not just measured. The list of those defined RailGauges is limited, and overseeable (today some 270 physical sizes are defined).
Using {{RailGauge}} allows us to track (follow) all articles with a specific gauge. This way the list can be made more accurate, correct and complete.
Also, the track definition can be directly linked to the sourcing article: 1,067 mm (3 ft 6 in).
Further more, the template allows to recognise named gauges such as "Russian gauge".

Tracking category[change source]

{{RailGauge}} detects that an undefined gauge is entered, and signal for maintenance. For example, metre gauge is only defined in metric. Entering an imperial size would categorise that article in Category:Articles using template 'RailGauge' with unrecognized input (0).

TemplateData[change source]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for RailGauge

The template formats a RailGauge size into standard notation and adds the conversion into the imperial/metric (other) size

Template parameters

ParameterDescriptionTypeStatus
RailGauge definition1

Defined RailGauge, in mm or ft in. Also can accept: ' '', m, gauge name

Stringrequired
Link top measurement unitslk

=on: adds link to the gauge defining article

Stringoptional
Alternative nameal

=on: Add gauge name (if existing)

Stringoptional
Alternative name, linkedallk

=on: Add gauge name (if existing) and link to its wiki page

Stringoptional
Display converted gaugedisp

Separator for the converted value: 1=none (first value only); =s, /: slash separator; =''Any text'' (2 or more characters): Any literal text written between the two values.

Default
(...) brackets
Stringoptional
Which unit to mention firstfirst

=met: metric first; =imp: imperial first (default: input unit)

Default
By input
Stringoptional
Allow line wrapping of textnowrap

wrap=off, on, all: allows lin breaking between the two measurements. Default: on. 'all' disallows linebreaking wiothing an alternative name

Default
off
Stringoptional
Wikilink unitsunitlink

=on: do wikilink

Default
Stringoptional
Categorize pageaddcat

=no: do not categorize

Default
yes
Stringoptional

See also[change source]

Template:Navbox RailGauge categories

Sources

External links[change source]

Sources
  • Light Rail Transit Association (LRTA)
  • Morrisson, Allen (2013). "Electric transport in latin america". Latin America is very well covered
  • "A world of trams and urban transit". Light Rail Transit Association (LRTA)). UK based, covering most countries
Scaled rail models