[PLIP-Advisories] Re: [Plone] #9286: Allow to show/hide portlets

[plip-advisories at lists.plone.org]

#9286: Allow to show/hide portlets
----------------------------+-----------------------------------------------
 Reporter:  igbun           |        Owner:  igbun
     Type:  PLIP            |       Status:  new  
 Priority:  minor           |    Milestone:  4.0  
Component:  Infrastructure  |   Resolution:       
 Keywords:  portlets        |  
----------------------------+-----------------------------------------------

Old description:

> '''Proposer:''' Ricardo Alves[[BR]]
> '''Seconder:''' [[BR]]
>
> == Motivation ==
>
> Currently, only the static text portlet can be hidden. This option should
> be available to all portlets in a more UI friendly away.
>
> == Assumptions ==
>
> The need to hide/disable portlets is very common. Most portlets have
> persistent settings, so the ability to keep them configured but hidden
> can make a difference. The portlets themselves may implement this feature
> individually (as the static portlet does), but there should be a more
> generic solution, allowing to show/hide portlets at the management
> screen.
>
> == Proposal ==
>
> Allow the user to hide individual portlets using the portlet management
> interface with a single click. Hidden portlets should be easily
> identified, e.g. using a different background color (gray), suggesting
> that the portlet is disabled.
>
> == Implementation ==
>
> This can be done using a simple, clickable show/hide icon, and some AJAX
> to perform the server changes. The show/hide option should be stored as
> an annotation (not at the portlet schema as currently implemented by the
> static portlet).
>
> The "hide" field should be removed from the static text portlet schema.
>
> In regarding to backwards compatibility, it should be fairly easy to keep
> old static text portlets working, based on the old value stored or, if
> necessary, using a specific migration.
>

> == Deliverables ==
>
> A new release of plone.app.portlets including these features.
>
> A new release of plone.portlet.static which removes the hide option.
>
> Updated documentation about the static portlet and the portlet management
> screen to explain the new features.
>
> == Risks ==
>
> The problem of users expecting to find the "hide" field when editing
> static text portlets, which is negligible considering the gains in
> usability.
>
> == Participants ==
>
> - Ricardo Alves (igbun)
>
> == Progress ==
>
> Not implemented yet.

New description:

 '''Proposer:''' Ricardo Alves[[BR]]
 '''Seconder:''' [[BR]]

 == Motivation ==

 Currently, only the static text portlet can be hidden. This option should
 be available to all portlets in a more UI friendly away.

 == Assumptions ==

 The need to hide/disable portlets is very common. Most portlets have
 persistent settings, so the ability to keep them configured but hidden can
 make a difference. The portlets themselves may implement this feature
 individually (as the static portlet does), but there should be a more
 generic solution, allowing to show/hide portlets at the management screen.

 == Proposal ==

 Allow the user to hide individual portlets using the portlet management
 interface with a single click. Hidden portlets should be easily
 identified, e.g. using a different background color (gray), suggesting
 that the portlet is disabled.

 == Implementation ==

 This can be done using a simple, clickable show/hide icon, and some AJAX
 to perform the server changes. The show/hide option should be stored as an
 annotation (not at the portlet schema as currently implemented by the
 static portlet).

 The "hide" field should be removed from the static text portlet schema.

 The GenericSetup import/export handler at plone.app.portlets should be
 updated, allowing to set the hidden flag to portlet assignments via
 GenericSetup.

 In regarding to backwards compatibility, it should be fairly easy to keep
 old static text portlets working, based on the old value stored or, if
 necessary, using a specific migration.


 == Deliverables ==

 A new release of plone.app.portlets including these features.

 A new release of plone.portlet.static which removes the hide option.

 Updated documentation about the static portlet and the portlet management
 screen to explain the new features.

 == Risks ==

 The problem of users expecting to find the "hide" field when editing
 static text portlets, which is negligible considering the gains in
 usability.

 == Participants ==

 - Ricardo Alves (igbun)

 == Progress ==

 Not implemented yet.

--

Comment(by igbun):

 Updated PLIP description to include the hidden flag at import/export via
 GenericSetup.

-- 
Ticket URL: <http://dev.plone.org/plone/ticket/9286#comment:15>
Plone <http://plone.org>
Plone Content Management System