Template:Rail color box/doc: Difference between revisions
m (→Parameters) |
m (1 revision imported: initial setup) |
(No difference)
|
Latest revision as of 06:57, 30 August 2024
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. |
This template is used on many pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
Template:Sidebar Adjacent stations
Uses Lua: |
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
- {{Rail color box|system=|line=|inline=|type=|note=}}
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
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
TemplateData documentation used by VisualEditor and other tools | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Template which generates colored boxes to indicate rail lines, optionally with a link to the line's article.
|
Examples
- {{Rail color box|system=Amtrak|line=Southwest Chief}} and {{Rail color box|Amtrak|Southwest Chief}} produce Script error: No such module "Adjacent stations"..
- {{Rail color box|SEPTA|Wilmington/Newark|note=(rush hour service only)}} produces Script error: No such module "Adjacent stations"..
System abbreviations
Lists of available systems are at Category:Rail transport color templates and Special:PrefixIndex/Module:Adjacent stations/.
Variants
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 | Script error: No such module "Adjacent stations"., Script error: No such module "Adjacent stations". |
{{Diagonal split color box }} | Color box split diagonally. Standard size. |