Template:Hidden/doc

This template creates a {{dynamic navigation box}} using style sheet declarations in MediaWiki:Common.css and Javascript code in MediaWiki:Common.js. In a saved,  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

{{Hidden
| expanded=true <!--(omit for initial hidden state)-->
| style = 
| headerstyle = 
| header = 
| contentstyle = 
| content =

|bg1= |bg2= |ta1= |ta2= |fw1= |fw2= 
}}

Parameters

Only two parameters are required for this template:

header

text for header (title); alternative to using unnamed parameter {{{1}}}

content

text for body (content); alternative to using unnamed parameter {{{2}}}

Optional

style

 CSS styling for template overall.

border

default is none.

headerstyle

CSS styling for title (header).

contentstyle

CSS styling for the hidden content.

expanded

any nonblank value (e.g. |expanded = on) will cause the template to be initially expanded by default.

multiline

any nonblank value (e.g. |multline = y) will reduce the line-height of the title and add some padding to avoid overlap with the show/hide button.

Note: This template will not respect the user preference "justify paragraphs".

Examples

Basic

In this example only the two required parameters are specified.

Template:Rh | Code	{{hidden|Title text here|Body text line 1<br/>Body text line 2}}
Template:Rh | Result	{{Template:PAGENAMETDOC|Title text here|Body text line 1 Body text line 2}}

Header background

Template:Rh | Code	{{hidden |Title text here |Body text line 1<br/>Body text line 2 |headerstyle=background:#ccccff |style=text-align:center; }}
Template:Rh | Result	{{Template:PAGENAMETDOC|Title text here|Body text line 1 Body text line 2|headerstyle=background:#ccccff|style=text-align:center;}}

CSS

Template:Rh | Code	{{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 }}
Template:Rh | Result	{{Template: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 Body text line 2 Body text line 3 }}

Issues

Show/hide button overlap

With ta1=right or a long header, the header may overlap the show/hide button:

{{[[Template:Template:PAGENAMETDOC|Template: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}}

Possible workaround is to use |multiline = y:

"{{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}}" gives "{{ Template: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}}"

Example with long header

{{ Template: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}}

Above example with workaround:

"{{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}}" gives "{{ Template: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.

example

You can't get here from the table of contents

Templatedata

This is the  TemplateData for this template used by TemplateWizard,  VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Hidden

{
	"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"
		},
		"border": {
			"label": "Border"
		},
		"css": {
			"aliases": [
				"style",
				"framestyle"
			],
			"label": "CSS"
		},
		"background": {
			"aliases": [
				"bg1"
			],
			"label": "Background"
		},
		"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"
		},
		"bg2": {},
		"ta2": {},
		"fw2": {},
		"contentcss": {
			"aliases": [
				"contentstyle"
			],
			"description": "Content style"
		}
	},
	"description": "Creates a dynamic navigation box which is initially collapsed by default.",
	"paramOrder": [
		"1",
		"2",
		"toggle",
		"expanded",
		"class",
		"css",
		"border",
		"background",
		"titlealign",
		"multiline",
		"fw1",
		"headercss",
		"bg2",
		"ta2",
		"fw2",
		"contentcss"
	]
}

Tracking category

• Category:Hidden templates using styles (0) – tracks usage of parameters bg1, bg2, ta1, ta2, fw1, fw2

See also

Supporting templates:

• Template:Hidden begin (backlinks edit)
• Template:Hidden end (backlinks edit)

Similar templates:

• Template:Hidden
• Template:Collapsible list (backlinks edit)