Template:Hidden/doc

Jump to navigation Jump to search

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 =

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

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

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

Header background

Code <syntaxhighlight lang="css" style="overflow:auto;">
Title text here

Body text line 1
Body text line 2

</syntaxhighlight>

Result
Title text here
Body text line 1
Body text line 2

CSS

Code

<syntaxhighlight lang="css">

Title text here
Body text line 1
Body text line 2
Body text line 3
</syntaxhighlight>
Result
Title text here
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: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}}" gives "

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 "

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

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

Tracking category

See also

Supporting templates:

Similar templates: