Ticket #9285 (closed PLIP: fixed)

Opened 5 years ago

Last modified 5 years ago

Show blocked portlets in management interface

Reported by: igbun Owned by: igbun
Priority: minor Milestone: 4.0
Component: Templates/CSS Version:
Keywords: portlets Cc: plip-advisories@…, grahamperrin@…

Description (last modified by igbun) (diff)

Proposer: Ricardo Alves
Seconder:

Motivation

The current interface for blacklisting portlet categories isn't much helpful, mostly because the user can't actually see what portlets he is blocking.

Assumptions

The current implementation of the portlet management screen only shows the portlet assigned to the current context and, since Plone 3.3, also displays the inherited portlets (if not blocked). Additionally, this screen gives the user the ability to block categories of portlets, which include:

  • portlets being inherited from the parent container;
  • group portlets;
  • content type portlets;

It is hard to the user to know exactly what we wants to block. If, for example, the user is not a site administrator, he won't be able to distinguish between group and content type portlets, without some try-and-error process.

Proposal

Change the portlet management screen to show all portlets, including the ones that are blocked. This way users are be able to see what's being blocked with a whole category and also the ones that are being inherited.

Portlets which are being blocked should be easily identified, e.g. using a different background color (gray), suggesting that the portlet is disabled.

Implementation

The implementation requires changes in plone.app.portlets. More specifically in class ContextualEditPortletManagerRenderer (at plone.app.portlets.browser.editmanager) and template templates/edit-manager-contextual.pt.

Based on the blacklisting information, this view knows which categories are being blacklisted and so it applies a different style, markup and options to portlets accordingly.

Risks

This is essentially a presentational improvement. The required changes won't break existing functionality.

Documentation changes will be necessary, but won't be critical.

Deriverables

  • New release of plone.app.portlets to include the required changes, with an improved portlet management screen, showing all portlets, even the blocked ones (e.g. in gray), grouped by categories.
  • Updated documentation.

Participants

  • Ricardo Alves (igbun)

Progress

There is a working implementation at branch plip9285-show-blocked-portlets

Still needs more testing, though. Also, some trivial CSS needs to be added in CMFPlone to differentiate the blocked portlets.

Change History

comment:1 Changed 5 years ago by igbun

  • Description modified (diff)

comment:2 Changed 5 years ago by igbun

  • Description modified (diff)

comment:3 Changed 5 years ago by igbun

Updated the description to reflect the PLIP template and also added more information.

comment:4 Changed 5 years ago by erikrose

  • Owner igbun deleted

Clearing Owner field of 4.0 PLIPs so we can use it to mean "implementor". (Many of these owners were automatically assigned from choosing a Component that had a default owner.)

comment:5 Changed 5 years ago by smcmahon

  • Cc plip-advisories@… added

comment:6 Changed 5 years ago by MatthewWilkes

FWT Vote: +1

comment:7 Changed 5 years ago by rossp

  • Owner set to igbun

I think the owner here was intentional.

comment:8 Changed 5 years ago by rossp

FWT vote +1.

comment:9 Changed 5 years ago by davisagli

FWT vote +1

comment:10 Changed 5 years ago by raphael

FWT vote +1

comment:11 Changed 5 years ago by calvinhp

FWT Vote: +1

comment:12 Changed 5 years ago by esteele

Approved by FWT vote.

comment:13 Changed 5 years ago by igbun

  • Status changed from new to assigned

comment:14 Changed 5 years ago by grahamperrin

  • Cc grahamperrin@… added

comment:15 Changed 5 years ago by igbun

(In [28886]) Added PLIP buildout configuration and details document, refs #9285.

comment:16 Changed 5 years ago by igbun

This PLIP is ready for review.

comment:17 Changed 5 years ago by erikrose

(In [29509]) Completed my review of the show-blocked-portlets PLIP. Refs #9285.

comment:18 Changed 5 years ago by esteele

Your PLIP has been reviewed by the Framework team. Feel free to discuss any suggested changes either here in the PLIP ticket or on the mailing lists. Final deadline for this PLIP is set for September 23.

comment:19 Changed 5 years ago by igbun

(In [29863]) Added docstrings to the affected and new methods, according to review. Refs #9285.

comment:20 Changed 5 years ago by igbun

(In [29864]) Updated PLIP status and description of further work. Refs #9285.

comment:21 Changed 5 years ago by erikrose

(In [30227]) Reverted inline styling. Refs #9285.

comment:22 Changed 5 years ago by erikrose

(In [30228]) Moved review to a separate file and updated for final vote. Refs #9285.

comment:23 Changed 5 years ago by esteele

This PLIP has been accepted for merging into Plone 4.0

The final vote was: Alec Mitchell +1 David Glick +1 Erik Rose +1 Laurence Rowe +1 Matthew Wilkes - Ross Patterson +1

Please merge your branches into the Plone 4.0 head by end-of-day Friday Oct 16. If you need assistance with merging, please contact me.

We'll be assigning a documentation ticket to this PLIP shortly. Please assist the docs team in documenting the changes and new features that this PLIP introduces.

comment:24 Changed 5 years ago by esteele

Please assist the doc team in creating/updating documentation relating to this PLIP. See #9610.

comment:25 Changed 5 years ago by esteele

(In [30484]) Merge PLIP #9285. Refs #9285.

comment:26 Changed 5 years ago by esteele

  • Status changed from assigned to closed
  • Resolution set to fixed

(In [30485]) Removing PLIP branch. Closes #9285.

Note: See TracTickets for help on using tickets.