Template:RouteBox/doc
This is a documentation subpage for Template:RouteBox. 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. |
This template is similar to {{Color box }}, but provides for both wikilinks and text color and omits the contrasting border.
Usage
{{RouteBox|text|link|box color|text color|border=|bold=}}
|
can be abbreviated to {{rbox|…}}
|
|
text (bold) to be displayed in the box |
|
any valid wikilink; [[ and ]] are not required; can be omitted if no link is wanted
|
|
background color of the box; default is black; can be omitted if text color is not specified
|
|
optional; default is white |
|
optional; default is box color |
|
optional; default is yes |
Examples
{{RouteBox|Line|Line}}
→ Template:Rbox
{{rbox|Circle line|Circle line (London Underground)|#{{rcr|London Underground|Circle}}|#{{rcr|London Underground|Piccadilly}}}}
→ Circle line
{{RouteBox|Text||bold=no}}
→ Template:Rbox
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. |
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
RouteBox
Adds a colored box with no border.
Parameter | Description | Type | Status | |
---|---|---|---|---|
text | 1 | text (bold by default) to be displayed in the box
| String | suggested |
link | 2 | The name of the page to link towards; can be omitted if no link is wanted
| Page name | optional |
box color | 3 | background color of the box; can be omitted if text color is not specified
| String | suggested |
text color | 4 | color of the text
| String | optional |
border | border | color of the border; enabled by default
| String | optional |
bold | bold | bolds the text; enabled by default
| String | optional |