Template:Collapse top/doc: Difference between revisions
→Parameters: documentation overhaul
w:en>Paine Ellsworth m (update /doc) |
w:en>SMcCandlish (→Parameters: documentation overhaul) |
||
Line 24: | Line 24: | ||
== Parameters == | == Parameters == | ||
This template takes the following parameters, all of which are optional | This template takes the following parameters, all of which are optional. They are case-sensitive. Those that take CSS measurements require them in CSS format (e.g. <code>{{mxt|2px}}</code> not <code>{{!mxt|2 px}}</code>. | ||
; | ;{{para|1}}, {{para|title}}<span style="font-weight: normal;">, or first unnamed parameter</span>: Will give the collapsed box a title, which occurs on the same line as the ''show'' link and is always visible. It defaults to "Extended content". For example, <code><nowiki>{{collapse top|title=This is the title text}}</nowiki></code> or <code><nowiki>{{collapse top|This is the title text}}</nowiki></code>. Note: The shorter markup will not work if the title value contain an equals (<code>=</code>) character. | ||
;warning: | ;{{para|warning|yes}}: Will display a default warning line under the main title which reads "The following is a closed debate. {{strongbad|Please do not modify it.}}" Any value supplied to this parameter will have this effect (i.e. {{para|warning|{{!mxt|no}}}} will not work as expected). | ||
;{{para|2}}<span style="font-weight: normal;"> or second unnamed parameter</span>: This is optional warning-line text. It will override the standard warning line above; it is not necessary to also use {{para|warning|yes}} in this case, though doing so is harmless. | |||
;left: | ;{{para|left|yes}}: Will align the title along the left margin. Text aligns centered between the left margin and the left bracket of the left ''show'' link by default. Any value will have this effect (i.e. {{para|left|{{!mxt|no}}}} will not work as expected); nor is there a {{para|{{!mxt|right}}}} parameter (only useful in a right-to-left language). | ||
;{{para|expand|yes}} <span style="font-weight: normal;">or</span> {{para|collapse|no}}: Will leave the material uncollapsed with the border and coloring. Default is to collapse the material. Any value will have this effect (i.e. {{para|expand|{{!mxt|no}}}} and {{para|collapse|{{!mxt|yes}}}} will not work as expected). | |||
;bg: Sets the background color of the collapsed material. Defaults to # | ;{{para|bg}}: Sets the background color of the collapsed material. Defaults to <code>#CCFFCC</code>, a green hue. Named colors are listed at [[List of colors]]. For example, <code><nowiki>{{collapse top|This is the title text|bg=#F0F2F5}}</nowiki></code> or <code><nowiki>{{collapse top|This is the title text|bg=LightGrey}}</nowiki></code> (HTML color codes require the leading <code>#</code>). | ||
;{{para|fc}}: Sets the font color of the title of the collapsible bar. Defaults to inheriting the current text color of the context. See {{para|bg}}, above, for details on color options. | |||
;border: Sets the width of the border line on the collapsed material. defaults to 1px. For example, <code><nowiki>{{collapse top | ;{{para|border}}: Sets the width of the border line on the collapsed material. defaults to <code>1px</code>. For example, <code><nowiki>{{collapse top|border=2px}}</nowiki></code>; going much thicker than this is not very useful. | ||
;b-color: Sets the border color. defaults to | ;{{para|b-color}}: Sets the border color. defaults to <code>Silver</code> (<code>#C0C0C0</code>). See {{para|bg}}, above, for details on color options. | ||
;padding: Sets the padding on the collapsed material | ;{{para|padding}}: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to <code>8px</code>. | ||
;{{para|width}}: Sets the width of the overall template relative to the page (or a block element containing the collapse box). This should virtually always be given as a percentage, e.g. {{para|width|50%}}, or in relative <samp>em</samp> units, e.g. {{para|width=30em}}. Pixel-based values should be avoided, as they are effectively meaningless – the result will be different depending on each user's browser and local CSS settings (which browser and operating system it is, zoom level, font sizes, etc.). | |||
;border2: Sets the border of the box that appears when template is expanded; defaults to | ;{{para|border2}}: Sets the properties of the border of the box that appears when template is expanded; defaults to <code>1px Silver</code> (there is no provision to change from a solid line). For example, <code><nowiki>{{collapse top|border2=2px}}</nowiki></code> (only width or color will be changed if only one value is supplied). See {{para|bg}}, above, for details on color options. | ||
;bg2: Sets background of the box that appears when template is expanded; defaults to | ;{{para|bg2}}: Sets the background color of the box that appears when template is expanded; defaults to <code>White</code> (<code>#FFFFFF</code>). See {{para|bg}}, above, for details on color options. | ||
;indent: | ;{{para|indent}}: Indents the box from the left of the page. Defaults to no indentation. Each <code>:</code> in talk page markup is approximately equivalent to <code>1.6em</code> of indent (e.g., to match <code>::::</code> indentation level, use {{para|indent|6.4em}}. You can also use a percentage value. Pixel-based values should be avoided (see {{para|width}}, above, for why). | ||
;clear: In some situations you may not want the default <code>clear: both;</code> CSS to apply, with puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use {{para|clear|none}}, {{para|clear|right}}, or {{para|clear|left}}, as needed. | ;{{para|clear}}: In some situations you may not want the default <code>clear: both;</code> CSS to apply, with puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use {{para|clear|none}}, {{para|clear|right}}, or {{para|clear|left}}, as needed. | ||
== Examples == | == Examples == |