Loading...
 

 Note

This page is to document "what Tiki should do". For feature documentation (what Tiki does), please see corresponding page on doc site
Various ways to get help when using Tiki (Cached) Type of page »  Feature page

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. pageguide.js


https://github.com/tracelytics/pageguide#readme
License: MIT

1.1.4. tourist


http://easelinc.github.io/tourist/ - https://github.com/easelinc/tourist
License: MIT

1.1.5. Bootstrap Tour


http://bootstraptour.com/
License: Apache 2 (Not compatible) but moving to MIT
Lots of features, including multi-page

1.1.6. Bootstrap Tour (guild)


https://github.com/Gild/bootstrap-tour (this is a different project, and dead)
License: MIT. No demo found.

1.1.7. Guiders.js


https://github.com/jeff-optimizely/Guiders-JS#readme
License: Apache 2 (Not compatible).

1.1.8. King_tour


License: Not declared (and broken demo)

1.1.9. Bootstro.js

1.1.10. trip.js

1.1.11. Bootstrap Application Wizard

1.1.12. Hopscotch

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)
Guiders.js https://github.com/jeff-optimizely/Guiders-JS#readme Apache 2.0 ? Element No
King Tour https://github.com/salesking/king_tour ? ? ? ?
Bootstro.js https://clu3.github.io/bootstro.js/ MIT Good if side modals aren't used (xs displays) Needs custom selectors. No
Trip.js http://eragonj.github.io/Trip.js/ MIT Good, depending on e/w modals Any unique No
Bootstrap Application Wizard https://github.com/amoffat/bootstrap-application-wizard Free to use with attribution ? (no demo) Special ? No ?
Hopscotch http://linkedin.github.io/hopscotch/ Apache 2.0 Yes Any unique Yes
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
Faqtoid** https://github.com/patrick-roberts/faqtoid MIT Yes Any unique 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.

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

 RatingSubjectSubmitted byImportanceEasy to solve?PriorityCategoryVolunteered to solveLastModifComments
(0) On tiki-listpages.php the "?" icon links to not found page on doc.tiki.orgluciash d' being910 easy90
  • Usability
  • Easy for Newbie Dev
2018-10-110
(0) 13.x doc.tiki.org :: help doc links report "Page not found"Marc Laporte8864
  • Regression
2014-07-300
(0) Site customisation should be highlighted and All features enabled by default, empty header.tpl othman70
  • Feature request
  • Dogfood on a *.tiki.org site
2009-05-181
nyloth-13 Aug 08
(0) maketoc should have plugin help70
  • Usability
  • Feature request
  • Consistency
2009-04-200
(0) All help links should point to wishlist as well (only for admins)70
  • Feature request
2009-09-030
(0) Advanced search help button in module search_box doesn't workConnor MacLeod of the Clan MacLeod60
  • Error
2009-09-210
(0) Blue Help Circle will not drop down in IE works in Firefoxroutedoctor0
  • Usability
2009-12-160

Pending

 RatingSubject Submitted byImportanceEasy to solve?PriorityCategoryVolunteered to solveLastModifComments
(0) Add "help popup" for all lines/fields/configurable items when using Admin to set up your modules.Dumarest70
  • Support request
2008-02-201
marclaporte-15 Jan 10
(0) Trackers:: field type helperMarc Laporte80
  • Feature request
  • Consistency
Marc Laporte2008-10-290
(0) wiki help - plugin list sortinggezza50
  • Usability
Jonny Bradley2013-06-050

Closed

 RatingSubjectSubmitted byImportanceEasy to solve?PriorityCategoryVolunteered to solveLastModifComments
(0) Tips about tracker pluginsMarc Laporte910 easy90
  • Feature request
  • Less than 30-minutes fix
2013-03-210
(0) Help system: upgrade script should update to new destination on doc.tikiwiki.orgMarc Laporte6848
  • Documentation (or Advocacy)
  • Less than 30-minutes fix
Marc Laporte2010-01-181
marclaporte-01 Aug 07
(1) tiki-admin.php & Wizards: mouse-over the information, warning, help icons doesn't show the expected content but the label againMarc Laporte8432
  • Usability
  • Regression
Jonny Bradley2015-11-141
xavi-11 Aug 14
(0) Help System is not listed as feature on Tiki Tracksdthacker60
  • Usability
  • Feature request
  • Documentation (or Advocacy)
2007-06-130
(0) Help System Link on Admin::General goes to useless pagedthacker9 high0
  • Usability
  • Documentation (or Advocacy)
dthacker2007-12-311
marclaporte-13 Jun 07
(0) Help URL's built incorrectly on tiki_admin.php pagesdthacker80
  • Error
  • Documentation (or Advocacy)
dthacker2008-03-260
(0) No Plugin-Help when editing forum or trackersamette9 high0
  • Usability
  • Feature request
  • Dogfood on a *.tiki.org site
  • Consistency
2009-08-160
(0) Full text search module needs Helpmarbux50
  • Usability
2010-01-150

alias

Page last modified on Thursday 24 December, 2015 18:34:10 GMT-0000

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools