Template:Collapsible option/doc: Difference between revisions
m (1 revision imported) |
No edit summary |
||
Line 14: | Line 14: | ||
*<code><nowiki>{{{1|}}}</nowiki></code> as part of a collapsible template's <code>state</code> parameter{{spaced ndash}}for instance, as {{para|state|<nowiki>{{{state|{{{1|}}}}}}</nowiki>}} or {{para|state|<nowiki>{{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}</nowiki>}}, etc. | *<code><nowiki>{{{1|}}}</nowiki></code> as part of a collapsible template's <code>state</code> parameter{{spaced ndash}}for instance, as {{para|state|<nowiki>{{{state|{{{1|}}}}}}</nowiki>}} or {{para|state|<nowiki>{{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}</nowiki>}}, etc. | ||
*<code><nowiki><noinclude></nowiki></code>,<code><nowiki><includeonly></nowiki></code>as part of a collapsible template's <code>state</code> argument{{spaced ndash}}for instance, as {{para|state|<nowiki>{{{state<includeonly>|collapsed</includeonly>}}}</nowiki>}} | *<code><nowiki><noinclude></nowiki></code>,<code><nowiki><includeonly></nowiki></code>as part of a collapsible template's <code>state</code> argument{{spaced ndash}}for instance, as {{para|state|<nowiki>{{{state<includeonly>|collapsed</includeonly>}}}</nowiki>}} | ||
===Changing the default state reported=== | ===Changing the default state reported=== | ||
Line 21: | Line 20: | ||
===''nobase''=== | ===''nobase''=== | ||
If the template name given to <nowiki>{{Collapsible option}}</nowiki> includes a (forward-)slash character ("/"), the parameter {{para<!--|plain-->|nobase}} (set to "on", "true", etc.) will need to be added so that the name is displayed correctly (i.e. so that {{wikivar|PAGENAME}} rather than the default {{wikivar|BASEPAGENAME}} is used to display it). | If the template name given to <nowiki>{{Collapsible option}}</nowiki> includes a (forward-)slash character ("/"), the parameter {{para<!--|plain-->|nobase}} (set to "on", "true", etc.) will need to be added so that the name is displayed correctly (i.e. so that {{wikivar|PAGENAME}} rather than the default {{wikivar|BASEPAGENAME}} is used to display it). | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | ||
| <!----CATEGORIES BELOW THIS LINE, PLEASE:----> | | <!----CATEGORIES BELOW THIS LINE, PLEASE:----> | ||
[[Category:Template namespace templates]] | [[Category:Template namespace templates]] | ||
[[Category: | [[Category:GoArch metatemplates]] | ||
}}</includeonly> | }}</includeonly> |
Latest revision as of 06:56, 11 July 2016
This is a documentation subpage for Template:Collapsible option. It contains usage information, categories and other content that is not part of the original template page. |
{{Collapsible option}} provides a standardised message for transclusion on the pages of collapsible templates whose collapsibility may be managed by the parameter state
.
It may be used on either the template page itself (wrapped within <noinclude>...</noinclude>
tags) or on the template's {{documentation subpage}}.
Indicating optional use of state name[edit source]
The state
parameter used to manage collapsible templates need not always be named explicitly, i.e. {{[Template name]|state}} can be the same as {{[Template name]|state=state}}. To indicate this in the {{Collapsible option}} message, add the parameter |statename=optional
. This modifies the message so that it reads (if it were used for itself):
How to manage this template's initial visibility
To manage this template's visibility when it first appears, add the parameter:
|state=collapsed
to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g.{{Collapsible option |state=collapsed}}
|state=expanded
to show the template in its expanded state, i.e. fully visible – e.g.{{Collapsible option |state=expanded}}
|state=autocollapse
to show the template in its collapsed state but only if there is another template of the same type on the page – e.g.{{Collapsible option |state=autocollapse}}
Unless set otherwise (see the |state=
parameter in the template's code), the template's default state is autocollapse
.
{{{1|}}}
as part of a collapsible template'sstate
parameter – for instance, as|state={{{state|{{{1|}}}}}}
or|state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}
, etc.<noinclude>
,<includeonly>
as part of a collapsible template'sstate
argument – for instance, as|state={{{state<includeonly>|collapsed</includeonly>}}}
Changing the default state reported[edit source]
To change the default state {{Collapsible option}} reports in its second bullet-point, add the parameter |default=collapsed
or |default=expanded
accordingly. To restore the default report, remove any |default=
previously included.
nobase[edit source]
If the template name given to {{Collapsible option}} includes a (forward-)slash character ("/"), the parameter |nobase=
(set to "on", "true", etc.) will need to be added so that the name is displayed correctly (i.e. so that {{PAGENAME|}}
rather than the default {{BASEPAGENAME|}}
is used to display it).