Jump to content

Template:Rail color box/doc

From Wikipedia, the free encyclopedia

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

[edit]

Parameters

[edit]
Template parameters
Parameter Description
system or 1 An identifier to specify which system's color and line article name convention should be used. Either Module:Adjacent stations/system or Template:system color must exist, e.g. Template:RE-BB color or Module:Adjacent stations/Taipei Metro
line or 2 The line or service to be linked.
inline or 3 An optional parameter to create a color box and link suitable for use inline with other text:
Value Description Example Example
yes Inline color box with link      C Line      Green Line
small Line strip with link   C Line   Green Line
dot Small circle with link C Line Green Line
square Small square with link  C Line  Green Line
link Linked box          
ldot Linked small circle
lsquare Linked small square
box Box with link omitted.          
route Box with text C Green
broute Bordered box with text C Green
croute Box with text and border radius C Green
xroute Transparent box with text and border radius C Green
type This adds " – type" to the end, where type 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.
note 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 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: ["border color"], ["text color"] and ["short name"]. Note that the ["background color"] key is not used by this template.

TemplateData

[edit]
TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Rail color box in articles based on its TemplateData.

TemplateData for Rail color box

Template which generates colored boxes to indicate rail lines, optionally with a link to the line's article.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
System1 system

no description

Stringrequired
Line2 line

no description

Stringsuggested
Inline display type3 inline

no description

Stringsuggested
Type (branch/service)type

no description

Stringoptional
Notenote

no description

Stringoptional

Examples

[edit]

System abbreviations

[edit]

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

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 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 Southeastern Pennsylvania Transportation Authority
SFRTA Tri-Rail
STLLR 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

[edit]
Color box templates
Template Description Example
{{Color box}} Color box size with black borders and text color. Standard size.   or  ORANGE 
{{Color box striped}} Striped color box. Standard size.     
{{RouteBox}} Borderless color box with text color and wikilinks.  ORANGE 
{{Colorbull}} Colored bullet with wikilinks.
{{Legend inline}} Color box size with black borders. Standard size.   
{{Color sample}} Color box size with black borders. Smaller size.
{{Swatch inline}} orange
{{Background color}} orange
{{Rail color box}} A version with more display options. Part of Module:Adjacent stations , Orange
{{Diagonal split color box}} Color box split diagonally. Standard size.