Module:Redirect/doc

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.

The template normally neither takes nor gives square brackets, so to show the result as a link use. 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

 * &rarr;
 * &rarr;
 * &rarr;

Note: WP:AFC and WP:AFD are both redirects, but TechInfoDepot: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.

Then use the function with the following syntax:

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.

Examples

 * &rarr;
 * &rarr;

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.

Then use the function with the following syntax:

page can be either the name of the redirect page as a string, or a mw.title object.