Module:Namespace detect/doc
This is the documentation page for Module:Namespace detect
 | This Lua module is used on 11,700,000+ pages, or roughly 174211% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module is used in system messages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module allows you to output different text depending on the namespace that a given page is in. It is a Lua implementation of the {{namespace detect}} template, with a few improvements: all namespaces and all namespace aliases are supported, and namespace names are detected automatically for the local wiki.
Usage
{{#invoke: Namespace detect | main
| page = <!-- page to detect namespace for, if not the current page -->
| main = <!-- text to return for the main namespace -->
| talk = <!-- text to return for talk namespaces -->
<!-- text to return for specific subject namespaces -->
| portal =
| category =
| user =
| wikipedia =
| education program =
| mediawiki =
| book =
| timedtext =
| template =
| special =
| media =
| file =
| image =
| help =
| module =
| other = <!-- text to return for unspecified namespaces -->
| demospace = <!-- namespace to display text for -->
| subjectns = <!-- set to "yes" to treat talk pages as the corresponding subject page -->
}}
Parameters
- main - text to return if the page is in the main namespace.
- talk - text to return if the page is in a talk namespace. This can be any talk namespace - it will match any of "Talk:", "Wikipedia talk:", "User talk:", etc.
- Subject namespace parameters, e.g. wikipedia, user, file... - the text to return if the page is in the corresponding namespace. This module accepts all subject namespaces as parameters, including namespace aliases and virtual namespaces. See below for a list of supported values.
- other - text to return if no parameters for the page's namespace were specified. This text is also returned if
|demospace=is set to an invalid namespace value. - subjectns - if on a talk page, use the corresponding subject page. Can be set with values of "yes", "y", "true" or "1".
- demopage - specifies a page to detect the namespace of. If not specified, and if the
|demospace=parameter is not set, then the module uses the current page. - demospace - force the module to behave as if the page was in the specified namespace. Often used for demonstrations.
Namespace parameters
Possible values for subject namespace parameters are as follows:
| Namespace | Aliases |
|---|---|
main
|
|
user
|
|
zoophilia wiki
|
project
|
file
|
image
|
mediawiki
|
|
template
|
|
help
|
|
category
|
|
item
|
|
property
|
|
module
|
|
portal
|
Table function
Use the following to display a table with the different possible namespace parameters:
{{#invoke:Namespace detect|table|talk=yes}}
To include the parameter for talk namespaces, use |talk=yes.
Porting to different wikis
This module is designed to be portable. To use it on a different wiki, all you need to do is to change the values in Module:Namespace detect/config. Instructions are available on that page.
Technical details
The module uses a data page at Module:Namespace detect/data. This page is loaded with mw.loadData, which means it is processed once per page rather than once per #invoke. This was done for performance reasons.
