Template:Hidden/doc

From Kerbal Space Program Wiki
Jump to: navigation, search

This template creates a dynamic navigation box using style sheet declarations in MediaWiki:Common.css and Javascript code in MediaWiki:Common.js. It displays the first parameter (the heading) with a [show] link on the right. If [show] is clicked by the user, the second parameter (the body) is displayed below the heading and the [show] link becomes [hide]. Clicking on [hide] then hides the body again and the [hide] link becomes [show] again.

The template does not provide an argument to designate the initial state of the show/hide control. In the nested case, show/hide controls in hidden content retain their state. There is no facility for collapse all or reveal all.

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.

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

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

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

Issues

Show/hide button overlap

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

Template:Evd

Template:Clr

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

Template:Clr

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

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

See also