Extension talk:GuidedTour

Jump to navigation Jump to search

About this board

There is one archived talk page.

Jakel181 (talkcontribs)

Will this work on other wikis with different skins other than the mediawiki vector skin?

Reply to "Skin Compatibility"

Uncaught Error: Could not show step 'overlay' because this.initialize() failed. Underlying error: missingtitle

Summary by Loman87

The variable declared at the beginning of the code must be an existing page in order to work.

Loman87 (talkcontribs)


I am getting this error. I am testing the extension using the sample tour available in the documentation (here). Any ideas?



Loman87 (talkcontribs)

Hello again,

there was a problem with variable 'Help:Guided tours/guider', that must be an existing page in order to work. Everything is ok now.


How to use a guided tour on a page in the User namespace?

小老虎3018 (talkcontribs)

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


Reply to "How to use a guided tour on a page in the User namespace?"
Noé (talkcontribs)


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?

Mattflaschen-WMF (talkcontribs) (talkcontribs)

Great, thank you!

Noé (talkcontribs)

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

Reply to "GuidedTour for IP"

Link to use with Short URL?

Summary by IlseMul

@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.

IlseMul (talkcontribs)

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


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!

Mattflaschen-WMF (talkcontribs)

Please provide the full URL.

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

IlseMul (talkcontribs)
Mattflaschen-WMF (talkcontribs)
IlseMul (talkcontribs)

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!

Mattflaschen-WMF (talkcontribs)

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.

IlseMul (talkcontribs)

Perfect! Thanks :)

Tour not loading on Special:Preferences

Planetenxin (talkcontribs)

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
Planetenxin (talkcontribs)
$wgAllowUserJs = true;

has no effect.

Mattflaschen-WMF (talkcontribs)

@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.)

Reply to "Tour not loading on Special:Preferences"
BIG RizZ (talkcontribs)

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?

Mattflaschen-WMF (talkcontribs)

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.

Reply to "Performance problem"
Adroit (talkcontribs)

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.

Mattflaschen-WMF (talkcontribs)

Nothing. Good catch, fixed.

Reply to "Redundant bullet points"

How to force a tour show to every new register?

2 (talkcontribs)

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?

Mattflaschen-WMF (talkcontribs)

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.

Reply to "How to force a tour show to every new register?"

troubleshooting install - Nothing happens

Gborgonovo (talkcontribs)

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.

Mattflaschen-WMF (talkcontribs)
Gborgonovo (talkcontribs)

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

Mattflaschen-WMF (talkcontribs)

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

Reply to "troubleshooting install - Nothing happens"