click on the Biowiki logo to go to homepage Home Home | EditEdit | Attach Attach | New New | Site Map Site Map | Help Help
Research Teaching
Main | JBrowse | TWiki
Biowiki > TWiki > RedirectPlugin


Advanced search...


Redirect Plugin

Create a redirect to another topic or website

You can use this plugin 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 Jump 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{""}%
  • Pass parameters:
    • Url parameters are passed on:"}%. 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:

Wikipedia-like "Redirected from..."

A redirect now appends the redirectedfrom parameter to the url which contains the Web.Topic that the user has been redirected from. This allows us to display Wikipedia like "Redirected from ..." text on the destination topic. You can use the %URLPARAM{redirectedfrom}% variable to access the parameter and create the "Redirected from..." text.

Below is an example you can put in your template:

%IF{ "$'URLPARAM{redirectedfrom}'" then="<span class='twikiGrayText'>(Redirected from <a href='%SCRIPTURLPATH{view}%/%URLPARAM{redirectedfrom}%?noredirect=on'>%URLPARAM{redirectedfrom}%</a>)</span>"}%

Which will display the following on topics that have been redirected:

(Redirected from Web.Topic)

%REDIRECT{"SomeTopic"}% in an included topic

Redirection happens even if %REDIRECT{"SomeTopic"}% is in an included topic. The redirectedfrom URL parameter has the including topic rather than included topic.

For example, let's say we have the following topics. Then, when IncludingTopic is viewed, redirection to the RedirectDestination occurs with the redirectedfrom=WEB.IncludingTopic URL parameter.





Related Topics

Plugin Settings

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

Test Topics

If installed:

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 TWiki server.

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the Plugins home (see below).
    • Unzip in your twiki installation directory. Content:
      File: Description:
      data/TWiki/RedirectPlugin.txt Plugin topic
      data/TWiki/VarREDIRECT.txt REDIRECT variable documentation topic
      data/Sandbox/RedirectPluginTest.txt Test topic
      data/Sandbox/RedirectPluginDestination.txt Test topic, landing page
      lib/TWiki/Plugins/ Plugin Perl module
    • Set the ownership of the extracted directories and files to the webserver user.

  • Plugin configuration and testing:
    • Run the configure script, and enable the plugin in the Plugins section.
    • Test if the installation was successful: See Test Topics section above.

Plugin Info

Plugin Author: TWiki:Main.SteveMokris
Copyright: © 2003 TWiki:Main.SteveMokris,
© 2003-2014 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2014-05-31
Change History:  
2014-05-31: TWikibug:Item7503: barfing undef Fast CGI and %TOC%
2013-08-14: TWikibug:Item7315: redirectedfrom URL parameter based on %BASEWEB% and %BASETOPIC% -- TWiki:Main.HideyoImazu
2012-12-01: TWikibug:Item7020: Add category to variable REDIRECT -- TWiki:Main.PeterThoeny
2012-09-20: TWikibug:Item6937: RedirectPlugin doesn't recognize Site.Site.Page format.
2011-07-15: TWikibug:Item6725: Change global package variables from "use vars" to "our"; doc improvements
2011-05-10: TWikibug:Item6701: Doc improvements, adding VarREDIRECT variable documentation -- TWiki:Main.PeterThoeny
2011-02-14: TWikibug:Item6664: Remove any newline characters from redirect URL before redirecting -- TWiki:Main.DipuDeshmukh
2010-07-25: TWikibug:Item6530: Doc fixes
24 Nov 2008: TWiki:Main.AndrewRJones: Ability to display Wikipedia like "Redirected from..."
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:

Related Topics: VarREDIRECT, RedirectPluginDestination, RedirectPluginTest, TWikiPlugins, AdminDocumentationCategory

Actions: Edit | Attach | New | Ref-By | Printable view | Raw view | Normal view | See diffs | Help | More...