Difference between revisions of "Template:Hidden/doc"

From blackwiki
Jump to navigation Jump to search
imported>DB1729
m (Reverted 1 edit by 2001:56A:770D:9800:282D:E922:75F9:43D0 (talk) to last revision by DB1729)
 
Line 1: Line 1:
 +
{{Documentation subpage}}
 +
<!-- 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}}
  
 +
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.
  
This template creates a using style sheet declarations in and  code In a saved, page this template creates a clickable link that toggles between It displays the first parameter (the heading) with alink on the right.  If is clicked by the user, it displays the second parameter  
+
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''.
below the heading and the link becomes Clicking on [hide] then hides the body and the [hide] link becomes again.
 
  
| expanded=true   
+
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 =  
 
| style =  
 +
| headerstyle =
 +
| header =
 +
| contentstyle =
 +
| content =
 +
 +
|fw1= |fw2= |bg1= |bg2= |ta1= |ta2=
 +
}}
 +
</pre>
 +
 +
===Parameters===
 
Only two parameters are required for this template:
 
Only two parameters are required for this template:
; header   
+
; header  : text for header (title); alternative to using unnamed parameter <nowiki>{{{1}}}</nowiki>
 +
; content : text for body (content); alternative to using unnamed parameter <nowiki>{{{2}}}</nowiki>
 +
 
 +
====Optional====
 +
; style        : [[w:Cascading Style Sheets|CSS]] styling for template overall.
 +
; headerstyle  : CSS styling for title (header).
 +
; 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".
  
 +
== Examples ==
  
; style  styling for template overall.
+
===Basic===
; headerstyle  : CSS styling for title (header).
+
In this example only the two required parameters are specified.
; contentstyle :any nonblank value will cause the template to be initially expanded by default.
+
{| class="wikitable"
; multiline    : any nonblank value (e.g. will reduce the line-height of the title and add some padding to avoid overlap with the button This template will not respect
+
| {{rh}} | Code
 +
| <pre>{{hidden|Title text here|Body text line 1<br/>Body text line 2}}</pre>
 +
|-
 +
| {{rh}} | Result
 +
| {{{{PAGENAMETDOC}}|Title text here|Body text line 1<br/>Body text line 2}}
 +
|}
  
 +
===Header background===
 +
{| class="wikitable"
 +
| {{rh}} | Code
 +
| <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
 
|headerstyle=background:#ccccff
 
|headerstyle=background:#ccccff
|style=text-align:centerTitle text here Body text line Body text line headerstyle=background:#ccccffsty
+
|style=text-align:center;
 +
}}
 +
</syntaxhighlight>
 +
|-
 +
| {{rh}} | Result
 +
| {{{{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 ==
 +
=== Show/hide button overlap ===
 +
<div style="background:pink;font-weight:bold">With ta1=right or a long header, the header may overlap the show/hide button:</div>
 +
{{evd|{{PAGENAMETDOC}}|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}}
 +
 
 +
{{clr}}
 +
;<div style="background:cyan;font-weight:bold">Possible workaround is to use {{para|multiline|y}}:</div>
 +
"<nowiki>{{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}}</nowiki>" gives "{{{{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}}"
  
 +
<div style="background:pink;font-weight:bold">Example with long header</div>
 +
{{{{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}}
  
weight:bold">With ta1=right or a long header, the header may overlap the buttonLorem 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 labor
+
{{clr}}
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
+
;<div style="background:cyan;font-weight:bold">Above example with workaround:</div>
 +
"<nowiki>{{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}}</nowiki>" gives "{{{{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}}"
  
abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc
+
=== Sections ===
Sections included inside a result in broken anchors in the table of contents at the top of the page.
+
Sections included inside a hidden block result in broken anchors in the table of contents at the top of the page.
You can't get here from the table  
+
{{hidden begin|title=example}}
 +
==== You can't get here from the table of contents ====
 +
{{hidden end}}
  
 +
==Tracking category==
 +
* {{clc|Hidden templates using styles}} – tracks usage of parameters bg1, bg2, ta1, ta2, fw1, fw2
  
below this line, please; interwikis go to Wikidata, thank you!  
+
==See also==
 +
Supporting templates:
 +
* {{tiw|Hidden begin}}
 +
* {{tiw|Hidden end}}
 +
Similar templates:
 +
* {{tim|Hidden}}
 +
* {{tiw|Collapsible list}}
 +
 
 +
<includeonly>{{Sandbox other||
 +
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
 +
[[Category:Collapse templates]]
 +
[[Category:Wikipedia formatting and function templates]]
 
[[Category:Templates that add a tracking category]]
 
[[Category:Templates that add a tracking category]]
 +
 +
}}</includeonly>

Latest revision as of 11:02, 14 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: