Template:Admin backlog/sandbox

This page has an administrative backlog that requires the attention of willing administrators.
Please replace this notice with {{no admin backlog}} when the backlog is cleared.

This is the template sandbox page for Template:Admin backlog (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is a customized wrapper for {{Backlog}}. Any field from {{Backlog}} can work so long as it is added to this template first. Questions? Just ask at Template talk:Backlog.

This is the {{admin backlog}} message box.

It can be put at the top of pages and categories that have a backlog which require the attention of administrators. A backlog is a list of things that need to be done and that have not been done for some time.

This template puts the pages into Category:Administrative backlog, where admins can see where work needs to be done.

Usage

Usually this template is used without any parameters, then it is always visible until it is manually removed. Like this:
{{admin backlog}}

Which renders like this:

This page has an administrative backlog that requires the attention of willing administrators.
Please replace this notice with {{no admin backlog}} when the backlog is cleared.

This template automatically shows the appropriate style depending on what kind of page it is shown on. The style above is for "other" pages such as "Wikipedia:" pages, and the style shown in the examples below is for category pages.

By adding disabled=yes, the box and accompanying category disappear from the page. This is functionally equivalent to removing the backlog notice.

Autoreport

Often it is more efficient to handle several cases in a backlog at a time, since then we are up to speed with what needs to be done. Thus we often don't want to know about a backlog until it has reached some size.

When this template is placed on a category page it can count the number of items in the category (pages + images + subcategories). Then it can be set to automatically only report when the number of items is above some limit. The autoreport limit can be set to whatever value you prefer. Like this:
{{admin backlog|10}}

If the category has 10 or more items this template will render like this:

This page has an administrative backlog that requires the attention of willing administrators.
This notice will hide itself when this category has fewer than 10 items. (recount)

But if the category has less than 10 items then this template will not report the page (not categorise it into Category:Administrative backlog), and will instead render like this:

If this category has 10 items or more, it will be reported as an administrative backlog. (recount)

Note that MediaWiki only parses the code when the category page is re-rendered. That is, when someone views the page and it is more than one week since it was last re-rendered. Thus, it can take a week before this template changes when the number of items have changed. (But if no one visits the page then it can take forever.) To get an immediate change you can purge the page, for instance by clicking the (recount) button in the template.

You can display a different number from the number actually used by placing the display number after the number which the auto-detection system uses. This option is designed to deal with a situation where a category has a few permanent items (such as subcategories), which shouldn't be counted. For example, Category:Requests for unblock has 3 subcategories which don't count towards the backlog, so it has the following header:
{{admin backlog|13|10}}

Silence

To prevent any output when there is no backlog, use {{admin backlog|silent=yes}}

Bot updates

In some cases, a bot automatically adds and removes this template from a page. In this instance, the bot parameter should be used as follows (using "RFC bot" as an example):
{{admin backlog|bot=RFC bot}}

Which renders like this:

This page has an administrative backlog that requires the attention of willing administrators.
This notice will be automatically removed by RFC bot (talk) when the backlog is cleared.

TemplateData

A banner to keep track of backlogs that require administrators' attention

Template parameters[Edit template data]
Parameter		Description	Type	Status
Backlog threshold	`1`	The number of items pending before the category/page/etc. is considered backlogged. For example, setting the threshold to 1 means the process is considered backlogged if it has any items in the queue. Suggested values `1` `25` `100`	Number	optional
Displayed backlog threshold	`2`	The number displayed as the backlog threshold. Useful if a backlog category has members that should not be counted towards the backlog (e.g. subcategories or example pages). See documentation for more information. Suggested values `1` `10`	Number	optional
disabled	`disabled`	If true, disables the template. This is functionally equivalent to removing the template. Default no Example yes	Boolean	optional
silent	`silent`	If true, hides the template entirely when there is no backlog. This parameter is ignored if not used on a category page Default no Example yes	Boolean	optional
Backlog link	`backloglink`	The destination of the backlog wikilink. Default :Category:Administrative backlog	String	optional
demospace	`demospace`	For use in testing. Makes the template function as if it were placed in the given namespace. Suggested values `Category` `Wikipedia`	String	optional
page	`page`	The type of ___location of the backlog. Defaults to "This category" if used in that namespace. Otherwise, defaults to "This page". Default This page	String	optional
bot	`bot`	The name of the bot which updates this notice, without the User: prefix. Example RMCD bot	User	optional
Automatically updated?	`auto`	If true, says that the notice will automatically hide itself. Note: this only affects the message on the template; it does NOT facilitate automatically removing the notice. Default no Example yes	Boolean	optional
remove	`remove`	If true, asks editors to remove the message entirely when the backlog is cleared. Otherwise, the template will ask editors to change the template to {{no admin backlog}}. Default no Example yes	Boolean	optional
debug	`_debug`	If true, wraps the result in nowiki tags to allow for easier debugging Default no Example yes	Boolean	optional