More actions
m Protected "Template:Hidden/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{wikipedia|page name}} | |||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
This template creates a | 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''. | 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 | Generally, collapsible templates should not be used in articles. For allowable uses and other considerations, please see MOS:COLLAPSE. | ||
== Usage == | == Usage == | ||
| Line 32: | Line 31: | ||
====Optional==== | ====Optional==== | ||
; style : | ; style : CSS styling for template overall. | ||
; border : border around the template. | ; border : border around the template. | ||
; headerstyle : CSS styling for title (header). | ; headerstyle : CSS styling for title (header). | ||
| Line 39: | Line 38: | ||
; 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. | ; 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. | ||
; class : add additional class attributes affecting the entire template. | ; class : add additional class attributes affecting the entire template. | ||
'''Note:''' This template will not respect the | '''Note:''' This template will not respect the user preference "justify paragraphs". | ||
== Examples == | == Examples == | ||
| Line 49: | Line 48: | ||
|- | |- | ||
| {{rh}} | Result | | {{rh}} | Result | ||
| {{ | | {{|Title text here|Body text line 1<br/>Body text line 2}} | ||
|} | |} | ||
| Line 65: | 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;}} | ||
|} | |} | ||
| Line 83: | Line 82: | ||
| {{rh}} | Result | | {{rh}} | Result | ||
| | | | ||
{{ | {{ | ||
| style = border:1px dashed red; width: 50%; | | style = border:1px dashed red; width: 50%; | ||
| headerstyle = background: #ccccff; font-size: 110%; | | headerstyle = background: #ccccff; font-size: 110%; | ||
| Line 95: | Line 94: | ||
=== Show/hide button overlap === | === 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> | <div style="background:pink;font-weight:bold">With ta1=right or a long header, the header may overlap the show/hide button:</div> | ||
{{tlx| | {{tlx||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|_show_result=y|_expand=y}} | ||
;<div style="background:cyan;font-weight:bold">Possible workaround is to use {{para|multiline|y}}:</div> | ;<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 "{{ | "<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 "{{ |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> | <div style="background:pink;font-weight:bold">Example with long header</div> | ||
{{ | {{ |abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc 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}} | ||
;<div style="background:cyan;font-weight:bold">Above example with workaround:</div> | ;<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 "{{ | "<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 "{{ |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 === | ||
| Line 230: | Line 227: | ||
==Tracking category== | ==Tracking category== | ||
* {{clc|Hidden templates using styles}} – tracks usage of parameters titlebgcolor, contentbgcolor, bg1, bg2, ta1, ta2, fw1, fw2 | * {{clc|Hidden templates using styles}} – tracks usage of parameters titlebgcolor, contentbgcolor, bg1, bg2, ta1, ta2, fw1, fw2 | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
Latest revision as of 05:19, 14 April 2025
| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
| This is a documentation subpage for Template:Hidden It may contain usage information, categories and other content that is not part of the original template page. |
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= |class= |border=
}}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
- border around the template.
- 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. - class
- add additional class attributes affecting the entire template.
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|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 |
{{ |
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
Lua error: expandTemplate: invalid title "Template:".
- 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 "{{ |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}}"
{{ |abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc 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 "{{ |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.
You can't get here from the table of contents
Templatedata
Creates a dynamic navigation box which is initially collapsed by default.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Header | 1 header title | Text for the header/title. | Unknown | optional |
| Content | 2 contents content text | Text for the content of the hidden. | Unknown | optional |
| Toggle | toggle showhide | no description | Unknown | optional |
| Expanded | expanded expand | no description | Unknown | optional |
| Class | class | Add additional class attributes affecting the entire template. | Unknown | optional |
| CSS | css style framestyle | no description | Unknown | optional |
| Border | border | Border around the template | Unknown | optional |
| Title background color | titlebgcolor bg1 background | no description | Unknown | optional |
| Title align | titlealign ta1 | no description | Unknown | optional |
| Multi-line | multiline multi-line | no description | Unknown | optional |
| Title font weight | fw1 | no description | Unknown | optional |
| Header style | headercss headerstyle titlestyle | no description | Unknown | optional |
| Content background color | contentbgcolor bg2 | no description | Unknown | optional |
| ta2 | ta2 | no description | Unknown | optional |
| fw2 | fw2 | no description | Unknown | optional |
| contentcss | contentcss contentstyle | Content style | Unknown | optional |
Tracking category
- Category:Hidden templates using styles (0) – tracks usage of parameters titlebgcolor, contentbgcolor, bg1, bg2, ta1, ta2, fw1, fw2