Template:ArticleAlertbotSubscription/doc

This template is used for subscribing to the article alerts for WikiProjects and work groups.

Usage
Place this template onto the main page of your WikiProject or work group, (aka task force or subproject) at any position. This template should not be subst. For further details on subscribing to the bot, see: Article alerts/Subscribing.

To identify the articles related to the project or work group, be sure to correctly specify the parameters:


 * If you subscribe for a WikiProject, and the project banner has the same name as the project, (e.g. the project is WikiProject Yellow Tulips and the banner is WikiProject Yellow Tulips), then no parameter is required. For example:




 * If you subscribe for a WikiProject with a non-standard banner name, (e.g. WPYTulips), then you will need to pass the non-standard name via the banner parameter. For example:




 * If you subscribe for a work group, then you will need to pass the name of the work group category, (i.e. the category in which the talk pages of the work group's articles can be found) via the wgcat parameter. For example:



Parameters

 * banner

Specifies the exact name of the project banner template, which is placed onto an article's talk page in order to associate it with the project. The value specified must be the exact name, not a redirected name, of the banner template without the namespace prefix. The template must be listed in either or one of its subcategories,  or.


 * wgcat

Specifies the work group category, which is the category into which an article's talk page is placed in order to associate it with the work group. The name of the category must be listed without the namespace prefix.

Note: Only one of the above parameters, either banner or wgcat, may be used at a time.


 * group

Specifies a replacement for the text project or work group. This is used for display purposes only, and does not influence the cleanup listings generated. For example, if your project has task forces rather than work groups, specify "group=task force" and the template will display: Article alerts for this task force is available...


 * display

Controls how the alerts list is displayed. Several options are available, see table below.


 * archivetime

This parameter controls the time (in days) that a closed workflow item will remain visible on the alerts list, before it is finally removed. The default value is 14 days. To change this e.g. to one month, set archivetime=30.


 * workflows

This parameter restricts the article alerts to selected workflows. For example, workflows=PROD will display only articles nominated for proposed deletion. See Article alerts/Subscribing for allowed values. The default value is workflows=ALL.

The values can also be combined in a comma-separated list. This will include alerts for the union of workflows specified. Values preceded by "!" will be excluded rather than included. The list is processed from the left to the right.


 * discussions

This parameter allows for transcluding discussion pages, e.g. AfD discussions, into the article alerts page. Each discussion will be displayed in a collapsible section. Supported values:

Note that trancluding discussions is supported only for some workflows. Also, transcluded discussions are incompatible with the "display=columns" option.

Categorization
This template populates.