History: PluginTour
Preview of version: 25 (current)
- «
- »
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
Parameters
Quick and easy way to build your product tours with Driver.jsIntroduced 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 | |||
title |
text | Title of the step | 15.0 | |
element |
text | Element to show the popup on; if empty, use the plugin location itself | 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. (Set 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 only show the tour once. (Set only in the first step.) | 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
The first step:
{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:
{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:
{TOUR(element="#module_1 .panel-heading" title="This is a module heading.")}This is a module.{TOUR}
The last step:
{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_buttonparameter. - Each step will pop over the middle of the page unless the
elementparameter is set correctly. - The position of the popup relative to the element it pops up over can be set with the
sideparameter. - To create a step that is positioned other than where the plugin syntax is input, use the
elementparameter 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