Difference between revisions of "Template:Hidden begin/doc"

From MansunWiki
Jump to: navigation, search
(Created page with "<includeonly>{{#invoke:Hatnote|hatnote}}</includeonly><noinclude> {{documentation}} <!-- Categories go on the /doc subpage, and interwikis go on Wikidata. --> </noinclude>")
 
m
 
Line 1: Line 1:
−
<includeonly>{{#invoke:Hatnote|hatnote}}</includeonly><noinclude>
+
{{Documentation subpage}}
−
{{documentation}}
+
{{hatnote|This documentation is shared by {{tl|Hidden begin}} and {{tl|Hidden end}}.}}
−
<!-- Categories go on the /doc subpage, and interwikis go on Wikidata. -->
+
{{TOC limit|2}}
−
</noinclude>
+
==Syntax==
 +
 
 +
<pre style="overflow:auto;">
 +
{{Hidden begin
 +
| expanded =  <!--"true", "on", yes", etc, otherwise omit-->
 +
| showhide =  <!--"left", otherwise omit-->
 +
| border =
 +
| style =
 +
| titlestyle =
 +
| title =
 +
| contentstyle =
 +
|bg1=
 +
|bg2=
 +
|ta1=
 +
|ta2=
 +
<!--Older, semi-deprecated parameters:-->
 +
|header= |extra1= |extra2=
 +
}}
 +
<!----[content to be hidden placed here]---->
 +
{{Hidden end}}
 +
</pre>
 +
 
 +
===Parameters===
 +
{| class="wikitable"
 +
! Parameter    || Description
 +
|-
 +
| ''showhide''<!--previously: <br />or ''toggle''-->  || Set to "left" (without speechmarks) to switch the [show/hide] link's position from the righthand end of the titlebar (default) to the left.
 +
|-
 +
| ''expanded''  || Set to anything ("true", "yes", etc) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).
 +
|-
 +
| ''border''    || [[Cascading Style Sheets|CSS styling]] for border around entire area. Overridden by ''style'' (if used).
 +
|-
 +
| ''style''    ||  CSS styling affecting entire area (titlebar and hidden/hideable content). Overrides ''border'' if used.
 +
|-
 +
|style="vertical-align:top;"| ''titlestyle'' || CSS styles to apply to the titlebar (e.g. {{para|titlestyle|border:1px solid lightgrey;}} to produce a border around it; {{para|titlestyle|background:''color'';}} to set its background color to [[Web colors#X11 color names|''color'']]&thinsp;; {{para|titlestyle|text-align:[center/right];}} to switch its text (''title'')'s alignment from left to center or right; etc).
 +
|-
 +
| ''title''    || Text shown in titlebar.
 +
|-
 +
| ''contentstyle''&nbsp; || CSS styling to apply to the hidden material (e.g. background and text-align, per ''titlestyle'').
 +
|-
 +
| ''bg1'' || background color for all; defaults to transparent
 +
|-
 +
| ''bg2'' || background color for content; defaults to transparent
 +
|-
 +
| ''ta1'' || text alignment for all; defaults to left
 +
|-
 +
| ''ta2'' || text alignment for content; defaults to left
 +
|}
 +
 
 +
==Examples==
 +
===Example 1===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin |title=Default example}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Default example}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
 
 +
===Example 2===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin
 +
| titlestyle = background:pink;
 +
| title = ''titlestyle'' is "background:pink;"
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 +
| titlestyle = background:pink;
 +
| title = ''titlestyle'' is "background:pink;"
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
 
 +
===Example 3===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin
 +
| titlestyle = background:pink; text-align:center;
 +
| title = added "text-align:center;"
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 +
| titlestyle = background:pink; text-align:center;
 +
| title = added "text-align:center;"
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
 
 +
===Example 4===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin
 +
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
 +
| title = ''title'' on right with 3.0em padding
 +
}}
 +
* change window width and
 +
* watch title alignment
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 +
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
 +
| title = ''title'' on right with 3.0em padding
 +
}}
 +
* change window width and
 +
* watch title alignment
 +
{{Hidden end}}
 +
 
 +
===Example 5===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin |showhide=left
 +
| titlestyle = background:palegreen;
 +
| title = ''showhide'' set to "left"
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |showhide=left
 +
| titlestyle = background:palegreen;
 +
| title = ''showhide'' set to "left"
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
 
 +
===Example 6===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin |showhide=left
 +
| titlestyle = background:palegreen;
 +
| title = <code style="background:transparent;">showhide=left</code>, hidden content 150% size and in bold (''contentstyle'')
 +
| contentstyle = font-size:150%; font-weight:bold;
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |showhide=left
 +
| titlestyle = background:palegreen;
 +
| title = <code style="background:transparent;">showhide=left</code>, hidden content 150% size and in bold (''contentstyle'')
 +
| contentstyle = font-size:150%; font-weight:bold;
 +
}}
 +
* def
 +
* ghi
 +
{{Hidden end}}
 +
 
 +
===Example 7===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin
 +
| header = [''header'' (deprecated)]
 +
| titlestyle = font-style:italic; padding-right:3.0em;
 +
| title = [''title'' set to this text]
 +
| border = 1px solid grey
 +
| bg1 = palegreen
 +
| bg2 = cyan
 +
| ta1 = left
 +
| ta2 = center
 +
| extra1 = font-size:120%
 +
| extra2 = font-size:150%
 +
}}
 +
* make window narrower and
 +
* title will wrap
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 +
| header = [''header'' (deprecated)]
 +
| titlestyle = font-style:italic; padding-right:3.0em;
 +
| title = [''title'' set to this text]
 +
| border = 1px solid grey
 +
| bg1 = palegreen
 +
| bg2 = cyan
 +
| ta1 = left
 +
| ta2 = center
 +
| extra1 = font-size:120%
 +
| extra2 = font-size:150%
 +
}}
 +
* make window narrower and
 +
* title will wrap
 +
{{Hidden end}}
 +
 
 +
===Example 8===
 +
<pre style="overflow:auto;">
 +
{{Hidden begin
 +
| titlestyle =
 +
| title = title&amp;nbsp;with&amp;nbsp;non-breaking&amp;nbsp;spaces&amp;nbsp;
 +
| border = 1px solid red
 +
| bg1 = cyan
 +
| bg2 = yellow
 +
| ta1 = right
 +
| ta2 = left
 +
| extra1 = font-size:120%; padding-right:2.5em;
 +
| extra2 = font-size:150%; padding-left:3.0em;
 +
}}
 +
* def ... these should have left padding
 +
* ghi
 +
{{Hidden end}}
 +
</pre>
 +
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 +
| titlestyle =
 +
| title = title&nbsp;with&nbsp;non-breaking&nbsp;spaces&nbsp;
 +
| border = 1px solid red
 +
| bg1 = cyan
 +
| bg2 = yellow
 +
| ta1 = right
 +
| ta2 = left
 +
| extra1 = font-size:120%; padding-right:2.5em;
 +
| extra2 = font-size:150%; padding-left:3.0em;
 +
}}
 +
* def ... these should have left padding
 +
* ghi
 +
{{Hidden end}}
 +
 
 +
==See also==
 +
* {{tl|Hidden}}
 +
 
 +
<includeonly>{{basepage subpage
 +
| <!-- ADD CATEGORIES BELOW THIS LINE -->
 +
[[Category:Collapse templates]]
 +
}}</includeonly>

Latest revision as of 20:47, 15 July 2015

{{#invoke:Hatnote|hatnote}}

Syntax

{{Hidden begin
| expanded =  <!--"true", "on", yes", etc, otherwise omit-->
| showhide =  <!--"left", otherwise omit-->
| border =
| style =
| titlestyle =
| title =
| contentstyle =
|bg1= 
|bg2= 
|ta1= 
|ta2=
<!--Older, semi-deprecated parameters:-->
|header= |extra1= |extra2=
}}
<!----[content to be hidden placed here]---->
{{Hidden end}}

Parameters

Parameter Description
showhide Set to "left" (without speechmarks) to switch the [show/hide] link's position from the righthand end of the titlebar (default) to the left.
expanded Set to anything ("true", "yes", etc) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).
border CSS styling for border around entire area. Overridden by style (if used).
style CSS styling affecting entire area (titlebar and hidden/hideable content). Overrides border if used.
titlestyle CSS styles to apply to the titlebar (e.g. |titlestyle=border:1px solid lightgrey; to produce a border around it; |titlestyle=background:color; to set its background color to color ; |titlestyle=text-align:[center/right]; to switch its text (title)'s alignment from left to center or right; etc).
title Text shown in titlebar.
contentstyle  CSS styling to apply to the hidden material (e.g. background and text-align, per titlestyle).
bg1 background color for all; defaults to transparent
bg2 background color for content; defaults to transparent
ta1 text alignment for all; defaults to left
ta2 text alignment for content; defaults to left

Examples

Example 1

{{Hidden begin |title=Default example}}
* def
* ghi
{{Hidden end}}

Example 2

{{Hidden begin
| titlestyle = background:pink;
| title = ''titlestyle'' is "background:pink;"
}}
* def
* ghi
{{Hidden end}}

Example 3

{{Hidden begin
| titlestyle = background:pink; text-align:center;
| title = added "text-align:center;"
}}
* def
* ghi
{{Hidden end}}

Example 4

{{Hidden begin
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
| title = ''title'' on right with 3.0em padding
}}
* change window width and
* watch title alignment
{{Hidden end}}

Example 5

{{Hidden begin |showhide=left
| titlestyle = background:palegreen;
| title = ''showhide'' set to "left"
}}
* def
* ghi
{{Hidden end}}

Example 6

{{Hidden begin |showhide=left
| titlestyle = background:palegreen;
| title = <code style="background:transparent;">showhide=left</code>, hidden content 150% size and in bold (''contentstyle'')
| contentstyle = font-size:150%; font-weight:bold;
}}
* def
* ghi
{{Hidden end}}

Example 7

{{Hidden begin
| header = [''header'' (deprecated)]
| titlestyle = font-style:italic; padding-right:3.0em;
| title = [''title'' set to this text]
| border = 1px solid grey
| bg1 = palegreen
| bg2 = cyan
| ta1 = left
| ta2 = center
| extra1 = font-size:120%
| extra2 = font-size:150%
}}
* make window narrower and
* title will wrap
{{Hidden end}}

Example 8

{{Hidden begin
| titlestyle =
| title = title&nbsp;with&nbsp;non-breaking&nbsp;spaces&nbsp;
| border = 1px solid red
| bg1 = cyan
| bg2 = yellow
| ta1 = right
| ta2 = left
| extra1 = font-size:120%; padding-right:2.5em;
| extra2 = font-size:150%; padding-left:3.0em;
}}
* def ... these should have left padding
* ghi
{{Hidden end}}

See also


Retrieved from ‘http://www.mansun.wiki/index.php?title=Template:Hidden_begin/doc&oldid=2058’