Template:Hidden begin/doc

This is a documentation subpage for Template:Hidden begin.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

Purge base's cache

This template was ported from a template from Wikipedia. It was originally at Template:Hidden begin/doc. The original authors of this template are shown on the template's edit history page.
This template's documentation was also ported from Wikipedia, originally from Template:Hidden begin/doc/doc. The original authors of the documentation are shown on the documentation's edit history page.
Wikipedia's text is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

Syntax

{{Hidden begin
| expanded = <!--"true", "on", yes", etc, otherwise omit-->
| showhide = <!--"left", otherwise omit-->
| class = 
| style = 
| border =
| title = 
| titlestyle = 
| bg1 = 
| ta1 = 
| contentstyle = 
| bg2 = 
| ta2 = 
<!--Older, semi-deprecated parameters:-->
| header = | extra1 = | extra2 = 
}}
<!----[content to be hidden placed here]---->
{{Hidden end}}

Parameters

Parameter	Description
showhide	Set to "left" (without speechmarks) to switch the [show/hide] link's position from the righthand end of the titlebar (default) to the left.
expanded	Set to anything ("true", "yes", etc.) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).
class	Class attribute affecting entire area.
style	CSS styling affecting entire area (titlebar and hidden/hideable content).
border	CSS styling for border around entire area. Will be overridden by any border styles in style.
title	Text shown in titlebar.
titlestyle	CSS styles to apply to the titlebar (e.g. |titlestyle=border:1px solid lightgrey; to produce a border around it; |titlestyle=background:color; to set its background color to color ; |titlestyle=text-align:[center/right]; to switch its text (title)'s alignment from left to center or right; etc.).
bg1	Background color for titlebar; defaults to transparent. May be overridden if titlestyle includes anything that changes the background.
ta1	Text alignment for titlebar; defaults to left. May be overridden if titlestyle includes anything that changes the text alignment.
contentstyle	CSS styling to apply to the hidden/hideable content (e.g. background and text-align, per titlestyle).
bg2	Background color for content; defaults to transparent. May be overridden if contentstyle includes anything changes the background.
ta2	Text alignment for content; defaults to left. May be overridden if contentstyle includes anything that changes the text alignment.

Examples

Example 1

 {{Hidden begin |title=Default example}}
 * def
 * ghi
 {{Hidden end}}

Default example

• def
• ghi

Example 2

 {{Hidden begin
 | titlestyle = background:black;
 | title = ''titlestyle'' is "background:black;"
 }}
 * def
 * ghi
 {{Hidden end}}

titlestyle is "background:black;"

• def
• ghi

Example 3

 {{Hidden begin
 | titlestyle = background:black;
 | title = added "ta1=center"
 | ta1 = center
 }}
 * def
 * ghi
 {{Hidden end}}

added "ta1=center"

• def
• ghi

Example 4

 {{Hidden begin
 | titlestyle = background:black; text-align:right; padding-right:3.0em;
 | title = ''title'' on right with 3.0em padding
 }}
 * change window width and
 * watch title alignment
 {{Hidden end}}

title on right with 3.0em padding

• change window width and
• watch title alignment

Example 5

 {{Hidden begin |showhide=left |expanded=true
 | titlestyle = background:palegreen;
 | title = ''showhide'' set to "left" and ''expanded'' set to "true"
 }}
 * def
 * ghi
 {{Hidden end}}

showhide set to "left" and expanded set to "true"

• def
• ghi

Example 6

{{Hidden begin |showhide=left
| titlestyle = background:palegreen;
| title = <code style="background:transparent;">showhide=left</code>, hidden content 150% size and in bold (''contentstyle'')
| contentstyle = font-size:150%; font-weight:bold;
}}
* def
* ghi
{{Hidden end}}

showhide=left, hidden content 150% size and in bold (contentstyle)

• def
• ghi

Example 7

{{Hidden begin
| header = [''header'' (deprecated)]
| titlestyle = font-style:italic; padding-right:3.0em;
| title = [''title'' set to this text]
| border = 1px solid grey
| bg1 = palegreen
| ta1 = right
| extra1 = font-size:120%; <!--semicolon required since titlestyle is used-->
| extra2 = font-size:150% <!--semicolon optional when contentstyle not used-->
}}
* make window narrower and
* title will wrap
{{Hidden end}}

[header (deprecated)][title set to this text]

• make window narrower and
• title will wrap

Example 8

{{Hidden begin
| titlestyle =
| title = title with non-breaking spaces 
| border = 1px solid red
| bg1 = cyan
| bg2 = yellow
| ta1 = right
| ta2 = left
| extra1 = font-size:120%; padding-right:2.5em;
| extra2 = font-size:150%; padding-left:3.0em;
}}
* def ... these should have left padding
* ghi
{{Hidden end}}

title with non-breaking spaces 

• def ... these should have left padding
• ghi

See also

• {{Hidden}}