Module:Redirect/doc
This is the documentation page for Module:Redirect
| 40x40px | 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. |
| 40x40px | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
| 40x40px | 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 contains functions to find the target of a redirect page.
Contents
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 {{#invoke:redirect|main|redirect-page-name}}.
The template normally neither takes nor gives square brackets, so to show the result as a link use [[{{#invoke:redirect|main|redirect-page-name}}]]. An error is produced if the redirect does not exist, but for versatility no error is given if the file is not a redirect (returns the original text) or if the file name is blank (returns blank).
However, if the parameter bracket is given a nonblank value, brackets will be passed on if present.
Examples
-
{{#invoke:redirect|main|WP:AFC}}→ WP:AFC -
{{#invoke:redirect|main|[[WP:AFD]]|bracket=yes}}→ WP:AFD -
{{#invoke:redirect|main|Wikipedia:Articles for deletion}}→ wikipedia:Articles for deletion
Note: WP:AFC and WP:AFD are both redirects, but Wikipedia:Articles for deletion is not.
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.
<source lang="lua"> local mRedirect = require('Module:Redirect') </source>
Then use the function with the following syntax:
<source lang="lua"> mRedirect.luaMain(rname, bracket) </source>
rname is the name of the redirect page, and if bracket 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 {{#invoke:redirect|isRedirect|redirect-page-name}}.
Examples
-
{{#invoke:redirect|isRedirect|WP:AFC}}→ -
{{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}}→
LuaIsRedirect
The isRedirect can be accessed from other Lua modules in the same way as the main function:
<source lang="lua"> local mRedirect = require('Module:Redirect') mRedirect.luaIsRedirect(rname) </source>
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.
<source lang="lua"> local mRedirect = require('Module:Redirect') </source>
Then use the function with the following syntax:
<source lang="lua"> mRedirect.getTarget(page) </source>
page can be either the name of the redirect page as a string, or a mw.title object.
See also
- bugzilla:66974 - 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:Submit an edit request, which uses this module
