An diofar eadar na mùthaidhean a rinneadh air "Mòideal:Category handler/doc"

{{high-risk| 4,700,000+ }}

 

 

== Use from other Lua modules ==

 

For cases where a module only needs to categorise in one of the namespaces main (articles), file (images) or category, then using this module is overkill. Instead, you can simply get a title object using [[rev:https://www.mediawiki.org/wiki/Extension:Scribunto/Lua reference manual#mw.title.getCurrentTitle#mw.title.getCurrentTitle|mw.title.getCurrentTitle]] and check the <code>nsText</code> field. For example:

local title = mw.title.getCurrentTitle()

if title.nsText == 'File' then

-- do something

end

However, if your module needs to categorize in any other namespace, then we recommend you use this module, since it provides proper category suppression and makes it easy to select how to categorize in the different namespaces.

 

=== Namespaces ===

 

 

:'''main''' = Main/article space, as in normal Wikipedia articles.

This module takes two or more parameters. Here's an example using a hello world program:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local result = 'Hello world!'

local category = categoryHandler{

nocat = frame.args.nocat -- So "nocat=true/false" works

}

return p

 

:'''main''', '''file''', '''help''', '''category''', '''portal''' and '''book'''

But it will ''not'' categorize in any other namespaces, e.g.:

And it will ''not'' categorize on blacklisted pages. (See section [[#Blacklist|blacklist]] below.)

 

 

Any module or template that is meant for one or more of the namespaces where this module categorizes can use the basic syntax as shown above.

This module takes one or more parameters named after the different page types as listed in section [[#Namespaces|namespaces]] above. By using those parameters you can specify exactly in which namespaces your template should categorize. Like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local result = 'This is a module meant for articles and talk pages.'

local category = categoryHandler{

nocat = frame.args.nocat -- So "nocat=true/false" works

}

return p

 

The above module will only categorize in main and talk space. But it will not categorize on /archive pages since they are blacklisted. (See section [[#Blacklist|blacklist]] below.) And if you need to demonstrate (discuss) the module on a talkpage, then you can feed "<code>nocat='true'</code>" to prevent that template from categorizing. (See section [[#Nocat|nocat]] below.) Like this:

Sometimes we want to use the same category in several namespaces, then do like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local result = 'This is a module used in several namespaces.'

local category = categoryHandler{

help = 1,

user = 1,

talk = '', -- No categories on talk pages

nocat = frame.args.nocat -- So "nocat=true/false" works

}

return p

 

In the above example we use a numbered parameter to feed one of the categories, and then we tell this module to use that numbered parameter for both the help and user space.

The category handler module also has a parameter called '''all'''. It works like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local result = 'This is a module used in all namespaces.'

local category = categoryHandler{

nocat = frame.args.nocat -- So "nocat=true/false" works

}

return p

 

 

We suggest avoiding the '''all''' parameter, since modules and templates should preferably only categorize in the namespaces they need to.

The all parameter can also be combined with the rest of the parameters. Like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local result = 'This is a module used in all namespaces.'

local category = categoryHandler{

nocat = frame.args.nocat -- So "nocat=true/false" works

}

return p

 

If the above module is placed on an article, then it will add the categories "Somecat1" and "Somecat2". But on all other types of pages it will instead add "Somecat1" and "Somecat3". As the example shows, the all parameter works independently of the rest of the parameters.

The category handler module understands the '''subpage''' parameter. Like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local category = categoryHandler{

subpage = 'no' -- Don't categorize on subpages

nocat = frame.args.nocat -- So "nocat=true/false" works

}

return p

 

If "<code>subpage='no'</code>" then this template will ''not'' categorize on subpages. For the rare occasion you ''only'' want to categorize on subpages, then use "<code>subpage='only'</code>". If '''subpage''' is empty or undefined then this template categorizes both on basepages and on subpages.

=== Blacklist ===

 

 

If you want a template to categorize on a blacklisted page, then feed "<code><nowiki>nocat = false</nowiki></code>" to the module when you place it on the page, thus skipping the blacklist check. Note that this module only categorizes if it has data for the namespace. For instance, if the basic syntax is used (see [[#Basic usage|basic usage]] above), then even if you set "<code>nocat = false</code>" the template will not categorize on a talk page, since it has no data for talk pages. But it has data for help space, so on a blacklisted help page it will categorize.

 

* If "<code>nocat = true</code>" then this template does ''not'' categorize.

* If "<code>nocat = false</code>" this template categorizes even when on blacklisted pages. (See section [[#Blacklist|blacklist]] above.)

 

Modules and templates that use {{tlf|category handler}} should forward '''nocat''', so they too understand '''nocat'''. The code "<code>nocat = frame.args.nocat</code>" shown in the examples on this page does that.

For backwards compatibility this module also understands the '''categories''' parameter. It works the same as '''nocat'''. Like this:

 

* If "<code>categories = true</code>" this template categorizes even when on blacklisted pages.

 

=== The "category2" parameter ===

Besides from categories, you can feed anything else to this module, for instance some text. Like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

local result = 'This is a module used on talk pages.'

local category = categoryHandler{

other = '<p class="error">This module should only be used on talk pages.</p>',

nocat = frame.args.nocat -- So "nocat=true/false" works

return p

 

When the template above is shown on anything else than a talk page, it will look like this:

 

:This is a module used on talk pages.{{#invoke:category handler|main

| other = <p class="error">This module should only be used on talk pages.</p>

| nocat = {{{nocat|}}} <!--So "nocat=true/false" works-->

For testing and demonstration purposes this module can take a parameter named '''page'''. Like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

return p

 

In the above code we on purpose left out the brackets around the category names so we see the output on the page. No matter on what kind of page the code above is used it will return this:

| main = Category:Some cat

| talk = Category:Talk cat

| page = User talk:Example

}}

You can make it so your module also understands the '''page''' parameter. That means you can test how your template will categorize on different pages, without having to actually edit those pages. Then do like this:

 

p = {}

local categoryHandler = require( 'Module:Category handler' ).main

 

return p

 

=== Parameters ===

* categories = frame.args.categories / false / true / 'no' / 'yes' / 'n' / 'y' / 'false' / 'true' / 0 / 1

* category2 = frame.args.category or '¬' / '' / 'no' / ''not defined'' / '¬' / 'yes'

 

Note that empty values to the "main" ... "other" parameters have special meaning (see examples above). The "all" parameter doesn't understand numbered parameters, since there should never be a need for that.

== Exporting to other wikis ==

 

 

== See also ==

* [[:w:en:Wikipedia:WikiProject Category Suppression]] – The WikiProject.

* [[:w:en:Wikipedia:Namespace]] – Lists all the namespaces.