Template:Collapsible lists option/doc
| This is a documentation subpage for Template:Collapsible lists option. It may contain usage information, categories and other content that is not part of the original template page. |
{{Collapsible lists option}} is a standardized documentation template indicating how the collapsible parts of a template built from {{Sidebar with collapsible lists}} may be managed.
When this template is transcluded, the texts within square brackets will either not appear or be replaced accordingly.
Usage
[edit]{{Collapsible lists option
| expandedname = <!--(see below)-->
| listnames =
| example = <!--(one of the listnames)-->
| default = <!--("all" or a listname, if either set to be shown)-->
}}
Parameters |expandedname=required, |example=, and |default= are optional.
expandedname=required
[edit]By default, template {{Collapsible lists option|listnames=...}} assumes that the template being documented allowed both a positional parameter |1= and a named parameter |expanded= to be used (usually seen by presence of {{{expanded|{{{1|}}}}}} in the wikitext of the template).
If only the named parameter is supported, then use {{Collapsible lists option|expandedname=required|listnames=...}} in the documentation, which will hide the part of documentation which talks about the positional parameter.
TemplateData
[edit]TemplateData for Collapsible lists option
A standardized documentation template indicating how the collapsible parts of a template built from {{Sidebar with collapsible lists}} may be managed.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
expandedname | If set to "required", the part of the documentation which talks about the positional parameter equivalent of "expanded" will be hidden.
| String | optional | |
| List names | listnames | The names of the lists of the template being documented, usually given as a list itself
| Content | required |
| Example | example | One of the listnames
| String | optional |
| Default | default | The listname that the documented template will show by default, or "all"
| String | optional |