Loading...
 
Skip to main content
Provide a step-by-step interactive tour

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. (Code added via https://gitlab.com/tikiwiki/tiki/-/merge_requests/4232)

Parameters

Quick and easy way to build your product tours with Driver.js
Introduced in Tiki 15. Required parameters are in bold.
Go to the source code
Preferences required: wikiplugin_tour

Parameters Accepted Values Description Default Since
(body of plugin) Content of the step
element text Element to show the popup on. It should be a valid CSS selector. 15.0
title text Title of the step 15.0
next_button_text text Text to show on the Next button. (Set only in the first step.) Next 27.0
number_of_steps int Number of steps in the tour. (Required only in the first step.) 27.0
overlay_color text Set an overlay color to be shown behind the popover and its element, highlighting the current step. (Set only in the first step.) transparent 27.0
overlay_opacity int Set the opacity of the overlay. (Set only in the first step.) 0.5 27.0
prev_button_text text Text to show on the Prev button. (Set only in the first step.) Previous 27.0
progress_text text Template for the progress text. You can use the following placeholders in the template: // - : The current step number. // - : Total number of steps. Example: Step of . (Set only in the first step.) of 27.0
show_restart_button text Display a button to restart the tour. Enter the text to appear on the button. (Set only in the first step.) 15.0
tour_id text Set a tour ID to be able to show the tour only once or use many steps. (This value should be identical for all steps of the same tour.) default 15.0
align end
start
center
The alignment of the popup. (Set only in the first step.) end 15.0
animate y
n
Animate the popup. (Set only in the first step.) y 27.0
show_once (blank)
y
n
Show automatically only once. tour_id should also be set if there are multiple tours. (Set only in the first step.) n 15.0
show_progress y
n
Show the progress text in popover. (Set only in the first step.) n 27.0
side right
top
bottom
left
The side of the popup. (Set only in the first step.) right 15.0
start y
n
Start the tour on page load? If "No", then a start button can be made with "Restart Button", below. (Set only in the first step.) y 15.0
allow_close y
n
Allow closing the popover by clicking on the backdrop. (Set only in the first step.) y 16.0

Examples

Let's see an example of a tour with 4 steps.

As a preliminary step, we ensure that we have various HTML elements that will be the subject of our tour:

Copy to clipboard
{DIV(id="PluginTour")}Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.{DIV} {DIV(id="PluginTourStep2")}Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.{DIV} {DIV(id="PluginTourStep3")}It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).{DIV} {DIV(id="PluginTourStep4")}IThere are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.{DIV}

The first step:

Copy to clipboard
{TOUR(title="What is Lorem Ipsum?" element="#PluginTour" start="y" tour_id="myTour" overlay_color="black" number_of_steps="4")}Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.{TOUR}

The second step:

Copy to clipboard
{TOUR(title="Where does it come from?" element="#PluginTourStep2" tour_id="myTour")}Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old.{TOUR}

The third step:

Copy to clipboard
{TOUR(element="#PluginTourStep3" title="Why do we use it?" tour_id="myTour")}It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. {TOUR}

The last step:

Copy to clipboard
{TOUR(element="#PluginTourStep4" title="Where can I get some?" tour_id="myTour")}There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable.{TOUR}

See the demo.

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.
  • The position of the popup relative to the element it pops up over can be set with the side parameter.
  • Use the element parameter to specify an HTML selector of the element that the step will be positioned over.

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

Collapse/expand modules below