docs/templates.rst

   1 Template Designer Documentation
   2 ===============================
   3
   4 .. highlight:: html+jinja
   5
   6 This document describes the syntax and semantics of the template engine and
   7 will be most useful as reference to those creating Jinja templates.  As the
   8 template engine is very flexible the configuration from the application might
   9 be slightly different from here in terms of delimiters and behavior of
  10 undefined values.
  11
  12
  13 Synopsis
  14 --------
  15
  16 A template is simply a text file.  It can generate any text-based format
  17 (HTML, XML, CSV, LaTeX, etc.).  It doesn't have a specific extension,
  18 ``.html`` or ``.xml`` are just fine.
  19
  20 A template contains **variables** or **expressions**, which get replaced with
  21 values when the template is evaluated, and tags, which control the logic of
  22 the template.  The template syntax is heavily inspired by Django and Python.
  23
  24 Below is a minimal template that illustrates a few basics.  We will cover
  25 the details later in that document::
  26
  27     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
  28     <html lang="en">
  29     <head>
  30         <title>My Webpage</title>
  31     </head>
  32     <body>
  33         <ul id="navigation">
  34         {% for item in navigation %}
  35             <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
  36         {% endfor %}
  37         </ul>
  38
  39         <h1>My Webpage</h1>
  40         {{ a_variable }}
  41     </body>
  42     </html>
  43
  44 This covers the default settings.  The application developer might have
  45 changed the syntax from ``{% foo %}`` to ``<% foo %>`` or something similar.
  46
  47 There are two kinds of delimiers. ``{% ... %}`` and ``{{ ... }}``.  The first
  48 one is used to execute statements such as for-loops or assign values, the
  49 latter prints the result of the expression to the template.
  50
  51 .. _variables:
  52
  53 Variables
  54 ---------
  55
  56 The application passes variables to the templates you can mess around in the
  57 template.  Variables may have attributes or elements on them you can access
  58 too.  How a variable looks like, heavily depends on the application providing
  59 those.
  60
  61 You can use a dot (``.``) to access attributes of a variable, alternative the
  62 so-called "subscribe" syntax (``[]``) can be used.  The following lines do
  63 the same::
  64
  65     {{ foo.bar }}
  66     {{ foo['bar'] }}
  67
  68 It's important to know that the curly braces are *not* part of the variable
  69 but the print statement.  If you access variables inside tags don't put the
  70 braces around.
  71
  72 If a variable or attribute does not exist you will get back an undefined
  73 value.  What you can do with that kind of value depends on the application
  74 configuration, the default behavior is that it evaluates to an empty string
  75 if printed and that you can iterate over it, but every other operation fails.
  76
  77 .. _filters:
  78
  79 Filters
  80 -------
  81
  82 Variables can by modified by **filters**.  Filters are separated from the
  83 variable by a pipe symbol (``|``) and may have optional arguments in
  84 parentheses.  Multiple filters can be chained.  The output of one filter is
  85 applied to the next.
  86
  87 ``{{ name|striptags|title }}`` for example will remove all HTML Tags from the
  88 `name` and title-cases it.  Filters that accept arguments have parentheses
  89 around the arguments, like a function call.  This example will join a list
  90 by spaces:  ``{{ list|join(', ') }}``.
  91
  92 The :ref:`builtin-filters` below describes all the builtin filters.
  93
  94 .. _tests:
  95
  96 Tests
  97 -----
  98
  99 Beside filters there are also so called "tests" available.  Tests can be used
 100 to test a variable against a common expression.  To test a variable or
 101 expression you add `is` plus the name of the test after the variable.  For
 102 example to find out if a variable is defined you can do ``name is defined``
 103 which will then return true or false depending on if `name` is defined.
 104
 105 Tests can accept arguments too.  If the test only takes one argument you can
 106 leave out the parentheses to group them.  For example the following two
 107 expressions do the same::
 108
 109     {% if loop.index is divisibleby 3 %}
 110     {% if loop.index is divisibleby(3) %}
 111
 112 The :ref:`builtin-tests` below describes all the builtin tests.
 113
 114
 115 Comments
 116 --------
 117
 118 To comment-out part of a line in a template, use the comment syntax which is
 119 by default set to ``{# ... #}``.  This is useful to comment out parts of the
 120 template for debugging or to add information for other template designers or
 121 yourself::
 122
 123     {# note: disabled template because we no longer user this
 124         {% for user in users %}
 125             ...
 126         {% endfor %}
 127     #}
 128
 129 .. _template-inheritance:
 130
 131 Template Inheritance
 132 --------------------
 133
 134 The most powerful part of Jinja is template inheritance. Template inheritance
 135 allows you to build a base "skeleton" template that contains all the common
 136 elements of your site and defines **blocks** that child templates can override.
 137
 138 Sounds complicated but is very basic. It's easiest to understand it by starting
 139 with an example.
 140
 141
 142 Base Template
 143 ~~~~~~~~~~~~~
 144
 145 This template, which we'll call ``base.html``, defines a simple HTML skeleton
 146 document that you might use for a simple two-column page. It's the job of
 147 "child" templates to fill the empty blocks with content::
 148
 149     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
 150     <html lang="en">
 151     <html xmlns="http://www.w3.org/1999/xhtml">
 152     <head>
 153         {% block head %}
 154         <link rel="stylesheet" href="style.css" />
 155         <title>{% block title %}{% endblock %} - My Webpage</title>
 156         {% endblock %}
 157     </head>
 158     <body>
 159         <div id="content">{% block content %}{% endblock %}</div>
 160         <div id="footer">
 161             {% block footer %}
 162             &copy; Copyright 2008 by <a href="http://domain.invalid/">you</a>.
 163             {% endblock %}
 164         </div>
 165     </body>
 166
 167 In this example, the ``{% block %}`` tags define four blocks that child templates
 168 can fill in. All the `block` tag does is to tell the template engine that a
 169 child template may override those portions of the template.
 170
 171 Child Template
 172 ~~~~~~~~~~~~~~
 173
 174 A child template might look like this::
 175
 176     {% extends "base.html" %}
 177     {% block title %}Index{% endblock %}
 178     {% block head %}
 179         {{ super() }}
 180         <style type="text/css">
 181             .important { color: #336699; }
 182         </style>
 183     {% endblock %}
 184     {% block content %}
 185         <h1>Index</h1>
 186         <p class="important">
 187           Welcome on my awsome homepage.
 188         </p>
 189     {% endblock %}
 190
 191 The ``{% extends %}`` tag is the key here. It tells the template engine that
 192 this template "extends" another template.  When the template system evaluates
 193 this template, first it locates the parent.  The extends tag should be the
 194 first tag in the template.  Everything before it is printed out normally and
 195 may cause confusion.
 196
 197 The filename of the template depends on the template loader.  For example the
 198 :class:`FileSystemLoader` allows you to access other templates by giving the
 199 filename.  You can access templates in subdirectories with an slash::
 200
 201     {% extends "layout/default.html" %}
 202
 203 But this behavior can depend on the application embedding Jinja.  Note that
 204 since the child template doesn't define the ``footer`` block, the value from
 205 the parent template is used instead.
 206
 207 You can't define multiple ``{% block %}`` tags with the same name in the
 208 same template.  This limitation exists because a block tag works in "both"
 209 directions.  That is, a block tag doesn't just provide a hole to fill - it
 210 also defines the content that fills the hole in the *parent*.  If there
 211 were two similarly-named ``{% block %}`` tags in a template, that template's
 212 parent wouldn't know which one of the blocks' content to use.
 213
 214 If you want to print a block multiple times you can however use the special
 215 `self` variable and call the block with that name::
 216
 217     <title>{% block title %}{% endblock %}</title>
 218     <h1>{{ self.title() }}</h1>
 219     {% block body %}{% endblock %}
 220
 221
 222 Unlike Python Jinja does not support multiple inheritance.  So you can only have
 223 one extends tag called per rendering.
 224
 225
 226 Super Blocks
 227 ~~~~~~~~~~~~
 228
 229 It's possible to render the contents of the parent block by calling `super`.
 230 This gives back the results of the parent block::
 231
 232     {% block sidebar %}
 233         <h3>Table Of Contents</h3>
 234         ...
 235         {{ super() }}
 236     {% endblock %}
 237
 238
 239 HTML Escaping
 240 -------------
 241
 242 When generating HTML from templates, there's always a risk that a variable will
 243 include characters that affect the resulting HTML.  There are two approaches:
 244 manually escaping each variable or automatically escaping everything by default.
 245
 246 Jinja supports both, but what is used depends on the application configuration.
 247 The default configuaration is no automatic escaping for various reasons:
 248
 249 -   escaping everything except of safe values will also mean that Jinja is
 250     escaping variables known to not include HTML such as numbers which is
 251     a huge performance hit.
 252
 253 -   The information about the safety of a variable is very fragile.  It could
 254     happen that by coercing safe and unsafe values the return value is double
 255     escaped HTML.
 256
 257 Working with Manual Escaping
 258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 259
 260 If manual escaping is enabled it's **your** responsibility to escape
 261 variables if needed.  What to escape?  If you have a variable that *may*
 262 include any of the following chars (``>``, ``<``, ``&``, or ``"``) you
 263 **have to** escape it unless the variable contains well-formed and trusted
 264 HTML.  Escaping works by piping the variable through the ``|e`` filter:
 265 ``{{ user.username|e }}``.
 266
 267 Working with Automatic Escaping
 268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 269
 270 When automatic escaping is enabled everything is escaped by default except
 271 for values explicitly marked as safe.  Those can either be marked by the
 272 application or in the template by using the `|safe` filter.  The main
 273 problem with this approach is that Python itself doesn't have the concept
 274 of tainted values so the information if a value is safe or unsafe can get
 275 lost.  If the information is lost escaping will take place which means that
 276 you could end up with double escaped contents.
 277
 278 Double escaping is easy to avoid however, just rely on the tools Jinja2
 279 provides and don't use builtin Python constructs such as the string modulo
 280 operator.
 281
 282 Functions returning template data (macros, `super`, `self.BLOCKNAME`) return
 283 safe markup always.
 284
 285 String literals in templates with automatic escaping are considered unsafe
 286 too.  The reason for this is that the safe string is an extension to Python
 287 and not every library will work properly with it.
 288
 289
 290 List of Control Structures
 291 --------------------------
 292
 293 A control structure refers to all those things that control the flow of a
 294 program - conditionals (i.e. if/elif/else), for-loops, as well as things like
 295 macros and blocks.  Control structures appear inside ``{% ... %}`` blocks
 296 in the default syntax.
 297
 298 For
 299 ~~~
 300
 301 Loop over each item in a sequence.  For example, to display a list of users
 302 provided in a variable called `users`::
 303
 304     <h1>Members</h1>
 305     <ul>
 306     {% for user in users %}
 307       <li>{{ user.username|e }}</li>
 308     {% endfor %}
 309     </ul>
 310
 311 Inside of a for loop block you can access some special variables:
 312
 313 +-----------------------+---------------------------------------------------+
 314 | Variable              | Description                                       |
 315 +=======================+===================================================+
 316 | `loop.index`          | The current iteration of the loop. (1 indexed)    |
 317 +-----------------------+---------------------------------------------------+
 318 | `loop.index0`         | The current iteration of the loop. (0 indexed)    |
 319 +-----------------------+---------------------------------------------------+
 320 | `loop.revindex`       | The number of iterations from the end of the loop |
 321 |                       | (1 indexed)                                       |
 322 +-----------------------+---------------------------------------------------+
 323 | `loop.revindex0`      | The number of iterations from the end of the loop |
 324 |                       | (0 indexed)                                       |
 325 +-----------------------+---------------------------------------------------+
 326 | `loop.first`          | True if first iteration.                          |
 327 +-----------------------+---------------------------------------------------+
 328 | `loop.last`           | True if last iteration.                           |
 329 +-----------------------+---------------------------------------------------+
 330 | `loop.length`         | The number of items in the sequence.              |
 331 +-----------------------+---------------------------------------------------+
 332 | `loop.cycle`          | A helper function to cycle between a list of      |
 333 |                       | sequences.  See the explanation below.            |
 334 +-----------------------+---------------------------------------------------+
 335
 336 Within a for-loop, it's possible to cycle among a list of strings/variables
 337 each time through the loop by using the special `loop.cycle` helper::
 338
 339     {% for row in rows %}
 340         <li class="{{ loop.cycle('odd', 'even') }}">{{ row }}</li>
 341     {% endfor %}
 342
 343 .. _loop-filtering:
 344
 345 Unlike in Python it's not possible to `break` or `continue` in a loop.  You
 346 can however filter the sequence during iteration which allows you to skip
 347 items.  The following example skips all the users which are hidden::
 348
 349     {% for user in users if not user.hidden %}
 350         <li>{{ user.username|e }}</li>
 351     {% endfor %}
 352
 353 The advantage is that the special `loop` variable will count correctly thus
 354 not counting the users not iterated over.
 355
 356 If no iteration took place because the sequence was empty or the filtering
 357 removed all the items from the sequence you can render a replacement block
 358 by using `else`::
 359
 360     <ul>
 361     {% for user in users %}
 362         <li>{{ user.username|e }}</li>
 363     {% else %}
 364         <li><em>no users found</em></li>
 365     {% endif %}
 366     </ul>
 367
 368
 369 If
 370 ~~
 371
 372 The `if` statement in Jinja is comparable with the if statements of Python.
 373 In the simplest form you can use it to test if a variable is defined, not
 374 empty or not false::
 375
 376     {% if users %}
 377     <ul>
 378     {% for user in users %}
 379         <li>{{ user.username|e }}</li>
 380     {% endfor %}
 381     </ul>
 382     {% endif %}
 383
 384 For multiple branches `elif` and `else` can be used like in Python.  You can
 385 use more complex :ref:`expressions` there too::
 386
 387     {% if kenny.sick %}
 388         Kenny is sick.
 389     {% elif kenny.dead %}
 390         You killed Kenny!  You bastard!!!
 391     {% else %}
 392         Kenny looks okay --- so far
 393     {% endif %}
 394
 395 If can also be used as :ref:`inline expression <if-expression>` and for
 396 :ref:`loop filtering <loop-filtering>`.
 397
 398
 399 Macros
 400 ~~~~~~
 401
 402 Macros are comparable with functions in regular programming languages.  They
 403 are useful to put often used idioms into reusable functions to not repeat
 404 yourself.
 405
 406 Macros can be defined in helper templates which then are :ref:`imported
 407 <import>` or directly in the template where they are used.  There is one big
 408 difference between those two possibilities.  A macro that is defined in the
 409 template where it's also used has access to the context passed to the template.
 410 A macro defined in another template and then imported can only access variables
 411 defined there or in the global context.
 412
 413 Here a small example of a macro that renders a form element::
 414
 415     {% macro input(name, value='', type='text', size=20) -%}
 416         <input type="{{ type }}" name="{{ name }}" value="{{
 417             value|e }}" size="{{ size }}">
 418     {%- endmacro %}
 419
 420 The macro can then be called like a function in the namespace::
 421
 422     <p>{{ input('username') }}</p>
 423     <p>{{ input('password', type='password') }}</p>
 424
 425 If the macro was defined in a different template you have to
 426 :ref:`import <import>` it first.
 427
 428 Inside macros you have access to three special variables:
 429
 430 `varargs`
 431     If more positional arguments are passed to the macro than accepted by the
 432     macro they end up in the special `varargs` variable as list of values.
 433
 434 `kwargs`
 435     Like `varargs` but for keyword arguments.  All unconsumed keyword
 436     arguments are stored in this special variable.
 437
 438 `caller`
 439     If the macro was called from a :ref:`call<call>` tag the caller is stored
 440     in this variable as macro which can be called.
 441
 442 Macros also expose some of their internal details.  The following attributes
 443 are available on a macro object:
 444
 445 `name`
 446     The name of the macro.  ``{{ input.name }}`` will print ``input``.
 447
 448 `arguments`
 449     A tuple of the names of arguments the macro accepts.
 450
 451 `defaults`
 452     A tuple of default values.
 453
 454 `catch_kwargs`
 455     This is `true` if the macro accepts extra keyword arguments (ie: accesses
 456     the special `kwargs` variable).
 457
 458 `catch_varargs`
 459     This is `true` if the macro accepts extra positional arguments (ie:
 460     accesses the special `varargs` variable).
 461
 462 `caller`
 463     This is `true` if the macro accesses the special `caller` variable and may
 464     be called from a :ref:`call<call>` tag.
 465
 466
 467 .. _call:
 468
 469 Call
 470 ~~~~
 471
 472 In some cases it can be useful to pass a macro to another macro.  For this
 473 purpose you can use the special `call` block.  The following example shows
 474 a macro that takes advantage of the call functionality and how it can be
 475 used::
 476
 477     {% macro render_dialog(title, class='dialog') -%}
 478         <div class="{{ class }}">
 479             <h2>{{ title }}</h2>
 480             <div class="contents">
 481                 {{ caller() }}
 482             </div>
 483         </div>
 484     {%- endmacro %}
 485
 486     {% call render_dialog('Hello World') %}
 487         This is a simple dialog rendered by using a macro and
 488         a call block.
 489     {% endcall %}
 490
 491 It's also possible to pass arguments back to the call block.  This makes it
 492 useful as replacement for loops.  It is however not possible to call a
 493 call block with another call block.
 494
 495 Here an example of how a call block can be used with arguments::
 496
 497     {% macro dump_users(users) -%}
 498         <ul>
 499         {%- for user in users %}
 500             <li><p>{{ user.username|e }}</p>{{ caller(user) }}</li>
 501         {%- endfor %}
 502         </ul>
 503     {%- endmacro %}
 504
 505     {% call(user) dump_users(list_of_user) %}
 506         <dl>
 507             <dl>Realname</dl>
 508             <dd>{{ user.realname|e }}</dd>
 509             <dl>Description</dl>
 510             <dd>{{ user.description }}</dd>
 511         </dl>
 512     {% endcall %}
 513
 514
 515 Assignments
 516 ~~~~~~~~~~~
 517
 518 Inside code blocks you can also assign values to variables.  Assignments at
 519 top level (outside of blocks, macros or loops) are exported from the template
 520 like top level macros and can be imported by other templates.
 521
 522 Assignments are just written in code blocks like any other statement just
 523 without explicit keyword::
 524
 525     {% navigation = [('index.html', 'Index'), ('about.html', 'About')] %}
 526
 527
 528 Extends
 529 ~~~~~~~
 530
 531 The `extends` tag can be used to extend a template from another one.  You
 532 can have multiple of them in a file but only one of them may be executed
 533 at the time.  There is no support for multiple inheritance.  See the section
 534 about :ref:`template-inheritance` above.
 535
 536
 537 Block
 538 ~~~~~
 539
 540 Blocks are used for inheritance and act as placeholders and replacements
 541 at the same time.  They are documented in detail as part of the section
 542 about :ref:`template-inheritance`.
 543
 544
 545 Include
 546 ~~~~~~~
 547
 548 The `include` statement is useful to include a template and return the
 549 rendered contents of that file into the current namespace::
 550
 551     {% include 'header.html' %}
 552         Body
 553     {% include 'footer.html' %}
 554
 555 Included templates have access to the variables of the active context by
 556 default.  For more details about context behavior of imports and includes
 557 see :ref:`import-visibility`.
 558
 559 .. _import:
 560
 561 Import
 562 ~~~~~~
 563
 564 Jinja2 supports putting often used code into macros.  These macros can go into
 565 different templates and get imported from there.  This works similar to the
 566 import statements in Python.  It's important to know that imports are cached
 567 and imported templates don't have access to the current template variables,
 568 just the globals by defualt.  For more details about context behavior of
 569 imports and includes see :ref:`import-visibility`.
 570
 571 There are two ways to import templates.  You can import the complete template
 572 into a variable or request specific macros / exported variables from it.
 573
 574 Imagine we have a helper module that renders forms (called `forms.html`)::
 575
 576     {% macro input(name, value='', type='text') -%}
 577         <input type="{{ type }}" value="{{ value|e }}" name="{{ name }}">
 578     {%- endmacro %}
 579
 580     {%- macro textarea(name, value='', rows=10, cols=40) -%}
 581         <textarea name="{{ name }}" rows="{{ rows }}" cols="{{ cols
 582             }}">{{ value|e }}</textarea>
 583     {%- endmacro %}
 584
 585 The easiest and most flexible is importing the whole module into a variable.
 586 That way you can access the attributes::
 587
 588     {% import 'forms.html' as forms %}
 589     <dl>
 590         <dt>Username</dt>
 591         <dd>{{ forms.input('username') }}</dd>
 592         <dt>Password</dt>
 593         <dd>{{ forms.input('password', type='password') }}</dd>
 594     </dl>
 595     <p>{{ forms.textarea('comment') }}</p>
 596
 597
 598 Alternatively you can import names from the template into the current
 599 namespace::
 600
 601     {% from 'forms.html' import input as input_field, textarea %}
 602     <dl>
 603         <dt>Username</dt>
 604         <dd>{{ input_field('username') }}</dd>
 605         <dt>Password</dt>
 606         <dd>{{ input_field('password', type='password') }}</dd>
 607     </dl>
 608     <p>{{ textarea('comment') }}</p>
 609
 610
 611 .. _import-visibility:
 612
 613 Import Context Behavior
 614 -----------------------
 615
 616 Per default included templates are passed the current context and imported
 617 templates not.  The reason for this is that imports unlike includes are
 618 cached as imports are often used just as a module that holds macros.
 619
 620 This however can be changed of course explicitly.  By adding `with context`
 621 or `without context` to the import/include directive the current context
 622 can be passed to the template and caching is disabled automatically.
 623
 624 Here two examples::
 625
 626     {% from 'forms.html' import input with context %}
 627     {% include 'header.html' without context %}
 628
 629
 630 .. _expressions:
 631
 632 Expressions
 633 -----------
 634
 635 Jinja allows basic expressions everywhere.  These work very similar to regular
 636 Python and even if you're not working with Python you should feel comfortable
 637 with it.
 638
 639 Literals
 640 ~~~~~~~~
 641
 642 The simplest form of expressions are literals.  Literals are representations
 643 for Python objects such as strings and numbers.  The following literals exist:
 644
 645 "Hello World":
 646     Everything between two double or single quotes is a string.  They are
 647     useful whenever you need a string in the template (for example as
 648     arguments to function calls, filters or just to extend or include a
 649     template).
 650
 651 42 / 42.23:
 652     Integers and floating point numbers are created by just writing the
 653     number down.  If a dot is present the number is a float, otherwise an
 654     integer.  Keep in mind that for Python ``42`` and ``42.0`` is something
 655     different.
 656
 657 ['list', 'of', 'objects']:
 658     Everything between two brackets is a list.  Lists are useful to store
 659     sequential data in or to iterate over them.  For example you can easily
 660     create a list of links using lists and tuples with a for loop::
 661
 662         <ul>
 663         {% for href, caption in [('index.html', 'Index'), ('about.html', 'About'),
 664                                  ('downloads.html', 'Downloads')] %}
 665             <li><a href="{{ href }}">{{ caption }}</a></li>
 666         {% endfor %}
 667         </ul>
 668
 669 ('tuple', 'of', 'values'):
 670     Tuples are like lists, just that you can't modify them.  If the tuple
 671     only has one item you have to end it with a comma.  Tuples are usually
 672     used to represent items of two or more elements.  See the example above
 673     for more details.
 674
 675 {'dict': 'of', 'key': 'and', 'value': 'pairs'}:
 676     A dict in Python is a structure that combines keys and values.  Keys must
 677     be unique and always have exactly one value.  Dicts are rarely used in
 678     templates, they are useful in some rare cases such as the :func:`xmlattr`
 679     filter.
 680
 681 true / false:
 682     true is always true and false is always false.  Keep in mind that those
 683     literals are lowercase!
 684
 685 Math
 686 ~~~~
 687
 688 Jinja allows you to calculate with values.  This is rarely useful in templates
 689 but exists for completeness sake.  The following operators are supported:
 690
 691 \+
 692     Adds two objects with each other.  Usually numbers but if both objects are
 693     strings or lists you can concatenate them this way.  This however is not
 694     the preferred way to concatenate strings!  For string concatenation have
 695     a look at the ``~`` operator.  ``{{ 1 + 1 }}`` is ``2``.
 696
 697 \-
 698     Substract two numbers from each other.  ``{{ 3 - 2 }}`` is ``1``.
 699
 700 /
 701     Divide two numbers.  The return value will be a floating point number.
 702     ``{{ 1 / 2 }}`` is ``{{ 0.5 }}``.
 703
 704 //
 705     Divide two numbers and return the truncated integer result.
 706     ``{{ 20 / 7 }}`` is ``2``.
 707
 708 %
 709     Calculate the remainder of an integer division between the left and right
 710     operand.  ``{{ 11 % 7 }}`` is ``4``.
 711
 712 \*
 713     Multiply the left operand with the right one.  ``{{ 2 * 2 }}`` would
 714     return ``4``.  This can also be used to repeat string multiple times.
 715     ``{{ '=' * 80 }}`` would print a bar of 80 equal signs.
 716
 717 \**
 718     Raise the left operand to the power of the right operand.  ``{{ 2**3 }}``
 719     would return ``8``.
 720
 721 Logic
 722 ~~~~~
 723
 724 For `if` statements / `for` filtering or `if` expressions it can be useful to
 725 combine group multiple expressions:
 726
 727 and
 728     Return true if the left and the right operand is true.
 729
 730 or
 731     Return true if the left or the right operand is true.
 732
 733 not
 734     negate a statement (see below).
 735
 736 (expr)
 737     group an expression.
 738
 739 Note that there is no support for any bit operations or something similar.
 740
 741 -   special note regarding ``not``: The ``is`` and ``in`` operators support
 742     negation using an infix notation too: ``foo is not bar`` and
 743     ``foo not in bar`` instead of ``not foo is bar`` and ``not foo in bar``.
 744     All other expressions require a prefix notation: ``not (foo and bar).``
 745
 746
 747 Other Operators
 748 ~~~~~~~~~~~~~~~
 749
 750 The following operators are very useful but don't fit into any of the other
 751 two categories:
 752
 753 in
 754     Perform sequence / mapping containment test.  Returns true if the left
 755     operand is contained in the right.  ``{{ 1 in [1, 2, 3] }}`` would for
 756     example return true.
 757
 758 is
 759     Performs a :ref:`test <tests>`.
 760
 761 \|
 762     Applies a :ref:`filter <filters>`.
 763
 764 ~
 765     Converts all operands into strings and concatenates them.
 766     ``{{ "Hello " ~ name ~ "!" }}`` would return (assuming `name` is
 767     ``'John'``) ``Hello John!``.
 768
 769 ()
 770     Call a callable: ``{{ post.render() }}``.  Inside of the parentheses you
 771     can use arguments and keyword arguments like in python:
 772     ``{{ post.render(user, full=true) }}``.
 773
 774 . / []
 775     Get an attribute of an object.  (See :ref:`variables`)
 776
 777
 778 .. _if-expression:
 779
 780 If Expression
 781 ~~~~~~~~~~~~~
 782
 783 It is also possible to use inline `if` expressions.  These are useful in some
 784 situations.  For example you can use this to extend from one template if a
 785 variable is defined, otherwise from the default layout template::
 786
 787     {% extends layout_template if layout_template is defined else 'master.html' %}
 788
 789 The general syntax is ``<do something> if <something is true> else <do
 790 something else>``.
 791
 792
 793 .. _builtin-filters:
 794
 795 List of Builtin Filters
 796 -----------------------
 797
 798 .. jinjafilters::
 799
 800
 801 .. _builtin-tests:
 802
 803 List of Builtin Tests
 804 ---------------------
 805
 806 .. jinjatests::
 807
 808
 809 List of Global Functions
 810 ------------------------
 811
 812 The following functions are available in the global scope by default:
 813
 814 .. function:: range([start,] stop[, step])
 815
 816     Return a list containing an arithmetic progression of integers.
 817     range(i, j) returns [i, i+1, i+2, ..., j-1]; start (!) defaults to 0.
 818     When step is given, it specifies the increment (or decrement).
 819     For example, range(4) returns [0, 1, 2, 3].  The end point is omitted!
 820     These are exactly the valid indices for a list of 4 elements.
 821
 822     This is useful to repeat a template block multiple times for example
 823     to fill a list.  Imagine you have 7 users in the list but you want to
 824     render three empty items to enforce a height with CSS::
 825
 826         <ul>
 827         {% for user in users %}
 828             <li>{{ user.username }}</li>
 829         {% endfor %}
 830         {% for number in range(10 - users|count) %}
 831             <li class="empty"><span>...</span></li>
 832         {% endfor %}
 833         </ul>
 834
 835 .. function:: lipsum(n=5, html=True, min=20, max=100)
 836
 837     Generates some lorem ipsum for the template.  Per default five paragraphs
 838     with HTML are generated each paragraph between 20 and 100 words.  If html
 839     is disabled regular text is returned.  This is useful to generate simple
 840     contents for layout testing.
 841
 842 .. function:: dict(**items)
 843
 844     A convenient alternative to dict literals.  ``{'foo': 'bar'}`` is the same
 845     as ``dict(foo='bar')``.