[jboss-jira] [JBoss JIRA] Commented: (JBPORTAL-1477) Custom render modes should be documented
[ http://jira.jboss.com/jira/browse/JBPORTAL-1477?page=comments#action_1236... ]
Andrew Oliver commented on JBPORTAL-1477:
-----------------------------------------
Mainly I was trying to point out that the documentation should be corrected from the
ambiguous: http://docs.jboss.com/jbportal/v2.4/reference-guide/en/html_single/#d0e1620
"
5.1.2. Rendering Modes
A porlet can have different view modes, three modes are defined by the specification but a
portal can extend those modes. The 3 modes are:
* VIEW - Generates markup reflecting the current state of the portlet.
* EDIT - Should allow a user to customize the behaviour of the portlet.
* HELP - Should provide some information to the user as to how to use the portlet.
"
to something more like:
"
5.1.2. Rendering Modes
A porlet can have different view modes, three modes are defined by the specification but a
portal can extend those modes. The 3 modes are:
* VIEW - Generates markup reflecting the current state of the portlet.
* EDIT - Should allow a user to customize the behaviour of the portlet.
* HELP - Should provide some information to the user as to how to use the portlet.
JBoss Portal does not presently support other modes or custom modes.
"
However I'd suggest that custom modes could be useful. WL Portal provides these:
http://dev2dev.bea.com/pub/a/2004/09/portal_webapps.html although their example is stupid.
I can see a number of ways this might interplay with other things like caching for
instance or "locked" where the portlet won't switch to edit mode or
everything is marked read only.
However the best argument is that portlets written to expect to use custom modes or
specific unsupported may not behave well in JBP and since other vendors offer them, it
makes sense to allow them. (However this is a separate issue from the documentation being
inspecific on this point)
Custom render modes should be documented
----------------------------------------
Key: JBPORTAL-1477
URL: http://jira.jboss.com/jira/browse/JBPORTAL-1477
Project: JBoss Portal
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Portal Documentation
Affects Versions: 2.6.CR1, 2.4.1 SP1
Reporter: Andrew Oliver
Assigned To: Julien Viet
It appears via:
The blanket statement of support is based on: http://jira.jboss.com/jira/browse/JBPTL-20
and
http://www.jbossworld.com/jbwv_2006/integration_and_presentation/LAPRUN_J...
and http://labs.jboss.com/portal/authors/articles/portal/magicbullet/
That custom render modes are supported. However the documentation is completely vague on
support just saying the spec allows for custom modes and saying nothing about portals
support for them. The doc also does not say HOW to define them. From these 3 I gather:
Basically the last url states:
"Some vendors define custom portlet modes that your portlets can implement. Support
for custom portlet modes is briefly defined in the specification, and is as simple as
adding a custom-portlet-mode node to the portlet descriptor and any other vendor-specific
modifications to the descriptor or the portlet class."
I suspect you define it in the portlet descriptor, the vendor specific descriptor and
portal configuration and it should work.
However I think the documentation should explicitly state support or non-support (I think
it is the former) and in the case of the former demonstrate how (which I think matches the
above)...
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira