Template:Colorbull

■

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 4,500 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Preview message: Transclusion count updated automatically (see documentation).

This template inserts a colored bullet, with an optional wikilink. The bullet’s shape and size can also be changed.

Usage

{{colorbull|color|shape|wikilink|size=|description=}}

Colors are most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See web colors for details. The default is black.
Shape is optional; valid arguments are:

c / circle / r / round	●
d / diamond	◆
tu / up / uptriangle	▲
td / dn / downtriangle	▼
tl / lt / lefttriangle	◀
tr / rt / righttriangle	▶
`default`	■

The wikilink parameter is also optional and specifies the article to which the text should point.
The named parameter size is a number specifying the bullet size as a % of the default style text size. Default is 100.
The named parameter description replaces the default color tooltip. This is also heard by a screen reader.

Examples

Visual effect	Markup
■	`{{colorbull}}`
■	`{{colorbull\|#039}}`
■	`{{colorbull\|size=50}}`
●	`{{colorbull\|red\|round}}`
◆	`{{colorbull\|green\|d}}`
▲	`{{colorbull\|\|tu\|triangle}}`

Color box templates
v
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.

{{*}} / {{bull}} / {{bullet}}, a simple bullet. (e.g. • )

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Colorbull in articles based on its TemplateData.

TemplateData for Colorbull

Parameter		Description	Type	Status
Color	`1`	Most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See the article web colors for details. Default black (or standard link color for links) Example #f00	String	suggested
Shape	`2`	“c” or “circle” or “r” or “round” gives ●; “d” or “diamond” gives ◆; “tu” or “up” or “uptriangle” gives ▲; “td” or “dn” or “downtriangle” gives ▼; “tl” or “lt” or “lefttriangle” gives ◀; “tr” or “rt” or “righttriangle” gives ▶; default is ■ Default ■	String	suggested
Link target	`3`	Optionally, a page name to link to.	Page name	optional
Size	`size`	The size of the bullet relative to surrounding text, as a percentage. Omit the % sign. Default The same size as surrounding text (100) Example 80	Number	optional
Description	`description`	When hovered over, this is also heard by a screen reader. This optional parameter can be used to change the default to something more user-friendly. Default the value used for color as a tooltip Example dark blue	String	optional

{
	"params": {
		"1": {
			"label": "Color",
			"description": "Most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination.  See the article web colors for details.",
			"example": "#f00",
			"type": "string",
			"default": "black (or standard link color for links)",
			"suggested": true
		},
		"2": {
			"label": "Shape",
			"description": "“c” or “circle” or “r” or “round” gives ●; “d” or “diamond” gives ◆; “tu” or “up” or “uptriangle” gives ▲; “td” or “dn” or “downtriangle” gives ▼; “tl” or “lt” or “lefttriangle” gives ◀; “tr” or “rt” or “righttriangle” gives ▶; default is ■",
			"type": "string",
			"suggested": true,
            "default": "■"
		},
		"3": {
			"label": "Link target",
			"description": "Optionally, a page name to link to.",
			"type": "wiki-page-name",
			"required": false
		},
		"size": {
			"label": "Size",
			"description": "The size of the bullet relative to surrounding text, as a percentage. Omit the % sign.",
			"example": "80",
			"type": "number",
			"default": "The same size as surrounding text (100)",
			"required": false
		},
		"description": {
			"label": "Description",
			"description": "When hovered over, this is also heard by a screen reader. This optional parameter can be used to change the default to something more user-friendly.",
			"example": "dark blue",
			"type": "string",
			"default": "the value used for color as a tooltip",
			"required": false
		}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"size",
                "description"
	],
	"description": " ",
	"format": "inline"
}

The above documentation is transcluded from Template:Colorbull/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Template:Colorbull

Usage

Examples

See also