View source for Template:Rail color box/doc

{{Documentation subpage}}
{{Sidebar Adjacent stations}}
{{tsh|rcb}}
== Usage ==
This template 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.

{| class="wikitable"
! Parameter
! Description
|-
| <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:BJS color]] or [[Module:Adjacent stations/Taipei Metro]]
|-
| <code>line</code> or <code>2</code>
| The line or service to be linked
|-
| <code>inline</code> or <code>3</code>
| An optional parameter to create a colorbox and link suitable for use inline with other text<br/>Valid arguments are '''yes''', '''small''', '''link''', '''box''', '''route''', '''xroute''' and '''croute'''
|-
| <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
|-
| <code>note</code>
| An optional note with more information, added at the end
|}

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/services have their own colors.

The template can be abbreviated as {{tl|rcb}}. All examples use this abbreviated form.

=== Examples ===
<code><nowiki>{{rcb|system=Amtrak|line=Southwest Chief}}</nowiki></code> and <code><nowiki>{{rcb|Amtrak|Southwest Chief}}</nowiki></code> produce
{{rcb|Amtrak|Southwest Chief}}

<code><nowiki>{{rcb|SEPTA|Wilmington/Newark|note=(rush hour service only)}}</nowiki></code> produces
{{rcb|SEPTA|Wilmington/Newark|note=(rush hour service only)}}

The optional parameter {{para|inline}} (or the third unnamed parameter) allows different display options for inline text.

{| class="wikitable"
|-
| <code>yes</code> || {{rcb|RTD|C|yes}} || {{rcb|Washington Metro|Green|yes}} || inline color box with link
|-
| <code>small</code> || {{rcb|RTD|C|small}} || {{rcb|Washington Metro|Green|small}} || smaller color box with link
|-
| <code>dot</code> || {{rcb|RTD|C|dot}} || {{rcb|Washington Metro|Green|dot}} || small circle with link
|-
| <code>square</code> || {{rcb|RTD|C|square}} || {{rcb|Washington Metro|Green|square}} || small square with link
|-
| <code>link</code> || {{rcb|RTD|C|link}} || {{rcb|Washington Metro|Green|link}} || linked box
|-
| <code>ldot</code> || {{rcb|RTD|C|ldot}} || {{rcb|Washington Metro|Green|ldot}} || linked circle
|-
| <code>lsquare</code> || {{rcb|RTD|C|lsquare}} || {{rcb|Washington Metro|Green|lsquare}} || linked square
|-
| <code>box</code> || {{rcb|RTD|C|box}} || {{rcb|Washington Metro|Green|box}} || box with link omitted
|-
| <code>route</code> || {{rcb|RTD|C|route}} || {{rcb|Washington Metro|Green|route}} || box with background color
|-
| <code>croute</code> || {{rcb|RTD|C|croute}} || {{rcb|Washington Metro|Green|croute}} || box with background color and border radius
|-
| <code>xroute</code> || {{rcb|RTD|C|xroute}} || {{rcb|Washington Metro|Green|xroute}} || box with colored text and border radius
|}

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.

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

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

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

==TemplateData==
{{TemplateData header}}
<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>