John James: Created page with "{{documentation subpage}} This is the {{tl|cat handler/blacklist}} sub-template. Do not use this templ..."

2011-08-12T09:58:45Z

Created page with "{{documentation subpage}}  This is the {{tl|cat handler/blacklist}} sub-template. Do not use this templ..."

New page

{{documentation subpage}}



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

Do not use this template directly, use {{tl|cat handler}} instead. This template is called from {{tl|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 {{tlf|cat handler}} to decide when not to categorize. To update the blacklist, edit this template.

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

:<code><nowiki>+{{cat handler/blacklist}}+</nowiki></code>

Which here on this page returns this:

:+{{cat 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 [[{{pgn|ns|page1|page2}}/testcases|/testcases]] subpage of this template. Like this:
:<code><nowiki>+{{cat handler/blacklist| page = User:Example }}+</nowiki></code>
:<code><nowiki>+{{cat handler/blacklist| page = User:Example/Archive 5}}+</nowiki></code>

Which returns this:

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

=== Technical details ===

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

=== See also ===

* [[Wikipedia:Wikipedia:Category suppression|Wikipedia:Category suppression]] – The how-to guide.
* [[Wikipedia:Wikipedia:WikiProject Category Suppression|Wikipedia:WikiProject Category Suppression]] – The WikiProject.

<includeonly>

[[Category:MisesWiki metatemplates]]

</includeonly>

Template:Cat handler/blacklist/doc - Revision history

John James: Created page with "{{documentation subpage}} This is the {{tl|cat handler/blacklist}} sub-template. Do not use this templ..."