Re: user editable context sensitive online help

Mikko Ohtamaa <mikko+plone-75aZqqp77KCaMPzRcYMCawC/[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
> Not sure if this off topic or not but just had an inspiration for an
> > online help solution while responding to a tender.
> > If every plone site had a help folder that contained content with a
> > special field for matching urls. Say a regular expression. So then
> > content creators could provide their own help pages for any screen
> > like ".*login_form" would match any login form screen. Then have a
> > global viewlet that puts links to help content available for that
> > page. Put that viewlet in a consistent location.
> > If such a system existed we might be able to ship parts of the user
> > manual as online help linked to relevant pages. Idea might need
> > refinement to handle upgrades of that standard help however.
>

We have been also tested online help solution where quick help for inputting
complex medical fields was required

1) We added new AT field attribute called "help_link"

2) Help_link is a site path to Document object having the help text as body

3) If field has AT help_link attribute a help link (? in blue circle) is
rendered next to the field label. This requires overriding AT base files and
fields folder due to plone_skins limitations, making it unsuitable for
generic use.

4) If the user clicks blue ? a jquery pop-up DIV is displayed next to the
field label, showing the content of help_link Document, retrieved via AJAX.
Jquery pop up is automatically closed when the user navigates forward.

5) The help-pop has also [edit this] link which allows to edit the on-line
help in wiki style by users (by giving Modify portal content permission to
all Members via workflow), so that the users can help each other in common
problems

AT based approach is bad due to its ties into AT internals.  CSS rules +
Javascript based solution sounds more suitable. However, it could be still
reasonable to define the help link in the field definition, so that code
maintenance overhead doesn't raise too much because of decoupling of two
related items.

-Mikko

------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.