Home
Hover Help (0.1)
- Hover Help download link: http://plone.org/products/hoverhelp/releases
- Homepage of Hover Help: http://plone.org/products/hoverhelp/
- Hover Help repository: https://svn.plone.org/svn/collective/HoverHelp
- Description source: https://svn.plone.org/svn/collective/HoverHelp/readme.txt
Help is stored in a skin in the skins directory as a series of Page Templates (although this could include images and so on). Each help section is written as a Page Template so it is translateable and can make use of all the appropriate macros (and skins, customisations and so on).
On the front end we use an Ajax style call to send a request to Plone. A tool inside Plone grabs the request and figures out an appropriate Page Template to call. Currently this is based on the content type, but this method could be customised extended to have almost any rule you'd like.
Once there an appropriate template is returned as a big blob of HTML. The client side then looks for the id a user is hovering over. It then looks inside the big blob of HTML for matching element id and shows help.
Advantages:
- help comes extra with no changes to any Plone templates at all
- Plone is not slowed down by passing help, it is only sent when requested
- help server could even be a seperate server
- if users have JS disabled, we just need to find another way to pull out Page Templates.
Disadvantages:
- JS is required
- Someone needs to write inline help
- Note: some problems with IE support
