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

From blackwiki
Jump to navigation Jump to search
imported>Eyesnore
m (Reverted edits by 66.87.134.126 (talk): Unexplained blanking of page (HG) (3.1.21))
(Blanked the page)
Line 1: Line 1:
{{Documentation subpage}}
 
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
{{hatnote|This documentation is shared by {{tl|Hidden begin}} and {{tl|Hidden end}}.}}
 
{{#ifeq: {{FULLPAGENAME}} | Template:Hidden begin
 
| {{high-risk| 125,500+ }}
 
| {{#ifeq: {{FULLPAGENAME}} | Template:Hidden end
 
  | {{high-risk| 125,600+ }}
 
  }}
 
}}
 
{{TOC limit|2}}
 
  
==Syntax==
 
 
<pre style="overflow:auto;">
 
{{Hidden begin
 
| expanded = <!--"true", "on", yes", etc, otherwise omit-->
 
| showhide = <!--"left", otherwise omit-->
 
| class =
 
| style =
 
| border =
 
| title =
 
| titlestyle =
 
| bg1 =
 
| ta1 =
 
| contentstyle =
 
| bg2 =
 
| 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).
 
|-
 
| ''class''    || [[WP:CLASS#Classes|Class attribute]] affecting entire area.
 
|-
 
| ''style''    ||  [[Cascading Style Sheets|CSS styling]] affecting entire area (titlebar and hidden/hideable content).
 
|-
 
| ''border''    ||  CSS styling for border around entire area. May be overridden if ''style'' includes anything that changes the border.
 
|-
 
| ''title''    || Text shown in titlebar.
 
|-
 
| 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.).
 
|-
 
| ''bg1'' || Background color for titlebar; defaults to transparent. May be overridden if ''titlestyle'' includes anything changes the background.
 
|-
 
| ''ta1'' || Text alignment for titlebar; defaults to left. May be overridden if ''titlestyle'' includes anything that changes the text alignment.
 
|-
 
| ''contentstyle''&nbsp; || CSS styling to apply to the hidden/hideable content (e.g. background and text-align, per ''titlestyle'').
 
|-
 
| ''bg2'' || Background color for content; defaults to transparent. May be overridden if ''contentstyle'' includes anything changes the background.
 
|-
 
| ''ta2'' || Text alignment for content; defaults to left. May be overridden if ''contentstyle'' includes anything that changes the text alignment.
 
|}
 
 
==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 |expanded=true
 
| titlestyle = background:palegreen;
 
| title = ''showhide'' set to "left" and ''expanded'' set to "true"
 
}}
 
* def
 
* ghi
 
{{Hidden end}}
 
</pre>
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |showhide=left |expanded=true
 
| titlestyle = background:palegreen;
 
| title = ''showhide'' set to "left" and ''expanded'' set to "true"
 
}}
 
* 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===
 
<!-- This example updated to show that bg1/ta1 only affect titlebar, used ta1=right since it is non-default for titlebar and content. -->
 
<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
 
| ta1 = right
 
| extra1 = font-size:120%; <!--semicolon required since titlestyle is used-->
 
| extra2 = font-size:150% <!--semicolon optional when contentstyle not used-->
 
}}
 
* 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
 
| ta1 = right
 
| 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>
 

Revision as of 03:24, 1 August 2016