View source for Template:RouteBox/doc

{{Documentation subpage}}
{{High-use}}
<!-- Categories and interwikis go at the bottom of this page. -->
{{Template shortcut|Rbox}}

This template is similar to {{tl|Color box}}, but provides for both [[wikilink]]s and text color and omits the contrasting border.

== Usage ==
<code>&#123;&#123;RouteBox|''text''|''link''|''box color''|''text color''|''border=''|''bold=''}}</code>
{|
|-
|
*<code>RouteBox</code>
|can be abbreviated to <code><nowiki>{{rbox|…}}</nowiki></code>
|-
|
*<code>''text''</code>
|text (bold) to be displayed in the box
|-
|
*<code>''link''</code>
|any valid wikilink; <code>&#91;&#91;</code> and <code>]]</code> are not required; can be omitted if no link is wanted
|-
|
*<code>''box color''</code>
|background color of the box; default is '''black'''; can be omitted if <code>''text color''</code> is not specified
|-
|
*<code>''text color''</code> 
|optional; default is '''white'''
|-
|
*<code>''border=''</code> 
|optional; default is '''box color'''
|-
|
*<code>''bold=''</code> 
|optional; default is '''yes'''
|}

=== Examples ===
<code><nowiki>{{RouteBox|Line|Line}}</nowiki></code> → {{rbox|Line|Line}}

<code><nowiki>{{rbox|Circle line|Circle line (London Underground)|#{{rcr|London Underground|Circle}}|#{{rcr|London Underground|Piccadilly}}}}</nowiki></code> → {{RouteBox|Circle line|Circle line (London Underground)|#{{rcr|London Underground|Circle}}|#{{rcr|London Underground|Piccadilly}}}}

<code><nowiki>{{RouteBox|Text||bold=no}}</nowiki></code> → {{rbox|Text||bold=no}}

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

== TemplateData ==
{{TemplateData header}}

<templatedata>
{
	"params": {
		"1": {
			"label": "text",
			"description": "text (bold by default) to be displayed in the box",
			"example": "Circle line",
			"type": "string",
			"suggested": true
		},
		"2": {
			"label": "link",
			"description": "The name of the page to link towards; can be omitted if no link is wanted",
			"example": "Circle line (London Underground)",
			"type": "wiki-page-name"
		},
		"3": {
			"label": "box color",
			"description": "background color of the box; can be omitted if text color is not specified",
			"example": "yellow",
			"type": "string",
			"default": "black",
			"suggested": true
		},
		"4": {
			"label": "text color",
			"description": "color of the text",
			"example": "blue",
			"type": "string",
			"default": "white"
		},
		"border": {
			"description": "color of the border; enabled by default",
			"example": "black",
			"type": "string",
			"default": "{{{3}}}"
		},
		"bold": {
			"description": "bolds the text; enabled by default",
			"example": "no",
			"type": "string",
			"default": "yes"
		}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"border",
		"bold"
	],
	"description": "Adds a colored box with no border.",
	"format": "inline"
}
</templatedata>

<includeonly>{{sandbox other||
[[Category:Color templates]]

}}</includeonly>