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:

where:
 *  is an optional location name.
 *  an optional region name or ISO 3166 code. (default =  )
 * See Category:Multiuse regional user templates for currently available   names and codes.


 *  an optional background color.
 *  an optional style.
 *  creates a standard format. (default for names of 18 or fewer characters.)
 *  creates a more elaborate but smaller format if available. (default for names of more than 18 characters)
 *  an optional alternate location name.
 *  an optional article to precede the location name.
 *   allows a multi-word location name to break between lines (default=   )
 *  an optional category blocking parameter:
 *   includes your user page in   (default)
 *  makes no category declaration.

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

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