Module:Redirect/doc: Difference between revisions
(Created page with "{{Documentation subpage}} {{Lua|Module:Arguments}} __NOTOC__ This module contains functions to find the target of a 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>{{((}}#invoke:redirect|main|page-name{{))}}</code>. If {{code|page-name}} does not exist or is not a redirect then {{code|page-name...") |
m (→Examples) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
== Main == | == 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 | 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 {{ml|redirect|main|page-name}}. If {{code|page-name}} does not exist or is not a redirect then {{code|page-name}} is returned. If {{code|page-name}} is blank then blank is returned. | ||
The function normally neither takes nor gives square brackets, so to show the result as a link use | The function normally neither takes nor gives square brackets, so to show the result as a link use {{mlc|redirect|main|page-name}}. | ||
If the parameter ''bracket'' is given a nonblank value, brackets will be passed on if present. | If the parameter ''bracket'' is given a nonblank value, brackets will be passed on if present. | ||
=== Examples === | === Examples === | ||
* | * {{mlc|redirect|main|wikipedia:AFC}} {{Rarr}} {{#invoke:redirect|main|wikipedia:AFC}} | ||
* | * {{mlc|redirect|main|{{!(n(}}wikipedia:AFD]]|bracket{{=}}yes}} {{Rarr}} {{#invoke:redirect|main|[[Wikipedia:AFD]]|bracket=yes}} | ||
* | * {{mlc|redirect|main|Wikipedia:Articles for deletion}} {{Rarr}} {{#invoke:redirect|main|Wikipedia:Articles for deletion}} | ||
* | * {{mlc|redirect|main|Wikipedia:Articles for rumination}} {{Rarr}} {{#invoke:redirect|main|Wikipedia:Articles for rumination}} | ||
Note: [[ | Note: [[wikipedia:AFC|AFC]] and [[wikipedia:AFD|AFD]] are both redirects, but [[Wikipedia:Articles for deletion]] is not, and [[Wikipedia:Articles for rumination]] does not exist. | ||
=== LuaMain === | === LuaMain === | ||
| Line 38: | Line 38: | ||
== IsRedirect == | == 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 | 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 {{mlc|redirect|isRedirect|page-name}}. | ||
=== Examples === | === Examples === | ||
* | * {{mlc|redirect|isRedirect|wikipedia:AFC}} {{Rarr}} {{#invoke:redirect|isRedirect|wikipedia:AFC}} | ||
* | * {{mlc|redirect|isRedirect|Wikipedia:Articles for deletion}} {{Rarr}} {{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}} | ||
* | * {{mlc|redirect|isRedirect|Wikipedia:Articles for rumination}} {{Rarr}} {{#invoke:redirect|isRedirect|Wikipedia:Articles for rumination}} | ||
=== LuaIsRedirect === | === LuaIsRedirect === | ||
Latest revision as of 05:37, 19 June 2023
|
It contains usage information, categories and other content that is not part of the original module page.
|
|---|
 | This module depends on the following other modules: |
This module contains functions to find the target of a 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 {{#invoke:redirect|main|page-name}}. If page-name does not exist or is not a redirect then page-name is returned. If page-name is blank then blank is returned.
The function normally neither takes nor gives square brackets, so to show the result as a link use {{#invoke:redirect|main|page-name}}.
If the parameter bracket is given a nonblank value, brackets will be passed on if present.
Examples
{{#invoke:redirect|main|wikipedia:AFC}}→ wikipedia:AFC{{#invoke:redirect|main|[[wikipedia:AFD]]|bracket=yes}}→ wikipedia:AFD{{#invoke:redirect|main|Wikipedia:Articles for deletion}}→ wikipedia:Articles for deletion{{#invoke:redirect|main|Wikipedia:Articles for rumination}}→ wikipedia:Articles for rumination
Note: AFC and 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.
local mRedirect = require('Module:Redirect')
Then use the function with the following syntax:
mRedirect.luaMain(rname, bracket)
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|page-name}}.
Examples
{{#invoke:redirect|isRedirect|wikipedia:AFC}}→{{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}}→{{#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:
local mRedirect = require('Module:Redirect')
mRedirect.luaIsRedirect(rname)
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.
local mRedirect = require('Module:Redirect')
Then use the function with the following syntax:
mRedirect.getTarget(page)
page can be either the name of the redirect page as a string, or a mw.title object.