Tour Application

Last modified by Admin on 2024/05/29 17:10

cogLet users create tour guides for any page
Developed by

XWiki Development Team

0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Installable with the Extension Manager


This application provides for the users a possibility to create tours for every page they want.
A tour represents the best way to understand the most important features inside a page. As you’ll see, the tour walks users step by step through page elements.


If the user doesn't like this kind of help, she can choose to close the tour without displaying all the steps. Then, a button on the bottom right of the page is displayed to show back the tour:



To create or to see all available tours, you can access the Tour application by using the application panels:


You will see the following page:


A tour will start when the Target Page or a Target Class entry is visited. A tour having the Target Page specified could be also started by clicking on the "Launch" link in the live table.

How to create a new Tour

Go to the Tour Application, and click on "Add New Entry". Select a name for your tour:


Then, fill the following form:


The fields are:

  • Description (optional): fill this field to have a description of your tour. This is purely for documentation purpose, it's not used by the application.
  • Active: whether or not the Tour should be displayed. By default, this option is enabled. You can disable a tour until it is fully written to avoid having users seeing an incomplete tour.
  • Target Page: the reference of the page where the tour should be displayed (example: Main.WebHome).
  • Target Class: the class name for which entries the tour should be displayed (example: XWiki.XWikiUsers)  Since 1.0. The Target Class should be used only when the Target Page is not specified.

Then save the page.

Adding steps

Edit the tour and click  NEW STEP  button to create new steps.



The fields are:

  • Element: CSS selector regarding the element on the page you want to put the popover on. If the element is not specified, the popover will be displayed in the center of the page.
  • Title: the title displayed in the step. It could be a translation key, like platform.dashboard.user.preferences for example.
  • Content: the content of the step. Wiki syntax and macros are allowed here!.
  • Placement: popover's position towards its element (‘top’,’right’,’bottom’,’left’).
  • Order: step index (the lower the number is, the first the step is displayed).
  • Backdrop: check it if you want to hide all the elements of the page that are not concerned by this step.
  • Target Page: the reference of the page where the step should be displayed (example: Main.WebHome).  Since 1.0. Adds the ability to create a Multipage tour. 
  • Target Action: the page action to use when visiting the page (example: edit).  Since 1.2. 
  • Query String: what query parameters to add to the URL when visiting (example: editor=wiki).  Since 1.2. 
  • Reflex: whether or not to go to the next step when clicking the target element.  Since 1.2. 

You can create any number of steps you want.

Then your tour is enabled. Go to the page on which the tour should be visible:


If you have different steps, you can click on the "next" and "previous" buttons:


You can select which element to show:

Force the display of a tour

The user can close a tour, and then his choice is saved on his browser. However, you can force the display of the tour adding ?startTour=true to the URL of the page.

How to create internationalized tour

First, you need to create a translation page and set the scope to "wiki".

Then, in your step:

  • you can put directly the translation key in the "title" field, it will be rendered.
  • you can use the {{translation key="someKey" /}} macro in the "content" field, like any other macro.

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

Release Notes


The application has been moved to xwiki-platform. The old contrib extension has been moved to the attic.

See XWiki Release Notes for following release notes.



The following translations have been updated with this release:


The following translations have been updated with this release:













If you have created some tours with a prior version of the application, you need to go to the TourCode.Upgrade page first. It will upgrade your existing content to the new format. Otherwise, your tours won't be displayed.

The following translations have been updated: 


Tours created with a prior version of the application do not work with this version. If you are concerned, please upgrade to a more recent version.




Failed attempt to fix a bug.


Failed attempt to fix a bug.


This version is not compatible with the previous one!

The following translations have been updated: 



Dependencies for this extension (org.xwiki.platform:xwiki-platform-tour-ui 16.4.0):

Get Connected