Skip to content

Commit 0e9942b

Browse files
committed
Add some notes about Chameleon in the documentation
1 parent 5912edb commit 0e9942b

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

doc/customizing.txt

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1642,11 +1642,42 @@ How the templates work
16421642
----------------------
16431643

16441644

1645+
Templating engines
1646+
~~~~~~~~~~~~~~~~~~
1647+
1648+
Since version 1.4.20 Roundup supports two templating engines: the original
1649+
`Template Attribute Language`_ (TAL) engine from Zope and the standalone
1650+
Chameleon templating engine. Chameleon is intended as a replacement for the
1651+
original TAL engine, and supports a syntax that is very similiar to the it,
1652+
but they are not 100% compatible. The major (and most likely the only)
1653+
incompatibility to worry about is the default expression type being
1654+
``python:`` instead of ``path:``. See also "Incompatibilities and
1655+
differences" section of `Chameleon documentation`__.
1656+
1657+
**NOTE1**: For historical reasons, examples given below assumes path
1658+
expression as default expression type. With Chameleon you have to manually
1659+
resolve the path expressions. A Chameleon-based, z3c.pt, that is fully
1660+
compatible with the old TAL implementation, is planned to be included in a
1661+
future release.
1662+
1663+
**NOTE2**: As of 1.4.20 Chameleon support is highly experimental and **not**
1664+
recommended for production use.
1665+
1666+
.. _Chameleon:
1667+
http://chameleon.repoze.org/
1668+
.. _z3c.pt:
1669+
http://pypi.python.org/pypi/z3c.pt
1670+
__ http://chameleon.repoze.org/docs/latest/reference.html#incompatibilities-and-differences
1671+
.. _TAL:
1672+
.. _Template Attribute Language:
1673+
http://dev.zope.org/Wikis/DevSite/Projects/ZPT/TAL%20Specification%201.4
1674+
1675+
16451676
Basic Templating Actions
16461677
~~~~~~~~~~~~~~~~~~~~~~~~
16471678

16481679
Roundup's templates consist of special attributes on the HTML tags.
1649-
These attributes form the `Template Attribute Language`_, or TAL.
1680+
These attributes form the **Template Attribute Language**, or TAL.
16501681
The basic TAL commands are:
16511682

16521683
**tal:define="variable expression; variable expression; ..."**
@@ -1743,10 +1774,6 @@ making arbitrary blocks of HTML conditional or repeatable (very handy
17431774
for repeating multiple table rows, which would othewise require an
17441775
illegal tag placement to effect the repeat).
17451776

1746-
.. _TAL:
1747-
.. _Template Attribute Language:
1748-
http://dev.zope.org/Wikis/DevSite/Projects/ZPT/TAL%20Specification%201.4
1749-
17501777

17511778
Templating Expressions
17521779
~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)