Skip to main content

Persistent Cheetah templates

Project description

============================
Persistent Cheetah templates
============================

Features:

- Cheetah template engine,
- sources in filesystem,
- stored in ZODB,
- editable TTW, simple "$var" Cheetah syntax for non-technical user,
- able to testing in management web-form,
- able to reset from source.

Use cases:

- mail templates,
- editable HTML snippets and pages,
- other.


* Needed imports for these tests *

>>> import os, tempfile
>>> temp_dir = tempfile.mkdtemp()

>>> import zope.component
>>> import ice.template

>>> from zope.configuration import xmlconfig
>>> context = xmlconfig.file('meta.zcml', ice.template)


Create templates
----------------

1) Create source file using Cheetah syntax "$" for the variables::

>>> file = os.path.join(temp_dir, 'welcome.tmpl')

>>> open(file, 'w').write('''
... Dear $user_name!
... Welcome to $site_name!
... ''')

2) Register template::

>>> context = xmlconfig.string('''
... <configure
... xmlns="http://namespaces.zope.org/zope"
... xmlns:ice="http://namespaces.zope.org/ice"
... i18n_domain="test">
...
... <ice:template
... name="welcome"
... title="Welcome"
... storage="my-templates"
... source="%s"
... variables="user_name
... site_name"
... />
...
... </configure>
... ''' % file, context=context)


Create storage
--------------

Need create (one or more) local utility to store templates.
Note, the utility name used for lookup the storage::

>>> templates = ice.template.Templates()

>>> zope.component.provideUtility(
... templates, ice.template.ITemplates, 'my-templates')


Usage
-----

Use template::

>>> data = {'user_name':u'Bob', 'site_name':'www.gnu.org'}

>>> templates.compileTemplate('welcome', data)
'\n Dear Bob!\n Welcome to www.gnu.org!\n'


Manage templates
----------------

Looking all templates, registered for this storage::

>>> list(templates.getAllTemplates())
[(u'welcome', <ice.template.zcml.Template object at ...>)]

Get variables names::

>>> templates.getVariables('welcome')
[u'user_name', u'site_name']

Get template::

>>> templates.getTemplate('welcome')
'\n Dear $user_name!\n Welcome to $site_name!\n'

Edit template::

>>> templates.setTemplate('welcome', "$site_name for you, $user_name")

>>> templates.compileTemplate('welcome', data)
'www.gnu.org for you, Bob'

Reset from source::

>>> templates.resetTemplate('welcome')
'\n Dear $user_name!\n Welcome to $site_name!\n'

>>> templates.compileTemplate('welcome', data)
'\n Dear Bob!\n Welcome to www.gnu.org!\n'


Using property
--------------

Another way to use special property::

>>> class Pagelet(object):
...
... template = ice.template.PersistentTemplate('my-templates', 'welcome')
...
... def update(self):
... self.data = {'user_name':'Man', 'site_name':'www.python.com.ua'}
...
... def render(self):
... return self.template(self.data)

>>> view = Pagelet()
>>> view.update()
>>> view.render()
'\n Dear Man!\n Welcome to www.python.com.ua!\n'


Management UI
-------------

Management persistent Cheetah templates UI based on z3c.pagelet layers.

There are 3 views for management templates:

1) Listing of all storages.
2) Listing of all templates in a storage.
3) Edit form for given template, reload, testing, preview.

Actually, you need to do only one: register listing of all storages
pagelet using class ice.template.browser.storages.Pagelet (see example
in configure.zcml in ice.template.browser module), because (2) and (3)
are already registered. For examples, take a look configure.zcml
in ice.template.tests module.

=======
CHANGES
=======


Version 0.1.0 (2009-05-04)
--------------------------

- Initial release, this code is moved from common ice.app library.

Project details


Release history Release notifications

This version

0.1.0

Download files

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

Files for ice.template, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size ice.template-0.1.0-py2.4.egg (33.3 kB) File type Egg Python version 2.4 Upload date Hashes View
Filename, size ice.template-0.1.0.tar.gz (12.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page