Template:User toolbox/doc
This is a documentation subpage for Template:User toolbox. It may contain usage information, categories and other content that is not part of the original template page. |
Shows various links to counters and other user stats tools, various sections, followed by an Actions with tasks that someone (usually administrators) may take with regard to a user. Note that many of these are punitive; the |simple=y
option should usually be used to suppress this section, and those relating to advanced user types like admins, bureaucrats and stewards, because they're usually not relevant.
Usage
[kulemba source]This template's initial visibility currently defaults to autocollapse
, meaning that if there is another collapsible item on the page (a navbox, sidebar, or table with the collapsible attribute), it is hidden apart from its title bar; if not, it is fully visible.
To change this template's initial visibility, the |state=
parameter may be used:
{{User toolbox|state=collapsed}}
will show the template collapsed, i.e. hidden apart from its title bar.{{User toolbox|state=expanded}}
will show the template expanded, i.e. fully visible.
Add {{User toolbox|1=Username}} to a page to display a user's links in the toolbox. If added to a user page, it will automatically get the username. If used on a subpage, specify the username manually or use {{User toolbox|{{ROOTPAGENAME}}}}. If used outside of user space, e.g. in the "Wikipedia talk:" namespace, the username must be specified.
- Typical example
{{User toolbox|1=Example}}
yields (when expanded):
- Full example
{{User toolbox|1=Example|simple=n}}
yields (when expanded):
- Parameters
|1=
to specify a different user name|state=uncollapsed
will expand the toolbox|heading=
to change the "User toolbox" heading|simple=n
shows all of the sections listed below|admin=y
to show the display of the Admin history section if the user is an administrator|bureaucrat=y
to show the display of the Bureaucrat history section if the user is a bureaucrat|steward=y
to show the display of the Steward history section if the user is a steward
TemplateData
[kulemba source]TemplateData for User toolbox
Parameter | Description | Type | Status | |
---|---|---|---|---|
Username | 1 | An alternative username to use instead of the page title. | String | optional |
Heading | heading | The heading for the toolbox other than "User toolbox". | String | optional |
Initial visibility | state | The template's initial visibility.
| String | optional |
Simple mode | simple | When enabled, automatically hides the administrator, bureaucrat, and steward history sections unless directly specified. | Boolean | optional |
Show admin history | admin | Display the admin history section if the user is an administrator. | Boolean | optional |
Show bureaucrat history | bureaucrat | Display the bureaucrat history section if the user is a bureaucrat. | Boolean | optional |
Show steward history | steward | Display the steward history section if the user is a steward. | Boolean | optional |
See also
[kulemba source]