Template:Rail color box/doc
This is a documentation subpage for Template:Rail color box. It contains usage information, categories and other content that is not part of the original template page. |
Pages related to |
Module:Adjacent stations |
---|
(talk | sandbox | sub-pages) |
{{Infobox station}} |
(talk | sandbox | testcases) |
{{Station link}} |
(talk | sandbox | testcases) |
{{Rail color}} |
(talk | sandbox | testcases) |
{{Line link}} |
(talk | sandbox | testcases) |
{{Rail icon}} |
(talk | sandbox | testcases) |
{{Rail color box}} |
(talk | sandbox | testcases) |
{{Adjacent stations}} |
(talk | sandbox | testcases) |
Usage[edit source]
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.
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:RTD 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 colorbox and link suitable for use inline with other text Valid arguments are yes, small, link, box, route, xroute and croute |
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/services have their own colors.
The template can be abbreviated as {{rcb}}. All examples use this abbreviated form.
Examples[edit source]
{{rcb|system=Amtrak|line=Southwest Chief}}
and {{rcb|Amtrak|Southwest Chief}}
produce
{{rcb|SEPTA|Wilmington/Newark|note=(rush hour service only)}}
produces
The optional parameter |inline=
(or the third unnamed parameter) allows different display options for inline text.
yes |
C Line | Green Line | inline color box with link |
small |
C Line | Green Line | smaller color box with link |
dot |
● C Line | ● Green Line | small circle with link |
square |
■ C Line | ■ Green Line | small square with link |
link |
linked box | ||
ldot |
● | ● | linked circle |
lsquare |
■ | ■ | linked square |
box |
box with link omitted | ||
route |
C | Green | box with background color |
croute |
C | Green | box with background color and border radius |
xroute |
C | Green | 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: "border color"
, "text color"
and "short name"
. Note that the "background color"
key is not used by this template.
System abbreviations[edit source]
Lists of available systems are at Category:Rail transport color templates and Special:PrefixIndex/Module:Adjacent stations/.
Variants[edit source]
Template | Description | Example |
---|---|---|
{{Color box}} | a small color box with black borders and text color | or ORANGE |
{{RouteBox}} | a borderless version with text color and wikilinks | ORANGE |
{{Colorbull}} | a colored bullet with wikilinks | ■ |
{{Legend2}} | another borderless version | |
{{Color sample}} | a small color box with black borders | |
{{Swatch inline}} | orange | |
{{Background color}} | orange | |
{{Rail color box}} | a version with more display options (part of Module:Adjacent stations) |
●, Orange, etc. |
{{Diagonal split color box}} | a small color box split diagonally | B R B R WB R W R WB W B W B B B B B W B B B B B B |
{{Motor type}} | A small color box corresponding to the motor type | SI A |
External links[edit source]
- Template:Rail color box/doc at Wikipedia, the free Terran-based encyclopedia that anyone can edit.