Template:Collapse/doc View history

(Created initial doc)
 
(→‎Around header text: updated template)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Template doc cleanup}}
{{Mbox
| type = construction
| text = This documentation is not fully updated to match the current ability of the template. Details can be found in the current version of the [https://en.wikipedia.org/wiki/Template:Collapse Wikipedia Template:Collapse] doc.
}}


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}}.
Line 39: Line 45:
Replace with:
Replace with:


<code>{{Tlsp|Collapse|1&#61;{{Lorem ipsum}}|2&#61;[[Wikipedia:Help:Section|Heading]]}}</code>
<code>{{Tls|Collapse|1&#61;{{Lorem ipsum}}|2&#61;[[Wikipedia:Help:Section|Heading]]}}</code>


===The expand parameter===
===The expand parameter===
Line 53: Line 59:
<includeonly>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Archival templates|{{PAGENAME}}]]
[[Category:Page formatting templates|{{PAGENAME}}]]
[[Category:Collapse templates|{{PAGENAME}}]]


</includeonly>
</includeonly>

Latest revision as of 17:07, 10 August 2022

This is a documentation subpage for Template:Collapse.
It contains usage information, categories and other content that is not part of the original template page.
This page contains one or more broken links likely from an incomplete Wikipedia documentation import. If you edit this page, consider either adding the missing links or update the template code and this documentation to not use any of the missing references.


This documentation is not fully updated to match the current ability of the template. Details can be found in the current version of the Wikipedia Template:Collapse doc.

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

Usage

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.

The bg parameter

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

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.

Around header text

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

The expand parameter

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. Note: |expand=no does not work; to disable the feature, you have to remove the entire |expand parameter and value.

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 {{collapse top}} and {{collapse bottom}} templates instead of {{collapse}}.

See also