This plugin was distributed previously as part of the McKessonApsWikiPlugins package, now as part of the CeryleWikiPlugins. This documentation is updated for the new version as appropriate.

The __~RedirectPlugin__ returns a fragment of Javascript into the page to do an automatic redirection and a link that can be manaully clicked on if Javascript is not enabled.

This plugin is useful if you have multiple wiki instances that you want to tie together.

Requires only one parameter, 'to', which can be an InterWiki link. If it cannot be interpreted as an interwiki link we assume it's some external link and just redirect to it as given.  If it __is__ an interwiki link, we first expand it, then redirect.

Note: There is a default 2 second pause before the redirection, so if you want to edit the page containing this plugin, you'd better be quick.  You may change the duration of the pause by providing a {{delay='1234'}} style parameter.

!! Features

Allows redirecting to:

* Other wiki pages (you could just use {{[[{SET alias='~OtherName'}]}} for this.
* Interwiki pages (you cannot do this with the alias feature)
* Arbitrary URL's (again you cannot do this with the alias feature)
And as some have pointed out, the end-user syntax is a bit more approachable than how you set an alias.

!! Usage:

Full syntax examples:
[{org.ceryle.wiki.plugin.redirect.RedirectPlugin to='http://www.google.com' delay='5000'}]
[{org.ceryle.wiki.plugin.redirect.RedirectPlugin to='JSPWiki:Main'}]
[{org.ceryle.wiki.plugin.redirect.RedirectPlugin to='SomeOtherPage'}]

And if you've added org.ceryle.wiki.plugin to your plugin search path, it can look as simple as:

[{Redirect to='SomeOtherPage'}]


!! Status/Notes

Included in the McKessonApsWikiPlugins jar. -- JohnVolkar\\
Now included in the CeryleWikiPlugins.jar. -- MurrayAltheim



I cannot find documentation in the wiki on setting an ALIAS ; is there any way to edit a page that has set ALIAS set on it without resorting to entering the files on the server?

--JJGabor, 19-Aug-2007


Knowing about the plugin is great, but where is the plugin?  I'm looking to install a single plugin, versus a full suite from McKessonApsWikiPlugins or CeryleWikiPlugins