Editing Template:Admin backlog/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Wrapper|Backlog}}

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

It can be put at the top of pages and categories that have a backlog which require the attention of [[Wikipedia:Administrators|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:
{{indent|5}}{{tlc|admin backlog}}

Which renders like this:

{{admin backlog|demospace=category|category=<nowiki />}}

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 <code>disabled=yes</code>, 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:
{{indent|5}}{{tlc|admin backlog|10}}

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

{{admin backlog|0|10|demospace=category|category=<nowiki />}}

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:

{{admin backlog|10|demospace=category|category=<nowiki />}}

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 [[Wikipedia:Purge|purge]] the page, for instance by clicking the <small>({{purge|recount}})</small> 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:
{{indent|5}}{{tlc|admin backlog|13|10}}

==Silence==
To prevent any output when there is no backlog, use {{tlc|admin backlog|2=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):
{{indent|5}}{{tlc|admin backlog|2=bot=RFC bot}}

Which renders like this:

{{admin backlog|bot=RFC bot|demospace=category|category=<nowiki />}}
==TemplateData==
<templatedata>
{
	"params": {
		"1": {
			"label": "Backlog threshold",
			"description": "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.",
			"type": "number",
			"suggestedvalues": [
				"1",
				"25",
				"100"
			]
		},
		"2": {
			"label": "Displayed backlog threshold ",
			"description": "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.",
			"type": "number",
			"suggestedvalues": [
				"1",
				"10"
			]
		},
		"disabled": {
			"description": "If true, disables the template. This is functionally equivalent to removing the template.",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"silent": {
			"description": "If true, hides the template entirely when there is no backlog. This parameter is ignored if not used on a category page",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"backloglink": {
			"description": "The destination of the backlog wikilink.",
			"type": "string",
			"default": ":Category:Administrative backlog",
			"label": "Backlog link"
		},
		"demospace": {
			"description": "For use in testing. Makes the template function as if it were placed in the given namespace.",
			"type": "string",
			"suggestedvalues": [
				"Category",
				"Wikipedia"
			]
		},
		"page": {
			"description": "The type of location of the backlog. Defaults to \"This category\" if used in that namespace. Otherwise, defaults to \"This page\".",
			"type": "string",
			"default": "This page"
		},
		"bot": {
			"description": "The name of the bot which updates this notice, without the User: prefix.",
			"example": "RMCD bot",
			"type": "wiki-user-name"
		},
		"auto": {
			"label": "Automatically updated?",
			"description": "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.",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"remove": {
			"description": "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}}.",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"_debug": {
			"label": "debug",
			"description": "If true, wraps the result in nowiki tags to allow for easier debugging",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		}
	},
	"description": "A banner to keep track of backlogs that require administrators' attention"
}
</templatedata>
== See also ==
* {{tl|backlog}} – For tagging pages that have a backlog that can be handled by regular editors (by non admins).
* {{tl|editprotected}} – For requesting assistance from an admin to edit a fully protected page.
* {{tl|no admin backlog}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Backlog templates|{{PAGENAME}}]]
}}</includeonly>