summaryrefslogtreecommitdiff
path: root/docs/intro.rst
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2008-05-26 12:07:44 +0200
committerArmin Ronacher <armin.ronacher@active-4.com>2008-05-26 12:07:44 +0200
commit61a5a24a51db49073a122ad9959d0950befa2e9d (patch)
tree82e77f6538fa0a16ddd4c86d550085e3904c6cd2 /docs/intro.rst
parent0c4f75795f9be2970982dddb59ca10dba7ca1cbd (diff)
downloadjinja2-61a5a24a51db49073a122ad9959d0950befa2e9d.tar.gz
fixed a bug in error reporting and some small documentation updates
--HG-- branch : trunk
Diffstat (limited to 'docs/intro.rst')
-rw-r--r--docs/intro.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/intro.rst b/docs/intro.rst
index ffb6839..abb8853 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -34,7 +34,8 @@ Prerequisites
Jinja2 needs at least **Python 2.4** to run. Additionally a working C-compiler
that can create python extensions should be installed for the debugger. If no
-C-compiler is available the `ctypes`_ module should be installed.
+C-compiler is available and you are using Python 2.4 the `ctypes`_ module
+should be installed.
.. _ctypes: http://python.net/crew/theller/ctypes/
@@ -97,8 +98,9 @@ Basic API Usage
This section gives you a brief introduction to the Python API for Jinja2 templates.
The most basic way to create a template and render it is through
-:class:`Template`. This however is not the recommended way to work with it,
-but the easiest
+:class:`Template`. This however is not the recommended way to work with it if
+your templates are not loaded from strings but the file system or another data
+source:
>>> from jinja2 import Template
>>> template = Template('Hello {{ name }}!')
@@ -110,3 +112,7 @@ object that provides a method called :meth:`~Template.render` which when
called with a dict or keyword arguments expands the template. The dict
or keywords arguments passed to the template are the so-called "context"
of the template.
+
+What you can see here is that Jinja2 is using unicode internally and the
+return value is an unicode string. So make sure that your application is
+indeed using unicode internally.