Difference between revisions of "Template:Colorbull/doc"
Jump to navigation
Jump to search
imported>Neveselbert (Restoration attempt) |
imported>Neveselbert (Temp revert) |
||
| Line 5: | Line 5: | ||
== Usage == | == Usage == | ||
| − | <code>{{colorbull{{!}} | + | <code>{{colorbull{{!}}''colour''{{!}}''shape''{{!}}''wikilink''{{!}}''size=''}}</code> |
| − | * | + | *''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: |
::{|class="wikitable" | ::{|class="wikitable" | ||
|- | |- | ||
| Line 23: | Line 23: | ||
| tr / rt / righttriangle || ▶ | | tr / rt / righttriangle || ▶ | ||
|- | |- | ||
| − | | | + | | ''default'' || ■ |
|} | |} | ||
| − | * The | + | * The ''wikilink'' parameter is also optional and specifies the article to which the text should point. |
| − | * The named parameter | + | * The named parameter ''size'' is a number specifying the bullet size as a percentage of the default style text size. Default is 100. |
| − | |||
=== Examples === | === Examples === | ||
| Line 74: | Line 73: | ||
"description": "Optionally, a page name to link to.", | "description": "Optionally, a page name to link to.", | ||
"type": "wiki-page-name", | "type": "wiki-page-name", | ||
| − | " | + | "suggested": true |
}, | }, | ||
"size": { | "size": { | ||
| Line 82: | Line 81: | ||
"type": "number", | "type": "number", | ||
"default": "The same size as surrounding text (100)", | "default": "The same size as surrounding text (100)", | ||
| − | " | + | "suggested": true |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
}, | }, | ||
Revision as of 23:09, 19 April 2019
| 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 inserts a colored bullet, with an optional wikilink. The bullet’s shape and size can also be changed.
Usage
{{colorbull|colour|shape|wikilink|size=}}
- 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 percentage of the default style text size. Default is 100.
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}} | a small color box with black borders and text color | or ORANGE |
| {{Color box striped}} | a striped version | |
| {{RouteBox}} | a borderless version with text color and wikilinks | Template:RouteBox |
| {{Colorbull}} | a colored bullet with wikilinks | ■ |
| {{Legend2}} | another borderless version | |
| {{Color sample}} | a small color box with black borders | |
| {{Swatch inline}} | Template:Swatch inline | |
| {{Background color}} | orange | |
| {{Rail color box}} | a version with more display options (part of Module:Adjacent stations) |
Template:Rcb, Template:Rcb, etc. |
| {{Diagonal split color box}} | a small color box split diagonally | |
| {{Motor type}} | A small color box corresponding to the motor type | Template:Motor type, etc. |
- REDIRECT Template:•)
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
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.
| 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 | suggested |
| Size | size | The size of the bullet relative to surrounding text, as a percentage. Omit the % sign.
| Number | suggested |
Format: inline