Difference between revisions of "Template:ArticleAlertSubscription/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Hellknowz
(tweak about cats)
blackwiki>Hellknowz
(add {{para|entrylimit}})
Line 19: Line 19:
 
<pre>
 
<pre>
 
{{ArticleAlertSubscription
 
{{ArticleAlertSubscription
−
  |project =
+
  |project =
 
  |category =
 
  |category =
 
}}</pre>
 
}}</pre>
Line 31: Line 31:
 
  |delivery    =
 
  |delivery    =
 
  |workflows  =
 
  |workflows  =
−
  |noremovals =
+
  |entrylimit =
 +
|noremovals
 
  |removeafter =
 
  |removeafter =
 
}}</pre>
 
}}</pre>
Line 52: Line 53:
 
: Each workflow covered by the Article Alerts has an associated code (see [[#Workflows|below]]). By default all workflows are covered, identical to {{para|workflows|ALL}}. If, for example, you do not want to receive notifications about ''Did You Know...?'' simply place {{para|workflows|ALL,!DYK}} ("ALL, but ''not'' DYK"). If you want deletion processes covered, but not PRODs, place {{para|workflows|DEL,!PROD}} ("include DEL, but ''not'' PROD"). This way, any combination can be achieved, for example, {{para|workflows|ALL,!QUAL,FAC}} ("ALL, but exclude QUAL assessments, however include FAC").
 
: Each workflow covered by the Article Alerts has an associated code (see [[#Workflows|below]]). By default all workflows are covered, identical to {{para|workflows|ALL}}. If, for example, you do not want to receive notifications about ''Did You Know...?'' simply place {{para|workflows|ALL,!DYK}} ("ALL, but ''not'' DYK"). If you want deletion processes covered, but not PRODs, place {{para|workflows|DEL,!PROD}} ("include DEL, but ''not'' PROD"). This way, any combination can be achieved, for example, {{para|workflows|ALL,!QUAL,FAC}} ("ALL, but exclude QUAL assessments, however include FAC").
  
−
*'''{{para|noremovals}}'''
+
*'''{{para|entrylimit}}'''
 +
: [[File:Ambox clock.svg|24px]] &nbsp; ''not yet implemented – defaults to 10''
 +
: The main report page will always list the full number of entries for each workflow. However, transclusion of the page is specified to only list a limited number of entries and display a link to the main page when more entries are available (e.g., "5 more..."). Set the {{para|entrylimit}} field to a number of entries you would like displayed when transcluding the report page, by default 10.
 +
 
 +
*'''{{para||noremovals}}'''
 
: [[File:Ambox clock.svg|24px]] &nbsp; ''not yet implemented – removed pages will be listed''
 
: [[File:Ambox clock.svg|24px]] &nbsp; ''not yet implemented – removed pages will be listed''
−
: By default, the pages removed from workflows (e.g. deleted, kept, moved, promoted, etc.) will be shown for a certain period of time. If this is not desired, the {{para|noremovals|yes}} field can be set. Pages removed from workflows will also disappear from the report list.
+
: By default, the pages removed from workflows (e.g. deleted, kept, moved, promoted, etc.) will be shown for a certain period of time. If this is not desired, an unnamed {{para||noremovals}} field can be set. Pages removed from workflows will also disappear from the report list.
  
 
*'''{{para|removeafter}}'''
 
*'''{{para|removeafter}}'''

Revision as of 11:19, 19 December 2010

Usage

Modern clock chris kemps 01 with Octagon-warning.svg     Please note that this specification is not finalized and may change.

Copy the following to the relevant section of Wikipedia:Article alerts/Subscription list. An explanation of the parameters is given below.

Subscription for a WikiProject pages marked with a project banner

{{ArticleAlertSubscription
 |banner =
}}

Subscription for taskforces/sub-projects with categorized pages

{{ArticleAlertSubscription
 |project  =
 |category =
}}

Custom subscription

{{ArticleAlertSubscription
 |banner      =
 |project     =
 |category    =
 |delivery    =
 |workflows   =
 |entrylimit  =
 |noremovals
 |removeafter =
}}

Parameters

  • |banner=
The name of the banner template that appears on the talk pages. For example, {{WikiProject Video games}} or {{WPMILHIST}}. This must be the true location of the template, not a redirect. Do not prefix with "Template:".
  • |project=
If the WikiProject name does not match the |banner= template name, enter the WikiProject name here. For example, WikiProject Military history does not match {{WPMILHIST}}, so |project=WikiProject Military history is needed.
  • |category=
If you want to receive alerts for a category of articles use this field and leave |banner= empty. Taskforces want to use this and specify |project= as their sub-page for default delivery to "Wikipedia:WikiProject Your project/taskforce/Article alerts". If the delivery page should be different or this isn't for a taskforce, you need to specify the exact |delivery= page (see right below). Do not prefix with "Category:".
  • |delivery=
By default the Article alerts are delivered to "Wikipedia:WikiProject Your project/Article alerts" for banner subscriptiosn or "Wikipedia:WikiProject Your project/taskforce/Article alerts" for category subscriptions. However, if you want them delivered elsewhere, use this field. If you subscribe to a category, you must also specify |delivery=.
  • |workflows=
Ambox clock.svg   not yet implemented – all workflows will be listed
Each workflow covered by the Article Alerts has an associated code (see below). By default all workflows are covered, identical to |workflows=ALL. If, for example, you do not want to receive notifications about Did You Know...? simply place |workflows=ALL,!DYK ("ALL, but not DYK"). If you want deletion processes covered, but not PRODs, place |workflows=DEL,!PROD ("include DEL, but not PROD"). This way, any combination can be achieved, for example, |workflows=ALL,!QUAL,FAC ("ALL, but exclude QUAL assessments, however include FAC").
  • |entrylimit=
Ambox clock.svg   not yet implemented – defaults to 10
The main report page will always list the full number of entries for each workflow. However, transclusion of the page is specified to only list a limited number of entries and display a link to the main page when more entries are available (e.g., "5 more..."). Set the |entrylimit= field to a number of entries you would like displayed when transcluding the report page, by default 10.
  • |noremovals
Ambox clock.svg   not yet implemented – removed pages will be listed
By default, the pages removed from workflows (e.g. deleted, kept, moved, promoted, etc.) will be shown for a certain period of time. If this is not desired, an unnamed |noremovals field can be set. Pages removed from workflows will also disappear from the report list.
  • |removeafter=
Ambox clock.svg   not yet implemented
Pages that have been removed from workflows (see above) will be kept for |removeafter= days before being removed from the list. By default, removed pages will remain on the list for 7 days.

Workflows

{{Wikipedia:Article alerts/Workflow grouping}}