Template:Hidden/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(27 intermediate revisions by 18 users not shown)
Line 1: Line 1:
<noinclude>{{documentation subpage}}</noinclude>
This template creates a [[w:Wikipedia:NavFrame|dynamic navigation box]] using style sheet declarations in [[MediaWiki:Common.css]] and Javascript code in [[MediaWiki:Common.js]]. It displays the first parameter (the heading) with a [show] link on the right.  If [show] is clicked by the user, the second parameter (the body) is displayed below the heading and the [show] link becomes [hide].  Clicking on [hide] then hides the body again and the [hide] link becomes [show] again.
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{interwikitmp-grp|V=D|wqt=|wsr=|mdw=|wdy=|wsp=|wvy=|wbk=}}
This template creates a [[Wikipedia:NavFrame|dynamic navigation box]] using style sheet declarations in [[MediaWiki:Common.css]] and Javascript code in [[MediaWiki:Common.js]]. It displays the first parameter (the heading) with a [show] link on the right.  If [show] is clicked by the user, the second parameter (the body) is displayed below the heading and the [show] link becomes [hide].  Clicking on [hide] then hides the body again and the [hide] link becomes [show] again.


The template does '''not''' provide an argument to designate the initial state of the show/hide control.  In the nested case, show/hide controls in hidden content retain their state.  There is no facility for ''collapse all'' or ''reveal all''.   
The template does '''not''' provide an argument to designate the initial state of the show/hide control.  In the nested case, show/hide controls in hidden content retain their state.  There is no facility for ''collapse all'' or ''reveal all''.   


==Usage==
==Usage==
===Syntax===
<pre style="overflow:auto;">
{{Hidden
|header=
|content=
|style=
|headerstyle=
|contentstyle=
|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 : text for header (or title); alternative to using unnamed parameter <nowiki>{{{1}}}</nowiki>
;header : text for header (or title); alternative to using unnamed parameter <nowiki>{{{1}}}</nowiki>
;content : text for content (or body); alternative to using unnamed parameter <nowiki>{{{2}}}</nowiki>
;content : text for content (or body); alternative to using unnamed parameter <nowiki>{{{2}}}</nowiki>


===Optional parameters===
====Optional====
 
;style : add [[w:Cascading Style Sheets|CSS]] to the main div.
;style : add [[w:Cascading Style Sheets|CSS]] to the main div.
;headerstyle : add [[w:Cascading Style Sheets|CSS]] to the header.
;headerstyle : add [[w:Cascading Style Sheets|CSS]] to the header.
Line 20: Line 34:


==Examples==
==Examples==
===The simplest===
===Basic===
In this example only the two required parameters are specified.
In this example only the two required parameters are specified.
{| class="wikitable"
{| class="wikitable"
| {{rh}} | Code
| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Code
| <pre>{{hidden|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
| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Result
| {{hidden|Title text here|Body text line 1<br/>Body text line 2}}
| {{hidden|Title text here|Body text line 1<br/>Body text line 2}}
|}
|}
Line 32: Line 46:
===Header background===
===Header background===
{| class="wikitable"
{| class="wikitable"
| {{rh}} | Code
| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Code
| <pre>{{hidden|Title text here|Body text line 1<br/>Body text line 2|headerstyle=background:#ccccff|bodystyle=text-align:center}}</pre>
| <pre style="overflow:auto;">
{{hidden
|Title text here
|Body text line 1<br/>Body text line 2
|headerstyle=background:#ccccff
|style=text-align:center;
}}
</pre>
|-
|-
| {{rh}} | Result
| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Result
| {{hidden|Title text here|Body text line 1<br/>Body text line 2|headerstyle=background:#ccccff|bodystyle=text-align:center}}
| {{hidden|Title text here|Body text line 1<br/>Body text line 2|headerstyle=background:#ccccff|style=text-align:center;}}
|}
|}


===CSS===
===CSS===
{| class="wikitable"
{| class="wikitable"
| {{rh}} | Code
| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Code
|  
|  
<pre>
<pre>
Line 53: Line 73:
}}</pre>
}}</pre>
|-
|-
| {{rh}} | Result
| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Result
|  
|  
{{hidden
{{hidden
Line 62: Line 82:
| content = Body text line 1<br />Body text line 2<br />Body text line 3
| content = Body text line 1<br />Body text line 2<br />Body text line 3
}}
}}
|}
|}


== Issues ==
== See also ==
=== Show/hide button overlap ===
* [[Template:Collapse top]]
 
<div style="background:pink;font-weight:bold">With ta1=right or a long header, the header may overlap the show/hide button:</div>
{{evd|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}}
 
{{clr}}
;<div style="background:cyan;font-weight:bold">Possible workaround is to add "padding-right:3em;" to the headercss parameter:</div>
"<nowiki>{{hidden|headerstyle=text-align:right; padding-right:3em;|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 "{{hidden|headerstyle=text-align:right; padding-right:3em;|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>
{{hidden|abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc 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}}
 
{{clr}}
;<div style="background:cyan;font-weight:bold">Above example with workaround:</div>
"<nowiki>{{hidden|headerstyle=padding-right:3em;|abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc 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 "{{hidden|headerstyle=padding-right:3em;|abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc 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.
{{hidden begin|title=example}}
==== You can't get here from the table of contents ====
{{hidden end}}
 
==See also==
* {{tiw|hidden begin}}
* {{tiw|hidden end}}
* {{tim|hidden}}.


<includeonly>
<includeonly>
[[Category:Collapse templates|{{PAGENAME}}]]
[[Category:Formatting templates]]
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
 
<!-- [[en:Template:Hidden]] -->
[[bs:Šablon:Sakrij]]
[[dsb:Pśedłoga:Nawikašćik]]
[[eo:Ŝablono:Kaŝskatolo]]
[[fr:Modèle:Boîte déroulante]]
[[hy:Կաղապար:Նավարկման զոլ]]
[[hsb:Předłoha:Nawigaciska lajsta]]
[[ja:Template:Hidden]]
[[pt:Predefinição:Oculto]]
{{Pp-template|small=yes}}
</includeonly>
</includeonly>

Latest revision as of 04:12, 14 May 2014

This template creates a dynamic navigation box using style sheet declarations in MediaWiki:Common.css and Javascript code in MediaWiki:Common.js. It displays the first parameter (the heading) with a [show] link on the right. If [show] is clicked by the user, the second parameter (the body) is displayed below the heading and the [show] link becomes [hide]. Clicking on [hide] then hides the body again and the [hide] link becomes [show] again.

The template does not provide an argument to designate the initial state of the show/hide control. In the nested case, show/hide controls in hidden content retain their state. There is no facility for collapse all or reveal all.

Usage

Syntax

{{Hidden
|header=
|content=
|style=
|headerstyle=
|contentstyle=
|fw1=
|fw2=
|bg1=
|bg2=
|ta1=
|ta2=
}}

Parameters

Only two parameters are required for this template:

header
text for header (or title); alternative to using unnamed parameter {{{1}}}
content
text for content (or body); alternative to using unnamed parameter {{{2}}}

Optional

style
add CSS to the main div.
headerstyle
add CSS to the header.
contentstyle
add CSS to the content box.


Note: This template will not respect the user preference "justify paragraphs".

Examples

Basic

In this example only the two required parameters are specified.

Code 
{{hidden|Title text here|Body text line 1<br/>Body text line 2}}
Result
Title text here

Body text line 1
Body text line 2

Header background

Code 
{{hidden
|Title text here
|Body text line 1<br/>Body text line 2
|headerstyle=background:#ccccff
|style=text-align:center;
}}
Result
Title text here

Body text line 1
Body text line 2

CSS

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
}}
Result
Title text here

Body text line 1
Body text line 2
Body text line 3

See also


Retrieved from "https://kodi.wiki/index.php?title=Template:Hidden/doc&oldid=75172"