Loading...
 
Skip to main content
Various ways to get help when using Tiki
(Cached)
4
Page actions
Refresh

Help

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


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

1.7. Others

1.8. Wishlist

Open

Rating Subject Submitted By Importance Easy to solve ? Priority Category Volunteered to solve Created Modified
(0) Tracker, Text Area help; The help button above a tracker area field at dev.t.o doesn't work anymore Bernard Sfez / Tiki Specialist 5 5 25
  • Regression
 15 Dec 22 15 Dec 22
(0) Advanced search help button in module search_box doesn't work Connor MacLeod of the Clan MacLeod 6 30 21 Sep 09 21 Sep 09
(0) Error in general help text hman 6 10 60
  • Error
  • Easy for Newbie Dev
  • Less than 30-minutes fix
 07 Aug 20 07 Aug 20
(0) Wiki argument variables, Documentation; The help tools of Tiki for Wiki argument variables redirect to the wrong page Bernard Sfez / Tiki Specialist 7 10 70
  • Error
  • Regression
 06 Jun 23 06 Jun 23
(0) maketoc should have plugin help nobody? 7 35 20 Apr 09 20 Apr 09
(0) All help links should point to wishlist as well (only for admins) nobody? 7 35 03 Sep 09 03 Sep 09
(0) Site customisation should be highlighted and All features enabled by default, empty header.tpl othman 7 35 03 Aug 08 06 Jul 24
(0) 13.x doc.tiki.org :: help doc links report "Page not found" Marc Laporte 8 8 64
  • Regression
 26 Jul 14 30 Jul 14
(0) Wiki page, Wiki plugins; Save button disappeared from the plugin modal that set a plugin from a Wiki page Bernard Sfez / Tiki Specialist 9 5 45
  • Regression
 26 Jun 23 26 Jun 23

Pending

Rating Subject Submitted By Importance Easy to solve ? Priority Category Volunteered to solve Created Modified
(0) SearchHelp popup window - text format error EdizonTN 1 5 5
  • Bug
 29 Oct 21 16 Mar 22
(0) Help, PDF.js: The feedback should help to find the solution when the feature is disabled Bernard Sfez / Tiki Specialist 5 5 25
  • Usability
 ibmussa 08 Jan 23 11 Jul 24
(0) Add "help popup" for all lines/fields/configurable items when using Admin to set up your modules. Dumarest 7 35 20 Feb 08 20 Feb 08
(0) Trackers:: field type helper Marc Laporte 8 40 marclaporte 29 Oct 08 29 Oct 08

Closed

Rating Subject Submitted By Importance Easy to solve ? Priority Category Volunteered to solve Created Modified
(0) Blue Help Circle will not drop down in IE works in Firefox routedoctor 25
  • Usability
 16 Dec 09 01 Jun 26
(0) 2FA tooltip should link to the documentation page Bernard Sfez / Tiki Specialist 3 5 15
  • Documentation (or Advocacy)
  • Easy for Newbie Dev
 josue.zirimwabagabo 19 Oct 24 12 Jan 25
(0) wiki help - plugin list sorting gezza 5 25
  • Usability
 jonnybradley 18 Dec 08 23 May 26
(0) Full text search module needs Help marbux 5 25 08 Nov 05 15 Jan 10
(0) Help system: upgrade script should update to new destination on doc.tikiwiki.org Marc Laporte 6 8 48
  • Documentation (or Advocacy)
  • Less than 30-minutes fix
 marclaporte 12 Jun 07 18 Jan 10
(0) Help System is not listed as feature on Tiki Tracks dthacker 6 30 13 Jun 07 13 Jun 07
(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
  • Regression
  • Usability
 jonnybradley 29 Jul 14 14 Nov 15
(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
  • Regression
 23 Jun 23 26 Jun 23
(0) Help URL's built incorrectly on tiki_admin.php pages dthacker 8 40 dthacker 03 Mar 08 26 Mar 08
(0) Tips about tracker plugins Marc Laporte 9 10 90
  • Feature request
  • Less than 30-minutes fix
 12 Nov 08 21 Mar 13
(0) On tiki-listpages.php the "?" icon links to not found page on doc.tiki.org luci 9 10 90
  • Usability
  • Easy for Newbie Dev
 benoit.roy 11 Oct 18 06 Dec 18
(0) No Plugin-Help when editing forum or trackers amette 9 high 45 04 Jul 05 16 Aug 09
(0) Help System Link on Admin::General goes to useless page dthacker 9 high 45 dthacker 13 Jun 07 31 Dec 07

Related

alias
History Source Comments
Show PHP error messages