Personal tools
You are here: Home Products Plone Roadmap #199: Integration of ARFilePreview in Plone core (preview of office and other binary files)
Document Actions

#199: Integration of ARFilePreview in Plone core (preview of office and other binary files)

Contents
  1. Definitions
  2. Motivation
  3. Assumptions
  4. Proposal
  5. Implementation
  6. Deliverables
  7. Risks
  8. Progress log
  9. Participants
by atReal last modified December 20, 2007 - 17:40
Make files previewable in Plone
Proposed by
Thierry Benita
Seconded by
Jean-Nicolas Bès
Proposal type
User interface
Repository branch
ARFilePreview-2.3-plone.transforms
State
being-discussed

Definitions

 

Motivation

Plone doesn't show a preview of binary (office?) files. This proposal is about adding an automatic/configurable preview on ATFile content type and subclasses.

Assumptions

We assume that a content transformation engine is available (PortalTransforms or plone.transforms).

Proposal

  • make it a zope3 style product (ie: an egg)
  • define a new viewlet
  • make it use plone.transforms by default and PloneTransforms as a fallback
  • make it store the html preview and subobjects as blob or file objects instead of strings
  • remove the AR (atReal) prefixes
  • add some translations
  • make it uninstalled by default (just like Marshall or Iterate)

Implementation

The preview and subobjects are currently stored as objects annotations.

The html transform is triggered by an IObjectEdited event.

Deliverables

  • plone.preview
    • documentation
    • localization
    • unit tests

Risks

The main risk is that uploading files could take a little more time because the transformation is triggered by a synchronous event.

We could work around this issue by :

  • limiting the maximum size of previewable files
  • triggering the preview manually (content action)
  • (HARD) implement an asynchronous preview engine that queues previewing jobs and process them later (later => in another thread/request)

 

 

The overhead of registering the configure.zcml but disabling the feature will be an event subscriber triggered to do nothing but checking the activation setting on each modifications of an object.

 

 

Progress log

The product is working but needs to be polished/reworked to be as pretty as the other Plone products.

Participants

Jean-Nicolas Bès (drjnut) atReal

Thierry Benita (tbenita) atReal

Framework team vote

Posted by Tom Lazar at December 20, 2007 - 13:20
-1 this seems like a lot of code for a feature that not everybody will be using. it's a great plip, but i'm against including this feature into plone core.

Lot of code?

Posted by Jean-Nicolas Bes at December 20, 2007 - 17:23
I don't think that this is "a lot of code" (I partially wrote ARFilePreview). Have a look at it ;-).

Why do I think that we need this in the future releases (3.5 or more)?

We agree that this is a great feature that people will be pleased to work with.

Think about using ExternalEditor along with the preview on an odt/doc file... It could make Plone as the standard "intranet desktop".

We are already using ARFilePreview/ExternalEditor like this on our own intranet and it's saving us a lot of time.

Framework team vote

Posted by Raphael Ritz at December 20, 2007 - 13:42
-1 like Tom I don't see the need for this in the core. This is a perfect fit for an add-on IMHO.

Framework vote

Posted by Martijn Pieters at December 21, 2007 - 17:21
-1 from me as well, it'd be a great add-on but it feels to 'heavy' in the way of storing the preview results in the ZODB (blobs or otherwise). This is something an integrator may add to a plone site if the customer requests it, not something that should be part of the default package.

Framework team vote

Posted by Andreas Zeidler at December 22, 2007 - 10:02
-1 (see http://lists.plone.org/pipermail/framework-team/2007-December/001624.html)

Framework team vote

Posted by Danny Bloemendaal at December 22, 2007 - 16:45
-1

For any issues with the web site functionality, please file a ticket.

Please consult the policy on plone.org content if you want your content published on this site.

Servers and hosting by