Difference between revisions of "Template:Category handler/blacklist/doc"

Latest revision as of 11:00, 18 April 2013

Template:documentation subpage Template:high-risk

This is the Template:tl sub-template.

Do not use this template directly, use Template:tl instead. This template is called from Template:tl, see user documentation there.

But if you came here to see or update the category suppression blacklist, then you are in the right place.

[edit] Updating the blacklist

This template contains a blacklist of the pages and page types where templates should not auto-categorise. This blacklist is used by Template:tlf to decide when not to categorise. To update the blacklist, edit this template.

This template uses Template:tl to do the pagename-detection, thus see Template:tl for the syntax to use for the blacklist rules.

When this template is placed on a page that should not categorise, then it should return "hide". And when placed on any other page it should return an empty string.

[edit] Testing the blacklist

There are two ways you can test what this blacklist returns for a page:

You can put this template on the page you want to test, and see what output it produces. You can use edit preview, no need to save. Like this:

+{{category handler/blacklist}}+

Which here on this page returns this:

+Template:category handler/blacklist+

The ++ used here is a simple way to make it visible when a template returns an empty string.

Or you can feed the pagename you want to test to this template. Then you can do all the testing for instance on the [[Template:pgn/testcases|/testcases]] subpage of this template. Like this:

+{{category handler/blacklist| page = User:Example }}+

+{{category handler/blacklist| page = User:Example/Archive 5}}+

Which returns this:

+Template:category handler/blacklist+

+Template:category handler/blacklist+

[edit] Technical details

Currently this template is only called from Template:tl, and indirectly from all templates that use Template:tlf. But in the future this template might also be directly called from other templates similar to Template:tlf. This means we can update the category suppression blacklist in one place.

[edit] See also

• Wikipedia:Category suppression – The how-to guide.
• Wikipedia:WikiProject Category Suppression – The WikiProject.