Redirect macro

Last modified by Admin on 2026/02/26 15:45

cogSetup a redirect in a document, with a given delay, to a specified location.
TypeXAR
CategoryMacro
Developed by

Paul Pantiru

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Success

Installable with the Extension Manager

Description

Setup a redirect in a document, with a given delay, to a specified location.

Screenshot from 2024-10-18 06-40-12.png

Information

Parameters:

reference - The XWiki document reference or URL to redirect to. The URL can be absolute or relative.
delay - expressed in seconds (optional: default is 0)
visible - whether to display a redirect notice box (optional: defaults is "true")

Example usage

With document reference

{{redirect reference="Sandbox.TestPage1" delay="3" visible="false"/}}

With absolute URL

{{redirect reference="https://www.w3.org" delay="2"/}}

With relative URL

{{redirect reference="/xwiki/bin/view/Sandbox/#HLinks"/}}
 

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Versions

Dependencies

Dependencies for this extension (org.xwiki.contrib.redirect:redirect-macro 1.1.0):

Get Connected