Similar to links in the app to doc.tiki.org, plugin helper (added in Tiki3) and module helper (in Tiki7), we need various helpers. In upcoming versions, we will add more.
Update: After evaluating the different scripts below, we decided on Bootstrap Tour. The license was changed to MIT and the library was added to Tiki trunk, to be Tiki 15. There's a doc page at https://doc.tiki.org/PluginTour with preliminary information so far.
Help popups / On-page guidance / site tour
When in help mode, Tiki should have help popup
- For internal Tiki features
- For sites/apps made with Tiki, like CartoGraf
- http://ninodezign.com/25-free-jquery-plugins-for-doing-guided-tours-through-a-website/
- https://github.com/search?o=desc&q=tour&s=stars&type=Repositories&utf8=%E2%9C%93
- http://dailyjs.com/2012/11/02/on-screen-guidance-intro/
- http://www.jquery4u.com/plugins/web-tour-instructional-plugins/
- http://www.webresourcesdepot.com/11-awesome-jquery-site-tour-plugins-for-guiding-users-with-style/
- https://www.designernews.co/stories/15273-a-list-of-product-tour-plugins-for-onboarding
- The selected library should work well enough in mobile mode
This is a nice example:
1.1.1. Joyride
http://www.zurb.com/playground/jquery-joyride-feature-tour-plugin
License: MIT
1.1.2. Intro.JS
Intro.js A better way for new feature introduction and step-by-step users guide for your website and project.
License: MIT
1.1.3. Bootstrap Tour
http://bootstraptour.com/
License: Apache 2 (Not compatible) but moving to MIT
Lots of features, including multi-page
1.1.4. trip.js
SheperdJS
https://shepherdjs.dev/
"In Drupal 9.2, Joyride was deprecated in favor of Shepherd"
Source: https://www.drupal.org/docs/8/core/modules/tour/overview
Driver.js
https://github.com/kamranahmedse/driver.js
| Page tour library | URL | License | Mobile performance | Selectors* | Multipage | |
| Intro.js | http://usablica.github.io/intro.js/ | MIT | Not good | |||
| Pageguide.js | https://github.com/tracelytics/pageguide | MIT | Not good | Special classes needed in page. | No | |
| Tourist | http://easelinc.github.io/tourist/ | MIT | IDs or classes | No | ||
| Bootstrap Tour | http://bootstraptour.com/ | Apache 2.0 | Good | IDs | yes (also multi subdomains) | |
| Trip.js | http://eragonj.github.io/Trip.js/ | MIT | Good, depending on e/w modals | Any unique | No | |
| Joyride | http://www.zurb.com/playground/jquery-joyride-feature-tour-plugin | MIT | Good | Any unique | No | |
| Tourbus | http://ryanfunduk.com/jquery-tourbus | MIT | Demo page isn't responsive (to sm size) | Any unique | No | |
| Hemi | https://github.com/heminei/jquery-hemi-intro Demo: http://heminei.github.io/jquery-hemi-intro/demo/ | MIT | Good except side modals in xs screens. | Any unique selector | No | |
| Driver.js | https://github.com/kamranahmedse/driver.js Demo: https://driverjs.com/ | MIT | Good | IDs or classes | No | |
Notes: *Selectors are the page elements that are the "tour stops". If they can be any element (id or unique class) then the tour can run on Tiki pages with no special markup, such as admin pages, etc. **Factoid is a package of website help components.
Regarding mobile performance, the scripts that are responsive all show the tour step popups clearly if the popups are positioned above or below their target elements, but if they pop up to the left or right, then some horizontal scrolling may be needed to see/access them on small screens, depending on the location of the target element on the screen.
See also: https://js.libhunt.com/libs/tours-and-guides
1.2. Query builder
Project to integrate a nifty tool to query data in Trackers or in the Spreadsheet. See: Tracker Query
1.2.1. Chart editor
And create some charts from this info, like this one
1.3. Function helper
Point & click to using functions in the Spreadsheet
1.4. Mathematical equations helper
1.5. Theme designer CSS helper
auto-complete, drop-downs, etc.
Autocompletion is available from CodeMirror 2.x!
1.6. File and Image helper
- http://elfinder.org/
- elFinder is an open-source file manager for web, written in JavaScript using jQuery UI.
- License: BSD
- Permits many features, including image cropping
- elFinder is an open-source file manager for web, written in JavaScript using jQuery UI.
- kfm
- http://www.phpletter.com/Demo/Tinymce-Ajax-File-Manager/
- draw
- http://navphp.sourceforge.net/
1.7. Others
1.8. Wishlist
Open
Pending
| Rating | Subject | Submitted by | Importance | Easy to solve? | Priority | Category | Volunteered to solve | Created | LastModif | Comments | |
|---|---|---|---|---|---|---|---|---|---|---|---|
| (0) | wiki help - plugin list sorting | gezza | 5 | 25 |
| Jonny Bradley | 2008-12-18 | 2013-06-05 | 0 | ||
| (0) | Trackers:: field type helper | Marc Laporte | 8 | 40 |
| Marc Laporte | 2008-10-29 | 2008-10-29 | 0 | ||
| (0) | SearchHelp popup window - text format error | EdizonTN | 1 low | 5 | 5 |
| 2021-10-29 | 2022-03-16 | 2 ibmussa-07 Oct 22 | ||
| (0) | Add "help popup" for all lines/fields/configurable items when using Admin to set up your modules. | Dumarest | 7 | 35 |
| 2008-02-20 | 2008-02-20 | 1 marclaporte-15 Jan 10 |
Closed
| Rating | Subject | Submitted by | Importance | Easy to solve? | Priority | Category | Volunteered to solve | Created | LastModif | Comments | |
|---|---|---|---|---|---|---|---|---|---|---|---|
| (0) | Tips about tracker plugins | Marc Laporte | 9 | 10 easy | 90 |
| 2008-11-12 | 2013-03-21 | 0 | ||
| (0) | On tiki-listpages.php the "?" icon links to not found page on doc.tiki.org | luciash d' being 🧙 | 9 | 10 easy | 90 |
| Benoit Roy | 2018-10-11 | 2018-12-06 | 1 benoit.roy-06 Dec 18 | |
| (0) | Help system: upgrade script should update to new destination on doc.tikiwiki.org | Marc Laporte | 6 | 8 | 48 |
| Marc Laporte | 2007-06-12 | 2010-01-18 | 1 marclaporte-01 Aug 07 | |
| (0) | No Plugin-Help when editing forum or trackers | amette | 9 high | 45 |
| 2005-07-04 | 2009-08-16 | 0 | |||
| (0) | Help System Link on Admin::General goes to useless page | dthacker | 9 high | 45 |
| dthacker | 2007-06-13 | 2007-12-31 | 1 marclaporte-13 Jun 07 | ||
| (0) | Help URL's built incorrectly on tiki_admin.php pages | dthacker | 8 | 40 |
| dthacker | 2008-03-03 | 2008-03-26 | 0 | ||
| (0) | Wiki Plugins, Wiki page help; It is not possible to add a plugin on a page using the Wiki Page help option | Bernard Sfez / Tiki Specialist | 8 | 5 | 40 |
| 2023-06-23 | 2023-06-26 | 3 Bsfez-26 Jun 23 | ||
| (1) | tiki-admin.php & Wizards: mouse-over the information, warning, help icons doesn't show the expected content but the label again | Marc Laporte | 8 | 4 | 32 |
| Jonny Bradley | 2014-07-29 | 2015-11-14 | 1 xavi-11 Aug 14 | |
| (0) | Help System is not listed as feature on Tiki Tracks | dthacker | 6 | 30 |
| 2007-06-13 | 2007-06-13 | 0 | |||
| (0) | Full text search module needs Help | marbux | 5 | 25 |
| 2005-11-08 | 2010-01-15 | 0 |
Related