Difference between revisions of "User:Evon R'al/Sandbox template/doc"
From EVE University Wiki
m (Blank page for next project) |
m (Working on template {{Color box}}) |
||
| Line 1: | Line 1: | ||
| + | <noinclude>{{main|Template:Color box}}</noinclude> | ||
| + | ==Syntax== | ||
| + | This template creates a colored text box. | ||
| + | {{code|<nowiki>{{Color box | color= | border= | text= | width= | content }}</nowiki>}} | ||
| + | === Parameters === | ||
| + | All the parameters are optional. | ||
| + | ;color | ||
| + | :This sets the background color of the text box. You can use either color names (e.g. <code>blue</code>, <code>green</code>), or the [http://www.w3schools.com/cssref/css_colors.asp color's RGB values] as a hexadecimal number (which must be preceded by a hash character, e.g. <code>#222222</code> for light gray, or <code>#990099</code> for purple). If omitted, the background color will be black. | ||
| + | ;border | ||
| + | :This sets the color of the border (color formatting as above). If omitted, the border will be light gray. | ||
| + | ;text | ||
| + | :This sets the color of the text (color formatting as above). If omitted, the text will be white. | ||
| + | ;width | ||
| + | :This sets the width of the text box. It's recommended to set this as a percentage (of the paragraph width), so <code>50%</code> will produce a text box half as wide as the surrounding paragraph. If omitted, the text box will be as wide as the surrounding paragraph (<code>100%</code>). | ||
| + | ;contents | ||
| + | :The contents of the text box. This can be as long or short as necessary, and wiki formatting (such as bold text or links) works just fine. | ||
| + | === Usage notes === | ||
| + | The background color should be darker than the border. Depending on how light the background color is, either white or black text is easier to read. Given that the default skin for the UniWiki has light text on a dark background, a text box with a light background will stand out much more than one with a darker background (but will also make a page look more cluttered, especially if it is used repeatedly). | ||
| + | == Related templates == | ||
| + | This template is used in a number of more specific templates, such as {{tl|Example}}. | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | <code><nowiki>{{Color box|A very basic text box}}</nowiki></code>: | ||
| + | {{Color box|A very basic text box}} | ||
| + | |||
| + | |||
| + | <code><nowiki>{{Color box|color=#144f1d|border=#2f8f2f|A more colorful box!}}</nowiki></code>: | ||
| + | {{Color box|color=#144f1d|border=#2f8f2f|A more colorful box!}} | ||
| + | |||
| + | |||
| + | <code><nowiki>{{Color box|color=#110033|border=#6600bb|width=50%|A smaller, purple box}}</nowiki></code>: | ||
| + | {{Color box|color=#110033|border=#6600bb|width=50%|A smaller, purple box}} | ||
| + | |||
| + | |||
| + | <code><nowiki>{{Color box|color=#66FFFF|border=#6600FF|text=#000000|A light blue box with dark text}}</nowiki></code>: | ||
| + | {{Color box|color=#66FFFF|border=#6600FF|text=#000000|A light blue box with dark text}} | ||
| + | |||
| + | <includeonly>[[Category:Formatting templates]]</includeonly> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> | ||
Revision as of 12:48, 6 December 2021
- Main article: Template:Color box
Syntax
This template creates a colored text box.
| {{Color box | color= | border= | text= | width= | content }} |
Parameters
All the parameters are optional.
- color
- This sets the background color of the text box. You can use either color names (e.g.
blue,green), or the color's RGB values as a hexadecimal number (which must be preceded by a hash character, e.g.#222222for light gray, or#990099for purple). If omitted, the background color will be black. - border
- This sets the color of the border (color formatting as above). If omitted, the border will be light gray.
- text
- This sets the color of the text (color formatting as above). If omitted, the text will be white.
- width
- This sets the width of the text box. It's recommended to set this as a percentage (of the paragraph width), so
50%will produce a text box half as wide as the surrounding paragraph. If omitted, the text box will be as wide as the surrounding paragraph (100%). - contents
- The contents of the text box. This can be as long or short as necessary, and wiki formatting (such as bold text or links) works just fine.
Usage notes
The background color should be darker than the border. Depending on how light the background color is, either white or black text is easier to read. Given that the default skin for the UniWiki has light text on a dark background, a text box with a light background will stand out much more than one with a darker background (but will also make a page look more cluttered, especially if it is used repeatedly).
Related templates
This template is used in a number of more specific templates, such as {{Example}}.
Examples
{{Color box|A very basic text box}}:
{{Color box|color=#144f1d|border=#2f8f2f|A more colorful box!}}:
{{Color box|color=#110033|border=#6600bb|width=50%|A smaller, purple box}}:
{{Color box|color=#66FFFF|border=#6600FF|text=#000000|A light blue box with dark text}}:
