Template:Suppress categories/doc: Difference between revisions

Latest revision as of 16:21, 31 December 2023

Uses Lua:

Module:Suppress categories

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Suppress categories.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

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

Template parameters

Parameter text is empty

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.

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
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

@@ Line 1: / Line 1: @@
+{{Lua|Module:Suppress categories}}
 {{TemplateBox
    |1        = 1
-   |1d-en    = The input text.
+   |1label-en= input text
+  |1type    = content
    |1stat    = required
@@ Line 8: / Line 10: @@
 The template properly handles categories escaped with the [[w:en:Help:Colon trick|colon trick]], categories whose names include invalid characters such as "<code>></code>", and categories that are surrounded with [[w:en:WP:NOWIKI|nowiki]] tags. However, it does not support complex wikitext such as nested links or [[w:en:WP:MAGIC|magic words]] like <code><nowiki>__TOC__</nowiki></code>. Even so, it should still remove the vast majority of categories from any given wikitext.
+    |desc-td-en       = This template strips categories from wikitext. For example, if passed the code "<nowiki>foo[[Category:Some category]]</nowiki>", it will return only "foo". It can be used to strip categories from templates as well; if passed the code "<nowiki>{{my template}}</nowiki>", it will return the template output minus the categories.
-Examples:
+  |example            = <nowiki>foo[[Category:Piped link|bar]]</nowiki>
-{| class="wikitable"
+  |example-value      = {{suppress categories|foo[[Category:Piped link|bar]]}}
-|-
-! Code
-! Output
-|-
-| <code><nowiki>{{suppress categories|foo}}</nowiki></code>
-| {{suppress categories|foo}}
-|-
-| <code><nowiki>{{suppress categories|foo[[Category:Some category]]}}</nowiki></code>
-| {{suppress categories|foo[[Category:Some category]]}}
-|-
-| <code><nowiki>{{suppress categories|foo[[Category:Some category]]bar[[Category:Another category]]}}</nowiki></code>
-| {{suppress categories|foo[[Category:Some category]]bar[[Category:Another category]]}}
-|-
-| <code><nowiki>{{suppress categories|foo{{{some_parameter|[[Category:Bar]]}}}}}</nowiki></code>
-| {{suppress categories|foo{{{some_parameter|[[Category:Bar]]}}}}}
-|-
-| <code><nowiki>{{suppress categories|foo[[Category:Bad ca[]tegory link]]}}</nowiki></code>
-| {{suppress categories|foo[[Category:Bad ca[]tegory link]]}}
-|-
-| <code><nowiki>{{suppress categories|foo[[:Category:Colon trick]]}}</nowiki></code>
-| {{suppress categories|foo[[:Category:Colon trick]]}}
-|-
-| <code><nowiki>{{suppress categories|foo[[Category:Piped link|bar]]}}</nowiki></code>
-| {{suppress categories|foo[[Category:Piped link|bar]]}}
-|-
-| <code><nowiki>{{suppress categories|foo[[Category:Piped link|ba[]r]]}}</nowiki></code>
-| {{suppress categories|foo[[Category:Piped link|ba[]r]]}}
-|-
-| <code><nowiki>{{suppress categories|foo[[non-category link]]}}</nowiki></code>
-| {{suppress categories|foo[[non-category link]]}}
-|-
-| <code><nowiki>{{suppress categories|foo[[ Category : Some category with spaces ]]}}</nowiki></code>
-| {{suppress categories|foo[[ Category : Some category with spaces ]]}}
-|-
-| <code><nowiki>{{suppress categories|{{User alternative account name|Example}}}}</nowiki></code>
-| {{suppress categories|{{User alternative account name|Example}}}}
-|-
-|}
    |namespace          = all
    |usergroup          = all
+  |useTemplateData    = only
 }}

commons>Tacsipacsi

Latest revision as of 16:21, 31 December 2023

Usage

Template parameters

Additional information

Example