Github mirror of MediaWiki extension GuidedTour - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing)
Go to file
jenkins-bot 174d76d9f2 Merge "gt.DefineTour: Fix back button, return builder" 2024-05-18 21:56:58 +00:00
.jsduck Use async API calls for wikitext parsing 2016-08-04 21:49:33 -04:00
.phan Add phan 2019-04-24 20:34:28 +02:00
i18n Localisation updates from https://translatewiki.net. 2024-03-28 08:32:01 +01:00
includes Use namespaced OutputPage class 2024-01-06 17:55:52 +01:00
modules gt.DefineTour: Fix back button, return builder 2024-05-13 22:17:26 -04:00
tests gt.DefineTour: Fix back button, return builder 2024-05-13 22:17:26 -04:00
.eslintignore Update ESLint config, allow ES6 2024-05-13 15:50:22 +01:00
.eslintrc.json Update ESLint config, allow ES6 2024-05-13 15:50:22 +01:00
.gitignore build: Updating lodash to 4.17.15 2019-08-02 06:02:03 +00:00
.gitreview Whoops, track not trace 2016-10-24 17:02:41 -07:00
.mailmap Update Legoktm's email address 2021-04-11 19:08:30 -07:00
.phpcs.xml build: Updating dependencies 2021-01-29 16:07:14 +00:00
.stylelintrc.json build: Update dependencies and fix 2018-02-14 18:28:29 +00:00
.svgo.config.js Update ESLint config, allow ES6 2024-05-13 15:50:22 +01:00
APACHE-2.0-LICENSE.txt Cleanup jsduck documentation and commenting: 2013-06-13 18:02:59 +00:00
AUTHORS Update Legoktm's email address 2021-04-11 19:08:30 -07:00
CODE_OF_CONDUCT.md build: Updating mediawiki/phan-taint-check-plugin to 1.3.0 2018-08-19 13:28:52 +00:00
COPYING Add COPYING file so license link on Special:Version works 2016-03-30 19:23:01 -04:00
Gruntfile.js Update ESLint config, allow ES6 2024-05-13 15:50:22 +01:00
MIT-LICENSE.txt Cleanup jsduck documentation and commenting: 2013-06-13 18:02:59 +00:00
README Remove instrumentation 2022-06-22 12:59:58 +01:00
composer.json build: Updating composer dependencies 2024-05-05 19:18:43 +00:00
extension.json Removes deprecated mediawiki.ui.button in favor of Codex 2024-02-28 22:22:34 +00:00
jsduck.json build: Updating dependencies 2021-01-29 16:07:14 +00:00
package-lock.json build: Updating grunt-banana-checker to 0.13.0 2024-05-18 12:06:18 +00:00
package.json build: Updating grunt-banana-checker to 0.13.0 2024-05-18 12:06:18 +00:00

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:
* Put the extension files in your extension directory
* Add the following line to your LocalSettings.php
wfLoadExtension( 'GuidedTour' );
* 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.