Difference between revisions of "Template:Ds/talk notice/doc"

From blackwiki
Jump to navigation Jump to search
imported>Callanecc
(→‎Use: Clarifying use of Template:Ds/editnotice)
imported>AGK
(ce)
Line 1: Line 1:
 
{{Documentation subpage}}{{TOCright}}
 
{{Documentation subpage}}{{TOCright}}
This template will display a warning on the article talk for users regarding discretionary sanctions in a given topic area. When deploying the template, you must declare which arbitration decision is in effect by using one of the [[#Decision codes|decision codes]]. You should place the template at the top of the page, below the talk header (if used) but above all other templates.
+
This template warns people on the talk page that arbitration discretionary sanctions have been authorised. Discretionary sanctions allow administrators to act quickly and decisively to prevent misconduct.
  
The template categorises pages into [[:Category:Wikipedia pages under discretionary sanctions]] or [[:Category:Wikipedia pages with discretionary sanctions editnotice]] depending on usage unless <code>nocat=yes</code> is included.
+
The template requires you to declare which arbitration decision authorised discretionary sanctions, by specifying a [[#Decision codes|#decision code]].
 +
 
 +
You should place the template at the top of the talk page, below the header (if used) but above all other templates.
 +
 
 +
The template places the page into [[:Category:Wikipedia pages under discretionary sanctions]] or [[:Category:Wikipedia pages with discretionary sanctions editnotice]] depending on usage unless <code>nocat=yes</code> is included.
  
 
=== Use ===
 
=== Use ===
This template should be used on the talk pages of pages which are subject to discretionary sanctions. It can also be used in an editnotice version to alert users to discretionary sanctions however should not be used to alert users to a current sanction, ''[[Template:Ds/editnotice]]'' has been designed for this function.
+
You may use this on the article talk page. You may also use it in an article edit notice for general information; however, edit notices about a special "page restriction" deployed under discretionary sanctions should instead be advertised using the special ''[[Template:Ds/editnotice]]'' template.
  
:{{tlx|Discretionary sanctions|topic{{=}}'''''code'''''}}
+
:{{tlx|Discretionary sanctions|'''''code'''''}}
:{{tlx|Discretionary sanctions|topic{{=}}'''''code'''''|style{{=}}'''''brief'' or ''long'''''}}
+
:{{tlx|Discretionary sanctions|'''''code'''''|'''''brief'' <u>or</u> ''long'''''}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 14: Line 18:
 
!Values
 
!Values
 
!Behaviour
 
!Behaviour
!Notes
 
 
|-
 
|-
|{{para|topic}} || {{var|code}}: Choose from [[#Decision codes]]; eg {{para|topic|tt}} for ''The Troubles''. || Determines which arbitration final decision will be linked to. || Mandatory.
+
|{{para|1}} (or {{para|topic}}) || {{var|code}}: Choose from [[#Decision codes]] below; e.g. {{para|topic|tt}} for ''The Troubles''. || Determines which arbitration final decision will be linked to.
 
|-
 
|-
|{{para|style}} || {{var|brief}} or {{var|long}}; see [[#Styles]] for what each style looks like. || Determines whether the longer or shorter message will be displayed. || Optional; defaults to {{para|style|brief}}.
+
|{{para|2}} (or {{para|style}}) || {{var|brief}} or {{var|long}}; see [[#Styles]] for what each looks like. || Determines whether the longer or shorter form will be displayed. || Optional; defaults to {{para|style|brief}}.
 
|}
 
|}
  
 
Empty templates, for copy-pasting:
 
Empty templates, for copy-pasting:
:{{tlx|Discretionary sanctions|topic{{=}}}}
+
:{{tlx|Discretionary sanctions|<!---->}}
:{{tlx|Discretionary sanctions|topic{{=}}|style{{=}}}}
+
:{{tlx|Discretionary sanctions|<!---->|<!---->}}
  
 
=== Styles ===
 
=== Styles ===
Line 29: Line 32:
 
The default is a concise, bold-print message:
 
The default is a concise, bold-print message:
  
{{tlx|Discretionary sanctions|topic{{=}}tpm|style{{=}}'''brief'''}} gives:
+
{{tlx|Discretionary sanctions|tpm|'''brief'''}} gives:
 
{{Discretionary sanctions|topic=tpm|style=brief|nocat=yes}}
 
{{Discretionary sanctions|topic=tpm|style=brief|nocat=yes}}
  
Alternatively there is a more wordy and detailed message, using the old-style "traffic light" format:
+
Alternatively there is a more wordy and detailed message:
  
{{tlx|Discretionary sanctions|topic{{=}}saq|style{{=}}'''long'''}} gives:
+
{{tlx|Discretionary sanctions|saq|'''long'''}} gives:
 
{{Discretionary sanctions|topic=saq|style=long|nocat=yes}}
 
{{Discretionary sanctions|topic=saq|style=long|nocat=yes}}
  
Line 40: Line 43:
 
{{Uw-sanctions/usage}}
 
{{Uw-sanctions/usage}}
  
If an article has sanctions, but doesn't fit into one of the above topic areas, this template is unsuitable. Use {{tl|sanctions}} instead.
+
If an article has sanctions but doesn't fit into one of the above topic areas, this template is unsuitable. Use {{tl|sanctions}} instead.
  
 
== See also ==
 
== See also ==
*'''{{tl|sanctions}}''': a talk page notice for general sanctions.
+
*'''{{tl|sanctions}}''': an equivalent for when any general sanction is in use (for instance, Wikipedia community general sanctions). This template is used only for arbitration discretionary sanctions.
*'''{{tl|uw-sanctions}}''': to be placed on user talk pages to individual users.
+
*'''{{tl|alert}}''': the template for alerting individual users to the existence of discretionary sanctions, as required under the system rules.
  
 
<includeonly>
 
<includeonly>

Revision as of 12:05, 10 May 2014

Template:TOCright

This template warns people on the talk page that arbitration discretionary sanctions have been authorised. Discretionary sanctions allow administrators to act quickly and decisively to prevent misconduct.

The template requires you to declare which arbitration decision authorised discretionary sanctions, by specifying a #decision code.

You should place the template at the top of the talk page, below the header (if used) but above all other templates.

The template places the page into Category:Wikipedia pages under discretionary sanctions or Category:Wikipedia pages with discretionary sanctions editnotice depending on usage unless nocat=yes is included.

Use

You may use this on the article talk page. You may also use it in an article edit notice for general information; however, edit notices about a special "page restriction" deployed under discretionary sanctions should instead be advertised using the special Template:Ds/editnotice template.

{{Discretionary sanctions|code}}
{{Discretionary sanctions|code|brief or long}}
Parameter Values Behaviour
|1= (or |topic=) code: Choose from #Decision codes below; e.g. |topic=tt for The Troubles. Determines which arbitration final decision will be linked to.
|2= (or |style=) brief or long; see #Styles for what each looks like. Determines whether the longer or shorter form will be displayed. Optional; defaults to |style=brief.

Empty templates, for copy-pasting:

{{Discretionary sanctions}}
{{Discretionary sanctions}}

Styles

The default is a concise, bold-print message:

{{Discretionary sanctions|tpm|brief}} gives:

Alternatively there is a more wordy and detailed message:

{{Discretionary sanctions|saq|long}} gives:

Decision codes

Template:Uw-sanctions/usage

If an article has sanctions but doesn't fit into one of the above topic areas, this template is unsuitable. Use {{sanctions}} instead.

See also

  • {{sanctions}}: an equivalent for when any general sanction is in use (for instance, Wikipedia community general sanctions). This template is used only for arbitration discretionary sanctions.
  • {{alert}}: the template for alerting individual users to the existence of discretionary sanctions, as required under the system rules.