Skip to main content

Grokkers for plone.tiles

Project description

This package provides declarative configuration (grokkers) for the plone.tiles package.

https://secure.travis-ci.org/plone/plone.directives.tiles.png?branch=master

Usage

A basic tile is configured like this:

from five import grok
from plone.directives import tiles

from my.package import MyMessageFactory as _
from my.package.interfaces import IMyTileSchema

class MyTile(tiles.Tile):
    grok.context(IContext)
    grok.require('zope2.View')

    grok.name('my.tile')
    grok.title(_(u"My title"))
    grok.description(_(u"My description"))

    tiles.add_permission('mypackage.AddMyTile')
    tiles.schema(IMyTileSchema)

Notes

  • A persistent tile can be configured by deriving from PersistentTile instead of Tile.

  • The context(), requires(), name(), and layer() directives are used in the same way as they are for a view derived from grok.View.

  • Templates are associated using the same semantics as are used for views. For example, a tile in mytiles.py defined in the class MyTile would be associated with a template mytiles_templates/mytile.pt by default.

  • Unlike a view, the name() directive is required and should give a dotted name for the tile by convention.

  • Dictionary key access (__getitem__()) is defined to work as it does in a tile. In a standard grokked view, it will retrieve a macro from the template. In a tile, it is used as a traversal hook to set the tile id, and subsequently to look up views on the tile. See plone.tiles for details.

  • Similarly, standard grokked views have a url() method which can be used to construct a URL, possibly with query string parameters. For grokked tiles, this is replaced by a url read-only property, which returns the canonical tile URL, as per plone.tiles.

Changelog

1.2 (unreleased)

  • Use zope.interface decorators. [gforcada]

  • Change i18n domain. [thet]

  • Cleanup package. [maurits]

1.1 (2012-11-26)

  • Added icon directive to support plone.tiles >= 1.1. [datakurre]

1.0 (2012-06-23)

  • Initial release [garbas]

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.directives.tiles-1.2.tar.gz (5.8 kB view details)

Uploaded Source

File details

Details for the file plone.directives.tiles-1.2.tar.gz.

File metadata

File hashes

Hashes for plone.directives.tiles-1.2.tar.gz
Algorithm Hash digest
SHA256 b6423aa5fdad0890d9504817eeb31741079ae1a25086eda098294bfc1d4f256a
MD5 78aa9408808be6cea363291974894479
BLAKE2b-256 ff83f0dc60a3270fb9e8964613757459298459291d795c0059d588cf8bea6f0e

See more details on using hashes here.

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