Skip to content
Github mirror of MediaWiki extension GuidedTour - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing)
Branch: master
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.
.jsduck
.phan
i18n
includes
modules
tests
.eslintrc.json
.gitignore
.gitreview
.mailmap
.phpcs.xml
.stylelintrc.json
APACHE-2.0-LICENSE.txt
AUTHORS
CODE_OF_CONDUCT.md
COPYING
Gruntfile.js
GuidedTour.php
MIT-LICENSE.txt
README
composer.json
extension.json
jsduck.json
package-lock.json
package.json

README

This is GuidedTour ( https://www.mediawiki.org/wiki/Extension:GuidedTour ), a
MediaWiki extension that allows the creation of guided tours.

It supports both extension-defined tours (with localization) and tours defined by editing
the MediaWiki namespace.

To use:
* Install the EventLogging extension, which is a dependency.
* Put the extension files in your extension directory
* Add the following line to your LocalSettings.php
require_once "$IP/extensions/GuidedTour/GuidedTour.php";
* Test that it worked by calling a page with tour=test appended to the URL. For
example http://MyServer/w/index.php?tour=test

'test' is a tour defined by the GuidedTour extension.
* Write an on-wiki tour on a page in the MediaWiki namespace.  Perhaps called
MediaWiki:Guidedtour-tour-mytour.js

Use this naming convention regardless of name. 'mytour' is the name of this
local tour.
* Call your intended page with tour=mytour appended to the URL. For example
http://MyServer/w/index.php?tour=mytour
* The name of the tour is the parameter you call it with.
In the examples above, that's 'test' and 'mytour'

License

This is free software.

For the main GuidedTour code and Guiders.js:

You may use, modify and distribute it under the terms of
the Apache License 2.0.

The mediawiki.libs.guiders directory is based on Guiders.js, developed by Optimizely
and Jeff Pickhardt.
See https://github.com/pickhardt/Guiders-JS

Further enhancements to Guiders.js were developed by the GuidedTour team.  Earlier
work is at https://phabricator.wikimedia.org/diffusion/EGTG/history/

but that repository is no longer used.

For the .docs dir, the MIT license applies:

Copyright (c) 2011-2013 VisualEditor Team, E3 team and others under the terms
of The MIT License.
You can’t perform that action at this time.