Skip to main content

Tools for managing themes in CMF and Plone sites

Project description

Overview

Tools for managing themes in CMF and Plone sites.

plone.theme

This package lets you mark the request with a “layer” interface conditional on the currently selected skin (theme) in the portal_skins tool.

Most Zope 3 “visual” directives, like <browser:page /> or <browser:viewlet /> accept a ‘layer’ attribute, which should point to an interface. Recall that a view is a multi-adapter on (context, request). Most views are registered so that the ‘request’ being adapted only needs to provide Interface. This is equivalent to saying layer=”*”.

By applying a marker interface to the request, and registering a view or viewlet with this interface as the adapted ‘layer’, we can override a more general view, or make a viewlet that is only shown for a particular layer.

In the context of CMF and Plone, we’d like to tie the layer to the current skin selection. We do that by name.

What you have to do

First, you should create a marker interface:

>>> from zope.interface import Interface
>>> class IMyTheme(Interface):
...     """Marker interface for skins part of 'My Theme'
...     """

Then, register this as a theme layer in ZCML:

<interface

interface=”.interfaces.IMyTheme” type=”zope.publisher.interfaces.browser.IBrowserSkinType” name=”My Theme” />

The title here must match the name of the theme/skin selection in portal_skins.

How it works

Behind the scenes, the <interface /> registration marks IMyTheme with the “IInterface” IThemelayer, and registers IMyTheme as a utility named “My Theme” and providing IBrowserSkinType.

We do something to this effect in tests/tests.zcml.

Let us define the “My Theme” skin selection:

>>> from Products.CMFCore.utils import getToolByName
>>> portal_skins = getToolByName(layer['portal'], 'portal_skins')
>>> default_skin = portal_skins.getDefaultSkin()
>>> skin_path = portal_skins._getSelections()[default_skin]
>>> portal_skins.addSkinSelection('My Theme', skin_path)

In tests/tests.zcml we have registered two version of a view called @@layer-test-view. One, for the default skin layer, simply outputs “Default”. The other outputs “My Theme”.

Before we turn on the skin, we will get the default view.

>>> from plone.testing.zope import Browser
>>> browser = Browser(layer['app'])
>>> browser.open(layer['portal'].absolute_url() + '/@@layer-test-view')
>>> from __future__ import print_function
>>> print(browser.contents)
Default
...

However, if we turn the skin on, we should see the effects of the marker interface being applied.

>>> portal_skins.default_skin = 'My Theme'
>>> import transaction
>>> transaction.commit()
>>> browser.open(layer['portal'].absolute_url() + '/@@layer-test-view')
>>> print(browser.contents)
My Theme
...

And if we switch back:

>>> portal_skins.default_skin = 'Plone Default'
>>> transaction.commit()
>>> browser.open(layer['portal'].absolute_url() + '/@@layer-test-view')
>>> print(browser.contents)
Default
...

Changelog

4.0.3 (2025-01-23)

Bug fixes:

  • Fix DeprecationWarnings. [maurits] (#4090)

4.0.2 (2024-11-30)

Bug fixes:

  • Fix removed unittest.makeSuite in python 3.13. [petschki] (#27)

4.0.1 (2023-10-07)

Internal:

  • Update configuration files. [plone devs] (cfffba8c)

4.0.0 (2023-04-27)

Breaking changes:

  • Drop Python 2 and Plone 5.2 support. [gforcada] (#6)

Internal:

  • Update configuration files. [plone devs] (2a4ba395)

3.0.7 (2020-04-22)

Bug fixes:

  • Minor packaging updates. (#1)

3.0.6 (2018-06-20)

Bug fixes:

  • Tests run on Python 3 [ale-rt]

3.0.5 (2018-04-04)

Bug fixes:

  • Handle case where we get no skinname in Zope4. [pbauer]

3.0.4 (2018-03-10)

Bug fixes:

  • Minor administrativa fixes. [gforcada]

3.0.3 (2017-07-03)

Bug fixes:

  • removed unittest2 dependency [kakshay21]

3.0.2 (2017-02-05)

Bug fixes:

  • Fixed test when using Zope 4. [maurits]

3.0.1 (2016-11-17)

Fixes:

  • Remove ZopeTestCase traces. [gforcada]

3.0.0 (2015-06-10)

  • 3.x is plone 5 only [vangheem]

2.1.4 (2015-04-28)

  • Remove dependency on CMFDefault [tomgross]

2.1.3 (2015-03-27)

  • Test layer is testing layer. [bloodbare]

2.1.2 (2015-03-21)

  • Move tests from PloneTestCase to plone.app.testing. [sdelcourt,timo]

2.1.1 (2014-03-02)

  • Remove hard dependency on CMFDefault. [davisagli]

2.1 - 2011-05-12

  • Update to import BeforeTraverseEvent from zope.traversing instead of zope.app.publication. [davisagli]

  • Add MANIFEST.in. [WouterVH]

2.0 - 2010-07-18

  • Update license to GPL version 2 only. [hannosch]

2.0b2 - 2010-03-05

  • Protect against running multiple times. This can happen when using ++skin++ traversers or VirtualHostMonster. [wichert]

2.0b1 - 2010-01-02

  • Fix an error introduced by my previous adjustment. If a skin layer extending the default layer was used (which is typical), then the default layer would end up with higher precedence than browser layers not extending the default layer. [davisagli]

2.0a2 - 2009-11-13

  • Inherit from the CMFDefault layer again, for compatibility with products that depend only on CMF but are also usable within Plone, and register views to the CMFDefault layer. [davisagli]

2.0a1 - 2009-04-05

  • Avoid inheriting from the CMFDefault browser layer and rather define our own. We don’t have anything in common with the CMFDefault layer. [hannosch]

  • Declare test dependencies in an extra. [hannosch]

  • Specify package dependencies. [hannosch]

1.1 - 2009-04-04

  • Make sure the theme layer takes precedence over other browser layers. [davisagli]

1.0 - 2007-08-15

  • First stable release [wichert]

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

plone_theme-4.0.3.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

plone.theme-4.0.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file plone_theme-4.0.3.tar.gz.

File metadata

  • Download URL: plone_theme-4.0.3.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.1

File hashes

Hashes for plone_theme-4.0.3.tar.gz
Algorithm Hash digest
SHA256 7bea16c0539238b06f4470d6040ab726686260c335291349b2c6685860748cd4
MD5 73c39e0019c36779ea3c104b37ce3771
BLAKE2b-256 0cc2803e776ee6f3de6a0de7b3333996416ca7b4829088c42d57c6f6aef2a33c

See more details on using hashes here.

File details

Details for the file plone.theme-4.0.3-py3-none-any.whl.

File metadata

  • Download URL: plone.theme-4.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.1

File hashes

Hashes for plone.theme-4.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb9509dd76db94a368c60bc39dfbe5240558002f810f5ef75b2d1fca7302bf1
MD5 6155aef8ecb03c1769f7ffe721b6b3eb
BLAKE2b-256 4837d97099c056413346fe58227a5ecfd61eedb93789ef07042331e6a9554922

See more details on using hashes here.

Supported by

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