Lihimi Tɛmplet:Rail color box/doc ni yi shɛli na

{{Documentation subpage}}
{{High-use}}
{{Sidebar Adjacent stations}}
{{Template shortcut|rcb}}
{{Lua|Module:Adjacent stations}}

'''Template:Rail color box''' is intended to be used within station and line infoboxes, diagrams, navboxes and tables to show a small color box and a link to the associated line or service name. Its use should be avoided within body text.

== Usage ==
* {{tlx|Rail color box|system{{=}}|line{{=}}|inline{{=}}|type{{=}}|note{{=}}}}

== Parameters ==
{| class="wikitable"
|+ Template parameters
|-
! scope="col" | Parameter
! scope="col" | Description
|-
! scope="row" | <code>system</code> or <code>1</code>
| An identifier to specify which system's color and line article name convention should be used. Either <code>Module:Adjacent stations/<var>system</var></code> or <code>Template:<var>system</var> color</code> ''must'' exist, e.g. [[Template:RE-BB color]] or [[Module:Adjacent stations/Taipei Metro]]
|-
! scope="row" | <code>line</code> or <code>2</code>
| The line or service to be linked.
|-
! scope="row" | <code>inline</code> or <code>3</code>
| An optional parameter to create a color box and link suitable for use inline with other text. Valid arguments are listed in the table below.
|-
! scope="row" | <code>type</code>
| This adds " – <var>type</var>" to the end, where <var>type</var> is the parameter value (which may be changed by a module subpage), and also passes the value to the data template or module. Typically a service or branch of the line.
|-
! scope="row" | <code>note</code>
| An optional note with more information added at the end.
|}

{| class="wikitable"
|+ {{para|inline}} accepted values
|-
! scope="col" | Parameter
! scope="col" | Description
! scope="col" | Example
! scope="col" | Example
|-
! scope="row" | {{Kbd|yes}}
| Inline color box with link.
| {{Rail color box|RTD|C|yes}}
| {{Rail color box|Washington Metro|Green|yes}}
|-
! scope="row" | {{Kbd|small}}
| Line strip with link.
| {{Rail color box|RTD|C|small}}
| {{Rail color box|Washington Metro|Green|small}}
|-
! scope="row" | {{Kbd|dot}}
| Small circle with link.
| {{Rail color box|RTD|C|dot}}
| {{Rail color box|Washington Metro|Green|dot}}
|-
! scope="row" | {{Kbd|square}}
| Small square with link.
| {{Rail color box|RTD|C|square}}
| {{Rail color box|Washington Metro|Green|square}}
|-
! scope="row" | {{Kbd|link}}
| Linked box.
| {{Rail color box|RTD|C|link}}
| {{Rail color box|Washington Metro|Green|link}}
|-
! scope="row" | {{Kbd|ldot}}
| Linked small circle.
| {{Rail color box|RTD|C|ldot}}
| {{Rail color box|Washington Metro|Green|ldot}}
|-
! scope="row" | {{Kbd|lsquare}}
| Linked small square.
| {{Rail color box|RTD|C|lsquare}}
| {{Rail color box|Washington Metro|Green|lsquare}}
|-
! scope="row" | {{Kbd|box}}
| Box with link omitted.
| {{Rail color box|RTD|C|box}}
| {{Rail color box|Washington Metro|Green|box}}
|-
! scope="row" | {{Kbd|route}}
| Box with text.
| {{Rail color box|RTD|C|route}}
| {{Rail color box|Washington Metro|Green|route}}
|-
! scope="row" | {{Kbd|croute}}
| Box with text and border radius.
| {{Rail color box|RTD|C|croute}}
| {{Rail color box|Washington Metro|Green|croute}}
|-
! scope="row" | {{Kbd|xroute}}
| Transparent box with text and border radius.
| {{Rail color box|RTD|C|xroute}}
| {{Rail color box|Washington Metro|Green|xroute}}
|}

For systems where multiple colors are used to designate different lines, the appropriate color will be selected based on the combination of the system and line parameters. The same is done for systems where types or services have their own colors. Some options, such as setting the text color, border color, and the short name for the latter three, require the use of a module subpage. Each line can have its own values, as can each type. The table keys for line and type tables are the same: <code>["border color"]</code>, <code>["text color"]</code> and <code>["short name"]</code>. Note that the <code>["background color"]</code> key is not used by this template.

===TemplateData===
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"system"
			],
			"label": "System",
			"type": "string",
			"required": true,
			"suggested": true
		},
		"2": {
			"aliases": [
				"line"
			],
			"label": "Line",
			"type": "string",
			"suggested": true
		},
		"3": {
			"aliases": [
				"inline"
			],
			"label": "Inline display type",
			"type": "string",
			"suggested": true
		},
		"note": {
			"type": "string",
			"label": "Note"
		},
		"type": {
			"label": "Type (branch/service)",
			"type": "string"
		}
	},
	"description": "Template which generates colored boxes to indicate rail lines, optionally with a link to the line's article.",
	"paramOrder": [
		"1",
		"2",
		"3",
		"type",
		"note"
	],
	"format": "inline"
}
</templatedata>
{{Collapse bottom}}

== Examples ==
* {{tlx|Rail color box|system{{=}}Amtrak|line{{=}}Southwest Chief}} and {{tlx|Rail color box|Amtrak|Southwest Chief}} produce {{Rail color box|Amtrak|Southwest Chief}}.
* {{tlx|Rail color box|SEPTA|Wilmington/Newark|note{{=}}(rush hour service only)}} produces {{Rail color box|SEPTA|Wilmington/Newark|note=(rush hour service only)}}.

== System abbreviations ==
Lists of available systems are at [[:Category:Rail transport color templates]] and [[Special:PrefixIndex/Module:Adjacent stations/]].

{| class="wikitable sortable mw-collapsible"
! scope="col" | Abbreviation
! scope="col" | System
|-
! scope="row" | AMT
| [[Agence métropolitaine de transport]]
|-
! scope="row" | BART
| [[Bay Area Rapid Transit]]
|-
! scope="row" | CTA
| [[Chicago Transit Authority]]
|-
! scope="row" | DART
| [[Dallas Area Rapid Transit]]
|-
! scope="row" | HBLR
| [[Hudson–Bergen Light Rail]]
|-
! scope="row" | KAT
| [[Kenosha Transit]]
|-
! scope="row" | LACMTA
| [[Los Angeles County Metro Rail]]
|-
! scope="row" | LIRR
| [[Long Island Rail Road]]
|-
! scope="row" | MARC
| [[MARC Train]]
|-
! scope="row" | MARTA
| [[Metropolitan Atlanta Rapid Transit Authority]]
|-
! scope="row" | MBTA
| [[MBTA Commuter Rail]]
|-
! scope="row" | METROMN
| [[Metro (Minnesota)]]
|-
! scope="row" | MNRR
| [[Metro-North Railroad]]
|-
! scope="row" | MUNI
| [[Muni Metro]]
|-
! scope="row" | NJT
| [[NJ Transit]]
|-
! scope="row" | NMRX
| [[New Mexico Rail Runner Express]]
|-
! scope="row" | NYCRR
| [[New York Central Railroad]]
|-
! scope="row" | PATCO
| [[Port Authority Transit Corporation]]
|-
! scope="row" | PATH
| [[Port Authority Trans-Hudson]]
|-
! scope="row" | PLR
| [[Pittsburgh Light Rail]]
|-
! scope="row" | RIRTR
| [[Rochester Subway]]
|-
! scope="row" | RTD
| [[Denver]] [[Regional Transportation District]]
|-
! scope="row" | SCAX
| [[Metrolink (California)]]
|-
! scope="row" | SCVTA
| [[Santa Clara Valley Transportation Authority light rail]]
|-
! scope="row" | SEPTA
| [[SEPTA|Southeastern Pennsylvania Transportation Authority]]
|-
! scope="row" | SFRTA
| [[Tri-Rail]]
|-
! scope="row" | STLLR
| [[Link light rail|Sound Transit Link light rail]]
|-
! scope="row" | SNDX
| [[Sounder commuter rail]]
|-
! scope="row" | STML
| [[St Louis MetroLink]]
|-
! scope="row" | TMTC
| [[MAX Light Rail]]
|-
! scope="row" | VMR
| [[Valley Metro Rail]]
|-
! scope="row" | VREX
| [[Virginia Railway Express]]
|-
! scope="row" | WMATA
| [[Washington Metropolitan Area Transit Authority]]
|}

== Variants ==
{{Color box templates}}

<includeonly>{{Sandbox other||
[[Category:Rail transport templates]]
}}</includeonly>