Template:Category handler/blacklist/doc

This is the {{category handler/blacklist}} sub-template.

Do not use this template directly, use {{category handler}} instead. This template is called from {{category handler}}, see user documentation there.

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

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 {{category handler}} to decide when not to categorise. To update the blacklist, edit this template.

This template uses {{if pagename}} to do the pagename-detection, thus see {{if pagename}} 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.

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:

+-- This module contains the blacklist used by Module:Category handler.

-- Pages that match Lua patterns in this list will not be categorised unless -- categorisation is explicitly requested.

return { '^Main Page$', -- don't categorise the main page.

-- Don't categorise the following pages or their subpages. -- "%f[/\0]" matches if the next character is "/" or the end of the string. '^Wikipedia:Cascade%-protected items%f[/\0]', '^User:UBX%f[/\0]', -- The userbox "template" space. '^User talk:UBX%f[/\0]',

-- Don't categorise subpages of these pages, but allow -- categorisation of the base page. '^Wikipedia:Template messages/.*$',

-- Don't categorise archives. '/[aA]rchive', "^Wikipedia:Administrators' noticeboard/IncidentArchive%d+$", }+

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 /testcases subpage of this template. Like this:

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

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

Which returns this:

+-- This module contains the blacklist used by Module:Category handler.

-- Pages that match Lua patterns in this list will not be categorised unless -- categorisation is explicitly requested.

return { '^Main Page$', -- don't categorise the main page.

-- Don't categorise the following pages or their subpages. -- "%f[/\0]" matches if the next character is "/" or the end of the string. '^Wikipedia:Cascade%-protected items%f[/\0]', '^User:UBX%f[/\0]', -- The userbox "template" space. '^User talk:UBX%f[/\0]',

-- Don't categorise subpages of these pages, but allow -- categorisation of the base page. '^Wikipedia:Template messages/.*$',

-- Don't categorise archives. '/[aA]rchive', "^Wikipedia:Administrators' noticeboard/IncidentArchive%d+$", }+

+-- This module contains the blacklist used by Module:Category handler.

-- Pages that match Lua patterns in this list will not be categorised unless -- categorisation is explicitly requested.

return { '^Main Page$', -- don't categorise the main page.

-- Don't categorise the following pages or their subpages. -- "%f[/\0]" matches if the next character is "/" or the end of the string. '^Wikipedia:Cascade%-protected items%f[/\0]', '^User:UBX%f[/\0]', -- The userbox "template" space. '^User talk:UBX%f[/\0]',

-- Don't categorise subpages of these pages, but allow -- categorisation of the base page. '^Wikipedia:Template messages/.*$',

-- Don't categorise archives. '/[aA]rchive', "^Wikipedia:Administrators' noticeboard/IncidentArchive%d+$", }+

Technical details

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

See also

• Wikipedia:Category suppression for a "how-to" guide.
• Wikipedia:WikiProject Category Suppression