Template:ArticleAlertbotSubscription/doc

From blackwiki
Jump to navigation Jump to search
Ambox outdated content.svg Note: This template is not used by the new AAlertBot bot as was previously used by ArticleAlertbot.

Currently the method of subscription is via {{ArticleAlertSubscription}} on a central subscription list. This template will only transclude the report delivery page onto the page it's placed on. However, the bot does not base its subscriptions on this templates usage or parameters.

This template was used for subscribing to the B. Wolterding's article alerts for WikiProjects and work groups.

Extended content

Usage

Place this template onto the main page of your WikiProject[1] 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: Wikipedia:Article alerts/Subscribing.

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

{{ArticleAlertbotSubscription}}
  • 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:
{{ArticleAlertbotSubscription|banner=WPYTulips}}
  • 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:
{{ArticleAlertbotSubscription|wgcat=Porcelain vases work group articles}}

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 Category:WikiProject banners or one of its subcategories, Category:WikiProject banners without quality assessment or Category:WikiProject banners with quality assessment.

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.

display= effect
plain (default value) The article alerts list will be transcluded into the project page, in the place where the subscription template is located. Sections will appear as level 3 headlines. No further formatting is done.
columns Displays a full-width box with colored header/footer, in which the alerts list is transcluded as 3 columns in small font.
box A margin box is displayed that links to the article alerts list. The list is not transcluded.
none Displays nothing at all. In this case, please provide project members with a link to the alerts list (such as [[/Article alerts]]), or transclude the alerts list manually in an appropriate place.
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 Wikipedia:Article alerts/Subscribing#Choosing which workflows to subscribe for 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:

discussions=0 (default)do not transclude discussions
discussions=1transclude discussions; active discussions will be shown in an expanded section, closed discussions in a collapsed section
discussions=2transclude discussions; all discussion sections are collapsed

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

Categorization

This template populates Category:ArticleAlertbot subscriptions.

Notes

  1. Please put the template directly onto your project page, not onto a subpage, since the bot evaluates the page title for several purposes. Some prefer to use the template on a transcluded subpage, but this is somewhat tricky: Please use the <includeonly> tag so that the template is really only transcluded once; otherwise the alert list might be generated in duplicate. In any case, use the template only once per project or work group. Of course, you can link to the actual alert list from anywhere, and as often as you like.