Metadata-Version: 1.0
Name: collective.templateengines
Version: 0.3.3
Summary: Template engine abstraction layer for Python
Home-page: http://www.twinapex.com/for-developers/open-source/for-plone/easy-template
Author: Mikko Ohtamaa
Author-email: mikko.ohtamaa@twinapex.com
License: License :: OSI Approved :: BSD License
Description: .. contents:: :depth: 2
        
        collective.templateengines  is an template engine abstraction layer for Python.
        It defines generic Zope interfaces for communicating with various Python template engines
        to achieve higher code reuse value.
        
        This package is still much in development. All contributions and comments are welcome.
        
        Features
        --------
        
        collective.templateengines helps you to achieve
        
        * Easy, pluggable, template language switching. Write template tag code only once and use it across all template engines
        using abstracted tag plug-ings
        
        * Clean your codebase from template engine dependencies
        
        * Generic error and warning reporting mechanism across template engines
        
        * EGG deployment and easy_install support from PyPi repository
        
        * Interfaces defined using standard `Zope interfaces <http://wiki.zope.org/Interfaces/FrontPage>`_ package
        
        * Backends for Django template Language, Cheetah and Jinja2
        
        * Unit tests
        
        
        Motivation
        ----------
        
        All template engines have their shortcomings. Sooner or later you want to try yet another engine,
        or someone else wants to use another template engine within your project. This package
        is aimed to make that transition as smooth as possible.
        
        Installation
        ------------
        
        - Install collective.templateengines egg
        
        - Install any of following template engine eggs: Django, Jinja2, Cheetah
        
        Usage
        -----
        
        Please take a look on `collective.easytemplate <http://plone.org/products/easy-template>`_ package how to support switching
        between template engines and registering tags for them.
        
        The following example shows how one can switch between Django and Cheetah template engines with one line of change.
        Naturally, the templates themselves need to be refactored.
        
        Cheetah::
        
        from collective.templateengines.backends import cheetah
        
        engine = cheetah.Engine()
        context = DictionaryContext({"foo":"bar"})
        template, syntax_errors = engine.loadString("Show variable $foo", False)
        result, evaluation_errors = template.evaluate(context)
        
        Django::
        
        from collective.templateengines.backends import djangotemplates
        
        engine = djangotemplates.Engine()
        context = DictionaryContext({"foo":"bar"})
        template, syntax_errors = engine.loadString("Show variable {{ foo }}", False)
        result, evaluation_errors = template.evaluate(context)
        
        
        Tags
        ----
        
        collective.templateengine uses term tag to refer to functions which you can use in the template engine context.
        In the future tags are indended to be expanded to cover template language structures as well.
        
        collective.templateengines does not come with any tags out of the box. To define tags, I recommend
        you to take a look on collective.easytemplate package.
        
        - Tags provide collective.templateengines.interfaces.ITag interface
        
        - Tags are registered to the template engine using Engine.addTag() function.
        
        
        Problems
        --------
        
        * Cheetah architecture lacks separate exposed compiling and evaluating phases
        
        * Cheetah exposes the full Python namespace to templates by default, making it hard to secure it
        
        * Cheetah cannot traverse Zope functions or attributes
        
        Examples
        --------
        
        Python Template Engines is used in
        
        * `Easy Template product <http://plone.org/products/easy-template>`_ for Plone.
        
        Links
        -----
        
        `Jinja2 template engines <http://jinja.pocoo.org/2/>`_
        
        `Django templates <http://docs.djangoproject.com/en/dev/ref/templates/>`_
        
        `Cheetah template engine <http://www.cheetahtemplate.org/>`_
        
        
        Author
        ------
        
        `Twinapex Team <mailto:info@twinapex.com>`_ - Python and Plone professionals for hire.
        
        * `Twinapex company site <http://www.twinapex.com>`_ (`Twinapex-yritysryhmä <http://www.twinapex.fi>`_)
        
        * `Twinapex company blog <http://blog.twinapex.fi>`_
        
        * `Twinapex mobile site <http://www.twinapex.mobi>`_
        
        * `More about Plone <http://www.twinapex.com/products/plone>`_ (`Lisätietoja Plone-julkaisujärjestelmästä <http://www.twinapex.fi/tuotteet/plone>`_)
        
        * `Other open source Plone products by Twinapex <http://www.twinapex.com/for-developers/open-source/for-plone>`_
        
        
        Changelog
        ---------
        
        0.3.2 - 0.3.3
        =============
        
        * Fixed lots of corner cases with Plone template contexts which were causing exceptions
        
        0.3.1 - 0.3.2
        =============
        
        * Fixed unicode problems with Archetypes accessors
        
        * Documentation clean ups
        
        
        0.3.0 - 0.3.1
        =============
        
        * Fixed problem in plone.py with problematic Archetypes schema fields
        
        0.1.1 - 0.3.0
        =============
        
        * Major rework
        
        0.1 - 0.1.1
        =============
        
        * Fixing PyPi deployment problems
        
        0.1
        =============
        
        * Initial release
        
        
Keywords: template templates engine python interface zope cheetah django backend utils generic
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
