Template:Cat handler/blacklist

From Wikibooks, open books for an open world
Jump to: navigation, search

Actual code of this blacklist:

</noinclude>{{if pagename
<!-- Start of blacklist -->

| Wikibooks:Templates/* = hide   <!-- Don't categorize on its subpages -->
| /archiv* = hide   <!-- Don't categorize on /archive pages -->

| Main Page = hide   <!-- Don't categorize the main page -->

<!-- End of blacklist -->
| page = {{{page|}}}   <!-- Never change this one, see the doc -->
}}<noinclude>
Template documentation[edit] [history] [purge]

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

Do not use this template directly, use {{cat handler}} instead. This template is called from {{cat 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-categorize. This blacklist is used by {{cat handler}} to decide when not to categorize. 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 categorize, 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:

+{{cat handler/blacklist}}+

Which here on this page returns this:

++

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. Like this:

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

Which returns this:

++
+hide+

Technical details

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