Template:Hidden/doc: Difference between revisions

Revision as of 04:40, 24 November 2011

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

@@ Line 1: / Line 1: @@
-Temp blanking of documentation because only very basic options are available right now. At least until I figure out how to make the original work.
+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.
-<includeonly>[[Category:Templates]]</includeonly>
+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===
+<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:
+;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>
+====Optional====
+;style : add [[w:Cascading Style Sheets|CSS]] to the main div.
+;headerstyle : add [[w:Cascading Style Sheets|CSS]] to the header.
+;contentstyle : add [[w:Cascading Style Sheets|CSS]] to the content box.
+<br/>'''Note:''' This template will not respect the user preference "justify paragraphs".
+==Examples==
+===Basic===
+In this example only the two required parameters are specified.
+{| class="wikitable"
+| 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>
+|-
+| 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}}
+|}
+===Header background===
+{| class="wikitable"
+| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Code
+| <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>
+|-
+| 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|style=text-align:center;}}
+|}
+===CSS===
+{| class="wikitable"
+| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Code
+|
+<pre>
+{{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
+}}</pre>
+|-
+| style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left" class="table-rh" | Result
+|
+{{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
+}}
+|}
+<includeonly>
+[[Category:Templates]]</includeonly>