imported>Oetterer |
|||
| Zeile 1: | Zeile 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
{{Module rating|beta}} | {{Module rating|beta}} | ||
| − | |||
This module contains functions to find the target of a [[Help:Redirect|redirect]] page. | This module contains functions to find the target of a [[Help:Redirect|redirect]] page. | ||
| Zeile 27: | Zeile 26: | ||
To use this, first load the module. | To use this, first load the module. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local mRedirect = require('Module:Redirect') | local mRedirect = require('Module:Redirect') | ||
| − | </ | + | </syntaxhighlight> |
Then use the function with the following syntax: | Then use the function with the following syntax: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mRedirect.luaMain(rname, bracket) | 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. | <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. | ||
| Zeile 54: | Zeile 53: | ||
To use it, first load the module. | To use it, first load the module. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local mRedirect = require('Module:Redirect') | local mRedirect = require('Module:Redirect') | ||
| − | </ | + | </syntaxhighlight> |
Then use the function with the following syntax: | Then use the function with the following syntax: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mRedirect.getTarget(page) | 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]]. | <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]]. | ||
| Zeile 69: | Zeile 68: | ||
* [[bugzilla:66974]] - Provide a standard way to get the target of a redirect page | * [[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 | * [[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 | + | * [[Template:Submit an edit request]], which uses this module<!-- null edit comment; remove --> |
Aktuelle Version vom 11. Oktober 2022, 07:58 Uhr
 | This is a documentation subpage for Modul:Redirect. It contains usage information, categories and other content that is not part of the original modul page. |
 | 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. |
This module contains functions to find the target of a redirect page.
Main[Quelltext bearbeiten]
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[Quelltext bearbeiten]
{{#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[Quelltext bearbeiten]
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[Quelltext bearbeiten]
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[Quelltext bearbeiten]
{{#invoke:redirect|isRedirect|WP:AFC}}→{{#invoke:redirect|isRedirect|Wikipedia:Articles for deletion}}→
GetTarget[Quelltext bearbeiten]
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.
See also[Quelltext bearbeiten]
- bugzilla:66974 - Provide a standard way to get the target of a redirect page
- mw:Extension:Scribunto/Lua reference manual, the Scribunto interface for determining a page's redirect status
- Template:Submit an edit request, which uses this module