View source for Template:Track gauge/doc

{{Documentation subpage}}
{{Lua|Module:Track gauge|Module:Track gauge/data|Module:TemplatePar}}

This template accepts a track gauge and returns that '''defined track gauge''' well formatted, plus the '''converted size value''' by another unit:
* <code><nowiki>{{Track gauge|1520 mm}}</nowiki></code> &rarr; {{Track gauge|1520 mm}}
* <code><nowiki>{{Track gauge|4 ft}}</nowiki></code> &rarr; {{Track gauge|4 ft}}

Extra options are available:
* <code><nowiki>{{Track gauge|1520 mm|lk=on}}</nowiki></code> &rarr; {{Track gauge|1520 mm|lk=on}}
* <code><nowiki>{{Track gauge|1520 mm|al=on}}</nowiki></code> &rarr; {{Track gauge|1520 mm|al=on}}
* <code><nowiki>{{Track gauge|1520 mm|allk=on}}</nowiki></code> &rarr; {{Track gauge|1520 mm|allk=on}}

__TOC__

==Input options==
The first parameter specifies the gauge:
* {{code|1=<nowiki>{{Track gauge|1435 mm}}</nowiki>}} → {{Track gauge|1435 mm}}
* {{code|1=<nowiki>{{Track gauge|4 ft 8.5 in}}</nowiki>}} → {{Track gauge|4 ft 8.5 in}}
* {{code|1=<nowiki>{{Track gauge|4 ft 8 1/2 in}}</nowiki>}} → {{Track gauge|4 ft 8 1/2 in}}
* {{code|1=<nowiki>{{Track gauge|56.5 in}}</nowiki>}} → {{Track gauge|56.5 in}}
* {{code|1=<nowiki>{{Track gauge|Standard gauge}}</nowiki>}} → {{Track gauge|Standard gauge}}
Rail track gauges can be entered as they are defined: in units {{xt|mm}} or {{xt|ft&nbsp;in}}. Also common accepted names can be used, see [[#Named gauges|below]].

The input value (a length, in metric or imperial units) must be a defined track gauge. Currently 135 gauges are defined by metric units, and 148 by imperial units. Some are defined in both unit systems, such as the standard gauge.

* When an input value is ''not recognised'' by the template, the template simply returns the input as it is: <nowiki>{{Track gauge|25in}}</nowiki> &rarr; {{Track gauge|25in}}<br>
: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 [[#Maintenance categories|below]].
* Some gauges in metric are defined in metres: {{xt|1 m}} is recognised. However, it is not available for all metric defined gauges. Using {{code|mm}} is a safer bet.

===List of defined track gauges===
{{Track gauge/doc/input options}}

===Formatting input===
When entering a track gauge (like <code><nowiki>{{Track gauge|1435mm}}</nowiki></code>, 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 (<code>'</code> and <code>"</code>) may be used for [foot, inch]. Any [foot, inch] size can be entered in all-inches ({{nowrap|1=<code>4 ft 8 1/2 in</code>}} equals <code>56&nbsp;1/2&nbsp;in</code> and <code>56.5&nbsp;in</code>).

{| class="wikitable mw-collapsible uncollapsed" style="width:100%;"
|+ style="background:#CEF2E0; text-align:center; border=1px solid #A3BFB1" | Input options, examples
|-
! Parameter<br/>input
! Result
! Note
|-
| {{nowrap|{{code|1435 mm}}}} || {{nowrap|{{Track gauge|1435 mm}}}} || standard gauge
|-
| {{nowrap|{{code|standard gauge}}}} || {{Track gauge|standard gauge}} || standard gauge, by name
|-
| {{code|4 ft 8.5 in}} || {{Track gauge|4 ft 8.5 in}} || standard gauge, this way puts imperial units first
|-
| {{code|UK sg}} || {{Track gauge|UK sg}} || standard gauge, this way puts imperial units first
|-
| {{code|56.5 in}}  || {{Track gauge|56.5 in}} || standard gauge, by all-inches
|-
| {{code|56.5"}}  || {{Track gauge|56 1/2"}} || standard gauge, using primes
|-
| {{code|56 1/2 in}}  || {{Track gauge|56 1/2 in}} || standard gauge, using slash for fraction
|-
| {{code|1 m}} || {{Track gauge|1m}} || {{xt|1 m}} is recognised, but not many more in {{code|m}}. Better use {{code|mm}}
|-
| {{code|16.5 mm}} || {{Track gauge|16.5 mm}} || [[HO scale]] model railway
|-
| {{code|16.5 in}} || {{Track gauge|16.5 in}} || Miniature railway
|-
| {{nowrap|{{code|7 ft 0.25 in}}}} || {{nowrap|{{Track gauge|7 ft 0.25 in}}}} || Brunel
|-
| {{nowrap|{{code|2140 mm}}}} || {{Track gauge|2140 mm}} || Not recognised (so no converted value). This track gauge, Brunel's, is not defined in mm.
|-
| {{code|65 in}} || {{Track gauge|65 in}} || Input not recognised (so no converted value); output copies the input.<br> 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==
<pre>
{{Track gauge
|
| lk=on
| first=imp, met
| disp= s, /, 1, br, [], &lt;any literal text>
| al=on
| allk=on
| nowrap=off (default), on, all
| addcat=no
| unitlink=on
}}
</pre>

{| class="wikitable"
|+ style="background:#CEF2E0" | Optional parameters
|-
! Parameter
! What it does
! Example (code)
! colspan=2 | Example (output)
|-
| lk=on
| '''Links the defining measure''' (first measure)<br>"defined size" depends on input
| <code><nowiki>{{Track gauge|3ft6in|lk=on}}</nowiki></code><br>
<code><nowiki>{{Track gauge|1067mm|lk=on}}</nowiki></code>
| colspan=2 | {{Track gauge|3ft6in|lk=on}}<br>{{Track gauge|1067mm|lk=on}}
|-
| al=on
| Adds the '''alternate name''' after the gauge measurement values
| <code><nowiki>{{Track gauge|sg|al=on}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|al=on}}
|-
| allk=on
| Adds a '''wikilink to the alternate name''' where applicable
| <code><nowiki>{{Track gauge|sg|allk=on}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|allk=on}}
|-
| first=imp<br>first=met
| Puts the requested measure first (metric, imperial)
| <code><nowiki>{{Track gauge|1000mm|first=imp}}</nowiki></code>
| colspan=2 | {{Track gauge|1000mm|first=imp}}
|-
| 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 {{para|disp}} are processed as described: 1, s, /, br).
| <code><nowiki>{{Track gauge|sg|disp=also defined as being}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|disp=also defined as being}}
|-
| disp=s or /
| Uses a '''slash as a separator''' rather than parentheses
| <code><nowiki>{{Track gauge|sg|disp=s}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|disp=s}}
|-
| disp=[]
| Uses a '''square brackets''' rather than parentheses
| <code><nowiki>{{Track gauge|sg|disp=[]}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|disp=[]}}
|-
| disp=1
| Only shows the '''first measure''' (may be used when repeated on a page<br>or in conjunction with <code>first=</code> to display the output only)
| <code><nowiki>{{Track gauge|sg|disp=1}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|disp=1}}
|-
| disp=br
| '''Forces a line break''' after the first size (and also before any gauge name)
| <code><nowiki>{{Track gauge|sg|disp=br}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|disp=br}}
|-
| 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.)
| <code><nowiki>{{Track gauge|sg|nowrap=on}}</nowiki></code>
| style="width:7em;" | {{Track gauge|sg|nowrap=on}}
|-
| addcat=no
| Will not add a maintenance category
| <code><nowiki>{{Track gauge|sg|addcat=no}}</nowiki></code>
| style="width:7em;" | {{Track gauge|sg|addcat=no}}
|-
| unitlink=on
| Adds wikilinks to the '''measurement unit''' labels
| <code><nowiki>{{Track gauge|sg|unitlink=on}}</nowiki></code>
| colspan=2 | {{Track gauge|sg|unitlink=on}}

|}

* Names can be ''universal'', being defined worldwide. For example: Iberian gauge, {{Track gauge|Iberian|al=on}}. Other names can be ''local''or culturally restricted, for example the name "Cape gauge" is used in South Africa for {{Track gauge|cape}}, but not in Japan (in Japan that same track gauge is not named).
* Also, two sizes can lead to one gauge name.

==Named gauges==
Established gauge names can be entered. The word "gauge" can be omitted. Case-insensitive (A=a). See also the {{para|al|}}, {{para|allk|}} parameters ([[#Parameters|below]]), to show a gauge name in the outcome.
{| class="wikitable mw-collapsible uncollapsed sortable" style="width:100%;"
|-
! Input
! Result
! Note
|-
| <nowiki>{{Track gauge|Baltimore gauge|al=on}}</nowiki> || {{Track gauge|Baltimore gauge|al=on}}
|-
| <nowiki>{{Track gauge|Baltimore|al=on}}</nowiki> || {{Track gauge|Baltimore|al=on}} || Omitting "&nbsp;gauge", same effect
|-
| <nowiki>{{Track gauge|baltimore|al=on}}</nowiki> || {{Track gauge|baltimore|al=on}} || Case-insensitive (A=a)
|-
| <nowiki>{{Track gauge|baltimore|al=on}}</nowiki> || {{Track gauge|baltimore|al=on}} || {{para|al|on}} shows the alternative (name)
|-
| <nowiki>{{Track gauge|baltimore|allk=on}}</nowiki> || {{Track gauge|baltimore|allk=on}} || {{para|allk|on}} shows the alternative (name), linked
|-
| <nowiki>{{Track gauge|baltimore|lk=on|al=on}}</nowiki> || {{Track gauge|baltimore|lk=on|al=on}} || {{para|lk|on}} links the size (as always)
|-
| <nowiki>{{Track gauge|Baltimore streetcar gauge|al=on}}</nowiki> || {{Track gauge|Baltimore streetcar gauge|al=on}} || This one has more names
|-
| <nowiki>{{Track gauge|Bosnian|al=on}}</nowiki> || {{Track gauge|Bosnian|al=on}} ||
|-
| <nowiki>{{Track gauge|Brunel|al=on}}</nowiki> || {{Track gauge|Brunel|al=on}} ||
|-
| <nowiki>{{Track gauge|Cape|al=on}}</nowiki> || {{Track gauge|Cape|al=on}} ||
|-
| <nowiki>{{Track gauge|Iberian|al=on}}</nowiki> || {{Track gauge|Iberian|al=on}} ||
|-
| <nowiki>{{Track gauge|Indian|al=on}}</nowiki> || {{Track gauge|Indian|al=on}} ||
|-
| <nowiki>{{Track gauge|Victorian|al=on}}</nowiki> || {{Track gauge|Victorian|al=on}} ||
|-
| <nowiki>{{Track gauge|Irish|al=on}}</nowiki> || {{Track gauge|Irish|al=on}} ||
|-
| <nowiki>{{Track gauge|metre|al=on}}</nowiki> || {{Track gauge|metre|al=on}} ||
|-
| <nowiki>{{Track gauge|Ohio|al=on}}</nowiki> || {{Track gauge|Ohio|al=on}} ||
|-
| <nowiki>{{Track gauge|Pennsylvania|al=on}}</nowiki> || {{Track gauge|Pennsylvania|al=on}} ||
|-
| <nowiki>{{Track gauge|Pennsylvania trolley|al=on}}</nowiki> || {{Track gauge|Pennsylvania trolley|al=on}} ||
|-
| <nowiki>{{Track gauge|Russian|al=on}}</nowiki> || {{Track gauge|Russian|al=on}} ||
|-
| <nowiki>{{Track gauge|Scotch|al=on}}</nowiki> || {{Track gauge|Scotch|al=on}} ||
|-
| <nowiki>{{Track gauge|standard gauge|al=on}}</nowiki> || {{Track gauge|standard gauge|al=on}} || Also: "sg", "metsg" (metric&nbsp;units first)
|-
| <nowiki>{{Track gauge|US sg|al=on}}</nowiki> || {{Track gauge|US sg|al=on}} || Also: "imp sg", "UK sg", "NA sg" (imperial&nbsp;units first)
|-
| <nowiki>{{Track gauge|Swedish three foot|al=on}}</nowiki> || {{Track gauge|Swedish three foot|al=on}} ||
|-
| <nowiki>{{Track gauge|Swedish|al=on}}</nowiki> || {{Track gauge|Swedish|al=on}} ||
|-
| <nowiki>{{Track gauge|Toronto|al=on}}</nowiki> || {{Track gauge|Toronto|al=on}} ||
|}

==English variant ([[WP:ENGVAR|ENGVAR]])==
This template defaults to UK-English. For articles written in US-English, set parameter {{para||engvar}} to {{para|engvar|en-US}}. In this situation, the US-English spelling is shown:
:<code><nowiki>{{track gauge|1000mm|allk=on|engvar=en-US}}</nowiki></code> &rarr; {{track gauge|1000mm|allk=on|engvar=en-US}}

As of 2016, the only two gauges impacted are the 1000 mm and 1009 mm gauges. In UK-English these are spelled metre, in US-English these are spelled meter.

==Why not use {{tlf|Convert}}?==
To convert a track gauge, using {{tl|Convert}} comes to mind. For example, standard gauge:
*  <nowiki>{{Convert|1435|mm|ftin|abbr=on}</nowiki>} &rarr; {{Convert|1435|mm|ftin|abbr=on}}

:However, this has some disadvantages. First of all, track gauges are '''defined''' by an  institute, not just measured. The list of those ''defined track gauges'' is limited, and overseeable (today some 270 physical sizes are defined).

:Using {{tlf|Track gauge}} 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: {{Track gauge|1067mm|lk=on}}.

: Further more, the template allows to recognise named gauges such as "Russian gauge".

==Tracking category==
: {{tlf|Track gauge}} detects that an ''undefined gauge'' is entered, and signal the page for maintenance. For example, metre gauge is only defined in metric. Entering an imperial size would categorise that article in {{clc|Articles using Template:Track gauge with unrecognized input}}.

==TemplateData==
{{TemplateData header}}
{{Collapse top|bg=#ccc|title=[[Wikipedia:TemplateData|TemplateData]]}}
<templatedata>
{
	"description": "The template formats a track gauge size into standard notation and adds the conversion into the imperial/metric (other) size",
	"params": {
		"1": {
			"label": "Track gauge definition",
			"description": "Defined track gauge, in mm or ft in. Also can accept: ' '', m, gauge name",
			"type": "string",
			"required": true
		},
		"lk": {
			"label": "Link top measurement units",
			"description": "=on: adds link to the gauge defining article",
			"type": "string"
		},
		"al": {
			"label": "Alternative name",
			"description": "=on: Add gauge name (if existing)",
			"type": "string"
		},
		"allk": {
			"label": "Alternative name, linked",
			"description": "=on: Add gauge name (if existing) and link to its wiki page",
			"type": "string"
		},
		"disp": {
			"label": "Display converted gauge",
			"description": "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.",
			"type": "string",
			"default": "(...) brackets"
		},
		"first": {
			"label": "Which unit to mention first",
			"description": "=met: metric first; =imp: imperial first (default: input unit)",
			"type": "string",
			"default": "By input"
		},
		"nowrap": {
			"label": "Allow line wrapping of text",
			"description": "wrap=off, on, all: allows lin breaking between the two measurements. Default: on. 'all' disallows linebreaking wiothing an alternative name",
			"type": "string",
			"default": "off"
		},
		"unitlink": {
			"label": "Wikilink units",
			"description": "=on: do wikilink",
			"type": "string"
		},
		"addcat": {
			"label": "Categorize page",
			"description": "=no: do not categorize",
			"type": "string",
			"default": "yes"
		},
		"engvar": {
			"label": "ENGVAR",
			"description": "When set to en-US, \"metRE\" is spelled \"metER\"",
			"example": "meter gauge only",
			"default": "en-UK"
		},
		"comma": {}
	},
	"paramOrder": [
		"1",
		"lk",
		"al",
		"allk",
		"disp",
		"first",
		"nowrap",
		"unitlink",
		"addcat",
		"engvar",
		"comma"
	]
}
</templatedata>
{{Collapse bottom}}

==See also==
{{navbox track gauge categories|state=collapsed|sortnotice=no|commonscat=}}
* {{tl|Track gauge/document gauge}}
* {{tl|Track gauge/status}} - talkpage infobox of a track gauge, to be used on the talkpage
; Sources
* [[List of scale model sizes]]
* [[Rail transport modelling scales]]

==External links; sources==
; Sources
* [http://www.lrta.org/world/worldind.html#index Light Rail Transit Association (LRTA)]
* {{cite web|url=http://www.tramz.com/tg.html|title=E{{lc:LECTRIC TRANSPORT IN LATIN AMERICA}}|first1=Allen|last1=Morrisson|date=2013}} Latin America is very well covered
* {{cite web|url=http://www.lrta.org/world/worldind.html|title=A world of trams and urban transit|publisher=[[Light Rail Transit Association]] (LRTA))}} UK based, covering most countries

* [[:de:Liste_der_Spurweiten]] (checking here in [[Template talk:Track gauge/dewiki list]])

;Scaled rail models
* {{cite web|url=http://www.nmra.org/standards/sandrp/S-3_1ProtoTrackwork.html|title=S-3.1 Trackwork, Proto & Fine Scales|publisher=[[NMRA]]|date=2004}}
* {{cite web|url=http://www.nmra.org/standards/sandrp/pdf/S-3.2%202010.02.24.pdf|title=S-3.2 Trackwork Standard Scales (metric)|date=2010|publisher=[[NMRA]]}}

:[[DGEG]] (German) [https://dgeg.de/107-Spurweiten_Auswahl Spurweiten_Auswahl 107-Spurweiten_Auswahl Spurweiten_Auswahl]

<includeonly>{{sandbox other||
[[Category:Rail transport templates]]
[[Category:Templates that add a tracking category]]
[[Category:Conversion templates]]
[[Category:Convert-like templates]]
}}</includeonly>