Redirect Plugin

Create a redirect to another topic or website.

I typically use this to make easy-to-type shortforms/acronyms of topic names. For example:

• Actual content appears under Main.LightweightDirectoryAccessProtocol
• Main.LDAP contains just a redirect tag. Referencing Main.LDAP anywhere or entering it in the Go box takes one directly to Main.LightweightDirectoryAccessProtocol

Syntax Rules

• Redirect to a topic within the web: %REDIRECT{"SomeTopic"}%
• Redirect to a topic in another web: %REDIRECT{"Someweb.SomeTopic"}%
• Redirect to any URL: %REDIRECT{"http://domain.com/"}%
• Pass parameters:
  • Url parameters are passed on: http://domain.com/twiki/bin/view/Main/TopicThatContainsARedirect?q=LDAP"}%. The landing topic url will contain these parameters
  • Parameters can also be passed to the variable: %REDIRECT{"Someweb.SomeTopic?q=LDAP"}%
  • REDIRECT parameters override url parameters

Prevent redirecting

To view the topic that contains a REDIRECT, pass parameter noredirect=on to the url. For example:

http://domain.com/twiki/bin/view/Main/WebHome?noredirect=on

Related Topics

• http://twiki.org/cgi-bin/view/Codev/RedirectPage
• http://twiki.org/cgi-bin/view/Codev/PageRedirectTag
• http://twiki.org/cgi-bin/view/Codev/TopicAliases
• http://twiki.org/cgi-bin/view/Codev/RedirectToRenamedPage

Plugin Settings

• Set SHORTDESCRIPTION = Create a redirect to another topic or website
• Set DEBUG = 0

Test topics

If installed:

• RedirectPluginTest - this topic should redirect to landing page:
• RedirectPluginDestination

Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip RedirectPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/RedirectPlugin.txt	Plugin topic
  data/TWiki/RedirectPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/RedirectPlugin.pm	Plugin Perl module

• Test if the installation was successful (see above syntax notes)

Plugin Info

Plugin Author:	TWiki:Main/SteveMokris
Plugin Version:	22 Apr 2006
Change History:
22 Apr 2007:	Arthur Clemens: url parameters are now passed on. Adapted from TWiki:Main.JohnRouillard.
21 Apr 2007:	Arthur Clemens: fixed redirect to non-wiki word topics; added noredirect=on parameter; added support for TWiki:Codev.ShorterURLs.
10 Aug 2006:	Ability to redirect to URL restored by TWiki:Main/ThomasWeigert. Also added support for URL parameters. Fixed a few bugs.
09 Jun 2006:	Dakar port by TWiki:Main/MeredithLesley
20 Jun 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RedirectPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RedirectPluginDev