diff doc/customizing.txt @ 4619:d9254d300d6e

Add some notes about Chameleon in the documentation
author Cheer Xiao <xiaqqaix@gmail.com>
date Mon, 30 Apr 2012 17:28:04 +0800
parents c62c0f383e41
children bce631d8f24d
line wrap: on
line diff
--- a/doc/customizing.txt	Fri Apr 27 12:52:33 2012 +0800
+++ b/doc/customizing.txt	Mon Apr 30 17:28:04 2012 +0800
@@ -1642,11 +1642,42 @@
 ----------------------
 
 
+Templating engines
+~~~~~~~~~~~~~~~~~~
+
+Since version 1.4.20 Roundup supports two templating engines: the original
+`Template Attribute Language`_ (TAL) engine from Zope and the standalone
+Chameleon templating engine. Chameleon is intended as a replacement for the
+original TAL engine, and supports a syntax that is very similiar to the it,
+but they are not 100% compatible. The major (and most likely the only)
+incompatibility to worry about is the default expression type being
+``python:`` instead of ``path:``. See also "Incompatibilities and
+differences" section of `Chameleon documentation`__.
+
+**NOTE1**: For historical reasons, examples given below assumes path
+expression as default expression type. With Chameleon you have to manually
+resolve the path expressions. A Chameleon-based, z3c.pt, that is fully
+compatible with the old TAL implementation, is planned to be included in a
+future release.
+
+**NOTE2**: As of 1.4.20 Chameleon support is highly experimental and **not**
+recommended for production use.
+
+.. _Chameleon:
+   http://chameleon.repoze.org/
+.. _z3c.pt:
+   http://pypi.python.org/pypi/z3c.pt
+__ http://chameleon.repoze.org/docs/latest/reference.html#incompatibilities-and-differences
+.. _TAL:
+.. _Template Attribute Language:
+   http://dev.zope.org/Wikis/DevSite/Projects/ZPT/TAL%20Specification%201.4
+
+
 Basic Templating Actions
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 Roundup's templates consist of special attributes on the HTML tags.
-These attributes form the `Template Attribute Language`_, or TAL.
+These attributes form the **Template Attribute Language**, or TAL.
 The basic TAL commands are:
 
 **tal:define="variable expression; variable expression; ..."**
@@ -1743,10 +1774,6 @@
 for repeating multiple table rows, which would othewise require an
 illegal tag placement to effect the repeat).
 
-.. _TAL:
-.. _Template Attribute Language:
-   http://dev.zope.org/Wikis/DevSite/Projects/ZPT/TAL%20Specification%201.4
-
 
 Templating Expressions
 ~~~~~~~~~~~~~~~~~~~~~~

Roundup Issue Tracker: http://roundup-tracker.org/