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 Florida
{{user retired|Florida|style=long}}	This user has retired in Florida
{{user retired|Barbados}}	This user has retired in Barbados
{{user retired|Dublin|region=Ireland}}	This user has retired in Dublin
{{user retired|Estes Park, Colorado|region=Colorado}}	This user has retired in Estes Park, Colorado
{{user retired|Vancouver|region=British Columbia}}	This user has retired in Vancouver
{{user retired|Western Australia}}	This user has retired in Western Australia
{{user retired|UK|art=the}}	This user has retired in the UK

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

See also

• This template invokes multiuse regional user templates.
• This template is compatible with the following customizable regional userbox templates:

Customizable location userbox templates

Template:Yybottom

• For help with this userbox template, please post a comment on the template talk page.

Code	Result	Users
{{User ancestry|Thailand}}	error	Transclusions
{{User cycled|California}}	error	Transclusions
{{User high point|Ireland}}	error	Transclusions
{{User highest|New Zealand}}	Template:User highest	Transclusions
{{User hiked|Scotland}}	Template:User hiked	Transclusions
{{User invitation|South Africa}}	This user invites you to visit South Africa.	Transclusions
{{User lived in|New Mexico}}	Template:User lived in	Transclusions
{{User lives in|Wales}}	This user lives in Wales.	Transclusions
{{User low point|North America}}	Template:User low point	Transclusions
{{User proud|Australia}}	This user is proud to be an Australian !	Transclusions
{{User retired|Florida}}	This user has retired in Florida	Transclusions
{{User studied in|New Jersey}}	Template:User studied in	Transclusions
{{User visited|India}}	This user has visited India.	Transclusions
{{User wishes to visit|Jalisco}}	error	Transclusions
{{User worked in|Antarctica}}	Template:User worked in	Transclusions
{{User Master Gardener|Washington}}	Template:User Master Gardener	Transclusions
{{User Professional Engineer|Colorado}}	Template:User Professional Engineer	Transclusions
{{Userbox-flag|Ohio|made this userbox featuring the flag of}}	Template:Userbox-flag	Transclusions
{{User:UBX/activity|has kayaked in|Nunavut}}	User:UBX/activity	Transclusions