Note: This is for Tiki27 and beyond, non-functional in Tiki25 and Tiki26 because Bootstrap Tour has not yet been ported to Bootstrap 5. For Tiki24 and under, look at PluginTour-Old.

Plugin Tour

Introduced in Tiki15

Use this wiki plugin to build your product tours, page component describers and other sequential information displays in a quick and easy way, using driver.js.


Parameters

Plugin Manager error: tour plugin not found

Examples

Let's see an example of a tour with 4 steps
The first step:

Copy to clipboard
{TOUR(title="Welcome to the tour" element="#PluginTour" start="y" tour_id="1" overlay_color="black")}Here's the start of a tour.{TOUR}


The second step:

Copy to clipboard
{TOUR(title="A typical second step")}This step is neither first nor last on the page, and isn't anchored to an element. It's nothing special.{TOUR}


The third step:

Copy to clipboard
{TOUR(element="#module_1 .panel-heading" title="This is a module heading.")}This is a module.{TOUR}


The last step:

Copy to clipboard
{TOUR(title="The last step")}This is the last step of the tour.{TOUR}

Usage notes 

  • For each step of the tour, input the Tour plugin syntax as shown above.
  • If the tour isn't configured to start on page load (if start="n" is set), a start button can be made with the show_restart_button parameter.
  • Each step will pop over the middle of the page unless the element parameter is set correctly.
  • The position of the popup relative to the element it pops up over can be set with the side parameter.
  • To create a step that is positioned other than where the plugin syntax is input, use the element parameter to specify an HTML id or other unique selector.

Adding a tour to a page that doesn't have wiki text content

Normally, as described above, the tour plugins are written into the wiki text of the page(s) on which the tour displays. However, it is possible to have a tour on an admin page or other such page that doesn't have wiki text.

This method uses a module for the tour plugin text that is assigned to, for example, the pagebottom module zone. Since all the steps of the tour are in the admin page content (and not in the module zone), the element parameter is used for each step that needs to be located in the page. But not all page elements in an admin page have unique DOM selectors, or ones that are easy to identify, so the ability to have a tour with complete tour-step placement may be limited for some pages.

Alias names for this page
Plugin Tour | Plugin Tours | PluginTours | Tour | Tours


Show PHP error messages