Template:User retired/doc

This template creates a custom userbox that indicates that you have retired in a specific nation, state, province, territory, district, city or town.

Use

To use this userbox template, place the following line of Wikitext on your user page:

{{User retired|location|region=|color=|style=|alt=|art=|wrap=|nocat=}}

where:

• location is an optional location name.
• region= an optional region name or ISO 3166 code. (default = location)

See Category:Multiuse regional user templates for currently available region names and codes.

• color= an optional background color.
• style= an optional style.
  • style=short creates a standard format. (default for names of 18 or fewer characters.)
  • style=long creates a more elaborate but smaller format if available. (default for names of more than 18 characters)
• alt= an optional alternate location name.
• art= an optional article to precede the location name.
• wrap=wrap allows a multi-word location name to break between lines (default= null )
• nocat= an optional category blocking parameter:
  • nocat=no  includes your user page in [[Category:Wikipedians in region]] (default)
  • nocat=yes makes no category declaration.

This template adds your user page to the approriate regional location category. A nocat=true parameter may be used to inhibit category declaration.

Examples

Wiki markup	Userbox
{{user retired}}	This user has retired.
{{user retired|Florida}}	This user has retired in the U.S. State of Florida.
{{user retired|Florida|style=long}}	This user has retired in the U.S. State of Florida.
{{user retired|Barbados}}	This user has retired in Barbados.
{{user retired|Dublin|region=Ireland}}	This user has retired in Ireland.
{{user retired|Estes Park, Colorado|region=Colorado}}	This user has retired in the U.S. State of Colorado.
{{user retired|Vancouver|region=British Columbia}}	This user has retired in the Canadian province of British Columbia.
{{user retired|Western Australia}}	This user has retired in the state of Western Australia.
{{user retired|UK|art=the}}	This user has retired in the United Kingdom.

If this template does not produce the desired userbox, you may wish to try a different set of parameters.