Wikipedia>JJMC89 bot III: Moving :Category:Residence user templates to :Category:Residence userboxes per Wikipedia:Categories for discussion/Log/2026 August 12#All categories for userboxes

2026-09-29T14:37:15Z

Moving Category:Residence user templates to Category:Residence userboxes per Wikipedia:Categories for discussion/Log/2026 August 12#All categories for userboxes

New page

{{Distinguish|Template:retired}}
{{documentation subpage}}__NOTOC__
This [[Help:Template|template]] creates a [[Wikipedia:Userboxes|custom userbox]] that indicates that you have [[Retirement|retired]] in a specific nation, state, province, territory, district, city or town.

This template does not imply retirement from the Wikipedia project.

Please be careful to not [[doxing|dox]] yourself using this template.

==Use==
To use this userbox template, place the following line of [[Help:Wikitext|Wikitext]] on [[Special:MyPage|your user page]]:
:'''<code><nowiki>{{User retired|location|region=|color=|style=|alt=|art=|wrap=|nocat=}}</nowiki></code>'''
where:
*'''<code>location </code>'''is an optional location name.
*'''<code>region= </code>'''an optional region name or [[ISO 3166-1|ISO 3166 code]]. (default = '''<code>location</code>''')
:See [[:Category:Multiuse regional user templates]] for currently available '''''<code>region</code>''''' names and codes.
*'''<code>color= </code>'''an optional background color.
*'''<code>style= </code>'''an optional style.
**'''<code>style=short </code>'''creates a standard format. (default for names of 18 or fewer characters.)
**'''<code>style=long </code>'''creates a more elaborate but smaller format if available. (default for names of more than 18 characters)
*'''<code>alt= </code>'''an optional alternate location name.
*'''<code>art= </code>'''an optional article to precede the location name.
*'''<code>wrap=wrap</code>''' allows a multi-word location name to break between lines (default= ''<code>null</code>'' )
*'''<code>nocat= </code>'''an optional category blocking parameter:
**'''<code>nocat=no </code>''' includes your user page in <code><nowiki>[[Category:Wikipedians in </nowiki>'''''region'''''<nowiki>]]</nowiki></code> (default)
**'''<code>nocat=yes </code>'''makes no category declaration.

This template adds your user page to the approriate [[:Category:Wikipedians by location|regional location category]]. A <code>nocat=true</code> parameter may be used to inhibit category declaration.

===Examples===
{|border="1" cellpadding="2"
![[Wiki markup]]
![[Wikipedia:Userboxes|Userbox]]
|-
|<code> <nowiki>{{user retired}}</nowiki> </code>
|{{user retired}}
|-
|<code> <nowiki>{{user retired|Florida}}</nowiki> </code>
|{{user retired|Florida}}
|-
|<code> <nowiki>{{user retired|Florida|style=long}}</nowiki> </code>
|{{user retired|Florida|style=long}}
|-
|<code> <nowiki>{{user retired|Barbados}}</nowiki> </code>
|{{user retired|Barbados}}
|-
|<code> <nowiki>{{user retired|Dublin|region=Ireland}}</nowiki> </code>
|{{user retired|Dublin|region=Ireland}}
|-
|<code> <nowiki>{{user retired|Estes Park, Colorado|region=Colorado}}</nowiki> </code>
|{{user retired|Estes Park, Colorado|region=Colorado}}
|-
|<code> <nowiki>{{user retired|Vancouver|region=British Columbia}}</nowiki> </code>
|{{user retired|Vancouver|region=British Columbia}}
|-
|<code> <nowiki>{{user retired|Western Australia}}</nowiki> </code>
|{{user retired|Western Australia}}
|-
|<code> <nowiki>{{user retired|UK|art=the}}</nowiki> </code>
|{{user retired|UK|art=the}}
|}
If this template does not produce the desired userbox, you may wish to try a different set of parameters.
{{-}}

{{Template:User activity/custom}}
<includeonly>{{Sandbox other||
[[Category:Residence userboxes| ]]
[[Category:Regional activity userboxes|Retired]]
}}</includeonly>

Template:User retired/doc - Revision history

Wikipedia>JJMC89 bot III: Moving :Category:Residence user templates to :Category:Residence userboxes per Wikipedia:Categories for discussion/Log/2026 August 12#All categories for userboxes