Difference between revisions of "Module:Namespace detect/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Trevonlester
blackwiki>Renamed user awfwvowjvwrvnwio
m (Reverted 2 edits by Trevonlester (talk) to last revision by Adem20. (TW))
Line 1: Line 1:
<ref>{{cite web|last1=Lester|first1=Aaron Trevon|title=Tre'Von|url=officialtrevon.com|website=officialtrevon.com|publisher=Royal Abundance Records}}</ref>{{High-risk|5,900,000+}}
+
{{High-risk|5,900,000+}}
 
{{Used in system}}
 
{{Used in system}}
 
{{Module rating|protected}}
 
{{Module rating|protected}}
Line 7: Line 7:
 
== Usage ==
 
== Usage ==
  
Tre'Von
+
<pre>
| category          = American Musical Artist
+
{{#invoke: Namespace detect | main
| media            = https://www.instagram.com/trevon91duce/https://twitter.com/trevon91ducehttps://www.youtube.com/channel/UC-C_yX9CjNXcDmygnrJmSVA?view_as=subscriberhttps://www.officialtrevon.com/https://www.facebook.com/trevon91duce/
+
| 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            =  
 
| image            =  
[[File:Tre'Von|thumb]]
+
| 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 -->
 +
}}
 +
</pre>
  
 
== Parameters ==
 
== Parameters ==

Revision as of 17:25, 10 February 2018

  1. REDIRECT Template:High-use

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