Vorlage:Collapse/doc: Unterschied zwischen den Versionen

ZIM HilfeWiki - das Wiki
imported>Oetterer
 
Zeile 5: Zeile 5:
 
The {{tlx|collapse|<nowiki>folding text</nowiki>}} template is used for placing collapse boxes around ''short'' discussions and bits of discussions. To fold ''long'' discussion threads, use {{tlx|Collapse top}}<code>... lots of text ...</code>{{tlx|Collapse bottom}}.
 
The {{tlx|collapse|<nowiki>folding text</nowiki>}} template is used for placing collapse boxes around ''short'' discussions and bits of discussions. To fold ''long'' discussion threads, use {{tlx|Collapse top}}<code>... lots of text ...</code>{{tlx|Collapse bottom}}.
  
−
This template should only be used in accordance with the [[Wikipedia:refactoring]] guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.
+
This template should only be used in accordance with the [[Wikipedia:refactoring talk pages]] guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.
 +
 
 +
Do not hide content in articles. This violates the [[WP:Manual of Style#Scrolling lists and collapsible content]] and [[WP:Accessibility]] guidelines.
  
 
== Usage ==
 
== Usage ==
−
 
+
'''''Note: {{Tl|Collapse}} needs to be [[Wikipedia:Substitution|substed]] in order for the time stamp functionality to work properly.'''''
−
'''''Note: {{Tl|Collapse}} needs to be substed in order for the time stamp functionality to work properly.'''''
 
  
 
{{Tlx|Collapse|1&#61;<var>Discussion text to be put into box.</var>|2&#61;<var>Optional custom heading</var>}}
 
{{Tlx|Collapse|1&#61;<var>Discussion text to be put into box.</var>|2&#61;<var>Optional custom heading</var>}}
Zeile 15: Zeile 16:
 
It is definitely safest to use the named {{para|1}} and {{para|2}} parameters, because otherwise any "=" character will break the template.
 
It is definitely safest to use the named {{para|1}} and {{para|2}} parameters, because otherwise any "=" character will break the template.
  
−
=== The bg parameter ===
+
For compatibility with various discussion-boxing and -closing, and discussion-wrapping templates, {{para|1}} can also be given as {{para|content}} or {{para|text}}, and {{para|2}} can also be given as {{para|title}}, {{para|reason}}, {{para|header}}, {{para|heading}}, or {{para|result}}.
  
−
The bg parameter is optional. It changes the background color. Use [[web color]] values (e.g. #F0F2F5).
+
=== HTML version ===
 +
If you find that the template does not function properly in a particular circumstance, this is mostly likely because the wikicode table markup (<code><nowiki>{|</nowiki></code>, etc.) only works when it is at the beginning of a newline.
 +
 
 +
<!--A workaround for this is the "pure HTML" ({{tag|table|o}}, etc.) variant of this template, '''{{tlx|Collapse/HTML}}''', which is identical (same parameters, etc.) other than in not  using wikimarkup for the layout-table code.-->
 +
 
 +
=== The <code>bg</code> parameter ===
 +
The <code>bg</code> parameter is optional. It changes the background color. Use [[wpen:Web color|Web color]] values (e.g. <code>#F0F2F5</code>).
  
 
;Example:
 
;Example:
 
   
 
   
−
{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|bg=#F0F2F5}<nowiki />} creates:
+
<code>{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|bg=#F0F2F5}<nowiki />}</code> creates:
  
 
{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}}
 
{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}}
  
−
=== The padding parameter ===
+
=== The <code>padding</code> parameter ===
−
The padding parameter adjusts the amount of cell padding (defaults to 8px):
+
The <code>padding</code> parameter adjusts the amount of cell padding (defaults to <code>8px</code>):
  
−
{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|padding=20px}<nowiki />} creates the following (expand the box to see the border padding effect):
+
<code>{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|padding=20px}<nowiki />}</code> creates the following (expand the box to see the border padding effect):
  
 
{{Collapse|1=Discussion text to be put into box.|padding=20px}}
 
{{Collapse|1=Discussion text to be put into box.|padding=20px}}
 +
 +
=== The <code>float</code> parameter ===
 +
The <code>float</code> parameter allows the collapsed content to float to the left, right, or center of the page (defaults to <code>none</code> with <code>width = 100%</code>):
 +
 +
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=center<nowiki>}}</nowiki></code> creates the following:
 +
 +
{{Collapse|1=Discussion text to be put into box.|float=center}}
 +
 +
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=center|width=30em<nowiki>}}</nowiki></code> creates the following:
 +
 +
{{Collapse|1=Discussion text to be put into box.|float=center|width=30em}}
 +
 +
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=left|width=30em<nowiki>}}</nowiki></code> creates the following:
 +
 +
{{Collapse|1=Discussion text to be put into box.|float=left|width=30em}}
 +
{{clear}}
 +
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=right|width=30em<nowiki>}}</nowiki></code> creates the following:
 +
 +
{{Collapse|1=Discussion text to be put into box.|float=right|width=30em}}
 +
{{clear}}
 +
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=none|width=30em<nowiki>}}</nowiki></code> creates the following:
 +
 +
{{Collapse|1=Discussion text to be put into box.|float=none|width=30em}}
  
 
=== Around header text ===
 
=== Around header text ===
−
 
 
When used with a section of text, include the section header in the collapsed portion of text. For example, given:
 
When used with a section of text, include the section header in the collapsed portion of text. For example, given:
  
Zeile 42: Zeile 71:
 
Replace with:
 
Replace with:
  
−
<code>{{Tl|Collapse|1&#61;{{Lorem ipsum}}|2&#61;[[Help:Section|Heading]]}}</code>
+
<pre>{{subst:Collapse|1=Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.|2=Heading}}
 +
</pre>
 +
 
 +
===The <code>expand</code> parameter===
 +
Simply add {{para|expand|yes}} to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link. Other options: {{para|expand|}} <code>yes, y, expand, expanded, uncollapse, uncollapsed</code>. Note: {{para|expand|no}} will fold the box (default).
  
−
===The expand parameter===
+
===The <code>clear</code> parameter===
−
Simply add {{para|expand|yes}} to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link.  Note: {{para|expand|no}} does not work; to disable the feature, you have to remove the entire {{para||expand}} parameter and value.
+
In some situations you may not want the default <code>clear: both;</code> CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use {{para|clear|none}}, {{para|clear|right}}, or {{para|clear|left}}, as needed.
  
 
===When content includes tables===
 
===When content includes tables===
−
This template frequently breaks when used around content that consists of or includes wikitables. Such content can be made collapsible by using the {{tlx|collapse top}} and {{tlx|collapse bottom}} templates instead of {{tlx|collapse}}.
+
This template frequently breaks when used around content that consists of or includes [[wpen:Help:Table|wikitables]]. Such content can be made collapsible by using the {{tlx|collapse top}} and {{tlx|collapse bottom}} templates instead of {{tlx|collapse}}.
 +
 
 +
If you want to collapse only the table and not other content, you can do this using wikitable parameters. See the [[wpen:Help:Collapsing#Collapsing tables by default|Collapsing tables]] guide for help.
 +
 
 +
==TemplateData==
 +
This is the TemplateData for this template used by [[wp:VisualEditor|VisualEditor]] and other tools.
 +
 
 +
<templatedata>
 +
{
 +
"description": "Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.",
 +
"params": {
 +
"1": {
 +
"label": "Contents",
 +
"description": "Contents of the box",
 +
"type": "content",
 +
"required": true,
 +
"aliases": [
 +
"content",
 +
"text"
 +
]
 +
},
 +
"2": {
 +
"label": "Title",
 +
"description": "Text of title bar. Defaults to \"Extended contents\".",
 +
"type": "string",
 +
"suggested": true,
 +
"aliases": [
 +
"title",
 +
"heading",
 +
"header",
 +
"reason",
 +
"result"
 +
],
 +
"default": "Extended content"
 +
},
 +
"expand": {
 +
"label": "Expanded by default?",
 +
"description": "Setting to \"yes\" (or \"y\", \"expand\", \"expanded\", \"uncollapse\", or \"uncollapsed\") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be expanded by default.  If not set or set to another value (e.g. \"no\") the box will be collapsed by default (its contents hidden).",
 +
"type": "string",
 +
"default": "no"
 +
},
 +
"border": {
 +
"label": "Border width",
 +
"description": "Width of the outermost border. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. \"px\") Example: 2px.",
 +
"type": "string",
 +
"default": "1px"
 +
},
 +
"bg": {
 +
"label": "Title bar's color",
 +
"description": "Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.",
 +
"type": "string",
 +
"aliases": [
 +
"background"
 +
],
 +
"default": "#F0F2F5"
 +
},
 +
"padding": {
 +
"label": "Padding",
 +
"description": "Width of the padding, the empty space between border and the contents. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. \"px\") Example: 2px.",
 +
"default": "8px"
 +
},
 +
"bg1": {
 +
"label": "Outer background",
 +
"description": "Color of the space between the inner and outer border. Can be set to any valid CSS color.",
 +
"type": "string",
 +
"default": "transparent"
 +
},
 +
"b-color": {
 +
"label": "Outer border color",
 +
"description": "Color of the outer border. Can be any valid CSS color.",
 +
"type": "string",
 +
"default": "silver"
 +
},
 +
"width": {
 +
"label": "Collapse box width",
 +
"description": "The width of the entire collapsed box.",
 +
"type": "string",
 +
"default": "100%"
 +
},
 +
"center": {
 +
"label": "Center-align title",
 +
"description": "If set to any value, the title will be centered.",
 +
"type": "boolean"
 +
},
 +
"fc": {
 +
"label": "Font color",
 +
"description": "Font color for the title. Also sets the color of the [show]/[hide] link. Can be any valid CSS color",
 +
"type": "string"
 +
},
 +
"class": {
 +
"label": "CSS class",
 +
"description": "Additional CSS class to add",
 +
"type": "string"
 +
},
 +
"float": {
 +
"label": "CSS float",
 +
"description": "CSS float, one of \"left\", \"right\", \"none\", \"center\"/\"centre\", or blank.",
 +
"type": "string"
 +
},
 +
"clear": {
 +
"label": "CSS clear",
 +
"description": "CSS clear value.  The default depends on the selected float.  Usually one of \"none\", \"left\", \"right\", or \"both\"",
 +
"type": "string"
 +
},
 +
"left": {
 +
"label": "Left-align title",
 +
"description": "Left-aligns the title.  Takes precedence over center.",
 +
"type": "boolean"
 +
},
 +
"border2": {
 +
"label": "Content border",
 +
"description": "CSS border styling to add to the content.",
 +
"type": "string",
 +
"default": "1px silver"
 +
},
 +
"bg2": {
 +
"label": "Content background color",
 +
"description": "Background color to use for expanded content.",
 +
"type": "string",
 +
"default": "white"
 +
}
 +
}
 +
}
 +
</templatedata>
 +
 
 +
== Re-using at other wikis ==
 +
This template depends upon having rules for the three classes (collapsible, uncollapsed, and collapsed) in the appropriate CSS files, and some related JavaScript installed. This template transcludes {{tl|main other}} and {{tl|lorem ipsum}}, which should also be imported at the same time.
 +
 
 +
For MediaWiki versions ≥ 1.18, this template can simply be exported and then imported into another MediaWiki installation. Some changes to the source code will need to be made in order for this template to become usable on the Main/Article (ns:0) [[mw:Help:Namespaces|namespace]].
  
 +
The toggle text can be edited at external Wiki's [[MediaWiki:Collapsible-expand]] and [[MediaWiki:Collapsible-collapse]] pages. Further information at [[mw:ResourceLoader/Modules#jquery.makeCollapsible|jquery.makeCollapsible module]].
 
== See also ==
 
== See also ==
 
* {{Tl|collapse top}}
 
* {{Tl|collapse top}}

Aktuelle Version vom 4. Oktober 2022, 10:39 Uhr

Shortcuts

The {{collapse|folding text}} template is used for placing collapse boxes around short discussions and bits of discussions. To fold long discussion threads, use {{Collapse top}}... lots of text ...{{Collapse bottom}}.

This template should only be used in accordance with the Wikipedia:refactoring talk pages guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Do not hide content in articles. This violates the WP:Manual of Style and WP:Accessibility guidelines.

Usage[Quelltext bearbeiten]

Note: {{Collapse}} needs to be substed in order for the time stamp functionality to work properly.

{{Collapse|1=Discussion text to be put into box.|2=Optional custom heading}}

It is definitely safest to use the named |1= and |2= parameters, because otherwise any "=" character will break the template.

For compatibility with various discussion-boxing and -closing, and discussion-wrapping templates, |1= can also be given as |content= or |text=, and |2= can also be given as |title=, |reason=, |header=, |heading=, or |result=.

HTML version[Quelltext bearbeiten]

If you find that the template does not function properly in a particular circumstance, this is mostly likely because the wikicode table markup ({|, etc.) only works when it is at the beginning of a newline.


The bg parameter[Quelltext bearbeiten]

The bg parameter is optional. It changes the background color. Use Web color values (e.g. #F0F2F5).

Example

{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}} creates:

Extended content
Discussion text to be put into box.

The padding parameter[Quelltext bearbeiten]

The padding parameter adjusts the amount of cell padding (defaults to 8px):

{{Collapse|1=Discussion text to be put into box.|padding=20px}} creates the following (expand the box to see the border padding effect):

Extended content
Discussion text to be put into box.

The float parameter[Quelltext bearbeiten]

The float parameter allows the collapsed content to float to the left, right, or center of the page (defaults to none with width = 100%):

{{Collapse|1=Discussion text to be put into box.|float=center}} creates the following:

Extended content
Discussion text to be put into box.

{{Collapse|1=Discussion text to be put into box.|float=center|width=30em}} creates the following:

Extended content
Discussion text to be put into box.

{{Collapse|1=Discussion text to be put into box.|float=left|width=30em}} creates the following:

Extended content
Discussion text to be put into box.

{{Collapse|1=Discussion text to be put into box.|float=right|width=30em}} creates the following:

Extended content
Discussion text to be put into box.

{{Collapse|1=Discussion text to be put into box.|float=none|width=30em}} creates the following:

Extended content
Discussion text to be put into box.

Around header text[Quelltext bearbeiten]

When used with a section of text, include the section header in the collapsed portion of text. For example, given:

== Heading ==
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Replace with: 

{{subst:Collapse|1=Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.|2=Heading}}

The expand parameter[Quelltext bearbeiten]

Simply add |expand=yes to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link. Other options: |expand= yes, y, expand, expanded, uncollapse, uncollapsed. Note: |expand=no will fold the box (default).

The clear parameter[Quelltext bearbeiten]

In some situations you may not want the default clear: both; CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use |clear=none, |clear=right, or |clear=left, as needed.

When content includes tables[Quelltext bearbeiten]

This template frequently breaks when used around content that consists of or includes wikitables. Such content can be made collapsible by using the {{collapse top}} and {{collapse bottom}} templates instead of {{collapse}}.

If you want to collapse only the table and not other content, you can do this using wikitable parameters. See the Collapsing tables guide for help.

TemplateData[Quelltext bearbeiten]

This is the TemplateData for this template used by VisualEditor and other tools.

Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.

Vorlagenparameter

ParameterBeschreibungTypStatus
Contents1 content text

Contents of the box

Inhalterforderlich
Title2 title heading header reason result

Text of title bar. Defaults to "Extended contents".

Standard
Extended content
Zeichenfolgevorgeschlagen
Expanded by default?expand

Setting to "yes" (or "y", "expand", "expanded", "uncollapse", or "uncollapsed") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be expanded by default. If not set or set to another value (e.g. "no") the box will be collapsed by default (its contents hidden).

Standard
no
Zeichenfolgeoptional
Border widthborder

Width of the outermost border. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. "px") Example: 2px.

Standard
1px
Zeichenfolgeoptional
Title bar's colorbg background

Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.

Standard
#F0F2F5
Zeichenfolgeoptional
Paddingpadding

Width of the padding, the empty space between border and the contents. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. "px") Example: 2px.

Standard
8px
Unbekanntoptional
Outer backgroundbg1

Color of the space between the inner and outer border. Can be set to any valid CSS color.

Standard
transparent
Zeichenfolgeoptional
Outer border colorb-color

Color of the outer border. Can be any valid CSS color.

Standard
silver
Zeichenfolgeoptional
Collapse box widthwidth

The width of the entire collapsed box.

Standard
100%
Zeichenfolgeoptional
Center-align titlecenter

If set to any value, the title will be centered.

Booleschoptional
Font colorfc

Font color for the title. Also sets the color of the [show]/[hide] link. Can be any valid CSS color

Zeichenfolgeoptional
CSS classclass

Additional CSS class to add

Zeichenfolgeoptional
CSS floatfloat

CSS float, one of "left", "right", "none", "center"/"centre", or blank.

Zeichenfolgeoptional
CSS clearclear

CSS clear value. The default depends on the selected float. Usually one of "none", "left", "right", or "both"

Zeichenfolgeoptional
Left-align titleleft

Left-aligns the title. Takes precedence over center.

Booleschoptional
Content borderborder2

CSS border styling to add to the content.

Standard
1px silver
Zeichenfolgeoptional
Content background colorbg2

Background color to use for expanded content.

Standard
white
Zeichenfolgeoptional

Re-using at other wikis[Quelltext bearbeiten]

This template depends upon having rules for the three classes (collapsible, uncollapsed, and collapsed) in the appropriate CSS files, and some related JavaScript installed. This template transcludes {{main other}} and {{lorem ipsum}}, which should also be imported at the same time.

For MediaWiki versions ≥ 1.18, this template can simply be exported and then imported into another MediaWiki installation. Some changes to the source code will need to be made in order for this template to become usable on the Main/Article (ns:0) namespace.

The toggle text can be edited at external Wiki's MediaWiki:Collapsible-expand and MediaWiki:Collapsible-collapse pages. Further information at jquery.makeCollapsible module.

See also[Quelltext bearbeiten]


Abgerufen von „https://hilfe.uni-paderborn.de/index.php?title=Vorlage:Collapse/doc&oldid=28885“
Cookies helfen uns bei der Bereitstellung des ZIM HilfeWikis. Bei der Nutzung vom ZIM HilfeWiki werden die in der Datenschutzerklärung beschriebenen Cookies gespeichert.
Weitere Informationen