History: PluginTour

• «
• »

            Note: This is for ((Tiki27)) and beyond, non-functional in ((Tiki25)) and ((Tiki26)) because [https://github.com/sorich87/bootstrap-tour/issues/774|Bootstrap Tour has not yet been ported to Bootstrap 5]. For ((Tiki24)) and under, look at ((PluginTour-Old)).

! Plugin Tour
''Introduced in ((Tiki15))''

{DIV(class="lead")}Use this ((wiki plugin)) to build your product tours, page component describers and other sequential information displays in a quick and easy way, using [https://driverjs.com/|driver.js].{DIV}{TOUR(title="Welcome to the tour" placement="bottom")}A tour created with PluginTour is being demonstrated on this page. Please check the source view of the page for details, along with the general documentation. {TOUR} 

{TOUR(element="#module_25 .panel-heading" title="This is a module" side="top")}Page elements outside of the wikitext can be anchors for tour steps. Just use a unique identifier (id or class).{TOUR}
!! Parameters {TOUR(side="top")}Use the appropriate parameters to create the tour steps/stops as you like.{TOUR}
{pluginmanager plugin="tour"}
{TOUR(orphan="y" title="I'm an orphan" backdrop="y")}I'm not connected to any page element.{TOUR}

!! Examples
Let's see an example of a tour with 4 steps
The first step:
{CODE()} {TOUR(title="Welcome to the tour" element="#PluginTour" start="y" tour_id="1" overlay_color="black")}Here's the start of a tour.{TOUR} {CODE}

The second step:
{CODE()}{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} {CODE}

The third step:
{CODE()}{TOUR(element="#module_1 .panel-heading" title="This is a module heading.")}This is a module.{TOUR}{CODE}

The last step:
{CODE()}{TOUR(title="The last step")}This is the last step of the tour.{TOUR} {CODE}

!! Usage notes {TOUR(Some tips about using the plugin)}This plugin has been tested in Tiki 27.{TOUR}
* 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
(alias(Plugin Tour)) | (alias(Plugin Tours)) | (alias(PluginTours)) | (alias(Tour)) | (alias(Tours))