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
Initial visibility: currently defaults to autocollapse
To set this template's initial visibility, the |state= parameter may be used:
|state=collapsed:{{User toolbox|state=collapsed}}to show the template collapsed, i.e., hidden apart from its title bar|state=expanded:{{User toolbox|state=expanded}}to show the template expanded, i.e., fully visible|state=autocollapse:{{User toolbox|state=autocollapse}}
If the |state= parameter in the template on this page is not set, the template's initial visibility is taken from the |default= parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse.
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=uncollapsedwill expand the toolbox|heading=to change the "User toolbox" heading|simple=nshows all of the sections listed below|admin=yto show the display of the Admin history section if the user is an administrator|bureaucrat=yto show the display of the Bureaucrat history section if the user is a bureaucrat|steward=yto show the display of the Steward history section if the user is a steward
See also