Template:Colorbull/doc
This is a documentation subpage for Template:Colorbull. 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 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}}
|
See also
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. |
- {{* }} / {{Bull }} / {{Bullet }}, a simple bullet. (e.g. Template:*)
This is the TemplateData documentation for this template used by VisualEditor and other tools.
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.
| 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 ■
| 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.
| 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.
| String | optional |