Template:Hidden end/doc: Difference between revisions

From Dothack Info
Jump to navigation Jump to search
mediawiki >Plastikspork
(Merged)
 
m (1 revision imported)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
#REDIRECT [[Template:Hidden begin/doc]]
{{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| 169038 }}
| {{#ifeq: {{FULLPAGENAME}} | Template:Hidden end
  | {{high-risk| 169128 }}
  }}
}}
{{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==
 
<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. Will be overridden by any border styles in ''style''.
|-
| ''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 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''&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.
|-
| ''width'' || Change the width from the default 100% to another setting, for example 75%
|}
 
==Examples==
 
===Example 1===
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin |title=Default example}}
* def
* ghi
{{Hidden end}}
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Default example}}
* def
* ghi
{{Hidden end}}
 
===Example 2===
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin |title=width example |width=40%}}
* def
* ghi
{{Hidden end}}
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Width example |width=40%}}
* def
* ghi
{{Hidden end}}
 
===Example 3===
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin
| titlestyle = background:pink;
| title = ''titlestyle'' is "background:pink;"
}}
* def
* ghi
{{Hidden end}}
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
| titlestyle = background:pink;
| title = ''titlestyle'' is "background:pink;"
}}
* def
* ghi
{{Hidden end}}
 
===Example 4===
<syntaxhighlight lang="moin" style="overflow:auto;">
{{Hidden begin
| titlestyle = background:pink;
| title = added "ta1=center"
| ta1 = center
}}
* def
* ghi
{{Hidden end}}
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
| titlestyle = background:pink;
| title = added "ta1=center"
| ta1 = center
}}
* def
* ghi
{{Hidden end}}
 
===Example 5===
<syntaxhighlight lang="moin" 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}}
</syntaxhighlight>
{{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 6===
<syntaxhighlight lang="moin" 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}}
</syntaxhighlight>
{{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 7===
<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 8===
<!-- 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 9===
<syntaxhighlight lang="text" style="overflow:auto;">
{{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}}
</syntaxhighlight>
{{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 22:30, 21 September 2023

Lua error: Internal error: The interpreter exited with status 1. Lua error: Internal error: The interpreter exited with status 1.

Template:TOC limit Lua error: Internal error: The interpreter exited with status 1.

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.
width Change the width from the default 100% to another setting, for example 75%

Examples

Example 1

<syntaxhighlight lang="moin" style="overflow:auto;">

Default example

</syntaxhighlight>

Default example

Example 2

<syntaxhighlight lang="moin" style="overflow:auto;">

width example

</syntaxhighlight>

Width example

Example 3

<syntaxhighlight lang="moin" style="overflow:auto;">

titlestyle is "background:pink;"

</syntaxhighlight>

titlestyle is "background:pink;"

Example 4

<syntaxhighlight lang="moin" style="overflow:auto;">

added "ta1=center"

</syntaxhighlight>

added "ta1=center"

Example 5

<syntaxhighlight lang="moin" style="overflow:auto;">

title on right with 3.0em padding

</syntaxhighlight>

title on right with 3.0em padding

Example 6

<syntaxhighlight lang="moin" style="overflow:auto;">

Collapse
showhide set to "left" and expanded set to "true"
* def
* ghi

</syntaxhighlight>

Collapse
showhide set to "left" and expanded set to "true"
  • def
  • ghi

Example 7

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

Example 8

{{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}}
[title set to this text]

Example 9

<syntaxhighlight lang="text" style="overflow:auto;">

title with non-breaking spaces 

</syntaxhighlight>

title with non-breaking spaces 

See also