Дидани манбаъи Шаблон:Track gauge/doc

{{Documentation subpage}}
{{lua|Module:Track gauge}}
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|al=on|lk=on}}</nowiki></code> &rarr; {{Track gauge|1520 mm|al=on|lk=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|Russian gauge}}</nowiki>}} → {{Track gauge|Russian 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]].

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 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!).
|}

* When an input value is ''not recognised'' by the template (see last two table examples), 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|1m}} is recognised. However, it is not available for all metric defined gauges. Using {{code|mm}} is a safer bet.

=== Aliases (list of defined track gauges) ===
{{Track gauge/doc/input options}}

==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}}
|-
| {{!xt|1=wrap=y}}
| '''Deprecated'''. The same as {{xt|1=nowrap=off}}.<br/>This is the ''default behaviour'', so can be removed without harm.
| 
|
|}

* 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 gaugfe 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 collapsible uncollapsed sortable" style="width:100%;"
|-
! Input
! Result
! Note
|-
| <nowiki>{{Track gauge|Baltimore gauge}}</nowiki> || {{Track gauge|Baltimore gauge}}
|-
| <nowiki>{{Track gauge|Baltimore}}</nowiki> || {{Track gauge|Baltimore}} || Omitting "&nbsp;gauge", same effect
|-
| <nowiki>{{Track gauge|baltimore}}</nowiki> || {{Track gauge|baltimore}} || 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}}</nowiki> || {{Track gauge|Baltimore streetcar gauge}} || This one has more names
|-
| <nowiki>{{Track gauge|Bosnian}}</nowiki> || {{Track gauge|Bosnian}} ||
|-
| <nowiki>{{Track gauge|Brunel}}</nowiki> || {{Track gauge|Brunel}} ||
|-
| <nowiki>{{Track gauge|Cape}}</nowiki> || {{Track gauge|Cape}} ||
|-
| <nowiki>{{Track gauge|Iberian}}</nowiki> || {{Track gauge|Iberian}} ||
|-
| <nowiki>{{Track gauge|Indian}}</nowiki> || {{Track gauge|Indian}} ||
|-
| <nowiki>{{Track gauge|Victorian}}</nowiki> || {{Track gauge|Victorian}} ||
|-
| <nowiki>{{Track gauge|Irish}}</nowiki> || {{Track gauge|Irish}} ||
|-
| <nowiki>{{Track gauge|metre}}</nowiki> || {{Track gauge|metre}} ||
|-
| <nowiki>{{Track gauge|Ohio}}</nowiki> || {{Track gauge|Ohio}} ||
|-
| <nowiki>{{Track gauge|Pennsylvania}}</nowiki> || {{Track gauge|Pennsylvania}} ||
|-
| <nowiki>{{Track gauge|Pennsylvania trolley}}</nowiki> || {{Track gauge|Pennsylvania trolley}} ||
|-
| <nowiki>{{Track gauge|Russian}}</nowiki> || {{Track gauge|Russian}} ||
|-
| <nowiki>{{Track gauge|Scotch}}</nowiki> || {{Track gauge|Scotch}} ||
|-
| <nowiki>{{Track gauge|standard gauge}}</nowiki> || {{Track gauge|standard gauge}} || Also: "sg", "metsg" (metric&nbsp;units first)
|-
| <nowiki>{{Track gauge|US sg}}</nowiki> || {{Track gauge|US sg}} || Also: "imp sg", "UK sg", "NA sg" (imperial&nbsp;units first)
|-
| <nowiki>{{Track gauge|Swedish three foot}}</nowiki> || {{Track gauge|Swedish three foot}} ||
|-
| <nowiki>{{Track gauge|Swedish}}</nowiki> || {{Track gauge|Swedish}} ||
|-
| <nowiki>{{Track gauge|Toronto}}</nowiki> || {{Track gauge|Toronto}} ||
|}

==Background==
There are two maintenance categories under [[:Category:Wikipedia track gauge categories]] that can help in maintenance of the template.
* [[:Category:Articles using template 'Track gauge' with unrecognized input]]: input to be checked. No error message on the page, but it needs attention.
* [[:Category:Pages with no gauge entered in Infobox rail line]]: template {{tl|Infobox rail line}} is used, but parameter {{para|gauge}} is empty.

Sometimes an input parameter is ''not recognised'' by the template (that is: it is not defined in the internal data list). The article page with this <nowiki>{{Track gauge|some unknown gauge}}</nowiki> is added to the maintenance category (named [[:Category:Articles using template 'Track gauge' with unrecognized input]]). Interested editors will check that category, and can edit that article page (for a spelling error), or [[Template talk:Track gauge|propose]] to add that track gauge to the template.

==TemplateData==
{{Collapse top|bg=#ccc|title=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"
		},
		"addcat": {
			"label": "Categorize page",
			"description": "=no: do not categorize",
			"type": "string",
			"default": "yes"
		},
		"wrap": {
			"label": "Allow wrapping",
			"description": "Deprecated. Is default behaviour",
			"type": "string"
		}
	}
}
</templatedata>
{{Collapse bottom}}

==See also==
{{navbox rail gauge categories|state=collapsed|sortnotice=no|commonscat=}}
{{Math templates|conversion|state=collapsed}}
* {{tl|Track gauge/document gauge}}

;Sources
* [[List of scale model sizes]]
* [[Rail transport modelling scales]]

* [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

;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]]}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[Category:Rail transport gauge templates|{{PAGENAME}}]]
[[Гурӯҳ:Шаблонҳои табдилдиҳӣ]]
[[Category:Subtemplates of Template Convert/non-scalable units|Rail gauge]]
}}</includeonly>