Kulemba Module:Redirect/doc

{{used in system}}
{{Module rating|beta}}
{{Module rating|protected}}
{{Lua|Module:Arguments}}
This module contains functions to find the target of a [[Help:Redirect|redirect]] page.

== Main ==

The main function accepts the name of a single page.  It determines if the page is a redirect; if so it looks up the page, extracts the target, and returns the target name as text. Its usage is <code><nowiki>{{#invoke:redirect|main|page-name}}</nowiki></code>. If <code>page-name</code> does not exist or is not a redirect then <code>page-name</code> is returned. If <code>page-name</code> is blank then blank is returned.

The function normally neither takes nor gives square brackets, so to show the result as a link use <code><nowiki>[[{{#invoke:redirect|main|page-name}}]]</nowiki></code>.  

If the parameter ''bracket'' is given a nonblank value, brackets will be passed on if present.

=== Examples ===

* <code><nowiki>{{#invoke:redirect|main|WP:AFC}}</nowiki></code> &rarr; {{#invoke:redirect|main|WP:AFC}}
* <code><nowiki>{{#invoke:redirect|main|[[WP:AFD]]|bracket=yes}}</nowiki></code> &rarr; {{#invoke:redirect|main|[[WP:AFD]]|bracket=yes}}
* <code><nowiki>{{#invoke:redirect|main|Wikipedia:Articles for deletion}}</nowiki></code> &rarr; {{#invoke:redirect|main|Wikipedia:Articles for deletion}}
* <code><nowiki>{{#invoke:redirect|main|Wikipedia:Articles for rumination}}</nowiki></code> &rarr; {{#invoke:redirect|main|Wikipedia:Articles for rumination}}

Note: [[WP:AFC]] and [[WP:AFD]] are both redirects, but [[Wikipedia:Articles for deletion]] is not, and [[Wikipedia:Articles for rumination]] does not exist.

=== LuaMain ===

If you want to use the main function from another Lua module, you may want to use the luaMain function. This provides the same functionality as the main function, but doesn't require that a frame object be available.

To use this, first load the module.

<syntaxhighlight lang="lua">
local mRedirect = require('Module:Redirect')
</syntaxhighlight>

Then use the function with the following syntax: 

<syntaxhighlight lang="lua">
mRedirect.luaMain(rname, bracket)
</syntaxhighlight>

<var>rname</var> is the name of the redirect page, and if <var>bracket</var> is anything but false or nil, the module will produce a link rather than just a page name.

== IsRedirect ==

The isRedirect function is used from wiki pages to find out if a given page is a redirect or not. If the page is a redirect, the function returns "yes", and if not the output is blank. Its usage is <code><nowiki>{{#invoke:redirect|isRedirect|page-name}}</nowiki></code>.

=== Examples ===

* <code><nowiki>{{#invoke:redirect|isRedirect|WP:AFC}}</nowiki></code> &rarr; {{#invoke:redirect|isRedirect|WP:AFC}}
* <code><nowiki>{{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}}</nowiki></code> &rarr; {{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}}
* <code><nowiki>{{#invoke:redirect|isRedirect|Wikipedia:Articles for rumination}}</nowiki></code> &rarr; {{#invoke:redirect|isRedirect|Wikipedia:Articles for rumination}}

=== LuaIsRedirect ===
The isRedirect can be accessed from other Lua modules in the same way as the main function:

<syntaxhighlight lang="lua">
local mRedirect = require('Module:Redirect')
mRedirect.luaIsRedirect(rname)
</syntaxhighlight>

== GetTarget ==

The getTarget function fetches the target page name of a redirect page, and is only usable from Lua. If the page specified is a redirect, then the target is returned; otherwise the function returns nil.

To use it, first load the module.

<syntaxhighlight lang="lua">
local mRedirect = require('Module:Redirect')
</syntaxhighlight>

Then use the function with the following syntax: 

<syntaxhighlight lang="lua">
mRedirect.getTarget(page)
</syntaxhighlight>

<var>page</var> can be either the name of the redirect page as a string, or a [[mw:Extension:Scribunto/Lua reference manual#Title objects|mw.title object]].

==See also==
* [[phab:T68974]] -  Provide a standard way to get the target of a redirect page
* [[mw:Extension:Scribunto/Lua reference manual#Title objects]], the Scribunto interface for determining a page's redirect status
* [[Template:Get QID]], which uses this module 
* [[Template:Submit an edit request]], which uses this module