Skip to main content

Carousel allows you to add user-configurable rotating banners to any section of a Plone site.

Project description


Carousel is a tool for featuring a rotating set of banner images in any section of your Plone site. Features:

  • Different sets of banners can be used in different sections of the site.

  • Banners can link to another page in the site, or an external URL.

  • Banners rotate via a simple fade effect every 8 seconds. This is implemented using the jQuery javascript library which is included with Plone, so it’s pretty lightweight.

  • Clicking on the title of a banner jumps to it immediately.

  • Images will not rotate while the mouse cursor is hovering over the Carousel.


Carousel requires Plone 3.0 or greater, mainly because it renders itself in a viewlet.


Add Products.Carousel to your buildout’s list of eggs, and re-run buildout.

Start up Zope and go to Site Setup, Add-on Products in your Plone site, and install the Carousel product.

Detailed overview and tests

Viewing the banners

Now if we return to the home page, where we initially configured the banners, the banner we just added should be rendered (before the tabs):

>>> browser.contents
...Pirates and Cowboys...

Adding banners in other scenarios

Non-structural folder - put the carousel in the containing folder

>>> self.setRoles(['Manager'])
>>> self.portal.invokeFactory('Folder', 'nonstructural')
>>> from zope.interface import alsoProvides
>>> from Products.CMFPlone.interfaces import INonStructuralFolder
>>> alsoProvides(self.portal.nonstructural, INonStructuralFolder)
>>> browser.getLink('Configure banners').click()
>>> browser.url

Collection, not default item - put the carousel in the collection itself

>>> self.portal.invokeFactory('Topic', 'topic')
>>> browser.getLink('Configure banners').click()
>>> browser.url

Collection, as default item – put the carousel in the containing folder

>>> self.portal.default_page = 'topic'
>>> browser.getLink('Configure banners').click()
>>> browser.url

Change history


1.1 (2010-03-26)

  • In Plone 4, add viewlet to the abovecontent viewlet manager by default, to avoid weird styles. [davisagli]

  • Added Spanish translation. [tzicatl]

  • Only show published banners in the Carousel, even for users who have permission to see others. [davisagli]

1.0 (2009-03-31)

  • Changed behavior of text links to swap banner on mouseover. [davisagli]

1.0b3 (2009-02-07)

  • Add ‘Carousel Banner’ to types not searched. [davisagli]

  • Locate carousel folder correctly on containers used as default pages (e.g. a Topic) [davisagli]

  • Apply proper security declarations to the getSize and tag methods of the banner type so that the view works okay when customized TTW. [davisagli]

  • Only display the carousel on default view; not any of the other tabs. [davisagli]

  • Fix viewlet removal on uninstallation. [davisagli]

  • Fix duplicate entries in quick installer. [davisagli]

1.0b2 (2009-02-04)

  • Declare dependency of our custom GS import step on the viewlets step. [davisagli]

  • Separate the (globally-registered) template from the (locally-registered) viewlet, so that the former can be customized using portal_view_customizations. [davisagli]

  • Added banner description to the template. Changed the ‘carousel-title’ class to ‘carousel-button’ so I could split out ‘carousel-title’ and ‘carousel-description’. [davisagli]

  • Handle non-structural folders correctly. [davisagli]

1.0b1 (2009-02-03)

  • Initial release. [davisagli]


  • David Glick [davisagli], Groundwire, Author

  • Matt Yoder [yomatters], Groundwire

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (42.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page