View source for Template:Hidden/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Template:Collapse Templates}}

This template creates a [[Help:Collapsing|dynamic navigation box]] using style sheet declarations in [[MediaWiki:Common.css]] and Javascript code in [[MediaWiki:Common.js]]. In a saved, [[Rendering (computer graphics)|rendered]] page this template creates a clickable link that toggles between [show] and [hide]. It displays the first parameter (the heading) with a [show] link on the right.  If [show] is clicked by the user, it displays the second parameter (the body) below the heading and the [show] link becomes [hide].  Clicking on [hide] then hides the body and the [hide] link becomes [show] again.

If this template is nested in another, the show/hide links in the hidden content keep their state; there is no parameter for ''collapse all'' or ''reveal all''.  

Generally, collapsible templates should not be used in articles. For allowable uses and other considerations, please see [[MOS:COLLAPSE]].

== Usage ==

===Full syntax===
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden
| expanded=true <!--(omit for initial hidden state)-->
| style = 
| headerstyle = 
| header = 
| contentstyle = 
| content =

|titlebgcolor= |contentbgcolor= |ta1= |ta2= |fw1= |fw2= |class= |border=
}}
</syntaxhighlight>

===Parameters===
Only two parameters are required for this template:
; header  : text for header (title); alternative to using unnamed parameter <nowiki>{{{1}}}</nowiki>
; content : text for body (content); alternative to using unnamed parameter <nowiki>{{{2}}}</nowiki>

====Optional====
; style        : [[w:Cascading Style Sheets|CSS]] styling for template overall.
; border       : border around the template.
; headerstyle  : CSS styling for title (header).
; contentstyle : CSS styling for the hidden content.
; expanded     : any nonblank value (e.g. {{para|expanded|on}}) will cause the template to be initially expanded by default.
; multiline    : any nonblank value (e.g. {{para|multline|y}}) will reduce the line-height of the title and add some padding to avoid overlap with the show/hide button.
; class        : add additional class attributes affecting the entire template.
'''Note:''' This template will not respect the [[Wikipedia:User preferences|user preference]] "justify paragraphs".

== Examples ==
===Basic===
In this example only the two required parameters are specified.
{| class="wikitable"
| {{rh}} | Code
| <syntaxhighlight lang="wikitext">{{hidden|Title text here|Body text line 1<br/>Body text line 2}}</syntaxhighlight>
|-
| {{rh}} | Result
| {{{{PAGENAMETDOC}}|Title text here|Body text line 1<br/>Body text line 2}}
|}

===Header background===
{| class="wikitable"
| {{rh}} | Code
| <syntaxhighlight lang="wikitext" style="overflow:auto;">
{{hidden
|Title text here
|Body text line 1<br/>Body text line 2
|headerstyle=background:#ccccff
|style=text-align:center;
}}
</syntaxhighlight>
|-
| {{rh}} | Result
| {{{{PAGENAMETDOC}}|Title text here|Body text line 1<br/>Body text line 2|headerstyle=background:#ccccff|style=text-align:center;}}
|}

===CSS===
{| class="wikitable"
| {{rh}} | Code
| 
<syntaxhighlight lang="wikitext">
{{hidden
| style = border: 1px dashed red; width: 50%;
| headerstyle = background: #ccccff; font-size: 110%;
| contentstyle = text-align: center; color: green;
| header = Title text here
| content = Body text line 1<br />Body text line 2<br />Body text line 3
}}</syntaxhighlight>
|-
| {{rh}} | Result
| 
{{{{PAGENAMETDOC}}
| style = border:1px dashed red; width: 50%;
| headerstyle = background: #ccccff; font-size: 110%;
| contentstyle = text-align: center; color:green;
| header = Title text here
| content = Body text line 1<br />Body text line 2<br />Body text line 3
}}
|}

== Issues ==
=== Show/hide button overlap ===
<div style="background:pink;font-weight:bold">With ta1=right or a long header, the header may overlap the show/hide button:</div>
{{tlx|{{PAGENAMETDOC}}|Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.|def|_show_result=y|_expand=y}}

{{clr}}
;<div style="background:cyan;font-weight:bold">Possible workaround is to use {{para|multiline|y}}:</div>
"<nowiki>{{hidden|multiline=y|Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.|def}}</nowiki>" gives "{{ {{PAGENAMETDOC}}|multiline=y|Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.|def}}"

<div style="background:pink;font-weight:bold">Example with long header</div>
{{ {{PAGENAMETDOC}}|abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc |def}}

{{clr}}
;<div style="background:cyan;font-weight:bold">Above example with workaround:</div>
"<nowiki>{{hidden|multiline=y|abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc |def}}</nowiki>" gives "{{ {{PAGENAMETDOC}}|multiline=y|abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc |def}}"

=== Sections ===
Sections included inside a hidden block result in broken anchors in the table of contents at the top of the page.
{{hidden begin|title=example}}
==== You can't get here from the table of contents ====
{{hidden end}}

== Templatedata ==
{{templatedata header}}
<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"header",
				"title"
			],
			"label": "Header",
			"description": "Text for the header/title."
		},
		"2": {
			"aliases": [
				"contents",
				"content",
				"text"
			],
			"label": "Content",
			"description": "Text for the content of the hidden."
		},
		"toggle": {
			"aliases": [
				"showhide"
			],
			"label": "Toggle"
		},
		"expanded": {
			"aliases": [
				"expand"
			],
			"label": "Expanded"
		},
		"class": {
			"label": "Class",
			"description": "Add additional class attributes affecting the entire template."
		},
		"border": {
			"label": "Border",
			"description": "Border around the template"
		},
		"css": {
			"aliases": [
				"style",
				"framestyle"
			],
			"label": "CSS"
		},
		"titlealign": {
			"aliases": [
				"ta1"
			],
			"label": "Title align"
		},
		"multiline": {
			"aliases": [
				"multi-line"
			],
			"label": "Multi-line"
		},
		"fw1": {
			"label": "Title font weight"
		},
		"headercss": {
			"aliases": [
				"headerstyle",
				"titlestyle"
			],
			"label": "Header style"
		},
		"ta2": {},
		"fw2": {},
		"contentcss": {
			"aliases": [
				"contentstyle"
			],
			"description": "Content style"
		},
		"contentbgcolor": {
			"aliases": [
				"bg2"
			],
			"label": "Content background color"
		},
		"titlebgcolor": {
			"aliases": [
				"bg1",
				"background"
			],
			"label": "Title background color"
		}
	},
	"description": "Creates a dynamic navigation box which is initially collapsed by default.",
	"paramOrder": [
		"1",
		"2",
		"toggle",
		"expanded",
		"class",
		"css",
		"border",
		"titlebgcolor",
		"titlealign",
		"multiline",
		"fw1",
		"headercss",
		"contentbgcolor",
		"ta2",
		"fw2",
		"contentcss"
	]
}</templatedata>

==Tracking category==
* {{clc|Hidden templates using styles}} – tracks usage of parameters titlebgcolor, contentbgcolor, bg1, bg2, ta1, ta2, fw1, fw2

==See also==
Supporting templates:
* {{tiw|Hidden begin}}
* {{tiw|Hidden end}}
Similar templates:
* {{tim|Hidden}}
* {{tiw|Collapsible list}}

<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Collapse templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>