PLIP: Cleanup and enhance icon and thumb aspects

[fgrcon]

Proposer : fgrcon

Seconder : Jens W. Klein

Abstract

Pre plone 5 icons to decorate content types were implemented using tags. Since plone 5 these image tags have been replaced by fontello fonts in css rules (:before{content=\e80...} ). Furthermore mimetype icons where used for file types such as *.pdf, *.xls and many more until plone 4.x. - in plone 5 all those are replaced by a single fontello font (paper clip).

There has been some confusion about icons and preview images (aka thumbs). In summary views thumbs were shown for objects containing a lead image. In plone 5.02 the option to show thumbs in further list and table views, folder content listing , portlets etc. was added.

Configurability of this feature (where to show thumbs, where to suppress them, individual thumb size ) is insufficient (only never, authenticated users only, always).

The implementation of this feature reuses an obsolete meta data catalog item: getIcon (now bool: True when item is an image cor contains an image (e.g. lead image) - this adds to the confusion between thumbs and icons enormously.

Concise but sufficient documentation (user and developer) is to be provided.

Motivation

Cleanup, better usabilty, make life easier for users, integrators, developers.
get same behavior, look and feel allover the framework

Assumptions

see abstract

Proposal & Implementation

- [ ] change meta-data name getIcon to hasImage (keep getIcon with deprecation warning for a while ?)
This should be moved to an independent PLIP beacause it needs further discussion. Renaming this metadata item might generate unacceptable effort for reindexing or cause problems for add ons.
Maybe just to be solved with explanations in documentation.

• provide more detailed options in Site Control panel (Suppress thumbs in list views, table views, summary view, portlets, default thumbsizes for list-, table-, summary- views and portlets.
  
• Additional behavior IThumbIconHandling (in p.a.contenttypes) for dexterity types, which allow to override thumb and icon options for folders and collections and custom types.
  This Behavior is added to folder and collection by default. (see comment by @ebrehault below, explanations will go into documentation ....)
  
• make thumbsize configurable in folder contents (structure pattern)
• add override thumb and icon options to all standard portlets in plone.app.portlets, ...collection, ...event :
  • navigation
  • news
  • revision
  • recent
  • plone.portlet.collection
  • plone.app.event

for all listed portlets:

• remove fontello font (paper clip) for file types and replace with mime type icon (to many mimetypes to create fontello fonts for each of them)

before e.g.:

after:

• documentation for all stakeholders (covering metadata, icons, thumb aspects)
  WIP will be submitted after prs are merged

• upgradesteps to reapply profiles ( new Registry records, add IThumbHandling behavior to dx folder and collection )

• plone-compile-resources

• some additional translations

  remove dead code as much as possible :

• plone.app.layout

• Products.CMFPlone

Deliverables

finished:

• Products.CMFPlone
• plone.app.content
• mockup (structure)
• plone.app.contentlisting
• plone.app.contenttypes
• plone.app.layout
• plone.app.portlets
• plone.portlet.collection
• plone.app.event
• plone.documentation
• plone.theme.barceloneta
• plone.app.upgrade

Risks

- renaming getIcon might cause troubles for addons
postponed see above..

• some test cases might need rework

Participants

fgrcon

most of the neccessary modifications are already implemented and tested in private environment. Pull requests will follow shortly.

Related issues

• Thumbs visibility: shown in too much listings Thumbs visibility: shown in too much listings #1322
• toggle preview images in folder/collection listings on per context basis Collection views do not display lead images set on a content type #1185
• Collection views do not display lead images set on a content type Collection views do not display lead images set on a content type #1185 (closed)
• Cleanup deprecated geticon ... code Cleanup deprecated geticon ... code #1151 (closed)
• Too many icons show in navigation portlet Too many icons show in navigation portlet #1093 (Closed)
• Add option to show thumbnails for images in Plone 5 content views Add option to show thumbnails for images in Plone 5 content views #1074 (closed)

Pull Requests

branchname: plip1734thumbs https://github.com/plone/buildout.coredev/tree/plip1734thumbs

[fgrcon]

http://jenkins.plone.org/job/pull-request-5.1/

[fgrcon]

http://jenkins.plone.org/job/pull-request-5.1/596/

[fgrcon]

@ebrehault @jensens @gforcada ....
finished
jenkins jobs in queue: http://jenkins.plone.org/job/plip-1734-icons-and-thumbs/5/
http://jenkins.plone.org/job/pull-request-5.1/134/

[ebrehault]

Tests are green :)
@jensens @gforcada shall we merge?

[rnixx]

fgrcon opened this Issue on 30 Aug 2016

well deserved

🥇

[gforcada]

@fgrcon as this is for 5.1 only, I would say yes, let's merge now 👍

[jensens]

Yes, ready for merge!

[svx]

I guess plone/documentation#809 should be merged, too ?

[ebrehault]

@fgrcon there is a confict here plone/plone.app.content#106, could you have a look?

[ebrehault]

@svx yes I did merge it

[svx]

@ebrehault awesome ! thanks !!!!

[ebrehault]

@fgrcon actually it was just a small this in CHANGES, I fixed it with the Github interface :)

So we are done !!!
Congrats @fgrcon, your efforts are very appreciated!

[fgrcon]

Thanks !!

[gforcada]

@fgrcon so what's your next PLIP going to be 😄