Template:Module other/doc

From Funkinchan
Revision as of 04:01, 20 September 2023 by Jedevari (talk | contribs) (making template)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

This is the {{module other}} meta-template.

This template helps other templates detect if they are on a "Module:" page or some "other" type of page.

Usage

This template usually takes two parameters, like this:

<syntaxhighlight lang="wikitext"> Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value). </syntaxhighlight>

If the template is on a "Module:" page, it will return this:

Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value).

If the template is on any other page, it will return this:

Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value).

A typical usage case could be to make it so that a template only adds a category when on module pages. Thus not adding other pages that just show the template. Like this:

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

Or to warn that a template should not be used on other pages:

<syntaxhighlight lang="wikitext"> Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value). </syntaxhighlight>

Note that in the first case above the "other" parameter was not used, and in the second example the "module" parameter was left empty.

Demospace

For testing and demonstration purposes this template can take a parameter named demospace.

  • If it has the value module it returns the module page text.
  • It if has the value other or any other value such as the name of some other namespace it returns the other pages text.
  • If the parameter is empty or undefined, the actual page type determines the result.

Like this:

<syntaxhighlight lang="wikitext"> Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value). </syntaxhighlight>

No matter on what kind of page the code above is used it will return this:

Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value).

You can make it so your template also understands the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:

<syntaxhighlight lang="wikitext"> Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value). </syntaxhighlight>

Technical details

This template detects "Module talk:" pages as type other.

This template works like {{main talk other}}, for more examples and technical details see full documentation there.


Template:Namespace and pagename-detecting templates