javascript only tour script based on jquery
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css
scripts
README
index.html
tour.json

README

Tour Script v1

Files:
index.html			Demo Page
css/site.css		Demo Site css

css/tour.css		Tourscript css (needed)
scripts/tour.js	Tourscript
tour.json				demo tour

scripts/jqueryui jqueryui, only for highlight effect


	Usage:
	create a .json file in the following format:
	[
		{
			"element" 	: "#divtoshow",
			"label"			: "description",
			"options" 	: "interactive",
			"highlight"	: ".inner"
		},
		{
			"element" 	: "#divtoshow",
			"label"			: "description",
			"options" 	: "interactive",
			"highlight"	: ".inner"
		},
	]

	Each hash is one item in the tour.
	- "element" is the box who should be higlighted. This can be any valid jquery selector (must be unique, or the first one will be chosen)
	- "label" is the description displayed underneath or above the highlighted element. It can contain html elements.
	- "options": Just write an option as text in this part to activate. The following options are currently available:
	- - interactive : when using this option, the user will be able to click something in the highlighted element. Any form submit or link click will continue to the next part of the tour
	- - lastItem : this option should be used for the last element of the tour. This will replace the 'continue tour' link with a 'end tour' link, closing the tour.
	- "highlight" is a highlight option for an element in the chosen element. The element will pulsate so the user can see what the description is currently talking about.


	Start Tour:
	start the tour by activating
	startTour("path/to/json/file/or/input");

	Navigation Elements:
	Use the following css classes for navigation bar:
	<a href="#" class='lastTourItem'>last item</a>
	<a href="#" class='nextTourItem'>next item</a>
	<a href="#" class="closeTour">end tour</a>

License

	Copyright (c) 2011, Thomas Diehl, DIEVOLUTION web development
	web: www.dievolution.com | twitter: @dievo

	released under the MIT License, http://www.opensource.org/licenses/mit-license.php

	Permission is hereby granted, free of charge, to any person obtaining a copy
	of this software and associated documentation files (the "Software"), to deal
	in the Software without restriction, including without limitation the rights
	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	copies of the Software, and to permit persons to whom the Software is
	furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in
	all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	THE SOFTWARE.