Template:Hidden/doc

This is a documentation subpage for Template:Hidden. It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 350,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandboxor/testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

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 allorreveal all.

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

• 1 Usage
  • 1.1 Full syntax
  • 1.2 Parameters
    • 1.2.1 Optional
• 2 Examples
  • 2.1 Basic
  • 2.2 Header background
  • 2.3 CSS
• 3 Issues
  • 3.1 Show/hide button overlap
  • 3.2 Sections
    • 3.2.1 You can't get here from the table of contents
• 4 Templatedata
• 5 Tracking category
• 6 See also

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

|titlebgcolor= |contentbgcolor= |ta1= |ta2= |fw1= |fw2= |class= |border=
}}

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}}}

style

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. |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.

class

add additional class attributes affecting the entire template.

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

In this example only the two required parameters are specified.

{{hidden|Title text here|Body text line 1<br/>Body text line 2}}

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

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

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

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

[1]

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 "

"

Example with long header

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 "

"

Sections included inside a hidden block result in broken anchors in the table of contents at the top of the page.

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

Supporting templates:

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

Similar templates:

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

Languages