History: PluginTour

• «
• »

            ! 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 with Bootstrap popovers in a quick and easy way, using [http://bootstraptour.com/|Bootstrap Tour].{DIV}{TOUR(title="Welcome to the tour" prev="-1" placement="bottom")}Here's what this code produces. This step's 'prev="-1"' parameter causes it to display first.{TOUR} 

{maketoc levels="2,3"}
{TOUR(element="#module_25 .panel-heading" title="This is a module" placement="top")}Page elements outside of the wikitext can be anchors for tour steps. Just use a unique identifier (id or class).{TOUR}
!! Parameters {TOUR(placement="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
The first step:
{CODE()} {TOUR(title="Welcome to the tour" prev="-1" element="#PluginTour")}Here's the start of a tour.{TOUR} {CODE}

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

A step that specifies a page element:
{CODE()}{TOUR(element="#module_1 .panel-heading" title="This is a module heading.")}This is a module.{TOUR}{CODE}

A step that indicates that the following step is on another page:{TOUR()}This is the last visible step in this page. The next step is on another page.{TOUR}
{CODE()}{TOUR(path="PluginTour-page-2")}This plugin has a title and body content, but these won't be displayed - this step is simply a redirect to the target page.{TOUR}{CODE}{TOUR(path="PluginTour-page-2")}This plugin has a title and body content, but these won't be displayed - this step is simply a redirect to the target page.{TOUR}

The last step:
{CODE()}{TOUR(next="-1")}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 15, 16, 17, and the upcoming 18.{TOUR}
* For each step of the tour, input the Tour plugin syntax as shown above. 
* The first and last steps need a -+prev="-1"+- and -+next="-1"+- parameter, respectively.
* 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 page element where the plugin syntax is input in the wiki page, etc. 
* The position of the popup relative to the element it pops up over can be set with the ''placement'' 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.
* Use the -+path+- parameter to indicate that the next step is on another page. Simply using a wiki page name is OK.
* A tour plugin step that uses the -+path+- parameter doesn't itself display (it is not visible); it simply acts as a redirect, so it shouldn't be used to contain information. Any guidance to the user that the tour is continuing on another page should be inserted in the ''previous'' plugin step (as of May 2017). 
* At this time, the "prev" button on the first step of the tour's second page is ghosted and doesn't work to return to the first page.

Alias names for this page
(alias(Plugin Tour)) | (alias(Plugin Tours)) | (alias(PluginTours)) | (alias(Tour)) | (alias(Tours))