Document cloud's document viewer integration into plone.
Project description
Introduction
This package integrates documentcloud’s viewer and pdf processing into plone.
Example viewer: https://www.documentcloud.org/documents/19864-goldman-sachs-internal-emails
Features
very nice document viewer
OCR
Searchable on OCR text
works with many different document types
plone.app.async integration with task monitor
lots of configuration options
PDF Album view for display groups of PDFs
Works with
Besides displaying PDFs, it will also display:
Word
Excel
Powerpoint
HTML
RTF
Install requirements
graphicsmagick
ghostscript
poppler
tesseract
pdftk
openoffice(for doc, excel, ppt, etc types)
md5 or md5sum command line tool
Async Integration
It it highly recommended to install and configure plone.app.async in combination with this package. Doing so will manage all pdf conversions processes asynchronously so the user isn’t delayed so much when saving files.
Settings
The product can be configured via a control panel item Document Viewer Settings.
Some interesting configuration options:
- Storage Type
If you want to be able to serve you files via amazon cloud, this will allow you to store the data in flat files that can be synced to another server.
- Storage Location
Where are the server to store the files.
- OCR
Use tesseract to scan the document for text. This process ca be slow so if your pdfs do not need to be OCR’d, you may disable.
- Auto Select Layout
For pdf files added to the site, automatically select the document viewer display.
- Auto Convert
When pdf files are added and modified, automatically convert.
- Auto layout file types
Types that should automatically be converted to document viewer
File storage integration
If you choose to use basic file storage instead of zodb blob storage, there are a few things you’ll want to keep in mind.
Use nginx to then serve the file system files. This might require you install a local nginx just for serving file storage on the plone server. You can get creative with how your file storage is used though.
Since in plone’s operation, it can be interrupted and the deletion of a file on the OS system system can not be done within a transaction, no files are ever deleted. However, there is an action you can put in a cron task to clean up your file storage directory. Just call the url http://zeoinstace/plone/@@dvcleanup-filestorage.
Upgrading from page turner
If you currently have page turner installed, this project will supercede it. Your page turner views will work but no future files added to the site will be converted to page turner.
To convert existing view, on every page turner enabled file, there will be a button Document Viewer Convert that you can click to manually convert page turner to document viewer.
To convert all existing views, go to portal_setup in the zmi, upgrades, select collective.documentviewer, click to show old upgrades and there should be an upgrade-all step to run.
Upgrading from pdfpal
If you want to upgrade from pdfpal, it is recommended that you simply uninstall pdf pal.
Document viewer will disable parts of pdfpal if installed with it otherwise. If you still want both installed, you’ll need to upgrade to at least version 0.7b5 in order for it to play nice with document viewer.
Also, version 0.7b5 has the best uninstall support so if you’re going to uninstall the product, first upgrade your egg to 0.7b5.
TODO
- reject converting pdf if too large and no async support provided?
or let people hang themselves?
Changelog
1.3b1 (2012-04-20)
default OCR to being off since it’s pretty slow
better logging when looking for binary files
be able to override width of viewer
1.3a3 (2012-04-20)
fix uninstall [vangheem]
1.3a2 (2012-04-19)
fix async bug if it wasn’t installed [vangheem]
1.3a1 (2012-04-19)
make sure to initialize catalog after db sync for large PDFs. [vangheem]
better integrate with pdfpal and pageturner so it’s easy to upgrade from those products. [vangheem]
1.2a2 (2012-04-19)
fix setting custom quota for async queue [vangheem]
fix group view clear button [vangheem]
add support for alternative md5sum binary [vangheem]
1.2a1 (2012-04-19)
fix full screen page bug [vangheem]
better async integration with quota setting [vangheem]
View async queue for conversions [vangheem]
index ocr data in portal catalog [vangheem]
better pdf group view with search [vangheem]
handle large files better [vangheem]
check if file has already been converted by storing hash of the file to check against. [vangheem]
be able to remove document viewer conversion tasks [vangheem]
add ability to cleanup file storage files for deleted plone File objects. [vangheem]
1.1a1 (2012-04-18)
add pdf folder album view [vangheem]
fix async integration [vangheem]
1.0a2 (2012-04-17)
add control panel icon [vangheem]
fix uninstall procedure [vangheem]
changing image type does not cause existing ones to fail. [vangheem]
1.0a1 (2012-04-17)
Initial release
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for collective.documentviewer-1.3b1.zip
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cf2beadb9e22faceeaa29f6d2308e1cba172172ee6dda80935d0ec7f9efce8a7 |
|
| MD5 | 32379ebb6fef9949adcdd7e9ef81aefd |
|
| BLAKE2b-256 | d546bfaa3b4e9ba2ca803fc507cb630bed82e7b8d2188f87841a46e9a3c733c0 |
