Template:Hidden/doc: Difference between revisions

From Unofficial Homecoming Wiki
Jump to navigation Jump to search
imported>Sekoia
(+Note: Please do not use this for spoilers (yet!))
imported>Sekoia
m (updating for {{Documentation}}, other minor tweaks)
Line 1: Line 1:
{{documentation subpage}}
{{divbox|blue|Important Note|3=Please do not use the Hidden template for Spoilers. Currently, there is no consensus as to whether the template should be used for spoilers. If you use it and consensus forms against it, your edits will be reverted. If consensus forms in favor of using it, a template will be made specifically for that purpose and all spoilers that you hide with this template will have to be updated to use the new template. So either way, you might as well wait until consensus forms.<br />
{{divbox|blue|Important Note|3=Please do not use the Hidden template for Spoilers. Currently, there is no consensus as to whether the template should be used for spoilers. If you use it and consensus forms against it, your edits will be reverted. If consensus forms in favor of using it, a template will be made specifically for that purpose and all spoilers that you hide with this template will have to be updated to use the new template. So either way, you might as well wait until consensus forms.<br />
<br />
<br />
If you'd like to help make that consensus form faster, then please voice your opinions on this thread: [http://paragonforums.com/forums/viewtopic.php?p=5270]}}
If you'd like to help make that consensus form faster, then please voice your opinions on this thread: [http://paragonforums.com/forums/viewtopic.php?p=5270]}}


{{TOCright}}
== Overview ==
This template creates a [[wikipedia: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.
This template creates a [[wikipedia: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.


Line 100: Line 103:


<includeonly>
<includeonly>
[[Category:Formatting templates|{{PAGENAME}}]]
[[Category:Formatting templates]]
</includeonly>
</includeonly>

Revision as of 07:11, 20 February 2008

This is a documentation subpage for Template:Hidden (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Overview

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.

Usage

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 parameters

headercss
add CSS to the header.
contentcss
add CSS to the content box.
fw1
the font-weight for the heading (default "bold")
fw2
the font-weight for the body (default "normal")
bg1
the background-color for the heading (default "transparent")
bg2
the background-color for the body (default "transparent")
ta1
the text-align for the heading (default "center")
ta2
the text-align for the body (default "left")


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

Examples

The simplest

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

Header background

Code
{{hidden|Title text here|Body text line 1<br/>Body text line 2|bg1=#ccccff|ta2=center}}
Result


CSS

Code
{{hidden
| headercss = background: #ccccff; font-size: 110%; width: 50%;
| contentcss = text-align: center; font-size: 110%; width: 50%;
| header = Title text here
| content = Body text line 1<br/>Body text line 2<br/>Body text line 3
}}
Result

Lorem ipsum

Code
{{hidden|ta1=left|bg1=cyan|bg2=yellow|lorem ipsum|{{lipsum}}}}
Result

Issues

First

A long header may overlap the show/hide button (!):

{{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}}

yields:

Second

With ta1=right or a long header the header overlaps the show/hide link (at least in some browsers):

Example with long header
Example with ta1=right
Example with ta1=right & first line blank