Let users create tour guides for any page

Description

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 don't like this kind of help, she can chose 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:

Access

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. 
  • Bootstrap-tour reflex documentation

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.

Tested on

This extension has been tested with the following configurations.

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

v1.3.1

• TOUR-71 Conflict window is displayed when editing a Tour entry page

v1.3

• TOUR-67 Next steps button doesn't appear anymore on XWiki 11.3 RC 1, only first box shown

v1.2

• TOUR-52 Multipage tours
• TOUR-53 Tours should restart if they finish
• TOUR-54 Provide a template provider for Tour
• TOUR-57 Add the ability to use the 'reflex' option in tour steps
• TOUR-58 Better translation for saving a step
• TOUR-60 Cannot save the "Target Action" and "Query String" from the UI

v1.1

• TOUR-49 The code xproperty for StepClass should be "Text" and not "PureText"
• TOUR-51 Disable Tour on small devices

v1.0.4

• TOUR-47 Impossible to edit the step content with the UI

v1.0.3

• TOUR-46 Upgrade bootstrap-tour to 0.11.0

v1.0.2

• TOUR-31 Steps translations are displayed in tour table
• TOUR-34 Tour application does not work on subwikis
• TOUR-39 Tour should display steps only for visible elements in page
• TOUR-40 Display tour title instead of tour name
• TOUR-41 Mark Tour.WebHome and Tour instances as hidden
• TOUR-42 Modify the Homepage Livetable to display Hidden pages

v1.0.1

• TOUR-32 Tours created with older versions do not work with Tour 1.0

The following translations have been updated: 

• French

v1.0

• TOUR-5 Add the ability to have a tour that change the current page
• TOUR-12 Add a nice UI to easily create Tour and Steps
• TOUR-22 Add a message to explain how the user can restart the tour
• TOUR-29 Add the ability to bind tours to classes

v0.2.4

• TOUR-21 Remove doextra (attachments, history) tabs for the Tour homepage

v0.2.3

• TOUR-18 Cannot install the Tour Application on XE

v0.2.2

Failed attempt to fix a bug.

v0.2.1

Failed attempt to fix a bug.

v0.2

• TOUR-3 Add the ability to add a tour for a page without editing that page
• TOUR-6 Save when the user has already seen the tour
• TOUR-7 bootstrap-tour dependency should not be bundled in a page
• TOUR-8 List all tours in the application page
• TOUR-9 Allow the user to dismiss a tour
• TOUR-13 Create integration tests for the Tour Application
• TOUR-14 Add the ability to use the 'backdrop' option in tour steps
• TOUR-15 The application is not translated
• TOUR-16 Add the ability to create internationalized tours
• TOUR-17 Add the ability to use XWiki syntax and macros in tour steps

The following translations have been updated: 

• French

v0.1

• TOUR-1 Create Tour Application

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-tour-ui 1.3.2):

• org.webjars:bootstrap-tour 0.12.0
• org.xwiki.platform:xwiki-platform-appwithinminutes-ui 6.4.1
• org.xwiki.platform:xwiki-platform-security-script 6.4.1