View source for Template:Retired/doc

{{Documentation subpage}}
{{High-use}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
{{further|Wikipedia:Retiring}}
{{Distinguish|Template:Not around|Template:User retired}}

{{Template notes
| Do not use this template unless you plan to '''completely and permanently stop editing'''.  Other templates are available if you might return at a later date, or if you plan to significantly reduce your activity.
| Do not use this template simply to hide from discussions.  If you're thinking about quitting because of a dispute, then try silently '''not editing at all''' for a few days first before you add this template to your user page.
| Do not use this template if you have been [[WP:SITEBAN|sitebanned]] or have engaged in [[WP:sockpuppetry|sockpuppetry]] or other serious misconduct after being [[WP:INDEF|indefinitely blocked]].
| If you later resume editing, please remove this template from your user page.
}}

== Usage ==
The syntax for this template is simple: {{tnull|Retired}} if you want it to display the above, or {{tnull|Retired|2=date=date (any format is acceptable)}} if you want it to display a date along with the above. You can also add a reason for your retirement as {{tnull|Retired|2=reason=your reason here}}. 

For bot accounts, use {{tnull|Retired|2=bot=yes}}

You can also change the template text from the default 'RETIRED' by adding an unnamed parameter. 

You can display the message ''This user has permanently retired from editing Wikipedia.'' instead of the default one by adding <code>|alttext=yes</code>.

To opt out of newsletters and mass messages when you retired, place it on your talk page and set the MMS switch to no, as follows: {{tnull|Retired|2=mms=no}}. This will add your user page to [[:Category:Wikipedians who opt out of message delivery]].

Retiring implies that you will not resume editing at any later date.  If there is any significant chance that you might eventually return, then it is preferable to announce an indefinite {{tl|Wikibreak}}.

Editors should promptly remove this template from their user pages if they resume editing for any reason.  If still editing on rare occasions, use {{tl|semi-retired}} in preference.

This template should be placed on a user page only by the concerned user, or at their request.

This template automatically populates [[:Category:Retired Wikipedians]]

=== Examples ===

 <nowiki>{{</nowiki>Retired|date={{#time:F Y}}|reason=due to certain personal issues}}

{{Retired|date={{Monthyear}}|reason=due to certain personal issues}}

 <nowiki>{{</nowiki>Retired|RETIRED PERMANENTLY|date={{#time:F Y}}|reason=due to certain personal issues}}

{{Retired|RETIRED PERMANENTLY|date={{Monthyear}}|reason=due to certain personal issues}}

 <nowiki>{{</nowiki>Retired|border=dashed 3px red|bgcolor=orange|fgcolor=blue|date=NOW!!!}}

{{Retired|border=dashed 3px red|bgcolor=orange|fgcolor=blue|date=NOW!!!}}

 <nowiki>{{</nowiki>Retired|bot=yes}}

{{Retired|bot=yes}}

== See also ==
{{Wikibreak templates}}

== External links ==
* [[meatball:GoodBye|What people usually mean when they say goodbye]]:  [[MeatballWiki]] on resignation manifestos
<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Wikibreak templates]]
}}</includeonly>