Difference between revisions of "Template:Hidden/doc"
imported>Zyxw m (Remove <includeonly> around {{high-use}} template, since it works correctly on /doc pages now.) |
imported>AlanM1 (expanded parm does this (confirmed)) |
||
| Line 6: | Line 6: | ||
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, [[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 [[Wikipedia:NavFrame|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''. | |
Do not use this template to hide content in articles. This violates the [[WP:Manual of Style#Scrolling lists and collapsible content|WP:Manual of Style § Scrolling lists and collapsible content]] and [[WP:Accessibility]] guidelines. This template is intended for use in pages in [[Wikipedia:Namespaces|namespaces]] other than the article namespace. | Do not use this template to hide content in articles. This violates the [[WP:Manual of Style#Scrolling lists and collapsible content|WP:Manual of Style § Scrolling lists and collapsible content]] and [[WP:Accessibility]] guidelines. This template is intended for use in pages in [[Wikipedia:Namespaces|namespaces]] other than the article namespace. | ||
Revision as of 20:18, 12 February 2019
| This is a documentation subpage for Template:Hidden. It contains usage information, categories and other content that is not part of the original template page. |
| 40px | This template is used on approximately 347,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| Collapsible templates |
|---|
| Script error: No such module "aligned table". |
| Article namespace |
|
| Infoboxes |
| Navigation templates |
| Talk namespace |
|
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.
Do not use this template to hide content in articles. This violates the WP:Manual of Style § Scrolling lists and collapsible content and WP:Accessibility guidelines. This template is intended for use in pages in namespaces other than the article namespace.
Contents
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 | 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
- 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}}"
{{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.
You can't get here from the table of contents
Tracking category
- Category:Hidden templates using styles (6) – tracks usage of parameters bg1, bg2, ta1, ta2, fw1, fw2
See also
Supporting templates:
Similar templates: