More actions
m Rewrite doc. |
m Update for new parameter. Update dependencies. |
||
| Line 1: | Line 1: | ||
; Description | ; Description | ||
: This template creates a colored text box. | : This template creates a colored text box. | ||
; Dependencies | |||
:; Used by | |||
:: {{T|Important note box}} | |||
; Syntax | ; Syntax | ||
: {{T|Color box|3=content|4=border= color|5=width= percentage|6=color= color|7=align= position|8=text= color}} | : {{T|Color box|3= content|4= border= color|5= width= percentage|6= color= color|7= align= position|8= text= color|9= italics= no}} | ||
:; Parameters | :; Parameters | ||
:: All named parameters are optional. | :: All named parameters, with an = in the syntax, are optional. | ||
::; content : The contents of the box. This can be as long or short as necessary, and wiki formatting (such as bold text or links) works just fine. '''Note:''' If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put 1= before your text), otherwise the template will display nothing. | ::; content : The contents of the box. This can be as long or short as necessary, and wiki formatting (such as bold text or links) works just fine. '''Note:''' If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put 1= before your text), otherwise the template will display nothing. | ||
::; border : Sets the border color of the box. The default is set to a shade of {{Co|#888888|gray}}. Colors can be given either by color name<ref>https://www.w3schools.com/cssref/css_colors.asp [2021-10-23]</ref> (e.g. {{Co|red|red}} or {{Co|green|green}}) or values<ref>https://www.w3schools.com/cssref/css_colors_legal.asp [2021-10-23]</ref> (like {{Co|#0000FF|#FF0000}}). | ::; border : Sets the border color of the box. The default is set to a shade of {{Co|#888888|gray}}. Colors can be given either by color name<ref>https://www.w3schools.com/cssref/css_colors.asp [2021-10-23]</ref> (e.g. {{Co|red|red}} or {{Co|green|green}}) or values<ref>https://www.w3schools.com/cssref/css_colors_legal.asp [2021-10-23]</ref> (like {{Co|#0000FF|#FF0000}}). | ||
| Line 12: | Line 16: | ||
::; align : Sets the position of the text within the box. The default is set to left. Values are: left, center, right or justify. | ::; align : Sets the position of the text within the box. The default is set to left. Values are: left, center, right or justify. | ||
::; text : Sets the text color of the box. The default is set to {{Co|white|white}}. For valid values see border. | ::; text : Sets the text color of the box. The default is set to {{Co|white|white}}. For valid values see border. | ||
::; italics : Set italics= no to override the default of the contents of the box being in italics. Otherwise omit. | |||
; Usage notes | ; Usage notes | ||