ravi-patel/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

use Jinja name consistently

Browse source
This commit is contained in:
David Lord 2025-08-19 10:43:16 -07:00
parent 38b4c1e19b
commit d8259eb119
No known key found for this signature in database
GPG key ID: 43368A7AA8CC5926
9 changed files with 31 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/templating.rst
View file

@ -1,21 +1,21 @@
Templates
=========
Flask leverages Jinja2 as its template engine. You are obviously free to use
a different template engine, but you still have to install Jinja2 to run
Flask leverages Jinja as its template engine. You are obviously free to use
a different template engine, but you still have to install Jinja to run
Flask itself. This requirement is necessary to enable rich extensions.
An extension can depend on Jinja2 being present.
An extension can depend on Jinja being present.
This section only gives a very quick introduction into how Jinja2
This section only gives a very quick introduction into how Jinja
is integrated into Flask. If you want information on the template
engine's syntax itself, head over to the official `Jinja2 Template
engine's syntax itself, head over to the official `Jinja Template
Documentation <https://jinja.palletsprojects.com/templates/>`_ for
more information.
Jinja Setup
-----------
Unless customized, Jinja2 is configured by Flask as follows:
Unless customized, Jinja is configured by Flask as follows:
- autoescaping is enabled for all templates ending in ``.html``,
``.htm``, ``.xml``, ``.xhtml``, as well as ``.svg`` when using
@ -25,13 +25,13 @@ Unless customized, Jinja2 is configured by Flask as follows:
- a template has the ability to opt in/out autoescaping with the
``{% autoescape %}`` tag.
- Flask inserts a couple of global functions and helpers into the
Jinja2 context, additionally to the values that are present by
Jinja context, additionally to the values that are present by
default.
Standard Context
----------------
The following global variables are available within Jinja2 templates
The following global variables are available within Jinja templates
by default:
.. data:: config
@ -140,7 +140,7 @@ using in this block.
Registering Filters
-------------------
If you want to register your own filters in Jinja2 you have two ways to do
If you want to register your own filters in Jinja you have two ways to do
that. You can either put them by hand into the
:attr:`~flask.Flask.jinja_env` of the application or use the
:meth:`~flask.Flask.template_filter` decorator.
@ -157,7 +157,7 @@ The two following examples work the same and both reverse an object::
In case of the decorator the argument is optional if you want to use the
function name as name of the filter. Once registered, you can use the filter
in your templates in the same way as Jinja2's builtin filters, for example if
in your templates in the same way as Jinja's builtin filters, for example if
you have a Python list in context called `mylist`::
{% for x in mylist | reverse %}
@ -211,7 +211,7 @@ strings. This can be used for streaming HTML in chunks to speed up
initial page load, or to save memory when rendering a very large
template.
The Jinja2 template engine supports rendering a template piece
The Jinja template engine supports rendering a template piece
by piece, returning an iterator of strings. Flask provides the
:func:`~flask.stream_template` and :func:`~flask.stream_template_string`
functions to make this easier to use.