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

From blackwiki
Jump to navigation Jump to search
imported>GoingBatty
m (typo(s) fixed: etc) → etc.) (2) using AWB (11376))
imported>WOSlinker
m (change source to syntaxhighlight)
 
(16 intermediate revisions by 14 users not shown)
Line 3: Line 3:
 
{{hatnote|This documentation is shared by {{tl|Hidden begin}} and {{tl|Hidden end}}.}}
 
{{hatnote|This documentation is shared by {{tl|Hidden begin}} and {{tl|Hidden end}}.}}
 
{{#ifeq: {{FULLPAGENAME}} | Template:Hidden begin
 
{{#ifeq: {{FULLPAGENAME}} | Template:Hidden begin
| {{high-risk| 125,500+ }}
+
| {{high-risk| 169038 }}
 
| {{#ifeq: {{FULLPAGENAME}} | Template:Hidden end
 
| {{#ifeq: {{FULLPAGENAME}} | Template:Hidden end
   | {{high-risk| 125,600+ }}
+
   | {{high-risk| 169128 }}
 
   }}
 
   }}
 
}}
 
}}
 
{{TOC limit|2}}
 
{{TOC limit|2}}
 +
{{Template:Collapse Templates}}
 +
 +
Do not use this template to hide content in articles. This violates the [[WP:Manual of Style#Scrolling lists and collapsible content|WP:Manual of Style § Scrolling lists and collapsible content]] and [[WP:Accessibility]] guidelines. This template is intended for use in pages in [[Wikipedia:Namespaces|namespaces]] other than the article namespace.
 +
 +
'''Note''': This template does not hide anything for mobile users ([[phab:T111565]]).
  
 
==Syntax==
 
==Syntax==
Line 14: Line 19:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
{{Hidden begin
 
{{Hidden begin
| expanded = <!--"true", "on", yes", etc, otherwise omit-->
+
| expanded = <!--"true", "on", yes", etc, otherwise omit-->
| showhide = <!--"left", otherwise omit-->
+
| showhide = <!--"left", otherwise omit-->
 +
| class =
 +
| style =
 
| border =
 
| border =
| style =
+
| title =  
| titlestyle =
+
| titlestyle =  
| title =
+
| bg1 =  
| contentstyle =
+
| ta1 =  
|bg1=  
+
| contentstyle =  
|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 40: Line 46:
 
| ''expanded''  || Set to anything ("true", "yes", etc.) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).
 
| ''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).
+
| ''class''     || [[WP:CLASS#Classes|Class attribute]] affecting entire area.
 
|-
 
|-
| ''style''    ||  CSS styling affecting entire area (titlebar and hidden/hideable content). Overrides ''border'' if used.
+
| ''style''    ||  [[Cascading Style Sheets|CSS styling]] affecting entire area (titlebar and hidden/hideable content).
 
|-
 
|-
|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.).
+
| ''border''   || CSS styling for border around entire area. Will be overridden by any border styles in ''style''.
 
|-
 
|-
 
| ''title''    || Text shown in titlebar.
 
| ''title''    || Text shown in titlebar.
 
|-
 
|-
| ''contentstyle''&nbsp; || CSS styling to apply to the hidden material (e.g. background and text-align, per ''titlestyle'').
+
| 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 all; defaults to transparent
+
| ''bg1'' || Background color for titlebar; defaults to transparent. May be overridden if ''titlestyle'' includes anything that changes the background.
 
|-
 
|-
| ''bg2'' || background color for content; defaults to transparent
+
| ''ta1'' || Text alignment for titlebar; defaults to left. May be overridden if ''titlestyle'' includes anything that changes the text alignment.
 
|-
 
|-
| ''ta1'' || text alignment for all; defaults to left
+
| ''contentstyle''&nbsp; || CSS styling to apply to the hidden/hideable content (e.g. background and text-align, per ''titlestyle'').
 
|-
 
|-
| ''ta2'' || text alignment for content; defaults to left
+
| ''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.
 
|}
 
|}
  
Line 62: Line 70:
  
 
===Example 1===
 
===Example 1===
<pre style="overflow:auto;">
+
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin |title=Default example}}
+
{{Hidden begin |title=Default example}}
* def
+
* def
* ghi
+
* ghi
{{Hidden end}}
+
{{Hidden end}}
</pre>
+
</syntaxhighlight>
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Default example}}
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Default example}}
 
* def
 
* def
Line 74: Line 82:
  
 
===Example 2===
 
===Example 2===
<pre style="overflow:auto;">
+
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin
+
{{Hidden begin
| titlestyle = background:pink;
+
| titlestyle = background:pink;
| title = ''titlestyle'' is "background:pink;"
+
| title = ''titlestyle'' is "background:pink;"
}}
+
}}
* def
+
* def
* ghi
+
* ghi
{{Hidden end}}
+
{{Hidden end}}
</pre>
+
</syntaxhighlight>
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
| titlestyle = background:pink;
 
| titlestyle = background:pink;
Line 92: Line 100:
  
 
===Example 3===
 
===Example 3===
<pre style="overflow:auto;">
+
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin
+
{{Hidden begin
| titlestyle = background:pink; text-align:center;
+
| titlestyle = background:pink;
| title = added "text-align:center;"
+
| title = added "ta1=center"
}}
+
| ta1 = center
* def
+
}}
* ghi
+
* def
{{Hidden end}}
+
* ghi
</pre>
+
{{Hidden end}}
 +
</syntaxhighlight>
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
| titlestyle = background:pink; text-align:center;
+
| titlestyle = background:pink;
| title = added "text-align:center;"
+
| title = added "ta1=center"
 +
| ta1 = center
 
}}
 
}}
 
* def
 
* def
Line 110: Line 120:
  
 
===Example 4===
 
===Example 4===
<pre style="overflow:auto;">
+
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin
+
{{Hidden begin
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
+
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
| title = ''title'' on right with 3.0em padding
+
| title = ''title'' on right with 3.0em padding
}}
+
}}
* change window width and
+
* change window width and
* watch title alignment
+
* watch title alignment
{{Hidden end}}
+
{{Hidden end}}
</pre>
+
</syntaxhighlight>
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
 
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
Line 128: Line 138:
  
 
===Example 5===
 
===Example 5===
<pre style="overflow:auto;">
+
<syntaxhighlight lang="moin" 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
* ghi
+
* ghi
{{Hidden end}}
+
{{Hidden end}}
</pre>
+
</syntaxhighlight>
{{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 166: Line 176:
  
 
===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 173: Line 184:
 
| 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 189: Line 198:
 
| 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%
 
}}
 
}}
Line 200: Line 207:
  
 
===Example 8===
 
===Example 8===
<pre style="overflow:auto;">
+
<syntaxhighlight lang="text" style="overflow:auto;">
 
{{Hidden begin
 
{{Hidden begin
 
| titlestyle =
 
| titlestyle =
| title = title&amp;nbsp;with&amp;nbsp;non-breaking&amp;nbsp;spaces&amp;nbsp;
+
| title = title&nbsp;with&nbsp;non-breaking&nbsp;spaces&nbsp;
 
| border = 1px solid red
 
| border = 1px solid red
 
| bg1 = cyan
 
| bg1 = cyan
Line 215: Line 222:
 
* ghi
 
* ghi
 
{{Hidden end}}
 
{{Hidden end}}
</pre>
+
</syntaxhighlight>
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
 
| titlestyle =
 
| titlestyle =

Latest revision as of 12:39, 7 July 2020

Do not use this template to hide content in articles. This violates the WP:Manual of Style § Scrolling lists and collapsible content and WP:Accessibility guidelines. This template is intended for use in pages in namespaces other than the article namespace.

Note: This template does not hide anything for mobile users (phab:T111565).

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. Will be overridden by any border styles in style.
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 that 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;
 | title = added "ta1=center"
 | ta1 = center
 }}
 * def
 * ghi
 {{Hidden end}}
added "ta1=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