Template:Hidden/doc

From Gerald R. Lucas
< Template:Hidden
Revision as of 09:28, 1 May 2023 by Grlucas (talk | contribs) (Created page with "{{Documentation subpage}} <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> {{high-use}} {{Template:Collapse Templates}} 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 [hid...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Lua error in package.lua at line 80: module 'Module:Transclusion_count/data/H' not found. Template:Collapse Templates

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 =

|titlebgcolor= |contentbgcolor= |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
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
Title text here
Body text line 1
Body text line 2

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

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

Templatedata

Template:Templatedata header

Creates a dynamic navigation box which is initially collapsed by default.

Template parameters

ParameterDescriptionTypeStatus
Header1 header title

Text for the header/title.

Unknownoptional
Content2 contents content text

Text for the content of the hidden.

Unknownoptional
Toggletoggle showhide

no description

Unknownoptional
Expandedexpanded expand

no description

Unknownoptional
Classclass

no description

Unknownoptional
CSScss style framestyle

no description

Unknownoptional
Borderborder

no description

Unknownoptional
Title background colortitlebgcolor bg1 background

no description

Unknownoptional
Title aligntitlealign ta1

no description

Unknownoptional
Multi-linemultiline multi-line

no description

Unknownoptional
Title font weightfw1

no description

Unknownoptional
Header styleheadercss headerstyle titlestyle

no description

Unknownoptional
Content background colorcontentbgcolor bg2

no description

Unknownoptional
ta2ta2

no description

Unknownoptional
fw2fw2

no description

Unknownoptional
contentcsscontentcss contentstyle

Content style

Unknownoptional

Tracking category

See also

Supporting templates:

Similar templates: