Extension talk:GuidedTour

There is one archived talk page.

Previous page history was archived for backup purposes at Extension talk:GuidedTour/LQT Archive 1 on 2015-07-10.

Is it possible to write a guided tour on "User:xxx" page and use it with any possible ways for personal use?

Thanks.

Hello,

I know GuidedTour by French Wikipedia's Tutoriels and I am building some for French Wiktionary. A question arised: are the tours accessible for IP?

Yes. Just log out and visit https://en.wikipedia.org/wiki/Earth?tour=test .

Great, thank you!

Ahah, you told me to log out, so I did. It works perfectly fine. Thanks!

@Mattflaschen-WMFhelped me fix the issue. I just needed to create this page and give it some text: http://wiki.neverendingrealms.com/index.php?title=Help:Guided_tours/guider

That solved my problem.

On my wiki I have Short URL (Manual:Short URL) implemented, which makes my wiki something like:

wiki/Main_Page

How do I go to the test link (and future other links) from here? At the moment nothing happens when I use, i.e. wiki/Special:AllPages?tour=test

Thanks for the help!

Please provide the full URL.

https://en.wikipedia.org/wiki/Special:AllPages?tour=test works fine.

Hi,

The full link is:

http://wiki.neverendingrealms.com/index.php?title=Main_Page&tour=test

Thanks for the help in advance!

It doesn't seem related to short URLs. I think it is a specific issue with your version of GuidedTour and the test tour.

You can either:

• Create http://wiki.neverendingrealms.com/index.php?title=Help:Guided_tours/guider (workaround; easiest)
• Upgrade MW and all extensions to 1.29 (or a version of the extension compatible with 1.29)
• Wait for https://gerrit.wikimedia.org/r/#/c/357443/ to get merged then upgrade your GuidedTour to latest 1.28.

Ah, thanks for looking into this! I assume MW 1.29 is in beta at the moment?

What would I put into that page that I would create?

From that merger page: test tries to exercise all the main features, including the ability to get the content of a tour step from a page. However, not all wikis have this feature set up. Rather than needing to do a maintenance script to populate this and have wikis maintain it, we can just skip this step if it's not present.

How would I go about setting up this feature? Re-install and set a specific setting I may have skipped/not seen?

Thanks again for all your help!

You're right. I thought 1.29 had been released, but it's actually expected to be released this month.

You can put anything on the http://wiki.neverendingrealms.com/index.php?title=Help:Guided_tours/guider page. E.g. feel free to use "Guided tours allow you to walk users through the wiki, or part of the user interface." It will appear on the tour.

That's enough to fix it.

Perfect! Thanks :)

We try to create a tour that explains important places in the Preferences.

We are unable to start the tour on Special:Preferences?tour=ourtour. No log entry, no JS errors. On all other Special pages, the tour can be started without any issues. Any idea?

• MW 1.27.x
• GuidedTour 2.0 (d2aebbb) 01:36, 5 May 2016
• EventLogging 0.9.0 (0aedc0f) 22:50, 11 April 2017
• all other extensions disabled

$wgAllowUserJs = true;

has no effect.

@Planetenxin: This is by design. User scripts (including gadgets, JS in MediaWiki namespace, etc.) are not allowed to run on Special:Preferences for security reasons.

(It sounds like you are using an on-wiki script (defined on a wiki page). If you are using an extension, that also will not work, but that part could potentially be revisited.)

Hi, it seems that the activation of the extension:GuidedTour (with the dependency) impacts the performance of our wiki installation extremely.

Some times it runs like a charm and sometimes it slows down the entire Wiki.

After some minutes not using the Wiki it takes around 1 minute to load any wiki page (not a guided tour) and afterwards everything is fast hence our suspicion that it has to do with a TTL (time to life) limitation.

Did you experience a similar behavior?

That's curious. I have not seen that behavior. Could be caching-related, but even with the GuidedTour library, it shouldn't be a minute.

what is the difference between the bullet points:

If a guider is not visible (i.e. above the fold) for a user, the browser will scroll the user to the location of the guider.--and--The page will scroll vertically to a guider's position, if it is out of view (i.e. above or below the fold). You can disable this for individual steps.

Nothing. Good catch, fixed.

Really confused by " mw.guidedTour.setTourCookie( tourName )". Is this a piece of JS code? What exactly the tourName mean here?

For example, The guided tour name for FIRSTEDIT is MediaWiki:Guidedtour-tour-firsteditjs. However, the "name" in the example codes are myfirstedit. which one should I use?

Yes, it's JavaScript.

With the built-in firstedit tour, the name (tourName) is 'firstedit'. 'myfirstedit' is meant to be a starting point to help a JavaScript developer write a new tour.

If 'firstedit' meets your needs already, you can just use it.

Hi, I like this extensiona lot, but it seems I really cannot see it at work. I'm running a fresh installation on MediaWiki 1.23.3, PHP 5.3.10, MySQL 5.5.38. Guided tour and EventLogging are at their very last version cloned from git. When I call the tour simply nothing happens, no message is shown, neither with debug options (error_reporting, dislay_errors) activated.

I don't where to go for further investigation. Thank you for your help.

What URL are you using? Did you try http://localhost/w/index.php?tour=test (or your wiki's equivalent URL)?

Thank you for your reply. I have not tried the extension a any more, but yes, the link was that.

Another thing you could check for is JavaScript errors in the browser console.

Hi installed both EventLogging and GuidedTour, and get this error message after activating GuidedTour. Can you help me, please?

Detected bug in an extension! Hook CanonicalNamespaces closure failed to return a value; should return true to continue hook processing or false to abort.

Backtrace:

#0 /var/www/[myfolder]/includes/GlobalFunctions.php(3883): Hooks::run('CanonicalNamesp...', Array)
#1 /var/www/[myfolder]/includes/Namespace.php(226): wfRunHooks('CanonicalNamesp...', Array)
#2 /var/www/[myfolder]/includes/Namespace.php(257): MWNamespace::getCanonicalNamespaces()
#3 /var/www/[myfolder]/languages/Language.php(705): MWNamespace::getCanonicalIndex('template')
#4 /var/www/[myfolder]/includes/Title.php(3136): Language->getNsIndex('Template')
#5 /var/www/[myfolder]/includes/Title.php(152): Title->secureAndSplit()
#6 /var/www/[myfolder]/extensions/DynamicPageList/DPLSetup.php(1232): Title::newFromText('Template:Extens...')
#7 /var/www/[myfolder]/extensions/DynamicPageList/DPLSetup.php(1211): ExtDynamicPageList::commonSetup()
#8 [internal function]: ExtDynamicPageList::setupDPL()
#9 /var/www/[myfolder]/includes/Setup.php(551): call_user_func(Array)
#10 /var/www/[myfolder]/includes/WebStart.php(161): require_once('/var/www/...')
#11 /var/www/[myfolder]/index.php(55): require('/var/www/...')
#12 {main}

If I deactivate the DynamicPageList extension I get the following error

Detected bug in an extension! Hook CanonicalNamespaces closure failed to return a value; should return true to continue hook processing or false to abort.

Backtrace:

#0 /var/www/[myfolder]/includes/GlobalFunctions.php(3883): Hooks::run('CanonicalNamesp...', Array)
#1 /var/www/[myfolder]/includes/Namespace.php(226): wfRunHooks('CanonicalNamesp...', Array)
#2 /var/www/[myfolder]/languages/Language.php(493): MWNamespace::getCanonicalNamespaces()
#3 /var/www/[myfolder]/includes/search/SearchEngine.php(349): Language->getNamespaces()
#4 /var/www/[myfolder]/includes/User.php(1241): SearchEngine::searchableNamespaces()
#5 /var/www/[myfolder]/includes/User.php(4334): User::getDefaultOptions()
#6 /var/www/[myfolder]/includes/User.php(348): User->loadOptions()
#7 /var/www/[myfolder]/includes/User.php(328): User->saveToCache()
#8 /var/www/[myfolder]/includes/User.php(286): User->loadFromId()
#9 /var/www/[myfolder]/includes/User.php(2073): User->load()
#10 /var/www/[myfolder]/includes/User.php(981): User->getToken(false)
#11 /var/www/[myfolder]/includes/User.php(289): User->loadFromSession()
#12 /var/www/[myfolder]/includes/User.php(4328): User->load()
#13 /var/www/[myfolder]/includes/User.php(2227): User->loadOptions()
#14 /var/www/[myfolder]/includes/context/RequestContext.php(296): User->getOption('language')
#15 /var/www/[myfolder]/includes/Message.php(360): RequestContext->getLanguage()
#16 /var/www/[myfolder]/includes/context/RequestContext.php(377): Message->setContext(Object(RequestContext))
#17 [internal function]: RequestContext->msg('pagetitle')
#18 /var/www/[myfolder]/includes/context/ContextSource.php(165): call_user_func_array(Array, Array)
#19 /var/www/[myfolder]/includes/OutputPage.php(878): ContextSource->msg('pagetitle')
#20 /var/www/[myfolder]/includes/Article.php(554): OutputPage->setPageTitle('Main Page')
#21 /var/www/[myfolder]/includes/actions/ViewAction.php(44): Article->view()
#22 /var/www/[myfolder]/includes/Wiki.php(439): ViewAction->show()
#23 /var/www/[myfolder]/includes/Wiki.php(305): MediaWiki->performAction(Object(Article), Object(Title))
#24 /var/www/[myfolder]/includes/Wiki.php(565): MediaWiki->performRequest()
#25 /var/www/[myfolder]/includes/Wiki.php(458): MediaWiki->main()
#26 /var/www/[myfolder]/index.php(59): MediaWiki->run()
#27 {main}

I hope you can help me, I love this extension! Thank you.

I don't know if it can be useful, but I have some custom namespaces: 100, 101, 110, 111, 500, 501, 510, 511. And subpages activated.

I have the same problem with GuidedTour extension disabled, so maybe it is a problem with EventLogging extension. See my question there. Thank you.

Thanks for trying GuidedTour. This issue is not with GuidedTour. Rather, there is an incompatibility between your version of core and the version of EventLogging. See my reply on the EventLogging talk page.

This post was posted by Mattflaschen, but signed as Superm401.

Hi installed both EventLogging and GuidedTour, and get this error message after activating GuidedTour. Help is much appreciated.

MediaWiki internal error.

Original exception: exception 'MWException' with message 'Detected bug in an extension! Hook GuidedTourHooks::onResourceLoaderRegisterModules failed to return a value; should return true to continue hook processing or false to abort.' in /home1/[my website path]/includes/Hooks.php:284
Stack trace:
#0 /home1/[my website path]/includes/GlobalFunctions.php(3883): Hooks::run('ResourceLoaderR...', Array)
#1 /home1/[my website path]/includes/resourceloader/ResourceLoader.php(206): wfRunHooks('ResourceLoaderR...', Array)
#2 /home1/[my website path]/includes/OutputPage.php(2565): ResourceLoader->__construct()
#3 /home1/[my website path]/includes/OutputPage.php(448): OutputPage->getResourceLoader()
#4 /home1/[my website path]/includes/OutputPage.php(473): OutputPage->filterModules(Array, 'bottom')
#5 /home1/[my website path]/includes/OutputPage.php(545): OutputPage->getModules(true, 'bottom', 'mModuleMessages')
#6 /home1/[my website path]/includes/OutputPage.php(2818): OutputPage->getModuleMessages(true, 'bottom')
#7 /home1/[my website path]/includes/OutputPage.php(2931): OutputPage->getScriptsForBottomQueue(false)
#8 /home1/[my website path]/includes/Skin.php(583): OutputPage->getBottomScripts()
#9 /home1/[my website path]/includes/SkinTemplate.php(390): Skin->bottomScripts()
#10 /home1/[my website path]/includes/OutputPage.php(2034): SkinTemplate->outputPage()
#11 /home1/[my website path]/includes/Wiki.php(572): OutputPage->output()
#12 /home1/[my website path]/includes/Wiki.php(458): MediaWiki->main()
#13 /home1/[my website path]/index.php(59): MediaWiki->run()
#14 {main}

Exception caught inside exception handler: exception 'MWException' with message 'Detected bug in an extension! Hook GuidedTourHooks::onResourceLoaderRegisterModules failed to return a value; should return true to continue hook processing or false to abort.' in /home1/[my website path]/includes/Hooks.php:284
Stack trace:
#0 /home1/[my website path]/includes/GlobalFunctions.php(3883): Hooks::run('ResourceLoaderR...', Array)
#1 /home1/[my website path]/includes/resourceloader/ResourceLoader.php(206): wfRunHooks('ResourceLoaderR...', Array)
#2 /home1/[my website path]/includes/OutputPage.php(2565): ResourceLoader->__construct()
#3 /home1/[my website path]/includes/OutputPage.php(448): OutputPage->getResourceLoader()
#4 /home1/[my website path]/includes/OutputPage.php(473): OutputPage->filterModules(Array, 'bottom')
#5 /home1/[my website path]/includes/OutputPage.php(545): OutputPage->getModules(true, 'bottom', 'mModuleMessages')
#6 /home1/[my website path]/includes/OutputPage.php(2818): OutputPage->getModuleMessages(true, 'bottom')
#7 /home1/[my website path]/includes/OutputPage.php(2931): OutputPage->getScriptsForBottomQueue(false)
#8 /home1/[my website path]/includes/Skin.php(583): OutputPage->getBottomScripts()
#9 /home1/[my website path]/includes/SkinTemplate.php(390): Skin->bottomScripts()
#10 /home1/[my website path]/includes/OutputPage.php(2034): SkinTemplate->outputPage()
#11 /home1/[my website path]/includes/Exception.php(227): OutputPage->output()
#12 /home1/[my website path]/includes/Exception.php(272): MWException->reportHTML()
#13 /home1/[my website path]/includes/Exception.php(643): MWException->report()
#14 /home1/[my website path]/includes/Exception.php(713): MWExceptionHandler::report(Object(MWException))
#15 /home1/[my website path]/includes/Wiki.php(461): MWExceptionHandler::handle(Object(MWException))
#16 /home1/[my website path]/index.php(59): MediaWiki->run()
#17 {main}

This post was posted by Vitruvian95, but signed as Felipe95a.

Thanks for the report. Core changed a few months ago so that a return true was no longer required here. However, I'm glad to add it so it isn't an obstacle to supporting older versions of MediaWiki core. This is fixed in latest master, so you can just pull to update.

This post was posted by Mattflaschen, but signed as Superm401.