Difference between revisions of "Template:ArticleAlertSubscription/doc"
Jump to navigation
Jump to search
blackwiki>Hellknowz m (→Parameters: implemented) |
blackwiki>Hellknowz (→Usage: add includesubcategories) |
||
| Line 49: | Line 49: | ||
*'''{{para|category}}''' | *'''{{para|category}}''' | ||
: If you want to receive alerts for a ''category'' of articles use this field and leave {{para|banner}} empty. Taskforces want to use this and specify {{para|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 {{para|delivery}} page (see right below). Do not prefix with "Category:". | : If you want to receive alerts for a ''category'' of articles use this field and leave {{para|banner}} empty. Taskforces want to use this and specify {{para|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 {{para|delivery}} page (see right below). Do not prefix with "Category:". | ||
| + | |||
| + | *'''{{para|includesubcategories|yes}}''' | ||
| + | : Use this parameter together with {{para|category}} if you instead want to receive alerts for the ''sub-categories'' of the category specified by {{para|category}}. This is useful for taskforces or projects that do not have a single category with all their pages in, but instead use sub-category system, such as WP1.0 categorization. So specifying category "''WikiProject Your Project articles by importance''" would include all the sub-categories, for example, "''WikiProject Your Project low/mid/high/top/unknown-importance articles''". | ||
*'''{{para|delivery}}''' | *'''{{para|delivery}}''' | ||
| − | : By default the Article alerts are delivered to "Wikipedia:''WikiProject Your project''/Article alerts" for banner | + | : By default the Article alerts are delivered to "Wikipedia:''WikiProject Your project''/Article alerts" for banner subscriptions 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 {{para|delivery}}. |
*'''{{para|workflows}}''' | *'''{{para|workflows}}''' | ||
| Line 66: | Line 69: | ||
*'''{{para|removeafter}}''' | *'''{{para|removeafter}}''' | ||
: [[File:Ambox clock.svg|24px]] ''not yet implemented'' | : [[File:Ambox clock.svg|24px]] ''not yet implemented'' | ||
| − | : Pages that have been removed from workflows (see above) will be kept for {{para|removeafter}} days before being removed from the list. By default, removed pages will remain on the list for | + | : Pages that have been removed from workflows (see above) will be kept for {{para|removeafter}} days before being removed from the list. By default, removed pages will remain on the list for 14 days since being added. |
==== Workflows ==== | ==== Workflows ==== | ||
Revision as of 09:21, 19 February 2011
| This is a documentation subpage for Template:ArticleAlertSubscription. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
| Please see Wikipedia:Article alerts/Subscribing for a user-friendly guide. |
This template is placed at Wikipedia:Article alerts/Subscription list to subscribe to WP:Article Alerts.
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 historyis 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:".
|includesubcategories=yes
- Use this parameter together with
|category=if you instead want to receive alerts for the sub-categories of the category specified by|category=. This is useful for taskforces or projects that do not have a single category with all their pages in, but instead use sub-category system, such as WP1.0 categorization. So specifying category "WikiProject Your Project articles by importance" would include all the sub-categories, for example, "WikiProject Your Project low/mid/high/top/unknown-importance articles".
|delivery=
- By default the Article alerts are delivered to "Wikipedia:WikiProject Your project/Article alerts" for banner subscriptions 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=
- 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=
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
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
|noremovalsfield can be set. Pages removed from workflows will also disappear from the report list.
|removeafter=
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 14 days since being added.
Workflows
{{Wikipedia:Article alerts/Workflow grouping}}