Template:Hidden begin/doc: Difference between revisions

From Dothack Info
Jump to navigation Jump to search
Visual
(Created page with "{{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...")
 
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{Uses TemplateStyles|Template:Hidden begin/styles.css}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- 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}}.}}
{{hatnote|This documentation is shared by {{tl|Hidden begin}} and {{tl|Hidden end}}.}}
{{#ifeq: {{FULLPAGENAME}} | Template:Hidden begin
{{Collapse Templates}}
| {{high-risk| 169038 }}
{{High-use}}
| {{#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.  
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.  
Line 16: Line 11:


==Syntax==
==Syntax==
 
<syntaxhighlight lang="wikitext" style="overflow:auto;">
<pre style="overflow:auto;">
{{Hidden begin
{{Hidden begin
| expanded = <!--"true", "on", yes", etc, otherwise omit-->
| showhide      = <!--"left", otherwise omit-->
| showhide = <!--"left", otherwise omit-->
| expanded      = <!--"true", "on", yes", etc, otherwise omit-->
| class =  
| class         =  
| style =  
| width          =  
| border =
| border         =  
| title =
| bgcolor        = <!--background color for both the title and content-->
| titlestyle =  
| style          =  
| bg1 =  
| ta1            =  
| ta1 =  
| titlebgcolor  = <!--background color for the title-->
| contentstyle =  
| titlestyle    =  
| bg2 =  
| title          =  
| ta2 =  
| ta2           =  
<!--Older, semi-deprecated parameters:-->
| contentbgcolor = <!--background color for the content-->
| header = | extra1 = | extra2 =  
| contentstyle  =  
}}
}}
<!----[content to be hidden placed here]---->
<!----[content to be hidden placed here]---->
{{Hidden end}}
{{Hidden end}}
</pre>
</syntaxhighlight>


===Parameters===
===Template data===
{| class="wikitable"
{{TemplateData header}}
! Parameter    || Description
<templatedata>
|-
{
| ''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.
"params": {
|-
"showhide": {
| ''expanded''  || Set to anything ("true", "yes", etc.) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).
"aliases": [
|-
"toggle"
| ''class''    || [[WP:CLASS#Classes|Class attribute]] affecting entire area.
],
|-
"label": "Show / Hide",
| ''style''    ||  [[Cascading Style Sheets|CSS styling]] affecting entire area (titlebar and hidden/hideable content).
"description": "Set to \"left\" (without speechmarks) to switch the [show/hide] link's position from the righthand end of the titlebar (default) to the left.",
|-
"type": "string",
| ''border''    ||  CSS styling for border around entire area. Will be overridden by any border styles in ''style''.
"suggestedvalues": [
|-
"left"
| ''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.).
"expanded": {
|-
"label": "Expanded",
| ''bg1'' || Background color for titlebar; defaults to transparent. May be overridden if ''titlestyle'' includes anything that changes the background.
"description": "Set to any value (\"true\", \"yes\", etc.) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).",
|-
"type": "string",
| ''ta1'' || Text alignment for titlebar; defaults to left. May be overridden if ''titlestyle'' includes anything that changes the text alignment.
"suggestedvalues": [
|-
"yes",
| ''contentstyle''&nbsp; || CSS styling to apply to the hidden/hideable content (e.g. background and text-align, per ''titlestyle'').
"true"
|-
]
| ''bg2'' || Background color for content; defaults to transparent. May be overridden if ''contentstyle'' includes anything changes the background.
},
|-
"class": {
| ''ta2'' || Text alignment for content; defaults to left. May be overridden if ''contentstyle'' includes anything that changes the text alignment.
"label": "Class",
|-
"description": "Add additional class attributes affecting the entire template.",
| ''width'' || Change the width from the default 100% to another setting, for example 75%
"type": "string"
|}
},
"width": {
"label": "Width",
"description": "Specify a width for the template.",
"example": "width=20%",
"type": "string",
"default": "100%"
},
"border": {
"label": "Border",
"description": "Add a border to the template",
"example": "1px solid black",
"type": "string"
},
"bgcolor": {
"label": "Background color",
"description": "Specify the background color for the template.",
"example": "#CCF",
"type": "string"
},
"style": {
"label": "Style",
"description": "Add additional style attributes affecting the entire template.",
"example": "font-size:110%;",
"type": "string"
},
"ta1": {
"label": "Title text align",
"description": "Specify the text-align property for the title.",
"example": "center",
"type": "string",
"suggestedvalues": [
"center",
"right",
"left"
],
"default": "left"
},
"titlebgcolor": {
"label": "Title background color",
"description": "Specify the background color for the title.",
"example": "#CCF",
"type": "string"
},
"titlestyle": {
"label": "Title style",
"description": "Add additional style attributes affecting the title.",
"example": "font-size:110%;",
"type": "string"
},
"title": {
"aliases": [
"header"
],
"label": "Title",
"description": "Text shown in titlebar.",
"type": "string"
},
"ta2": {
"label": "Content text align",
"description": "Specify the text-align property for the content.",
"example": "center",
"type": "string",
"suggestedvalues": [
"center",
"right",
"left"
],
"default": "left"
},
"contentbgcolor": {
"label": "Content background color",
"description": "Specify the background color for the content .",
"example": "#CCF",
"type": "string"
},
"contentstyle": {
"aliases": [
"bodystyle"
],
"label": "Content style",
"description": "Add additional style attributes affecting the content.",
"example": "font-size:110%;",
"type": "string"
}
},
"description": "This template creates a dynamic navigation box which is initially collapsed by default.",
"format": "inline"
}
</templatedata>


==Examples==
==Examples==
 
The following are examples with commonly used parameters
===Example 1===
===Example 1===
<syntaxhighlight lang="moin" style="overflow:auto;">
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden begin |title=Default example}}
{{Hidden begin|title=Example title}}
* def
* Example text 1
* ghi
* Example text 2
{{Hidden end}}
{{Hidden end}}
</syntaxhighlight>
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Default example}}
{{Hidden begin|title=Example title}}
* def
* Example text 1
* ghi
* Example text 2
{{Hidden end}}
{{Hidden end}}


===Example 2===
===Example 2===
<syntaxhighlight lang="moin" style="overflow:auto;">
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden begin |title=width example |width=40%}}
{{Hidden begin|title=Example title|width=50%|border=1px solid black}}
* def
* Example text 1
* ghi
* Example text 2
{{Hidden end}}
{{Hidden end}}
</syntaxhighlight>
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}} |title=Width example |width=40%}}
{{Hidden begin|title=Example title|width=50%|border=1px solid black}}
* def
* Example text 1
* ghi
* Example text 2
{{Hidden end}}
{{Hidden end}}


===Example 3===
===Example 3===
<syntaxhighlight lang="moin" style="overflow:auto;">
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden begin
{{Hidden begin|title=Example title|bgcolor=pink|titlebgcolor=#CCF|contentbgcolor=skyblue}}
| titlestyle = background:pink;
* Example text 1
| title = ''titlestyle'' is "background:pink;"
* Example text 2
}}
{{Hidden end}}
* def
* ghi
{{Hidden end}}
</syntaxhighlight>
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
{{Hidden begin|title=Example title|bgcolor=pink|titlebgcolor=#CCF|contentbgcolor=skyblue}}
| titlestyle = background:pink;
* Example text 1
| title = ''titlestyle'' is "background:pink;"
* Example text 2
}}
* def
* ghi
{{Hidden end}}
{{Hidden end}}


===Example 4===
===Example 4===
<syntaxhighlight lang="moin" style="overflow:auto;">
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden begin
{{Hidden begin|title=Example title|titlebgcolor=pink|ta1=center|ta2=right}}
| titlestyle = background:pink;
* Example text 1
| title = added "ta1=center"
* Example text 2
| ta1 = center
{{Hidden end}}
}}
* def
* ghi
{{Hidden end}}
</syntaxhighlight>
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
{{Hidden begin|title=Example title|titlebgcolor=pink|ta1=center|ta2=right}}
| titlestyle = background:pink;
* Example text 1
| title = added "ta1=center"
* Example text 2
| ta1 = center
}}
* def
* ghi
{{Hidden end}}
{{Hidden end}}


===Example 5===
===Example 5===
<syntaxhighlight lang="moin" style="overflow:auto;">
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden begin
{{Hidden begin|title=Example title|titlebgcolor=#98FB98|showhide=left}}
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
* Example text 1
| title = ''title'' on right with 3.0em padding
* Example text 2
}}
{{Hidden end}}
* change window width and
* watch title alignment
{{Hidden end}}
</syntaxhighlight>
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
{{Hidden begin|title=Example title|titlebgcolor=#98FB98|showhide=left}}
| titlestyle = background:pink; text-align:right; padding-right:3.0em;
* Example text 1
| title = ''title'' on right with 3.0em padding
* Example text 2
}}
* change window width and
* watch title alignment
{{Hidden end}}
{{Hidden end}}


===Example 6===
===Example 6===
<syntaxhighlight lang="moin" style="overflow:auto;">
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Hidden begin |showhide=left |expanded=true
{{Hidden begin|title=Example title|titlebgcolor=#FFEBCD|expanded=yes}}
| titlestyle = background:palegreen;
* Example text 1
| title = ''showhide'' set to "left" and ''expanded'' set to "true"
* Example text 2
}}
* 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}}
{{Hidden end}}
</syntaxhighlight>
</syntaxhighlight>
{{Hidden begin{{#ifeq:{{SUBPAGENAME}}|sandbox |/sandbox}}
{{Hidden begin|title=Example title|titlebgcolor=#FFEBCD|expanded=yes}}
| titlestyle =
* Example text 1
| title = title&nbsp;with&nbsp;non-breaking&nbsp;spaces&nbsp;
* Example text 2
| 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}}
{{Hidden end}}


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. Lua error: Internal error: The interpreter exited with status 1. Lua error: Internal error: The interpreter exited with status 1. 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

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

</syntaxhighlight>

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Hidden begin

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

<templatedata> { "params": { "showhide": { "aliases": [ "toggle" ], "label": "Show / Hide", "description": "Set to \"left\" (without speechmarks) to switch the [show/hide] link's position from the righthand end of the titlebar (default) to the left.", "type": "string", "suggestedvalues": [ "left" ] }, "expanded": { "label": "Expanded", "description": "Set to any value (\"true\", \"yes\", etc.) to switch the hidden section's initial state from collapsed (hidden) to expanded (visible).", "type": "string", "suggestedvalues": [ "yes", "true" ] }, "class": { "label": "Class", "description": "Add additional class attributes affecting the entire template.", "type": "string" }, "width": { "label": "Width", "description": "Specify a width for the template.", "example": "width=20%", "type": "string", "default": "100%" }, "border": { "label": "Border", "description": "Add a border to the template", "example": "1px solid black", "type": "string" }, "bgcolor": { "label": "Background color", "description": "Specify the background color for the template.", "example": "#CCF", "type": "string" }, "style": { "label": "Style", "description": "Add additional style attributes affecting the entire template.", "example": "font-size:110%;", "type": "string" }, "ta1": { "label": "Title text align", "description": "Specify the text-align property for the title.", "example": "center", "type": "string", "suggestedvalues": [ "center", "right", "left" ], "default": "left" }, "titlebgcolor": { "label": "Title background color", "description": "Specify the background color for the title.", "example": "#CCF", "type": "string" }, "titlestyle": { "label": "Title style", "description": "Add additional style attributes affecting the title.", "example": "font-size:110%;", "type": "string" }, "title": { "aliases": [ "header" ], "label": "Title", "description": "Text shown in titlebar.", "type": "string" }, "ta2": { "label": "Content text align", "description": "Specify the text-align property for the content.", "example": "center", "type": "string", "suggestedvalues": [ "center", "right", "left" ], "default": "left" }, "contentbgcolor": { "label": "Content background color", "description": "Specify the background color for the content .", "example": "#CCF", "type": "string" }, "contentstyle": { "aliases": [ "bodystyle" ], "label": "Content style", "description": "Add additional style attributes affecting the content.", "example": "font-size:110%;", "type": "string" } }, "description": "This template creates a dynamic navigation box which is initially collapsed by default.", "format": "inline" } </templatedata>

Examples

The following are examples with commonly used parameters

Example 1

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

Example title

</syntaxhighlight>

Example title

Example 2

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

Example title

</syntaxhighlight>

Example title

Example 3

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

Example title

</syntaxhighlight>

Example title

Example 4

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

Example title

</syntaxhighlight>

Example title

Example 5

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

Example title

</syntaxhighlight>

Example title

Example 6

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

Collapse
Example title
  • Example text 1
  • Example text 2

</syntaxhighlight>

Collapse
Example title
  • Example text 1
  • Example text 2

See also


Retrieved from "https://dothack.info/index.php?title=Template:Hidden_begin/doc&oldid=7393"