Loading...
 

 Note

This page is to document "what Tiki should do". For feature documentation (what Tiki does), please see corresponding page on doc site

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.

1. Help popups / On-page guidance / site tour

When in help mode, Tiki should have help popup


This is a nice example:

1.1. Joyride


http://www.zurb.com/playground/jquery-joyride-feature-tour-plugin
License: MIT

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


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

1.4. tourist


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

1.5. Bootstrap Tour


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

1.6. Bootstrap Tour (guild)


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

1.7. Guiders.js


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

1.8. King_tour


License: Not declared (and broken demo)

1.9. Bootstro.js

1.10. trip.js

1.11. Bootstrap Application Wizard

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.

2. Query builder

Project to integrate a nifty tool to query data in Trackers or in the Spreadsheet. See: Tracker Query

2.1. Chart editor

And create some charts from this info, like this one

3. Function helper

Point & click to using functions in the Spreadsheet

4. Mathematical equations helper

5. Theme designer CSS helper

auto-complete, drop-downs, etc.
Autocompletion is available from CodeMirror 2.x!

6. File and Image helper

7. Others

8. Wishlist

Open

 Submitted byRatingSubjectCategoryPriorityImportanceEasy to solve?Volunteered to solveLastModifComs
openMarc Laporte (0) 13.x doc.tiki.org :: help doc links report "Page not found"Bug: Regression64
8
8
 
2014-07-300
openothman (0) Site customisation should be highlighted and All features enabled by default, empty header.tpl Feature request
Dogfood on a *.tiki.org site
7
 
 
2009-05-181
nyloth-13 Aug 08
open (0) maketoc should have plugin helpBug: Usability
Feature request
Bug: Consistency
7
 
 
2009-04-200
open (0) All help links should point to wishlist as well (only for admins)Feature request
7
 
 
2009-09-030
openConnor MacLeod of the Clan MacLeod (0) Advanced search help button in module search_box doesn't workBug: Error
6
 
 
2009-09-210
openroutedoctor (0) Blue Help Circle will not drop down in IE works in FirefoxBug: Usability
 
 
 
2009-12-160

Pending

 Submitted byRatingSubjectCategoryPriorityImportanceEasy to solve?Volunteered to solveLastModifComs
pendingMarc Laporte (1) tiki-admin.php & Wizards: mouse-over the information, warning, help icons doesn't show the expected content but the label againBug: Usability
Bug: Regression
32
8
4
Jonny Bradley
2014-10-151
xavi-11 Aug 14
pendinggezza (0) wiki help - plugin list sortingBug: Usability0
5
 
Jonny Bradley
2013-06-050
pendingDumarest (0) Add "help popup" for all lines/fields/configurable items when using Admin to set up your modules.Support request
7
 
 
2008-02-201
marclaporte-15 Jan 10
pendingMarc Laporte (0) Trackers:: field type helperFeature request
Bug: Consistency
8
 
Marc Laporte
2008-10-290

Closed

 Submitted byRatingSubjectCategoryPriorityImportanceEasy to solve?Volunteered to solveLastModifComs
closedMarc Laporte (0) Help system: upgrade script should update to new destination on doc.tikiwiki.orgDocumentation (or Advocacy)
Less than 30-minute fix
48
6
8
Marc Laporte
2010-01-181
marclaporte-01 Aug 07
closeddthacker (0) Help System is not listed as feature on Tiki TracksBug: Usability
Feature request
Documentation (or Advocacy)
6
 
 
2007-06-130
closeddthacker (0) Help System Link on Admin::General goes to useless pageBug: Usability
Documentation (or Advocacy)
9 high
 
dthacker
2007-12-311
marclaporte-13 Jun 07
closeddthacker (0) Help URL's built incorrectly on tiki_admin.php pagesBug: Error
Documentation (or Advocacy)
8
 
dthacker
2008-03-260
closedMarc Laporte (0) Tips about tracker pluginsFeature request
Less than 30-minute fix
9
10 easy
 
2013-03-210
closedamette (0) No Plugin-Help when editing forum or trackersBug: Usability
Feature request
Dogfood on a *.tiki.org site
Bug: Consistency
9 high
 
 
2009-08-160
closedmarbux (0) Full text search module needs HelpBug: Usability
5
 
 
2010-01-160

alias
Contributors to this page: Gary Cunningham-Lee , Marc Laporte and Xavi .
Page last modified on Monday 31 August, 2015 16:07:59 CEST by Gary Cunningham-Lee.

Search Wishes (subject only)

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 7.x
Administration
Ajax 2.x
Articles & Submissions
Backlinks
Banner
Batch 6.x
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Credits 6.x
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 8.x
DogFood
Draw 7.x
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
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 3.x
Mobile Tiki and Voice Tiki
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Payment 5.x
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Report
Score
Search engine optimization (SEO)
Search
Security
Semantic links 3.x
Share
Shopping Cart 5.x
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 2.x
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests 2.x
Timesheet
Token Access
Toolbar (Quicktags)
Trackers
TRIM
User Administration
User Files
User Menu
Watch
WebHelp
Webmail and Groupmail
WebServices 3.x
Wiki 3D
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 4.x
WYSIWTSN 4.x
WYSIWYCA
WYSIWYG 2.x
XMLRPC




Useful Tools