Difference between revisions of "Module:Redirect/doc"
Arcangelus (talk | contribs) (Created page with "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...") |
Arcangelus (talk | contribs) m (→Examples: More examples from this wiki. I used the same examples from the redirect section for clarity.) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This module contains functions to find the target of a | + | This module contains functions to find the target of a redirect page. |
== Main == | == Main == | ||
| Line 10: | Line 10: | ||
=== Examples === | === Examples === | ||
| − | + | * <code><nowiki>{{#invoke:redirect|main|Insect}}</nowiki></code> → {{#invoke:redirect|main|Insect}} | |
| − | + | * <code><nowiki>{{#invoke:redirect|main|Heart}}</nowiki></code> → {{#invoke:redirect|main|Heart}} | |
| − | * <code><nowiki>{{#invoke:redirect|main| | + | * <code><nowiki>{{#invoke:redirect|main|Insulation - Heat Factor}}</nowiki></code> → {{#invoke:redirect|main|Insulation - Heat Factor}} |
| − | * <code><nowiki>{{#invoke:redirect|main| | ||
| − | * <code><nowiki>{{#invoke:redirect|main| | ||
=== LuaMain === | === LuaMain === | ||
| Line 39: | Line 37: | ||
=== Examples === | === Examples === | ||
| − | + | * <code><nowiki>{{#invoke:redirect|isRedirect|Insect}}</nowiki></code> → {{#invoke:redirect|isRedirect|Insect}} | |
| − | * <code><nowiki>{{#invoke:redirect|isRedirect| | + | * <code><nowiki>{{#invoke:redirect|isRedirect|Heart}}</nowiki></code> → {{#invoke:redirect|isRedirect|Heart}} |
| − | * <code><nowiki>{{#invoke:redirect|isRedirect| | + | * <code><nowiki>{{#invoke:redirect|isRedirect|Insulation - Heat Factor}}</nowiki></code> → {{#invoke:redirect|isRedirect|Insulation - Heat Factor}} |
| − | * <code><nowiki>{{#invoke:redirect|isRedirect| | ||
=== LuaIsRedirect === | === LuaIsRedirect === | ||
Latest revision as of 16:05, 29 November 2024
This module contains functions to find the target of a redirect page.
Main[edit]
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[edit]
{{#invoke:redirect|main|Insect}}→ Insectoids{{#invoke:redirect|main|Heart}}→ Heart{{#invoke:redirect|main|Insulation - Heat Factor}}→ Insulation - Heat
LuaMain[edit]
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[edit]
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[edit]
{{#invoke:redirect|isRedirect|Insect}}→ yes{{#invoke:redirect|isRedirect|Heart}}→{{#invoke:redirect|isRedirect|Insulation - Heat Factor}}→ yes
LuaIsRedirect[edit]
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[edit]
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.