Products.Carousel 1.0

Configuring a Carousel banner folder

The items displayed by Carousel are known as “Carousel Banners” and can exist within a “Carousel Folder” in any section of the site. For purposes of demonstration, let’s add a Carousel folder to the root of the site.

Carousel folders are a matter of configuration more than content, so they don’t appear on the Add menu. Instead, there is a ‘Configure banners’ tab. Clicking it while within a section that doesn’t yet have a Carousel folder will result in the creation of a new one:

>>> browser.open('http://nohost/plone')
>>> browser.getLink('Configure banners').click()
>>> browser.url
'http://nohost/plone/carousel'

The new folder should now provide the ICarouselFolder interface:

>>> from Products.Carousel.interfaces import ICarouselFolder
>>> ICarouselFolder.providedBy(self.portal.carousel)
True

If, on the other hand, we’re in a folder that already has a Carousel folder, the existing one will be used:

>>> browser.goBack()
>>> browser.getLink('Configure banners').click()
>>> browser.url
'http://nohost/plone/carousel'

And if we try to configure banners while we’re already doing so, nothing should change:

>>> browser.getLink('Configure banners').click()
>>> browser.url
'http://nohost/plone/carousel'

Adding a Carousel banner

Now that we’re within the Carousel folder, we can add a Carousel banner using the add menu:

>>> browser.getLink('Carousel Banner').click()
>>> browser.url
'http://nohost/plone/carousel/portal_factory/Carousel Banner/carousel_banner.../edit'

We can set various things including a title, target URL, and image:

>>> browser.getControl('Title').value = 'Pirates and Cowboys agree: Ninjas suck'
>>> browser.getControl('URL').value = 'http://www.plone.org'
>>> browser.getControl(name='image_file')
<Control name='image_file' type='file'>
>>> browser.getControl('Save').click()
>>> 'Changes saved.' in browser.contents
True

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.open('http://nohost/plone')
>>> browser.contents
<BLANKLINE>
...Pirates and Cowboys...
...class="contentViews"...

Adding banners in other scenarios

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

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

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

>>> self.portal.invokeFactory('Topic', 'topic')
'topic'
>>> browser.open('http://nohost/plone/topic')
>>> browser.getLink('Configure banners').click()
>>> browser.url
'http://nohost/plone/topic/carousel'

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

>>> self.portal.default_page = 'topic'
>>> browser.open('http://nohost/plone/topic')
>>> browser.getLink('Configure banners').click()
>>> browser.url
'http://nohost/plone/carousel'

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]