Difference between revisions of "Module:Suppress categories/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (tweak) |
blackwiki>Mr. Stradivarius (rate as alpha) |
||
| Line 1: | Line 1: | ||
| + | {{module rating|alpha}} | ||
| + | |||
This is a simple module to strip [[Help:Category|categories]] from [[Help:Wiki markup|wikitext]]. For example, if passed the code "<code><nowiki>foo[[Category:Some category]]</nowiki></code>", it will return only "<code>foo</code>". | This is a simple module to strip [[Help:Category|categories]] from [[Help:Wiki markup|wikitext]]. For example, if passed the code "<code><nowiki>foo[[Category:Some category]]</nowiki></code>", it will return only "<code>foo</code>". | ||
Revision as of 13:29, 5 July 2013
| This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
This is a simple module to strip categories from wikitext. For example, if passed the code "foo[[Category:Some category]]", it will return only "foo".
The module 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
{{#invoke:Suppress categories|main|input text}}
Examples
| Code | Output |
|---|---|
{{#invoke:Suppress categories|main|foo}}
|
foo |
{{#invoke:Suppress categories|main|foo[[Category:Some category]]}}
|
foo |
{{#invoke:Suppress categories|main|foo[[Category:Some category]]bar[[Category:Another category]]}}
|
foobar |
{{#invoke:Suppress categories|main|foo{{{some_parameter|[[Category:Bar]]}}}}}
|
foo |
{{#invoke:Suppress categories|main|foo[[Category:Bad ca[]tegory link]]}}
|
foo[[Category:Bad ca[]tegory link]] |
{{#invoke:Suppress categories|main|foo[[:Category:Pipe trick]]}}
|
fooCategory:Pipe trick |
{{#invoke:Suppress categories|main|foo[[Category:Piped link|bar]]}}
|
foo |
{{#invoke:Suppress categories|main|foo[[Category:Piped link|ba[]r]]}}
|
foo |
{{#invoke:Suppress categories|main|foo[[non-category link]]}}
|
foonon-category link |
{{#invoke:Suppress categories|main|foo[[ Category : Some category with spaces ]]}}
|
foo |