View source for Template:Uw-aeblock/doc

{{Documentation subpage}}
{{substituted|auto=yes}}
{{Twinkle standard installation}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

===Usage===
The following parameters are required:
:<code><nowiki>{{subst:Uw-aeblock|reason=</nowiki>''brief reason specifying the misconduct''<nowiki>}}</nowiki></code>

The following parameter is optional but is highly advised:
:<code><nowiki>{{subst:Uw-aeblock|reason=</nowiki>''brief reason specifying the misconduct''<nowiki>|decision=</nowiki>''full pagename of the arbitration decision (will be auto linked)'' <u>or</u> ''if enforcing contentious topics see [[#codes]] below''<nowiki>}}</nowiki></code>

Other optional parameters:
:{{para|time|Duration}} - can be used to specify the duration of the block.
::{{para|indef|yes}} - if the block is indefinite - ensure that the arbitration decision allows indefinite blocks.
:{{para|partial|yes}} - can be used if a partial block is used as the method of enforcement.
::{{para|area|partial block restrictions}} - can be used to indicate which areas the editor is blocked from, else the template displays "...editing <ins>certain areas of the encyclopedia</ins>."
:{{para|notalk|yes}} - if access to the talk page has also been revoked.
:{{para|page|pagename}} - page on which the conduct supporting the block occurred.
:{{para|noappealtome|yes}} - removes the sentence telling the user that they can appeal to the enforcing admin by email. Blocked users can still appeal to the enforcing admin (or in any of the venues described at [[WP:CTOPAPPEALS]]), and this option just makes appeal via email less visible as an option.
:{{para|sig|yes}} - appends your signature inside the block template.
:{{para|for}} - if the word "for" before the <code>reason</code> doesn't grammatically work. For example, if for=per is written, the block notice will say "to enforce an arbitration decision per". Don't use this parameter if you don't want to change the word "for".
:{{para|decision}} (or {{para|topic}}, {{para|t}}) - the topic code of the arbitration enforcement area, as listed below.
:{{para|hiddentext}} - can be set to "no" to hide the default template hidden text.

===Important notes===
* ''If blocking under the contentious topics procedure, a reason for the sanction '''must''' be supplied.''
* ''Remember to log the sanction on the applicable case page.''

* This template has been carefully designed based on guidelines by the [[Wikipedia:WikiProject User warnings|user warnings project]] and the [[Wikipedia:Arbitration Committee|Arbitration Committee]].
* Please refer to the [[Wikipedia:Template messages/User talk namespace|index of message templates]] before using any template on user talk pages to warn a user. Applying the best template available for your purpose may help reduce confusion from the message you are sending. '''Note:''' ''Only uninvolved [[Wikipedia:Administrators|administrators]] can issue arbitration enforcement blocks''; adding a block template does not constitute a block. See [[Wikipedia:Arbitration/Requests/Enforcement|arbitration enforcement requests]] to request that a user be [[Wikipedia:Blocking policy|blocked]] as enforcement of an arbitration decision.
* Before blocking a user as an arbitration enforcement action, ensure that you have read the relevant remedies and enforcement provisions of the arbitration case which may include the [[Wikipedia:Contentious topics|contentious topics procedure]].
* Please remember to [[Help:Substitution|substitute]] the template by using <code><nowiki>{{subst:</nowiki>Uw-aeblock<nowiki>}}</nowiki></code> rather than <code><nowiki>{{</nowiki>Uw-aeblock<nowiki>}}</nowiki></code>.
* Although this template '''must be substituted''' in the user talk page, it has also been designed to display properly when substitution is not possible.
* {{Find substed templates notice}}

==={{anchor|codes}} Codes===

The "decision code" is one of the same decision codes used in the other standardised Arbitration Enforcement templates:
{{Ds/topics/table}}
{{Uw-block/doc/Block templates}}

{{Ds/topics/single notice}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:User block templates]]
[[Category:Standardised Wikipedia arbitration enforcement templates]]

}}</includeonly>