Plone4ArtistsImage ================== Overview -------- Plone4ArtistsImage is a Plone product built to expose the ``p4a.image`` framework in a Plone setting. In a nutshell it provides the following features: File support Uploaded Image objects are scanned for image mime types and are *image enhanced* automatically if a registered mime type is found. (In the future, File objects will be handled as well.) Image metadata support Image information is read from and written to JPEG and TIFF image files. Image container support Any folder or smart folder can be *media activated* which turns it into an image container which knows how to display an overview for all contained images. Slideshow support Media activated folders can display a slideshow of contained images. (Not yet implemented) External filesystem storage support By default all image content is stored directly within the ZODB, but by using the BlobFile_ product all image content can be stored automatically outside the ZODB on the filesystem. Content Licensing support All image content can automatically be licensed using the ContentLicensing_ product. Requirements ------------ - Zope 2.9.4+ (Zope 2.10+ is not supported at this time) - Plone 2.5.1+ (Plone 3.0+ is not supported at this time) - Five_ 1.4.2+ (Five 1.5+ is not supported at this time) - CMFonFive_ 1.3.4+ .. _Five: http://codespeak.net/z3/five/ .. _CMFonFive: http://codespeak.net/z3/cmfonfive/ Optional Dependencies --------------------- Licensing Support - ContentLicensing_ 1.0.2 or higher External Filesystem Support - BlobFile_ 1.0alpha1 or higher .. _BlobFile: http://plone.org/products/blobfile .. _ContentLicensing: http://plone.org/products/contentlicensing .. _basesyndication: https://svn.plone.org/svn/collective/basesyndication/ .. _fatsyndication: https://svn.plone.org/svn/collective/fatsyndication/ Installation ------------ If you're installing from the *Plone4ArtistsImage* bundle release you simply need to install all of the included Zope 2 products into your ``$INSTANCE_HOME/Products`` directory. (This will be added in the future.) If you're installing just the *Plone4ArtistsImage* Zope 2 product, you'll need the other dependencies installed manually as well. Please see their install files for proper installation instructions. Configuration within a Plone site is simply a matter of going to the *Add/Remove Products* configlet and installing the ``Plone4ArtistsImage`` product. Basic Usage ----------- Note: The Plone4ArtistsImage product does not install any content types. - images with mime types ``image/jpeg`` or ``image/tiff`` will automatically become *image enhanced* (and in future, files) - folders and files can be toggled to be image enhanced by selecting the **activate image** menu item in their respective **actions** drop down menus. Smart Folders ------------- You can use image enhanced smart folders to display images from across your site. Which image files appear in your smart folder depends on the criteria you specify in the **criteria** drop down menu of the smart folder. Here are step-by-step instructions for creating three commonly used image smart folders: (1) A smart folder containing all image files from the whole site: 1. Create a smart folder, give it a Title and save it 2. Image-activate the smart folder in the **actions** drop down menu 3. Click the **criteria** tab 4. In the *Add New Search Criteria* box, set *Field name* to *MIME Types* 5. Click *add* 6. In the *criterion details* column set *Value* to *image/jpeg* 7. Click the *save* button just below the *MIME Types* table, i.e. not the save button at the bottom of the page (2) A smart folder containing all images by a particular photography: Repeat steps 1. to 7. in (1) above 8. In the *Add New Search Criteria* box, set *Field name* to *Photographer name* 9. Click *add* 10. In the *criterion details* column set *Value* for Photographer name to the name of the photographer 11. Click the *save* button just below *Photographer name*, i.e. not the save button at the bottom of the page XXX not sure about genre (3) A smart folder containing all images of a particular genre: Repeat steps 1. to 7. in (1) above 8. In the *Add New Search Criteria* box, set *Field name* to *Genre* 9. Click *add* 10. Enter the number that corresponds to the genre. For a list of genres and corresponding numbers, please see the file: Plone4ArtistsImage/pythonlib/p4a/image/genre.py 11. Click the *save* button just below *Genre*, i.e. not the save button at the bottom of the page *Photographer name* and *genre* are set up as search criteria when Plone4ArtistsImage is installed, because they are the criteria thought most likely to be required. If you want to add other criteria, to e.g. have a folder for all songs recorded in 1976, you have to do a little more work. See the following page for instructions on creating your own search criteria: http://plone.org/documentation/how-to/using-topics Directory Layout ---------------- Please note that this product is just a Zope 2 integration layer for the ``p4a.image`` and ``p4a.ploneimage`` python packages. See the actual python package directories within the ``$INSTANCE_HOME/Products/Plone4ArtistsImage/pythonlib`` directory for further details. Testing ------- To run the Plone4ArtistsImage tests you must use the standard Zope testrunner:: $INSTANCE_HOME/bin/zopectl test -s Products.Plone4ArtistsImage