Template:Suppress categories

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Suppress categories/doc.

This template strips categories from wikitext. For example, if passed the code "foo[[Category:Some category]]", it will return only "foo". It can be used to strip categories from templates as well; if passed the code "{{my template}}", it will return the template output minus the categories.

The template properly handles categories escaped with the colon trick, categories whose names include invalid characters such as ">", and categories that are surrounded with nowiki tags. However, it does not support complex wikitext such as nested links or magic words like __TOC__. Even so, it should still remove the vast majority of categories from any given wikitext.

Usage

{{Suppress categories |1= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

This template strips categories from wikitext. For example, if passed the code "foo[[Category:Some category]]", it will return only "foo". It can be used to strip categories from templates as well; if passed the code "{{my template}}", it will return the template output minus the categories.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
input text	1		Content	required

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Example

{{Suppress categories|foo[[Category:Piped link|bar]]}}

renders as:

foo