collective.easyslideshow 3.0

An easy slideshow solution for Plone

Introduction

EasySlideshow is a Plone product that makes it easy for any content editor to create and manage online slideshows. It comes with all the settings you need to customize your slideshows, such as:

• Adjusting the delay between slide transitions;

• Managing the height/width of slideshow images;

• Controlling whether or not captions are shown with slides;

• Selecting whether or not users can pause the slideshow when cursor is hovering over the slideshow;

• Selecting slides timeout;

• Displaying navigation as numbers, titles, thumbnails, or not at all.

In order to create a slideshow, content editors just upload pictures to a regular folder, click the folder’s Action menu, and select Enable Slideshow. This transforms the regular folder into a slideshow folder, and automatically changes the folder display to a slideshow view. To modify the order in which the slideshow displays the images, content editors just need to reorder the pictures in the folder by dragging them up or down in the Contents tab.

Besides living in a dedicated folder, EasySlideshow also supports the ability to display images in a portlet (a.k.a. side box). Slideshows can actually be displayed in any template by calling the slideshow macro that ships with EasySlideshow.

While EasySlideshow’s global parameters are controlled via the Control Panel (log in, click Site Setup, and select EasySlideshow Configuration), content editors also have the ability to override the global settings for a specific slideshow directly at the folder level. This allows the use of EasySlideshow in multiple locations on your site without having to make the appearance and function of all slideshows the same.

EasySlideshow is Plone 4 compatible (Plone 3.3.x and up) and requires no custom installation, as it leverages the jQuery library that already ships with Plone. EasySlideshow uses fields already found in the Plone image type for presentation. The jQuery plugin that is the basis for this product is jQuery Cycle2.

Examples

Sites that use EasySlideshow include:

• ReTrans

• The Huck Institutes

• Drive Aluminum

• Simons Foundation Autism Research Initiative

• IEEE Information Theory Society

• Indiana Historical Society

• UVA Health System

Installation

• In your buildout.cfg, add collective.easyslideshow to the list of eggs within the [instance] section. The package is using z3c.autoinclude so there is no need to add it to zcml if you are using Plone 3.2+:

  [instance]
  eggs = collective.easyslideshow
  zcml = collective.easyslideshow

• Run buildout, and start up the instance

• Install collective.easyslideshow via portal_quickinstaller

NOTES: * version 2.1 requires Plone >= 4.1 * version 2.2 requires >= 4.3

Uninstall

• Uninstall collective.easyslideshow via portal_quickinstaller

• Existing slideshow folders will be fully reverted to normal folders

• Marker interfaces, layout, and annotations will be removed

• Slideshow portlets will be deleted

Upgrading to 3.x

When upgrading to EasySlideshow 3.0 or greater, you will need to first upgrade to 2.2. Version 2.2 removes dependencies on p4a.subtyper.

Steps for upgrading:

1. Install version 2.2 into your existing Lineage powered site

2. Go to the Plone Site Setup and from the Add-Ons panel click the button to upgrade EasySlideshow

3. Install version 3.x

4. Go to the Plone Site Setup and from the Add-Ons panel click the button to upgrade EasySlideshow

Use

• Create a folder in your site

• Once EasySlideshow has been installed, you will be able to subtype the folder so it becomes a slideshow folder, by clicking on Sub-types tab then selecting slideshow

• Add images into the folder

• The caption on top of the image in the slideshow displays each image’s Title and Description

• To link a slide to a page in your site, edit the image, click on the Categorization tab, and set a related link. Each slide can have its own related link.

• Properties can be changed either site wide or on each slideshow individually. Go to site setup to set the site wide properties. For changing the properties of individual slideshow, there is a slideshow tab available on each slideshow folder.

• A slideshow portlet is also available. Each portlet has its own settings, and displays the images from a folder that you choose.

• Images will be automatically resized to fit the height and width set in the slideshow properties, unless you choose to display them at their original size. White space will display to the right or bottom of images that do not match the width to height ratio of the slideshow.

Customization

• Slideshow appearance can be further modified by overriding slideshow_macros.pt

• The slideshow macro can be put into a custom template with the following code:

  <metal:block use-macro="here/slideshow_macros/macros/slideshow">
  slideshow here...
  </metal:block>

• When used on a custom template, the slideshow will look for images in a folder called Slideshow Folder (id slideshow-folder) at the same level as the page on which it will be displayed. The name of this folder can be modified within the macro.

• For more transition options, see the Cycle2 Download page http://malsup.com/jquery/cycle2/download/

• See http://malsup.com/jquery/cycle2 for further functions and customizations that can be used.

Changelog

2.2 (2015-02-06)

• Add upgrade step to remove p4a interfaces [cdw9]

• Update transition options, Cycle2 has less available by default [cdw9]

• Remove anything related to p4a. Allow slideshow folder to be enabled and disabled in actions menu [cdw9]

• Add new option to display images at full size instead of being resized, new option to display navigation as titles (uses image title) [cdw9]

• Remove skins, put everything into resource directories [cdw9]

• Upgrade to Cycle2. This requires jQuery 1.7+ (Plone 4.3+) [cdw9]

• Remove dependency on base_properties [cdw9]

2.1.2 (2013-06-03)

• Fixed bad calls in ZPT to find paths to images. [calvinhp]

2.1.1 (2013-06-02)

• Fixed Changelog to allow the rst to compile correctly. [calvinhp]

2.1 (2013-06-02)

• Fixed to be Plone 4.3 compatible with backward compatibility to Plone 4.1 [calvinhp]

• Added upgrade step to update the getRelatedLink index. NOTE: this upgrade step needs to be run so that the related item links continue to function. [davidblewett]

• set random_order setting to be imported in an upgrade step for sites migrating to latest Easy Slideshow. This way, slideshow folders will no longer error out. [cwainwright]

• added include for CMFCore permissions.zcml to avoid an error on certain versions of Plone [cwainwright]

2.0 (2012-02-10)

• added a randomize option to display the slides of a slideshow in random order [tbesluau]

• made quickinstall actually execute install/uninstall properly instead of simply running the default profile [claytron, tbesluau]

• handling removal of slideshow portlets when uninstalling [tbesluau]

• handling removal of marker interfaces and annotations on slideshow folders when uninstalling [tbesluau]

• updating README for uninstall instruction [cwainwright, tbesluau]

• testing/QA [clshaw01, elizabeth]

• migrated branch for adding i18n support and adding French translations [tbesluau]

• added option to display slideshow navigation as thumbnails. Options for displaying numbers or no navigation are still available [cwainwright]

• moved propertiestool.xml to initial profile, so that default profile doesn’t overwrite slideshow settings [cwainwright]

• utilize plone.app.imaging to resize images for display in the slideshows. Will use sizes set in individual slideshow properties. Applies to slideshow folders and portlets. refs #6 [cwainwright]

• Updated slideshow_folder_view for Plone 4: uses macro content-core, removed viewlet managers refs #3 [cwainwright]

• Fixed slideshow display for when javascript is disabled. Display the first slide, and make sure overflow is properly hidden. refs #2 [cwainwright]

• Compressed jquery-cycle.js [cwainwright]

• Updated colors/display of slideshow portlet navigation [cwainwright]

• Fixed slideshow portlet so that multiple portlets can be added, and all will function with their individual settings [cwainwright]

• Remove paste install as this was not working on windows and not needed for the product to function [claytron]

1.0 (2011-01-07)

• Fix up docs in preparation for 1.0 release. [claytron]

• Allowed for individual folders to have their own slideshow properties [tbesluau]

• Made CSS that removes content type images specific to just #slideshow [cwainwright]

• Added browser tests for the configlet [tbesluau]

• Added test for the SlideshowView getImages method and stub for getPortletImages. [davidblewett]

• Updated the change log format. [clayton]

• added version.txt in the collective/easyslideshow folder and modified setup.py to grab it automatically [tbesluau]

• fixed the portlet so it grabs the slideshow folder correctly [lucielejard]

• created an image for the easyslideshow configuration in site setup [cwainwright]

• moved propertiestool.xml into the initial profile [cwainwright]

• made the uninstall stop running on reinstall [tbesluau]

• updated the versioning style in metadata.xml [cwainwright]

• added cssregistry, jsregistry, portlets, and skins to the uninstall profile to ensure everything gets removed [cwainwright]

• cleaned up the README so it is valid reStructuredText [cwainwright]

• added installation instructions to the README [cwainwright]

• using z3c.autoinclude [tbesluau]

• wrote up some documentation on how to use the slideshow [cwainwright]

• removed insert-after=custom code. This generally causes a problem when easyslideshow is installed after the theme – the slideshow_macros override stops working. [cwainwright]

• Slideshow portlet. It is almost done, but I have not yet been successful in getting the selected folder to display its images in the slideshow. [cwainwright]

0.5 (2010-02-22)

• put in a condition on install - do not add the slideshow folder view to the display dropdown if it is already there [cwainwright]

• fixed the title property for the slideshow propertiestool.xml [cwainwright]

0.4 (2009-12-11)

• including docs from the egg to avoid errors on install [cwainwright]

0.2 (2009-10-23)

• changed up the way the slideshow_folder_view is made available, so that it gets run with the default profile instead of just an install. [cwainwright]

0.1 (2009-10-15)

• when easyslideshow is installed, slideshow_folder_view is made available from the display menu on a folder - on uninstall, slideshow_folder_view is removed from the display menu, and any folders using that view are reset to folder_listing [cwainwright]

• created an uninstall profile to remove the EasySlideshow Configuration from the control panel [cwainwright]

• added disclaimer about all images being the same size - fixed spacing on caption [cwainwright]

• changed the way the caption is positioned, so that it is always at the bottom of the slideshow container, no matter the image size - made the variable descriptions more descriptive [cwainwright]

• moved height and width variables to the template from CSS due to caching issues. [cwainwright]

• added a control panel for the slideshow via Site Setup for easy customization functionality [cwainwright]

• cleaned up slideshow_macro code - set the slideshow to be hidden until everything is loaded (to avoid all slides being seen before the slideshow has loaded) [cwainwright]

• moved the stylesheet and JS to the skins directory so that the stylesheet can use dtml. Also added dtml variables to the stylesheet so the slideshow will use colors set in base_properties. [cwainwright]

• fixed links to portal_url [cwainwright]

• make sure the index exists before searching/re-indexing [claytron]

• fixed interface path [claytron]

• don’t set options in skins.xml that aren’t changed - register skins recursively [claytron]

• initial import of a jquery based slideshow product [claytron]