For the last few months I’ve been working on a new plugin for TiddlyWiki that presents interactive step-by-step tours. It includes a basic “Introduction to TiddlyWiki” tour that will be available at tiddlywiki.com, but also supports user defined tours that people can use to help visitors to their own wikis.
Like the recently introduced Geospatial Plugin, this work was undertaken as part of my commercial activity for clients of Federatial. In this case, the client is Anna Freud, a UK-based charity that works to improve the mental health of children and young people. We plan to deploy a custom version of the tour to help newcomers to their mental health manuals (for example, see the AMBIT manual).
The edition for submitting documentation changes also uses the Tour plugin, albeit a modified version that adds some extra features like support for multiple tours and optionally skipping steps depending on a filter. When time permits I will tidy up and submit those changes to this prospective core plugin.
One the features I would like to introduce is the ability to highlight a single DOM element and positioning the tour window next to it. An example of this can be found in the driver.js library:
If themes can be used with the Tour plugin, then we can create presentations like powerpoint!
I mean a tour can have a setting to use its own theme (including font/font-size/colors/background colors).
Very small comments:
(1) At least once the first phase is finished, it might be ideal if finishing one goal automatically brings the next into view, rather than having to hit “next” each time.
(2) The tourist is invited to search for “help”. But there are not any search results for help. That is slightly awkward.
The basic set of tools here is beautiful. I’m looking forward to developing a version for my teaching projects. (Most of these are read-only, with no access to things like control panel, but I still want to show people how tags work, how to search, etc.)
With regard to the tour itself, I second Springer’s comment about the search for help. An intro to search should display at least a few search results. Maybe a search for Neptune instead.
Hi @stefan_from_germany I think the reference documentation within the plugin is up to date and complete. We could certainly do with some more introductory documentation, and I would welcome contributions.
I’m sure there’s an opportunity for lots of improvements, but some of the things that would be good to have include:
Expand the plugin “readme” tab to give a general outline of how the tours are defined
Expand the plugin “docs” tab with an introduction and some examples
Another example tour. I had hoped to include one on tags. It’s a good topic because it starts fairly simply but it will be a challenge to explain the way that the ordering of tiddlers with a tag is done
But as I say, any improvements would be most welcome.
which is a nice effect).
Confetti!