Difference between revisions of "Module:Namespace detect/doc"
Jump to navigation
Jump to search
blackwiki>Christian75 ({{High-risk|3,250,000}}) |
blackwiki>Mr. Stradivarius (add info about the table function) |
||
| Line 48: | Line 48: | ||
{{#invoke:Namespace detect|table}} | {{#invoke:Namespace detect|table}} | ||
| + | |||
| + | == 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 {{para|talk|yes}}. | ||
== Porting to different wikis == | == 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 the "cfg" table. | 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 the "cfg" table. | ||
Revision as of 10:39, 20 October 2013
- REDIRECT Template:High-use
25px This page is a redirect:
|
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.
Contents
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 =
| wp =
| 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 -->
}}
Parameters
- page - 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. - 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. - 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
|
|
blackwiki
|
project
|
file
|
image
|
mediawiki
|
|
template
|
|
help
|
|
category
|
|
module
|
|
translations
|
|
gadget
|
|
gadget definition
|
|
topic
|
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 the "cfg" table.