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

From blackwiki
Jump to navigation Jump to search
imported>Zyxw
(document "class" parameter, correct note about "border" being overridden by "style" which would only occur if "style" included anything that would change border)
imported>Zyxw
(update to show "bg1" and "ta1" only affect titlebar and could possibly be overridden by "titlestyle", also "bg2" and "ta2" could possibly be overridden by "contentstyle", group style parameters by area affected, update examples 5 and 7)
Line 17: Line 17:
 
| showhide = <!--"left", otherwise omit-->
 
| showhide = <!--"left", otherwise omit-->
 
| class =  
 
| class =  
| border =
 
 
| style =  
 
| style =  
 +
| border =
 +
| title =
 
| titlestyle =  
 
| titlestyle =  
| title =  
+
| bg1 =
 +
| ta1 =  
 
| contentstyle =  
 
| contentstyle =  
| bg1 =
 
 
| bg2 =  
 
| bg2 =  
| ta1 =
 
 
| ta2 =  
 
| ta2 =  
 
<!--Older, semi-deprecated parameters:-->
 
<!--Older, semi-deprecated parameters:-->
| header = | extra1= | extra2 =  
+
| header = | extra1 = | extra2 =  
 
}}
 
}}
 
<!----[content to be hidden placed here]---->
 
<!----[content to be hidden placed here]---->
Line 43: Line 43:
 
| ''class''    || [[WP:CLASS#Classes|Class attribute]] affecting entire area.
 
| ''class''    || [[WP:CLASS#Classes|Class attribute]] affecting entire area.
 
|-
 
|-
| ''border''   || [[Cascading Style Sheets|CSS styling]] for border around entire area. May be overridden if ''style'' includes anything that would change the border.
+
| ''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.
 
|-
 
|-
| ''style''    || CSS styling affecting entire area (titlebar and hidden/hideable content). Can be used with ''border'' if "style" doesn't include anything that would change 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.).
 
| 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.
+
| ''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'').
 
| ''contentstyle''&nbsp; || CSS styling to apply to the hidden/hideable content (e.g. background and text-align, per ''titlestyle'').
 
|-
 
|-
| ''bg1'' || background color for all; defaults to transparent
+
| ''bg2'' || Background color for content; defaults to transparent. May be overridden if ''contentstyle'' includes anything changes the background.
 
|-
 
|-
| ''bg2'' || background color for content; defaults to transparent
+
| ''ta2'' || Text alignment for content; defaults to left. May be overridden if ''contentstyle'' includes anything that changes the text alignment.
|-
 
| ''ta1'' || text alignment for all; defaults to left
 
|-
 
| ''ta2'' || text alignment for content; defaults to left
 
 
|}
 
|}
  
Line 132: Line 132:
 
===Example 5===
 
===Example 5===
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
{{Hidden begin |showhide=left
+
{{Hidden begin |showhide=left |expanded=true
 
| titlestyle = background:palegreen;
 
| titlestyle = background:palegreen;
| title = ''showhide'' set to "left"
+
| title = ''showhide'' set to "left" and ''expanded'' set to "true"
 
}}
 
}}
 
* def
 
* def
Line 140: Line 140:
 
{{Hidden end}}
 
{{Hidden end}}
 
</pre>
 
</pre>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |showhide=left
+
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |showhide=left |expanded=true
 
| titlestyle = background:palegreen;
 
| titlestyle = background:palegreen;
| title = ''showhide'' set to "left"
+
| title = ''showhide'' set to "left" and ''expanded'' set to "true"
 
}}
 
}}
 
* def
 
* def
Line 169: Line 169:
  
 
===Example 7===
 
===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;">
 
<pre style="overflow:auto;">
 
{{Hidden begin
 
{{Hidden begin
Line 176: Line 177:
 
| border = 1px solid grey
 
| border = 1px solid grey
 
| bg1 = palegreen
 
| bg1 = palegreen
| bg2 = cyan
+
| ta1 = right
| ta1 = left
+
| extra1 = font-size:120%; <!--semicolon required since titlestyle is used-->
| ta2 = center
+
| extra2 = font-size:150% <!--semicolon optional when contentstyle not used-->
| extra1 = font-size:120%
 
| extra2 = font-size:150%
 
 
}}
 
}}
 
* make window narrower and
 
* make window narrower and
Line 192: Line 191:
 
| border = 1px solid grey
 
| border = 1px solid grey
 
| bg1 = palegreen
 
| bg1 = palegreen
| bg2 = cyan
+
| ta1 = right
| ta1 = left
+
| extra1 = font-size:120%;
| ta2 = center
 
| extra1 = font-size:120%
 
 
| extra2 = font-size:150%
 
| extra2 = font-size:150%
 
}}
 
}}

Revision as of 06:08, 6 September 2015

Syntax

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

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).
class Class attribute affecting entire area.
style 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.
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.).
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  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

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

Example 2

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

Example 3

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

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}}
title on right with 3.0em padding
  • change window width and
  • watch title alignment

Example 5

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

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}}
showhide=left, hidden content 150% size and in bold (contentstyle)
  • def
  • ghi

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
| 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}}
[header (deprecated)][title set to this text]
  • make window narrower and
  • title will wrap

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}}
title with non-breaking spaces 
  • def ... these should have left padding
  • ghi

See also