View source for Template:Colorbull/doc

{{Documentation subpage}}
{{High-use}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

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

== Usage ==
<code>&#123;&#123;colorbull{{!}}{{var|color}}{{!}}{{var|shape}}{{!}}{{var|wikilink}}{{!}}{{var|size<nowiki>=</nowiki>}}{{!}}{{var|description<nowiki>=</nowiki>}}}}</code>

*{{var|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.
*{{var|Shape}} is optional; valid arguments are:
::{|class="wikitable"
|-
| c / circle / r / round || ●
|-
| d / diamond || ◆
|-
| tu / up / uptriangle || ▲
|-
| td / dn / downtriangle || ▼
|-
| tl / lt / lefttriangle || ◀
|-
| tr / rt / righttriangle || ▶
|-
| {{var|default}} || ■
|}
* The {{var|wikilink}} parameter is also optional and specifies the article to which the text should point.
* The named parameter {{var|size}} is a number specifying the bullet size as a % of the default style text size. Default is 100.
* The named parameter {{var|description}} replaces the default <code>{{var|color}}</code> tooltip. This is also heard by a screen reader.

=== Examples ===
{| class="wikitable"
|-
! Visual<br/>effect !! Markup
|-
| {{colorbull}} || <code><nowiki>{{colorbull}}</nowiki></code>
|-
| {{colorbull|#039}} || <code><nowiki>{{colorbull|#039}}</nowiki></code>
|-
| {{colorbull|size=50}} || <code><nowiki>{{colorbull|size=50}}</nowiki></code>
|-
| {{colorbull|red|round}} || <code><nowiki>{{colorbull|red|round}}</nowiki></code>
|-
| {{colorbull|green|d}} || <code><nowiki>{{colorbull|green|d}}</nowiki></code>
|-
| {{colorbull||tu|triangle}} || <code><nowiki>{{colorbull||tu|triangle}}</nowiki></code>
|}

== See also ==
{{Color box templates}}
*{{tl|*}} / {{tl|bull}} / {{tl|bullet}}, a simple bullet. (e.g. {{*}})


{{Format TemplateData|TOC=0|JSON=
{
	"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"
} }}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Color templates]]

}}</includeonly>