OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

wsrp message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Handling HELP

My original intention was to wait until this issue is resolved in JSR168 
EG and then bring the outcome for the consideration of WSRP TC. Because 
WSRP is about to stop receiving change requests and I believe it is 
something that WSRP should also address, I'm bringing it now.

IMO, the current state of the specification does not address a common 
use case for handling Help: help being provided by an external system, 
using static pages or displaying Help content at the same time the user 
is trying to do a task (while the portlet is in VIEW or EDIT mode). 
Following is a list of requirements that would address this use case.


1. It must be possible for Help to be rendered directly by external 
pages (JSP, static HTML, etc).
2. It must be possible for a portlet to use an external Help system.
3. It must be possible to display Help side to side with the operation 
the portlet is performing. This has to be done without breaking the 
portlet window semantics (a portlet window can have a single state).
4. It must be possible to fulfill the previous requirements using the 
Help button in the portlet window decoration.
5. How this is done it must be simple for portlet developers.

A few clarifications:

Portlet Window is the visual representation of portlet in a portal page.
The portlet window decoration would be the title bar of the visual 
representation that normally has a set of buttons to control the portlet 
(EDIT, HELP, MIN, MAX, etc).
Requirement #3 it could be the case of a popup window or an iframe 
within the portal page that shows the help while the portlet is being 
displayed in VIEW or EDIT. The portlet window semantics sentence refers 
to the fact that a portlet has a single 
portlet-mode/window-state/navigational-state at any given time.


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]