Difference between revisions of "Template:Hidden/doc"

From blackwiki
Jump to navigation Jump to search
imported>DB1729
(Reverted 1 edit by 2001:56A:7725:7E00:7458:DCC2:5D9A:9911 (talk): Unexplained removal of content)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata  
+
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
 
+
{{high-use| 111160 }}
 +
{{Template:Collapse Templates}}
  
Generally, collapsible templates should not be used in articles. For allowable uses and other considerations,  
+
This template creates a [[Wikipedia:NavFrame|dynamic navigation box]] using style sheet declarations in [[MediaWiki:Common.css]] and Javascript code in [[MediaWiki:Common.js]]. In a saved, [[Rendering (computer graphics)|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===
 +
<pre style="overflow:auto;">
 +
{{Hidden
 +
| expanded=true  <!--(omit for initial hidden state)-->
 +
| style =
 +
| headerstyle =
 +
| header =
 +
| contentstyle =
 +
| content =
 +
 
 +
|fw1= |fw2= |bg1= |bg2= |ta1= |ta2=
 +
}}
 +
</pre>
  
 
===Parameters===
 
===Parameters===
Line 13: Line 34:
 
; style        : [[w:Cascading Style Sheets|CSS]] styling for template overall.
 
; style        : [[w:Cascading Style Sheets|CSS]] styling for template overall.
 
; headerstyle  : CSS styling for title (header).
 
; headerstyle  : CSS styling for title (header).
; contentstyle : any nonblank value (e.g. {{para|multline|y}}) will reduce the line-height of the title and add some padding to avoid overlap with the show/hide button.
+
; contentstyle : CSS styling for the hidden content.
 +
; expanded    : any nonblank value (e.g. {{para|expanded|on}}) will cause the template to be initially expanded by default.
 +
; multiline    : any nonblank value (e.g. {{para|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 [[Wikipedia:User preferences|user preference]] "justify paragraphs".
 
'''Note:''' This template will not respect the [[Wikipedia:User preferences|user preference]] "justify paragraphs".
  
Line 22: Line 45:
 
{| class="wikitable"
 
{| class="wikitable"
 
| {{rh}} | Code
 
| {{rh}} | Code
| <pre>{{Title text here|Body text line 1<br/>Body text line 2}}</pre>
+
| <pre>{{hidden|Title text here|Body text line 1<br/>Body text line 2}}</pre>
 
|-
 
|-
 
| {{rh}} | Result
 
| {{rh}} | Result
Line 31: Line 54:
 
{| class="wikitable"
 
{| class="wikitable"
 
| {{rh}} | Code
 
| {{rh}} | Code
| <syntaxhighlight lang="css" style="overflow:auto;
+
| <syntaxhighlight lang="css" style="overflow:auto;">
 +
{{hidden
 
|Title text here
 
|Title text here
 
|Body text line 1<br/>Body text line 2
 
|Body text line 1<br/>Body text line 2
Line 40: Line 64:
 
|-
 
|-
 
| {{rh}} | Result
 
| {{rh}} | Result
|Title text here|Body text line 1<br/>Body text line 2|headerstyle=background:#ccccff|style=text-align:center;}}
+
| {{{{PAGENAMETDOC}}|Title text here|Body text line 1<br/>Body text line 2|headerstyle=background:#ccccff|style=text-align:center;}}
 +
|}
 +
 
 +
===CSS===
 +
{| class="wikitable"
 +
| {{rh}} | Code
 +
|
 +
<syntaxhighlight lang="css">
 +
{{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
 +
}}</syntaxhighlight>
 +
|-
 +
| {{rh}} | Result
 +
|
 +
{{{{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<br />Body text line 2<br />Body text line 3
 +
}}
 +
|}
  
 
== Issues ==
 
== Issues ==

Revision as of 14:31, 2 December 2020

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.

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:Xpd2

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

Tracking category

See also

Supporting templates:

Similar templates: