· 8 years ago · Mar 02, 2018, 06:50 AM
1
2<!DOCTYPE html>
3<html lang="en">
4 <head>
5 <meta charset="utf-8">
6 <meta http-equiv="X-UA-Compatible" content="IE=edge">
7 <meta name="viewport" content="width=device-width, initial-scale=1">
8 <meta name="ROBOTS" content="ALL" />
9 <meta http-equiv="imagetoolbar" content="no" />
10 <meta name="MSSmartTagsPreventParsing" content="true" />
11 <meta name="Copyright" content="Django Software Foundation" />
12 <meta name="keywords" content="Python, Django, framework, open-source" />
13 <meta name="description" content="" />
14
15 <!-- Favicons -->
16 <link rel="apple-touch-icon" href="/s/img/icon-touch.e4872c4da341.png">
17 <link rel="icon" sizes="192x192" href="/s/img/icon-touch.e4872c4da341.png">
18 <link rel="shortcut icon" href="/s/img/favicon.6dbf28c0650e.ico">
19 <meta name="msapplication-TileColor" content="#113228">
20 <meta name="msapplication-TileImage" content="/s/img/icon-tile.b01ac0ef9f67.png">
21
22 <title>Built-in template tags and filters | Django documentation | Django</title>
23
24 <link rel="stylesheet" href="/s/css/output.eaf30ba6d68d.css" >
25 <script src="/s/js/lib/webfontloader/webfontloader.e75218f5f090.js"></script>
26 <script>
27 WebFont.load({
28 custom: {
29 families: ['FontAwesome', 'Fira+Mono'],
30 },
31 google: {
32 families: ['Roboto:400italic,700italic,300,700,400:latin'
33 ]
34 },
35 classes: false,
36 events: false,
37 timeout: 1000
38 });
39 </script>
40 <script src="/s/js/lib/modernizr.3b36762e418a.js"></script>
41
42
43
44
45
46
47 <link rel="canonical" href="https://docs.djangoproject.com/en/2.0/ref/templates/builtins/">
48
49
50 <link rel="search"
51 type="application/opensearchdescription+xml"
52 href="https://docs.djangoproject.com/en/1.11/search/description/"
53 title="Django documentation">
54
55 </head>
56
57 <body id="generic" class="">
58
59 <div role="banner" id="top">
60 <div class="container">
61 <a class="logo" href="https://www.djangoproject.com/">Django</a>
62 <p class="meta">The web framework for perfectionists with deadlines.</p>
63 <div role="navigation">
64 <ul>
65 <li>
66 <a href="https://www.djangoproject.com/start/overview/">Overview</a>
67 </li>
68 <li>
69 <a href="https://www.djangoproject.com/download/">Download</a>
70 </li>
71 <li class="active">
72 <a href="https://docs.djangoproject.com/">Documentation</a>
73 </li>
74 <li>
75 <a href="https://www.djangoproject.com/weblog/">News</a>
76 </li>
77 <li>
78 <a href="https://www.djangoproject.com/community/">Community</a>
79 </li>
80 <li>
81 <a href="https://code.djangoproject.com/">Code</a>
82 </li>
83 <li>
84 <a href="https://www.djangoproject.com/foundation/">About</a>
85 </li>
86 <li>
87 <a href="https://www.djangoproject.com/fundraising/">♥ Donate</a>
88 </li>
89 </ul>
90 </div>
91 </div>
92</div>
93
94
95 <div class="copy-banner">
96 <div class="container">
97
98 <h1><a href="https://docs.djangoproject.com/en/1.11/">Documentation</a></h1>
99
100 </div>
101 </div>
102 <div id="billboard"></div>
103
104 <div class="container sidebar-right">
105 <div role="main">
106
107
108
109
110
111
112<div id="version-switcher">
113 <ul id="doc-languages" class="language-switcher">
114
115
116 <li class="other">
117
118
119
120 <a href="https://docs.djangoproject.com/el/1.11/ref/templates/builtins/">el</a>
121 </li>
122
123
124
125
126
127 <li class="other">
128
129
130
131 <a href="https://docs.djangoproject.com/es/1.11/ref/templates/builtins/">es</a>
132 </li>
133
134
135
136 <li class="other">
137
138
139
140 <a href="https://docs.djangoproject.com/fr/1.11/ref/templates/builtins/">fr</a>
141 </li>
142
143
144
145 <li class="other">
146
147
148
149 <a href="https://docs.djangoproject.com/id/1.11/ref/templates/builtins/">id</a>
150 </li>
151
152
153
154 <li class="other">
155
156
157
158 <a href="https://docs.djangoproject.com/ja/1.11/ref/templates/builtins/">ja</a>
159 </li>
160
161
162
163 <li class="other">
164
165
166
167 <a href="https://docs.djangoproject.com/ko/1.11/ref/templates/builtins/">ko</a>
168 </li>
169
170
171
172 <li class="other">
173
174
175
176 <a href="https://docs.djangoproject.com/pl/1.11/ref/templates/builtins/">pl</a>
177 </li>
178
179
180
181 <li class="other">
182
183
184
185 <a href="https://docs.djangoproject.com/pt-br/1.11/ref/templates/builtins/">pt-br</a>
186 </li>
187
188
189 <li class="current"
190 title="Click on the links on the left to switch to another language.">
191 <span>Language: <strong>en</strong></span>
192 </li>
193 </ul>
194
195
196 <ul id="doc-versions" class="version-switcher">
197
198
199 <li class="other">
200
201
202
203 <a href="https://docs.djangoproject.com/en/1.7/ref/templates/builtins/">1.7</a>
204 </li>
205
206
207
208 <li class="other">
209
210
211
212 <a href="https://docs.djangoproject.com/en/1.8/ref/templates/builtins/">1.8</a>
213 </li>
214
215
216
217 <li class="other">
218
219
220
221 <a href="https://docs.djangoproject.com/en/1.9/ref/templates/builtins/">1.9</a>
222 </li>
223
224
225
226 <li class="other">
227
228
229
230 <a href="https://docs.djangoproject.com/en/1.10/ref/templates/builtins/">1.10</a>
231 </li>
232
233
234
235
236
237 <li class="other">
238
239
240
241 <a href="https://docs.djangoproject.com/en/2.0/ref/templates/builtins/">2.0</a>
242 </li>
243
244
245
246 <li class="other">
247
248
249
250 <a href="https://docs.djangoproject.com/en/dev/ref/templates/builtins/">dev</a>
251 </li>
252
253
254 <li class="current"
255 title="This document describes Django 1.11. Click on the links on the left to see other versions.">
256 <span>Documentation version:
257 <strong>1.11</strong>
258 </span>
259 </li>
260 </ul>
261</div>
262
263
264<div id="docs-content">
265<div class="section" id="s-built-in-template-tags-and-filters">
266<span id="built-in-template-tags-and-filters"></span><h1>Built-in template tags and filters<a class="headerlink" href="#built-in-template-tags-and-filters" title="Permalink to this headline">¶</a></h1>
267<p>This document describes Django’s built-in template tags and filters. It is
268recommended that you use the <a class="reference internal" href="../../contrib/admin/admindocs/"><span class="doc">automatic documentation</span></a>, if available, as this will also include
269documentation for any custom tags or filters installed.</p>
270<div class="section" id="s-built-in-tag-reference">
271<span id="s-ref-templates-builtins-tags"></span><span id="built-in-tag-reference"></span><span id="ref-templates-builtins-tags"></span><h2>Built-in tag reference<a class="headerlink" href="#built-in-tag-reference" title="Permalink to this headline">¶</a></h2>
272<div class="section" id="s-autoescape">
273<span id="s-std:templatetag-autoescape"></span><span id="autoescape"></span><span id="std:templatetag-autoescape"></span><h3><code class="docutils literal notranslate"><span class="pre">autoescape</span></code><a class="headerlink" href="#autoescape" title="Permalink to this headline">¶</a></h3>
274<p>Controls the current auto-escaping behavior. This tag takes either <code class="docutils literal notranslate"><span class="pre">on</span></code> or
275<code class="docutils literal notranslate"><span class="pre">off</span></code> as an argument and that determines whether auto-escaping is in effect
276inside the block. The block is closed with an <code class="docutils literal notranslate"><span class="pre">endautoescape</span></code> ending tag.</p>
277<p>When auto-escaping is in effect, all variable content has HTML escaping applied
278to it before placing the result into the output (but after any filters have
279been applied). This is equivalent to manually applying the <a class="reference internal" href="#std:templatefilter-escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">escape</span></code></a>
280filter to each variable.</p>
281<p>The only exceptions are variables that are already marked as “safe†from
282escaping, either by the code that populated the variable, or because it has had
283the <a class="reference internal" href="#std:templatefilter-safe"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">safe</span></code></a> or <a class="reference internal" href="#std:templatefilter-escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">escape</span></code></a> filters applied.</p>
284<p>Sample usage:</p>
285<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">autoescape</span> <span class="nv">on</span> <span class="cp">%}</span>
286 <span class="cp">{{</span> <span class="nv">body</span> <span class="cp">}}</span>
287<span class="cp">{%</span> <span class="k">endautoescape</span> <span class="cp">%}</span>
288</pre></div>
289</div>
290</div>
291<div class="section" id="s-block">
292<span id="s-std:templatetag-block"></span><span id="block"></span><span id="std:templatetag-block"></span><h3><code class="docutils literal notranslate"><span class="pre">block</span></code><a class="headerlink" href="#block" title="Permalink to this headline">¶</a></h3>
293<p>Defines a block that can be overridden by child templates. See
294<a class="reference internal" href="../language/#template-inheritance"><span class="std std-ref">Template inheritance</span></a> for more information.</p>
295</div>
296<div class="section" id="s-comment">
297<span id="s-std:templatetag-comment"></span><span id="comment"></span><span id="std:templatetag-comment"></span><h3><code class="docutils literal notranslate"><span class="pre">comment</span></code><a class="headerlink" href="#comment" title="Permalink to this headline">¶</a></h3>
298<p>Ignores everything between <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">comment</span> <span class="pre">%}</span></code> and <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">endcomment</span> <span class="pre">%}</span></code>.
299An optional note may be inserted in the first tag. For example, this is
300useful when commenting out code for documenting why the code was disabled.</p>
301<p>Sample usage:</p>
302<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">p</span><span class="p">></span>Rendered text with <span class="cp">{{</span> <span class="nv">pub_date</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"c"</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">p</span><span class="p">></span>
303<span class="cp">{%</span> <span class="k">comment</span> <span class="s2">"Optional note"</span> <span class="cp">%}</span>
304 <span class="p"><</span><span class="nt">p</span><span class="p">></span>Commented out text with <span class="cp">{{</span> <span class="nv">create_date</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"c"</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">p</span><span class="p">></span>
305<span class="cp">{%</span> <span class="k">endcomment</span> <span class="cp">%}</span>
306</pre></div>
307</div>
308<p><code class="docutils literal notranslate"><span class="pre">comment</span></code> tags cannot be nested.</p>
309</div>
310<div class="section" id="s-csrf-token">
311<span id="s-std:templatetag-csrf_token"></span><span id="csrf-token"></span><span id="std:templatetag-csrf_token"></span><h3><code class="docutils literal notranslate"><span class="pre">csrf_token</span></code><a class="headerlink" href="#csrf-token" title="Permalink to this headline">¶</a></h3>
312<p>This tag is used for CSRF protection, as described in the documentation for
313<a class="reference internal" href="../../csrf/"><span class="doc">Cross Site Request Forgeries</span></a>.</p>
314</div>
315<div class="section" id="s-cycle">
316<span id="s-std:templatetag-cycle"></span><span id="cycle"></span><span id="std:templatetag-cycle"></span><h3><code class="docutils literal notranslate"><span class="pre">cycle</span></code><a class="headerlink" href="#cycle" title="Permalink to this headline">¶</a></h3>
317<p>Produces one of its arguments each time this tag is encountered. The first
318argument is produced on the first encounter, the second argument on the second
319encounter, and so forth. Once all arguments are exhausted, the tag cycles to
320the first argument and produces it again.</p>
321<p>This tag is particularly useful in a loop:</p>
322<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">o</span> <span class="k">in</span> <span class="nv">some_list</span> <span class="cp">%}</span>
323 <span class="p"><</span><span class="nt">tr</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'row1'</span> <span class="s1">'row2'</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>
324 ...
325 <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
326<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
327</pre></div>
328</div>
329<p>The first iteration produces HTML that refers to class <code class="docutils literal notranslate"><span class="pre">row1</span></code>, the second to
330<code class="docutils literal notranslate"><span class="pre">row2</span></code>, the third to <code class="docutils literal notranslate"><span class="pre">row1</span></code> again, and so on for each iteration of the
331loop.</p>
332<p>You can use variables, too. For example, if you have two template variables,
333<code class="docutils literal notranslate"><span class="pre">rowvalue1</span></code> and <code class="docutils literal notranslate"><span class="pre">rowvalue2</span></code>, you can alternate between their values like
334this:</p>
335<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">o</span> <span class="k">in</span> <span class="nv">some_list</span> <span class="cp">%}</span>
336 <span class="p"><</span><span class="nt">tr</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="nv">rowvalue1</span> <span class="nv">rowvalue2</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>
337 ...
338 <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
339<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
340</pre></div>
341</div>
342<p>Variables included in the cycle will be escaped. You can disable auto-escaping
343with:</p>
344<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">o</span> <span class="k">in</span> <span class="nv">some_list</span> <span class="cp">%}</span>
345 <span class="p"><</span><span class="nt">tr</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">autoescape</span> <span class="nv">off</span> <span class="cp">%}{%</span> <span class="k">cycle</span> <span class="nv">rowvalue1</span> <span class="nv">rowvalue2</span> <span class="cp">%}{%</span> <span class="k">endautoescape</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>
346 ...
347 <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
348<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
349</pre></div>
350</div>
351<p>You can mix variables and strings:</p>
352<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">o</span> <span class="k">in</span> <span class="nv">some_list</span> <span class="cp">%}</span>
353 <span class="p"><</span><span class="nt">tr</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'row1'</span> <span class="nv">rowvalue2</span> <span class="s1">'row3'</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>
354 ...
355 <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
356<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
357</pre></div>
358</div>
359<p>In some cases you might want to refer to the current value of a cycle
360without advancing to the next value. To do this,
361just give the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">cycle</span> <span class="pre">%}</span></code> tag a name, using “asâ€, like this:</p>
362<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'row1'</span> <span class="s1">'row2'</span> <span class="k">as</span> <span class="nv">rowcolors</span> <span class="cp">%}</span>
363</pre></div>
364</div>
365<p>From then on, you can insert the current value of the cycle wherever you’d like
366in your template by referencing the cycle name as a context variable. If you
367want to move the cycle to the next value independently of the original
368<code class="docutils literal notranslate"><span class="pre">cycle</span></code> tag, you can use another <code class="docutils literal notranslate"><span class="pre">cycle</span></code> tag and specify the name of the
369variable. So, the following template:</p>
370<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">tr</span><span class="p">></span>
371 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'row1'</span> <span class="s1">'row2'</span> <span class="k">as</span> <span class="nv">rowcolors</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
372 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">rowcolors</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
373<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
374<span class="p"><</span><span class="nt">tr</span><span class="p">></span>
375 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="nv">rowcolors</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
376 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">rowcolors</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
377<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
378</pre></div>
379</div>
380<p>would output:</p>
381<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">tr</span><span class="p">></span>
382 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"row1"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
383 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"row1"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
384<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
385<span class="p"><</span><span class="nt">tr</span><span class="p">></span>
386 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"row2"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
387 <span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">"row2"</span><span class="p">></span>...<span class="p"></</span><span class="nt">td</span><span class="p">></span>
388<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
389</pre></div>
390</div>
391<p>You can use any number of values in a <code class="docutils literal notranslate"><span class="pre">cycle</span></code> tag, separated by spaces.
392Values enclosed in single quotes (<code class="docutils literal notranslate"><span class="pre">'</span></code>) or double quotes (<code class="docutils literal notranslate"><span class="pre">"</span></code>) are treated
393as string literals, while values without quotes are treated as template
394variables.</p>
395<p>By default, when you use the <code class="docutils literal notranslate"><span class="pre">as</span></code> keyword with the cycle tag, the
396usage of <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">cycle</span> <span class="pre">%}</span></code> that initiates the cycle will itself produce
397the first value in the cycle. This could be a problem if you want to
398use the value in a nested loop or an included template. If you only want
399to declare the cycle but not produce the first value, you can add a
400<code class="docutils literal notranslate"><span class="pre">silent</span></code> keyword as the last keyword in the tag. For example:</p>
401<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">obj</span> <span class="k">in</span> <span class="nv">some_list</span> <span class="cp">%}</span>
402 <span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'row1'</span> <span class="s1">'row2'</span> <span class="k">as</span> <span class="nv">rowcolors</span> <span class="nv">silent</span> <span class="cp">%}</span>
403 <span class="p"><</span><span class="nt">tr</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">rowcolors</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span><span class="cp">{%</span> <span class="k">include</span> <span class="s2">"subtemplate.html"</span> <span class="cp">%}</span><span class="p"></</span><span class="nt">tr</span><span class="p">></span>
404<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
405</pre></div>
406</div>
407<p>This will output a list of <code class="docutils literal notranslate"><span class="pre"><tr></span></code> elements with <code class="docutils literal notranslate"><span class="pre">class</span></code>
408alternating between <code class="docutils literal notranslate"><span class="pre">row1</span></code> and <code class="docutils literal notranslate"><span class="pre">row2</span></code>. The subtemplate will have
409access to <code class="docutils literal notranslate"><span class="pre">rowcolors</span></code> in its context and the value will match the class
410of the <code class="docutils literal notranslate"><span class="pre"><tr></span></code> that encloses it. If the <code class="docutils literal notranslate"><span class="pre">silent</span></code> keyword were to be
411omitted, <code class="docutils literal notranslate"><span class="pre">row1</span></code> and <code class="docutils literal notranslate"><span class="pre">row2</span></code> would be emitted as normal text, outside the
412<code class="docutils literal notranslate"><span class="pre"><tr></span></code> element.</p>
413<p>When the silent keyword is used on a cycle definition, the silence
414automatically applies to all subsequent uses of that specific cycle tag.
415The following template would output <em>nothing</em>, even though the second
416call to <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">cycle</span> <span class="pre">%}</span></code> doesn’t specify <code class="docutils literal notranslate"><span class="pre">silent</span></code>:</p>
417<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'row1'</span> <span class="s1">'row2'</span> <span class="k">as</span> <span class="nv">rowcolors</span> <span class="nv">silent</span> <span class="cp">%}</span>
418<span class="cp">{%</span> <span class="k">cycle</span> <span class="nv">rowcolors</span> <span class="cp">%}</span>
419</pre></div>
420</div>
421<p>You can use the <a class="reference internal" href="#std:templatetag-resetcycle"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">resetcycle</span></code></a> tag to make a <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">cycle</span> <span class="pre">%}</span></code> tag restart
422from its first value when it’s next encountered.</p>
423</div>
424<div class="section" id="s-debug">
425<span id="s-std:templatetag-debug"></span><span id="debug"></span><span id="std:templatetag-debug"></span><h3><code class="docutils literal notranslate"><span class="pre">debug</span></code><a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
426<p>Outputs a whole load of debugging information, including the current context
427and imported modules.</p>
428</div>
429<div class="section" id="s-extends">
430<span id="s-std:templatetag-extends"></span><span id="extends"></span><span id="std:templatetag-extends"></span><h3><code class="docutils literal notranslate"><span class="pre">extends</span></code><a class="headerlink" href="#extends" title="Permalink to this headline">¶</a></h3>
431<p>Signals that this template extends a parent template.</p>
432<p>This tag can be used in two ways:</p>
433<ul class="simple">
434<li><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">extends</span> <span class="pre">"base.html"</span> <span class="pre">%}</span></code> (with quotes) uses the literal value
435<code class="docutils literal notranslate"><span class="pre">"base.html"</span></code> as the name of the parent template to extend.</li>
436<li><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">extends</span> <span class="pre">variable</span> <span class="pre">%}</span></code> uses the value of <code class="docutils literal notranslate"><span class="pre">variable</span></code>. If the variable
437evaluates to a string, Django will use that string as the name of the
438parent template. If the variable evaluates to a <code class="docutils literal notranslate"><span class="pre">Template</span></code> object,
439Django will use that object as the parent template.</li>
440</ul>
441<p>See <a class="reference internal" href="../language/#template-inheritance"><span class="std std-ref">Template inheritance</span></a> for more information.</p>
442<p>Normally the template name is relative to the template loader’s root directory.
443A string argument may also be a relative path starting with <code class="docutils literal notranslate"><span class="pre">./</span></code> or <code class="docutils literal notranslate"><span class="pre">../</span></code>.
444For example, assume the following directory structure:</p>
445<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>dir1/
446 template.html
447 base2.html
448 my/
449 base3.html
450base1.html
451</pre></div>
452</div>
453<p>In <code class="docutils literal notranslate"><span class="pre">template.html</span></code>, the following paths would be valid:</p>
454<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">extends</span> <span class="s2">"./base2.html"</span> <span class="cp">%}</span>
455<span class="cp">{%</span> <span class="k">extends</span> <span class="s2">"../base1.html"</span> <span class="cp">%}</span>
456<span class="cp">{%</span> <span class="k">extends</span> <span class="s2">"./my/base3.html"</span> <span class="cp">%}</span>
457</pre></div>
458</div>
459<div class="versionadded">
460<span class="title">New in Django 1.10:</span> <p>The ability to use relative paths was added.</p>
461</div>
462</div>
463<div class="section" id="s-filter">
464<span id="s-std:templatetag-filter"></span><span id="filter"></span><span id="std:templatetag-filter"></span><h3><code class="docutils literal notranslate"><span class="pre">filter</span></code><a class="headerlink" href="#filter" title="Permalink to this headline">¶</a></h3>
465<p>Filters the contents of the block through one or more filters. Multiple
466filters can be specified with pipes and filters can have arguments, just as
467in variable syntax.</p>
468<p>Note that the block includes <em>all</em> the text between the <code class="docutils literal notranslate"><span class="pre">filter</span></code> and
469<code class="docutils literal notranslate"><span class="pre">endfilter</span></code> tags.</p>
470<p>Sample usage:</p>
471<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">filter</span> <span class="nf">force_escape</span><span class="o">|</span><span class="nf">lower</span> <span class="cp">%}</span>
472 This text will be HTML-escaped, and will appear in all lowercase.
473<span class="cp">{%</span> <span class="k">endfilter</span> <span class="cp">%}</span>
474</pre></div>
475</div>
476<div class="admonition note">
477<p class="first admonition-title">Note</p>
478<p class="last">The <a class="reference internal" href="#std:templatefilter-escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">escape</span></code></a> and <a class="reference internal" href="#std:templatefilter-safe"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">safe</span></code></a> filters are not acceptable
479arguments. Instead, use the <a class="reference internal" href="#std:templatetag-autoescape"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">autoescape</span></code></a> tag to manage autoescaping
480for blocks of template code.</p>
481</div>
482</div>
483<div class="section" id="s-firstof">
484<span id="s-std:templatetag-firstof"></span><span id="firstof"></span><span id="std:templatetag-firstof"></span><h3><code class="docutils literal notranslate"><span class="pre">firstof</span></code><a class="headerlink" href="#firstof" title="Permalink to this headline">¶</a></h3>
485<p>Outputs the first argument variable that is not <code class="docutils literal notranslate"><span class="pre">False</span></code>. Outputs nothing if
486all the passed variables are <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
487<p>Sample usage:</p>
488<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">firstof</span> <span class="nv">var1</span> <span class="nv">var2</span> <span class="nv">var3</span> <span class="cp">%}</span>
489</pre></div>
490</div>
491<p>This is equivalent to:</p>
492<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">var1</span> <span class="cp">%}</span>
493 <span class="cp">{{</span> <span class="nv">var1</span> <span class="cp">}}</span>
494<span class="cp">{%</span> <span class="k">elif</span> <span class="nv">var2</span> <span class="cp">%}</span>
495 <span class="cp">{{</span> <span class="nv">var2</span> <span class="cp">}}</span>
496<span class="cp">{%</span> <span class="k">elif</span> <span class="nv">var3</span> <span class="cp">%}</span>
497 <span class="cp">{{</span> <span class="nv">var3</span> <span class="cp">}}</span>
498<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
499</pre></div>
500</div>
501<p>You can also use a literal string as a fallback value in case all
502passed variables are False:</p>
503<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">firstof</span> <span class="nv">var1</span> <span class="nv">var2</span> <span class="nv">var3</span> <span class="s2">"fallback value"</span> <span class="cp">%}</span>
504</pre></div>
505</div>
506<p>This tag auto-escapes variable values. You can disable auto-escaping with:</p>
507<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">autoescape</span> <span class="nv">off</span> <span class="cp">%}</span>
508 <span class="cp">{%</span> <span class="k">firstof</span> <span class="nv">var1</span> <span class="nv">var2</span> <span class="nv">var3</span> <span class="s2">"<strong>fallback value</strong>"</span> <span class="cp">%}</span>
509<span class="cp">{%</span> <span class="k">endautoescape</span> <span class="cp">%}</span>
510</pre></div>
511</div>
512<p>Or if only some variables should be escaped, you can use:</p>
513<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">firstof</span> <span class="nv">var1</span> <span class="nv">var2</span><span class="o">|</span><span class="nf">safe</span> <span class="nv">var3</span> <span class="s2">"<strong>fallback value</strong>"</span><span class="o">|</span><span class="nf">safe</span> <span class="cp">%}</span>
514</pre></div>
515</div>
516<p>You can use the syntax <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">firstof</span> <span class="pre">var1</span> <span class="pre">var2</span> <span class="pre">var3</span> <span class="pre">as</span> <span class="pre">value</span> <span class="pre">%}</span></code> to store the
517output inside a variable.</p>
518</div>
519<div class="section" id="s-for">
520<span id="s-std:templatetag-for"></span><span id="for"></span><span id="std:templatetag-for"></span><h3><code class="docutils literal notranslate"><span class="pre">for</span></code><a class="headerlink" href="#for" title="Permalink to this headline">¶</a></h3>
521<p>Loops over each item in an array, making the item available in a context
522variable. For example, to display a list of athletes provided in
523<code class="docutils literal notranslate"><span class="pre">athlete_list</span></code>:</p>
524<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">ul</span><span class="p">></span>
525<span class="cp">{%</span> <span class="k">for</span> <span class="nv">athlete</span> <span class="k">in</span> <span class="nv">athlete_list</span> <span class="cp">%}</span>
526 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">athlete.name</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">li</span><span class="p">></span>
527<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
528<span class="p"></</span><span class="nt">ul</span><span class="p">></span>
529</pre></div>
530</div>
531<p>You can loop over a list in reverse by using
532<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">for</span> <span class="pre">obj</span> <span class="pre">in</span> <span class="pre">list</span> <span class="pre">reversed</span> <span class="pre">%}</span></code>.</p>
533<p>If you need to loop over a list of lists, you can unpack the values
534in each sublist into individual variables. For example, if your context
535contains a list of (x,y) coordinates called <code class="docutils literal notranslate"><span class="pre">points</span></code>, you could use the
536following to output the list of points:</p>
537<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">x</span><span class="o">,</span> <span class="nv">y</span> <span class="k">in</span> <span class="nv">points</span> <span class="cp">%}</span>
538 There is a point at <span class="cp">{{</span> <span class="nv">x</span> <span class="cp">}}</span>,<span class="cp">{{</span> <span class="nv">y</span> <span class="cp">}}</span>
539<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
540</pre></div>
541</div>
542<p>This can also be useful if you need to access the items in a dictionary.
543For example, if your context contained a dictionary <code class="docutils literal notranslate"><span class="pre">data</span></code>, the following
544would display the keys and values of the dictionary:</p>
545<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">key</span><span class="o">,</span> <span class="nv">value</span> <span class="k">in</span> <span class="nv">data.items</span> <span class="cp">%}</span>
546 <span class="cp">{{</span> <span class="nv">key</span> <span class="cp">}}</span>: <span class="cp">{{</span> <span class="nv">value</span> <span class="cp">}}</span>
547<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
548</pre></div>
549</div>
550<p>Keep in mind that for the dot operator, dictionary key lookup takes precedence
551over method lookup. Therefore if the <code class="docutils literal notranslate"><span class="pre">data</span></code> dictionary contains a key named
552<code class="docutils literal notranslate"><span class="pre">'items'</span></code>, <code class="docutils literal notranslate"><span class="pre">data.items</span></code> will return <code class="docutils literal notranslate"><span class="pre">data['items']</span></code> instead of
553<code class="docutils literal notranslate"><span class="pre">data.items()</span></code>. Avoid adding keys that are named like dictionary methods if
554you want to use those methods in a template (<code class="docutils literal notranslate"><span class="pre">items</span></code>, <code class="docutils literal notranslate"><span class="pre">values</span></code>, <code class="docutils literal notranslate"><span class="pre">keys</span></code>,
555etc.). Read more about the lookup order of the dot operator in the
556<a class="reference internal" href="../language/#template-variables"><span class="std std-ref">documentation of template variables</span></a>.</p>
557<p>The for loop sets a number of variables available within the loop:</p>
558<table class="docutils">
559<colgroup>
560<col width="36%" />
561<col width="64%" />
562</colgroup>
563<thead valign="bottom">
564<tr class="row-odd"><th class="head">Variable</th>
565<th class="head">Description</th>
566</tr>
567</thead>
568<tbody valign="top">
569<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">forloop.counter</span></code></td>
570<td>The current iteration of the loop (1-indexed)</td>
571</tr>
572<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">forloop.counter0</span></code></td>
573<td>The current iteration of the loop (0-indexed)</td>
574</tr>
575<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">forloop.revcounter</span></code></td>
576<td>The number of iterations from the end of the
577loop (1-indexed)</td>
578</tr>
579<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">forloop.revcounter0</span></code></td>
580<td>The number of iterations from the end of the
581loop (0-indexed)</td>
582</tr>
583<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">forloop.first</span></code></td>
584<td>True if this is the first time through the loop</td>
585</tr>
586<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">forloop.last</span></code></td>
587<td>True if this is the last time through the loop</td>
588</tr>
589<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">forloop.parentloop</span></code></td>
590<td>For nested loops, this is the loop surrounding
591the current one</td>
592</tr>
593</tbody>
594</table>
595</div>
596<div class="section" id="s-for-empty">
597<span id="for-empty"></span><h3><code class="docutils literal notranslate"><span class="pre">for</span></code> … <code class="docutils literal notranslate"><span class="pre">empty</span></code><a class="headerlink" href="#for-empty" title="Permalink to this headline">¶</a></h3>
598<p>The <code class="docutils literal notranslate"><span class="pre">for</span></code> tag can take an optional <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">empty</span> <span class="pre">%}</span></code> clause whose text is
599displayed if the given array is empty or could not be found:</p>
600<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">ul</span><span class="p">></span>
601<span class="cp">{%</span> <span class="k">for</span> <span class="nv">athlete</span> <span class="k">in</span> <span class="nv">athlete_list</span> <span class="cp">%}</span>
602 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">athlete.name</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">li</span><span class="p">></span>
603<span class="cp">{%</span> <span class="k">empty</span> <span class="cp">%}</span>
604 <span class="p"><</span><span class="nt">li</span><span class="p">></span>Sorry, no athletes in this list.<span class="p"></</span><span class="nt">li</span><span class="p">></span>
605<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
606<span class="p"></</span><span class="nt">ul</span><span class="p">></span>
607</pre></div>
608</div>
609<p>The above is equivalent to – but shorter, cleaner, and possibly faster
610than – the following:</p>
611<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">ul</span><span class="p">></span>
612 <span class="cp">{%</span> <span class="k">if</span> <span class="nv">athlete_list</span> <span class="cp">%}</span>
613 <span class="cp">{%</span> <span class="k">for</span> <span class="nv">athlete</span> <span class="k">in</span> <span class="nv">athlete_list</span> <span class="cp">%}</span>
614 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">athlete.name</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">li</span><span class="p">></span>
615 <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
616 <span class="cp">{%</span> <span class="k">else</span> <span class="cp">%}</span>
617 <span class="p"><</span><span class="nt">li</span><span class="p">></span>Sorry, no athletes in this list.<span class="p"></</span><span class="nt">li</span><span class="p">></span>
618 <span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
619<span class="p"></</span><span class="nt">ul</span><span class="p">></span>
620</pre></div>
621</div>
622</div>
623<div class="section" id="s-if">
624<span id="s-std:templatetag-if"></span><span id="if"></span><span id="std:templatetag-if"></span><h3><code class="docutils literal notranslate"><span class="pre">if</span></code><a class="headerlink" href="#if" title="Permalink to this headline">¶</a></h3>
625<p>The <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">if</span> <span class="pre">%}</span></code> tag evaluates a variable, and if that variable is “true†(i.e.
626exists, is not empty, and is not a false boolean value) the contents of the
627block are output:</p>
628<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">athlete_list</span> <span class="cp">%}</span>
629 Number of athletes: <span class="cp">{{</span> <span class="nv">athlete_list</span><span class="o">|</span><span class="nf">length</span> <span class="cp">}}</span>
630<span class="cp">{%</span> <span class="k">elif</span> <span class="nv">athlete_in_locker_room_list</span> <span class="cp">%}</span>
631 Athletes should be out of the locker room soon!
632<span class="cp">{%</span> <span class="k">else</span> <span class="cp">%}</span>
633 No athletes.
634<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
635</pre></div>
636</div>
637<p>In the above, if <code class="docutils literal notranslate"><span class="pre">athlete_list</span></code> is not empty, the number of athletes will be
638displayed by the <code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">athlete_list|length</span> <span class="pre">}}</span></code> variable.</p>
639<p>As you can see, the <code class="docutils literal notranslate"><span class="pre">if</span></code> tag may take one or several <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">elif</span> <span class="pre">%}</span></code>
640clauses, as well as an <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">else</span> <span class="pre">%}</span></code> clause that will be displayed if all
641previous conditions fail. These clauses are optional.</p>
642<div class="section" id="s-boolean-operators">
643<span id="boolean-operators"></span><h4>Boolean operators<a class="headerlink" href="#boolean-operators" title="Permalink to this headline">¶</a></h4>
644<p><a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> tags may use <code class="docutils literal notranslate"><span class="pre">and</span></code>, <code class="docutils literal notranslate"><span class="pre">or</span></code> or <code class="docutils literal notranslate"><span class="pre">not</span></code> to test a number of
645variables or to negate a given variable:</p>
646<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">athlete_list</span> <span class="k">and</span> <span class="nv">coach_list</span> <span class="cp">%}</span>
647 Both athletes and coaches are available.
648<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
649
650<span class="cp">{%</span> <span class="k">if</span> <span class="k">not</span> <span class="nv">athlete_list</span> <span class="cp">%}</span>
651 There are no athletes.
652<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
653
654<span class="cp">{%</span> <span class="k">if</span> <span class="nv">athlete_list</span> <span class="k">or</span> <span class="nv">coach_list</span> <span class="cp">%}</span>
655 There are some athletes or some coaches.
656<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
657
658<span class="cp">{%</span> <span class="k">if</span> <span class="k">not</span> <span class="nv">athlete_list</span> <span class="k">or</span> <span class="nv">coach_list</span> <span class="cp">%}</span>
659 There are no athletes or there are some coaches.
660<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
661
662<span class="cp">{%</span> <span class="k">if</span> <span class="nv">athlete_list</span> <span class="k">and</span> <span class="k">not</span> <span class="nv">coach_list</span> <span class="cp">%}</span>
663 There are some athletes and absolutely no coaches.
664<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
665</pre></div>
666</div>
667<p>Use of both <code class="docutils literal notranslate"><span class="pre">and</span></code> and <code class="docutils literal notranslate"><span class="pre">or</span></code> clauses within the same tag is allowed, with
668<code class="docutils literal notranslate"><span class="pre">and</span></code> having higher precedence than <code class="docutils literal notranslate"><span class="pre">or</span></code> e.g.:</p>
669<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">athlete_list</span> <span class="k">and</span> <span class="nv">coach_list</span> <span class="k">or</span> <span class="nv">cheerleader_list</span> <span class="cp">%}</span>
670</pre></div>
671</div>
672<p>will be interpreted like:</p>
673<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="n">athlete_list</span> <span class="ow">and</span> <span class="n">coach_list</span><span class="p">)</span> <span class="ow">or</span> <span class="n">cheerleader_list</span>
674</pre></div>
675</div>
676<p>Use of actual parentheses in the <a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> tag is invalid syntax. If you need
677them to indicate precedence, you should use nested <a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> tags.</p>
678<p><a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> tags may also use the operators <code class="docutils literal notranslate"><span class="pre">==</span></code>, <code class="docutils literal notranslate"><span class="pre">!=</span></code>, <code class="docutils literal notranslate"><span class="pre"><</span></code>, <code class="docutils literal notranslate"><span class="pre">></span></code>,
679<code class="docutils literal notranslate"><span class="pre"><=</span></code>, <code class="docutils literal notranslate"><span class="pre">>=</span></code>, <code class="docutils literal notranslate"><span class="pre">in</span></code>, <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code>, <code class="docutils literal notranslate"><span class="pre">is</span></code>, and <code class="docutils literal notranslate"><span class="pre">is</span> <span class="pre">not</span></code> which work as
680follows:</p>
681<div class="section" id="s-operator">
682<span id="operator"></span><h5><code class="docutils literal notranslate"><span class="pre">==</span></code> operator<a class="headerlink" href="#operator" title="Permalink to this headline">¶</a></h5>
683<p>Equality. Example:</p>
684<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="o">==</span> <span class="s2">"x"</span> <span class="cp">%}</span>
685 This appears if variable somevar equals the string "x"
686<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
687</pre></div>
688</div>
689</div>
690<div class="section" id="s-id1">
691<span id="id1"></span><h5><code class="docutils literal notranslate"><span class="pre">!=</span></code> operator<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h5>
692<p>Inequality. Example:</p>
693<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="p">!</span><span class="o">=</span> <span class="s2">"x"</span> <span class="cp">%}</span>
694 This appears if variable somevar does not equal the string "x",
695 or if somevar is not found in the context
696<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
697</pre></div>
698</div>
699</div>
700<div class="section" id="s-id2">
701<span id="id2"></span><h5><code class="docutils literal notranslate"><span class="pre"><</span></code> operator<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h5>
702<p>Less than. Example:</p>
703<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="o"><</span> <span class="m">100</span> <span class="cp">%}</span>
704 This appears if variable somevar is less than 100.
705<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
706</pre></div>
707</div>
708</div>
709<div class="section" id="s-id3">
710<span id="id3"></span><h5><code class="docutils literal notranslate"><span class="pre">></span></code> operator<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h5>
711<p>Greater than. Example:</p>
712<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="o">></span> <span class="m">0</span> <span class="cp">%}</span>
713 This appears if variable somevar is greater than 0.
714<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
715</pre></div>
716</div>
717</div>
718<div class="section" id="s-id4">
719<span id="id4"></span><h5><code class="docutils literal notranslate"><span class="pre"><=</span></code> operator<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h5>
720<p>Less than or equal to. Example:</p>
721<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="o"><=</span> <span class="m">100</span> <span class="cp">%}</span>
722 This appears if variable somevar is less than 100 or equal to 100.
723<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
724</pre></div>
725</div>
726</div>
727<div class="section" id="s-id5">
728<span id="id5"></span><h5><code class="docutils literal notranslate"><span class="pre">>=</span></code> operator<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h5>
729<p>Greater than or equal to. Example:</p>
730<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="o">>=</span> <span class="m">1</span> <span class="cp">%}</span>
731 This appears if variable somevar is greater than 1 or equal to 1.
732<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
733</pre></div>
734</div>
735</div>
736<div class="section" id="s-in-operator">
737<span id="in-operator"></span><h5><code class="docutils literal notranslate"><span class="pre">in</span></code> operator<a class="headerlink" href="#in-operator" title="Permalink to this headline">¶</a></h5>
738<p>Contained within. This operator is supported by many Python containers to test
739whether the given value is in the container. The following are some examples
740of how <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">in</span> <span class="pre">y</span></code> will be interpreted:</p>
741<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="s2">"bc"</span> <span class="k">in</span> <span class="s2">"abcdef"</span> <span class="cp">%}</span>
742 This appears since "bc" is a substring of "abcdef"
743<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
744
745<span class="cp">{%</span> <span class="k">if</span> <span class="s2">"hello"</span> <span class="k">in</span> <span class="nv">greetings</span> <span class="cp">%}</span>
746 If greetings is a list or set, one element of which is the string
747 "hello", this will appear.
748<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
749
750<span class="cp">{%</span> <span class="k">if</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span> <span class="cp">%}</span>
751 If users is a QuerySet, this will appear if user is an
752 instance that belongs to the QuerySet.
753<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
754</pre></div>
755</div>
756</div>
757<div class="section" id="s-not-in-operator">
758<span id="not-in-operator"></span><h5><code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code> operator<a class="headerlink" href="#not-in-operator" title="Permalink to this headline">¶</a></h5>
759<p>Not contained within. This is the negation of the <code class="docutils literal notranslate"><span class="pre">in</span></code> operator.</p>
760</div>
761<div class="section" id="s-is-operator">
762<span id="is-operator"></span><h5><code class="docutils literal notranslate"><span class="pre">is</span></code> operator<a class="headerlink" href="#is-operator" title="Permalink to this headline">¶</a></h5>
763<div class="versionadded">
764<span class="title">New in Django 1.10.</span> </div>
765<p>Object identity. Tests if two values are the same object. Example:</p>
766<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="k">is</span> <span class="nf">True</span> <span class="cp">%}</span>
767 This appears if and only if somevar is True.
768<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
769
770<span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="k">is</span> <span class="nf">None</span> <span class="cp">%}</span>
771 This appears if somevar is None, or if somevar is not found in the context.
772<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
773</pre></div>
774</div>
775</div>
776<div class="section" id="s-is-not-operator">
777<span id="is-not-operator"></span><h5><code class="docutils literal notranslate"><span class="pre">is</span> <span class="pre">not</span></code> operator<a class="headerlink" href="#is-not-operator" title="Permalink to this headline">¶</a></h5>
778<div class="versionadded">
779<span class="title">New in Django 1.10.</span> </div>
780<p>Negated object identity. Tests if two values are not the same object. This is
781the negation of the <code class="docutils literal notranslate"><span class="pre">is</span></code> operator. Example:</p>
782<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="k">is</span> <span class="k">not</span> <span class="nf">True</span> <span class="cp">%}</span>
783 This appears if somevar is not True, or if somevar is not found in the
784 context.
785<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
786
787<span class="cp">{%</span> <span class="k">if</span> <span class="nv">somevar</span> <span class="k">is</span> <span class="k">not</span> <span class="nf">None</span> <span class="cp">%}</span>
788 This appears if and only if somevar is not None.
789<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
790</pre></div>
791</div>
792</div>
793</div>
794<div class="section" id="s-filters">
795<span id="filters"></span><h4>Filters<a class="headerlink" href="#filters" title="Permalink to this headline">¶</a></h4>
796<p>You can also use filters in the <a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> expression. For example:</p>
797<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">messages</span><span class="o">|</span><span class="nf">length</span> <span class="o">>=</span> <span class="m">100</span> <span class="cp">%}</span>
798 You have lots of messages today!
799<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
800</pre></div>
801</div>
802</div>
803<div class="section" id="s-complex-expressions">
804<span id="complex-expressions"></span><h4>Complex expressions<a class="headerlink" href="#complex-expressions" title="Permalink to this headline">¶</a></h4>
805<p>All of the above can be combined to form complex expressions. For such
806expressions, it can be important to know how the operators are grouped when the
807expression is evaluated - that is, the precedence rules. The precedence of the
808operators, from lowest to highest, is as follows:</p>
809<ul class="simple">
810<li><code class="docutils literal notranslate"><span class="pre">or</span></code></li>
811<li><code class="docutils literal notranslate"><span class="pre">and</span></code></li>
812<li><code class="docutils literal notranslate"><span class="pre">not</span></code></li>
813<li><code class="docutils literal notranslate"><span class="pre">in</span></code></li>
814<li><code class="docutils literal notranslate"><span class="pre">==</span></code>, <code class="docutils literal notranslate"><span class="pre">!=</span></code>, <code class="docutils literal notranslate"><span class="pre"><</span></code>, <code class="docutils literal notranslate"><span class="pre">></span></code>, <code class="docutils literal notranslate"><span class="pre"><=</span></code>, <code class="docutils literal notranslate"><span class="pre">>=</span></code></li>
815</ul>
816<p>(This follows Python exactly). So, for example, the following complex
817<a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> tag:</p>
818<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">a</span> <span class="o">==</span> <span class="nv">b</span> <span class="k">or</span> <span class="nv">c</span> <span class="o">==</span> <span class="nv">d</span> <span class="k">and</span> <span class="nv">e</span> <span class="cp">%}</span>
819</pre></div>
820</div>
821<p>…will be interpreted as:</p>
822<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">a</span> <span class="o">==</span> <span class="n">b</span><span class="p">)</span> <span class="ow">or</span> <span class="p">((</span><span class="n">c</span> <span class="o">==</span> <span class="n">d</span><span class="p">)</span> <span class="ow">and</span> <span class="n">e</span><span class="p">)</span>
823</pre></div>
824</div>
825<p>If you need different precedence, you will need to use nested <a class="reference internal" href="#std:templatetag-if"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">if</span></code></a> tags.
826Sometimes that is better for clarity anyway, for the sake of those who do not
827know the precedence rules.</p>
828<p>The comparison operators cannot be ‘chained’ like in Python or in mathematical
829notation. For example, instead of using:</p>
830<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">a</span> <span class="o">></span> <span class="nv">b</span> <span class="o">></span> <span class="nv">c</span> <span class="cp">%}</span> (WRONG)
831</pre></div>
832</div>
833<p>you should use:</p>
834<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">a</span> <span class="o">></span> <span class="nv">b</span> <span class="k">and</span> <span class="nv">b</span> <span class="o">></span> <span class="nv">c</span> <span class="cp">%}</span>
835</pre></div>
836</div>
837</div>
838</div>
839<div class="section" id="s-ifequal-and-ifnotequal">
840<span id="ifequal-and-ifnotequal"></span><h3><code class="docutils literal notranslate"><span class="pre">ifequal</span></code> and <code class="docutils literal notranslate"><span class="pre">ifnotequal</span></code><a class="headerlink" href="#ifequal-and-ifnotequal" title="Permalink to this headline">¶</a></h3>
841<p><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">ifequal</span> <span class="pre">a</span> <span class="pre">b</span> <span class="pre">%}</span> <span class="pre">...</span> <span class="pre">{%</span> <span class="pre">endifequal</span> <span class="pre">%}</span></code> is an obsolete way to write
842<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">if</span> <span class="pre">a</span> <span class="pre">==</span> <span class="pre">b</span> <span class="pre">%}</span> <span class="pre">...</span> <span class="pre">{%</span> <span class="pre">endif</span> <span class="pre">%}</span></code>. Likewise, <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">ifnotequal</span> <span class="pre">a</span> <span class="pre">b</span> <span class="pre">%}</span> <span class="pre">...</span>
843<span class="pre">{%</span> <span class="pre">endifnotequal</span> <span class="pre">%}</span></code> is superseded by <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">if</span> <span class="pre">a</span> <span class="pre">!=</span> <span class="pre">b</span> <span class="pre">%}</span> <span class="pre">...</span> <span class="pre">{%</span> <span class="pre">endif</span> <span class="pre">%}</span></code>.
844The <code class="docutils literal notranslate"><span class="pre">ifequal</span></code> and <code class="docutils literal notranslate"><span class="pre">ifnotequal</span></code> tags will be deprecated in a future release.</p>
845</div>
846<div class="section" id="s-ifchanged">
847<span id="s-std:templatetag-ifchanged"></span><span id="ifchanged"></span><span id="std:templatetag-ifchanged"></span><h3><code class="docutils literal notranslate"><span class="pre">ifchanged</span></code><a class="headerlink" href="#ifchanged" title="Permalink to this headline">¶</a></h3>
848<p>Check if a value has changed from the last iteration of a loop.</p>
849<p>The <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">ifchanged</span> <span class="pre">%}</span></code> block tag is used within a loop. It has two possible
850uses.</p>
851<ol class="arabic">
852<li><p class="first">Checks its own rendered contents against its previous state and only
853displays the content if it has changed. For example, this displays a list of
854days, only displaying the month if it changes:</p>
855<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">h1</span><span class="p">></span>Archive for <span class="cp">{{</span> <span class="nv">year</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">h1</span><span class="p">></span>
856
857<span class="cp">{%</span> <span class="k">for</span> <span class="nv">date</span> <span class="k">in</span> <span class="nv">days</span> <span class="cp">%}</span>
858 <span class="cp">{%</span> <span class="k">ifchanged</span> <span class="cp">%}</span><span class="p"><</span><span class="nt">h3</span><span class="p">></span><span class="cp">{{</span> <span class="nv">date</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"F"</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">h3</span><span class="p">></span><span class="cp">{%</span> <span class="k">endifchanged</span> <span class="cp">%}</span>
859 <span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">date</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"M/d"</span><span class="o">|</span><span class="nf">lower</span> <span class="cp">}}</span><span class="s">/"</span><span class="p">></span><span class="cp">{{</span> <span class="nv">date</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"j"</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">a</span><span class="p">></span>
860<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
861</pre></div>
862</div>
863</li>
864<li><p class="first">If given one or more variables, check whether any variable has changed.
865For example, the following shows the date every time it changes, while
866showing the hour if either the hour or the date has changed:</p>
867<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">date</span> <span class="k">in</span> <span class="nv">days</span> <span class="cp">%}</span>
868 <span class="cp">{%</span> <span class="k">ifchanged</span> <span class="nv">date.date</span> <span class="cp">%}</span> <span class="cp">{{</span> <span class="nv">date.date</span> <span class="cp">}}</span> <span class="cp">{%</span> <span class="k">endifchanged</span> <span class="cp">%}</span>
869 <span class="cp">{%</span> <span class="k">ifchanged</span> <span class="nv">date.hour</span> <span class="nv">date.date</span> <span class="cp">%}</span>
870 <span class="cp">{{</span> <span class="nv">date.hour</span> <span class="cp">}}</span>
871 <span class="cp">{%</span> <span class="k">endifchanged</span> <span class="cp">%}</span>
872<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
873</pre></div>
874</div>
875</li>
876</ol>
877<p>The <code class="docutils literal notranslate"><span class="pre">ifchanged</span></code> tag can also take an optional <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">else</span> <span class="pre">%}</span></code> clause that
878will be displayed if the value has not changed:</p>
879<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">match</span> <span class="k">in</span> <span class="nv">matches</span> <span class="cp">%}</span>
880 <span class="p"><</span><span class="nt">div</span> <span class="na">style</span><span class="o">=</span><span class="s">"background-color:</span>
881<span class="s"> </span><span class="cp">{%</span> <span class="k">ifchanged</span> <span class="nv">match.ballot_id</span> <span class="cp">%}</span><span class="s"></span>
882<span class="s"> </span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s2">"red"</span> <span class="s2">"blue"</span> <span class="cp">%}</span><span class="s"></span>
883<span class="s"> </span><span class="cp">{%</span> <span class="k">else</span> <span class="cp">%}</span><span class="s"></span>
884<span class="s"> gray</span>
885<span class="s"> </span><span class="cp">{%</span> <span class="k">endifchanged</span> <span class="cp">%}</span><span class="s"></span>
886<span class="s"> "</span><span class="p">></span><span class="cp">{{</span> <span class="nv">match</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">div</span><span class="p">></span>
887<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
888</pre></div>
889</div>
890</div>
891<div class="section" id="s-include">
892<span id="s-std:templatetag-include"></span><span id="include"></span><span id="std:templatetag-include"></span><h3><code class="docutils literal notranslate"><span class="pre">include</span></code><a class="headerlink" href="#include" title="Permalink to this headline">¶</a></h3>
893<p>Loads a template and renders it with the current context. This is a way of
894“including†other templates within a template.</p>
895<p>The template name can either be a variable or a hard-coded (quoted) string,
896in either single or double quotes.</p>
897<p>This example includes the contents of the template <code class="docutils literal notranslate"><span class="pre">"foo/bar.html"</span></code>:</p>
898<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="s2">"foo/bar.html"</span> <span class="cp">%}</span>
899</pre></div>
900</div>
901<p>Normally the template name is relative to the template loader’s root directory.
902A string argument may also be a relative path starting with <code class="docutils literal notranslate"><span class="pre">./</span></code> or <code class="docutils literal notranslate"><span class="pre">../</span></code>
903as described in the <a class="reference internal" href="#std:templatetag-extends"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">extends</span></code></a> tag.</p>
904<div class="versionadded">
905<span class="title">New in Django 1.10:</span> <p>The ability to use a relative path was added.</p>
906</div>
907<p>This example includes the contents of the template whose name is contained in
908the variable <code class="docutils literal notranslate"><span class="pre">template_name</span></code>:</p>
909<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="nv">template_name</span> <span class="cp">%}</span>
910</pre></div>
911</div>
912<p>The variable may also be any object with a <code class="docutils literal notranslate"><span class="pre">render()</span></code> method that accepts a
913context. This allows you to reference a compiled <code class="docutils literal notranslate"><span class="pre">Template</span></code> in your context.</p>
914<p>An included template is rendered within the context of the template that
915includes it. This example produces the output <code class="docutils literal notranslate"><span class="pre">"Hello,</span> <span class="pre">John!"</span></code>:</p>
916<ul>
917<li><p class="first">Context: variable <code class="docutils literal notranslate"><span class="pre">person</span></code> is set to <code class="docutils literal notranslate"><span class="pre">"John"</span></code> and variable <code class="docutils literal notranslate"><span class="pre">greeting</span></code>
918is set to <code class="docutils literal notranslate"><span class="pre">"Hello"</span></code>.</p>
919</li>
920<li><p class="first">Template:</p>
921<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="s2">"name_snippet.html"</span> <span class="cp">%}</span>
922</pre></div>
923</div>
924</li>
925<li><p class="first">The <code class="docutils literal notranslate"><span class="pre">name_snippet.html</span></code> template:</p>
926<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">greeting</span> <span class="cp">}}</span>, <span class="cp">{{</span> <span class="nv">person</span><span class="o">|</span><span class="nf">default</span><span class="s2">:"friend"</span> <span class="cp">}}</span>!
927</pre></div>
928</div>
929</li>
930</ul>
931<p>You can pass additional context to the template using keyword arguments:</p>
932<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="s2">"name_snippet.html"</span> <span class="k">with</span> <span class="nv">person</span><span class="o">=</span><span class="s2">"Jane"</span> <span class="nv">greeting</span><span class="o">=</span><span class="s2">"Hello"</span> <span class="cp">%}</span>
933</pre></div>
934</div>
935<p>If you want to render the context only with the variables provided (or even
936no variables at all), use the <code class="docutils literal notranslate"><span class="pre">only</span></code> option. No other variables are
937available to the included template:</p>
938<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="s2">"name_snippet.html"</span> <span class="k">with</span> <span class="nv">greeting</span><span class="o">=</span><span class="s2">"Hi"</span> <span class="nv">only</span> <span class="cp">%}</span>
939</pre></div>
940</div>
941<p>If the included template causes an exception while it’s rendered (including
942if it’s missing or has syntax errors), the behavior varies depending on the
943<a class="reference internal" href="../api/#django.template.Engine" title="django.template.Engine"><code class="xref py py-class docutils literal notranslate"><span class="pre">template</span> <span class="pre">engine's</span></code></a> <code class="docutils literal notranslate"><span class="pre">debug</span></code> option (if not
944set, this option defaults to the value of <a class="reference internal" href="../../settings/#std:setting-DEBUG"><code class="xref std std-setting docutils literal notranslate"><span class="pre">DEBUG</span></code></a>). When debug mode is
945turned on, an exception like <a class="reference internal" href="../../../topics/templates/#django.template.TemplateDoesNotExist" title="django.template.TemplateDoesNotExist"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TemplateDoesNotExist</span></code></a> or
946<a class="reference internal" href="../../../topics/templates/#django.template.TemplateSyntaxError" title="django.template.TemplateSyntaxError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TemplateSyntaxError</span></code></a> will be raised. When debug mode
947is turned off, <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">include</span> <span class="pre">%}</span></code> logs a warning to the <code class="docutils literal notranslate"><span class="pre">django.template</span></code>
948logger with the exception that happens while rendering the included template
949and returns an empty string.</p>
950<div class="deprecated">
951<p><span class="versionmodified">Deprecated since version 1.11: </span>Silencing exceptions raised while rendering the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">include</span> <span class="pre">%}</span></code> template
952tag is deprecated. In Django 2.1, the exception will be raised.</p>
953</div>
954<div class="admonition note">
955<p class="first admonition-title">Note</p>
956<p>The <a class="reference internal" href="#std:templatetag-include"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">include</span></code></a> tag should be considered as an implementation of
957“render this subtemplate and include the HTMLâ€, not as “parse this
958subtemplate and include its contents as if it were part of the parentâ€.
959This means that there is no shared state between included templates –
960each include is a completely independent rendering process.</p>
961<p class="last">Blocks are evaluated <em>before</em> they are included. This means that a template
962that includes blocks from another will contain blocks that have <em>already
963been evaluated and rendered</em> - not blocks that can be overridden by, for
964example, an extending template.</p>
965</div>
966</div>
967<div class="section" id="s-load">
968<span id="s-std:templatetag-load"></span><span id="load"></span><span id="std:templatetag-load"></span><h3><code class="docutils literal notranslate"><span class="pre">load</span></code><a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h3>
969<p>Loads a custom template tag set.</p>
970<p>For example, the following template would load all the tags and filters
971registered in <code class="docutils literal notranslate"><span class="pre">somelibrary</span></code> and <code class="docutils literal notranslate"><span class="pre">otherlibrary</span></code> located in package
972<code class="docutils literal notranslate"><span class="pre">package</span></code>:</p>
973<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">somelibrary</span> <span class="nv">package.otherlibrary</span> <span class="cp">%}</span>
974</pre></div>
975</div>
976<p>You can also selectively load individual filters or tags from a library, using
977the <code class="docutils literal notranslate"><span class="pre">from</span></code> argument. In this example, the template tags/filters named <code class="docutils literal notranslate"><span class="pre">foo</span></code>
978and <code class="docutils literal notranslate"><span class="pre">bar</span></code> will be loaded from <code class="docutils literal notranslate"><span class="pre">somelibrary</span></code>:</p>
979<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">foo</span> <span class="nv">bar</span> <span class="nv">from</span> <span class="nv">somelibrary</span> <span class="cp">%}</span>
980</pre></div>
981</div>
982<p>See <a class="reference internal" href="../../../howto/custom-template-tags/"><span class="doc">Custom tag and filter libraries</span></a> for
983more information.</p>
984</div>
985<div class="section" id="s-lorem">
986<span id="s-std:templatetag-lorem"></span><span id="lorem"></span><span id="std:templatetag-lorem"></span><h3><code class="docutils literal notranslate"><span class="pre">lorem</span></code><a class="headerlink" href="#lorem" title="Permalink to this headline">¶</a></h3>
987<p>Displays random “lorem ipsum†Latin text. This is useful for providing sample
988data in templates.</p>
989<p>Usage:</p>
990<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">lorem</span> <span class="o">[</span><span class="nv">count</span><span class="o">]</span> <span class="o">[</span><span class="nv">method</span><span class="o">]</span> <span class="o">[</span><span class="nv">random</span><span class="o">]</span> <span class="cp">%}</span>
991</pre></div>
992</div>
993<p>The <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">lorem</span> <span class="pre">%}</span></code> tag can be used with zero, one, two or three arguments.
994The arguments are:</p>
995<table class="docutils">
996<colgroup>
997<col width="15%" />
998<col width="85%" />
999</colgroup>
1000<thead valign="bottom">
1001<tr class="row-odd"><th class="head">Argument</th>
1002<th class="head">Description</th>
1003</tr>
1004</thead>
1005<tbody valign="top">
1006<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">count</span></code></td>
1007<td>A number (or variable) containing the number of paragraphs or
1008words to generate (default is 1).</td>
1009</tr>
1010<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">method</span></code></td>
1011<td>Either <code class="docutils literal notranslate"><span class="pre">w</span></code> for words, <code class="docutils literal notranslate"><span class="pre">p</span></code> for HTML paragraphs or <code class="docutils literal notranslate"><span class="pre">b</span></code>
1012for plain-text paragraph blocks (default is <code class="docutils literal notranslate"><span class="pre">b</span></code>).</td>
1013</tr>
1014<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">random</span></code></td>
1015<td>The word <code class="docutils literal notranslate"><span class="pre">random</span></code>, which if given, does not use the common
1016paragraph (“Lorem ipsum dolor sit amet…â€) when generating
1017text.</td>
1018</tr>
1019</tbody>
1020</table>
1021<p>Examples:</p>
1022<ul class="simple">
1023<li><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">lorem</span> <span class="pre">%}</span></code> will output the common “lorem ipsum†paragraph.</li>
1024<li><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">lorem</span> <span class="pre">3</span> <span class="pre">p</span> <span class="pre">%}</span></code> will output the common “lorem ipsum†paragraph
1025and two random paragraphs each wrapped in HTML <code class="docutils literal notranslate"><span class="pre"><p></span></code> tags.</li>
1026<li><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">lorem</span> <span class="pre">2</span> <span class="pre">w</span> <span class="pre">random</span> <span class="pre">%}</span></code> will output two random Latin words.</li>
1027</ul>
1028</div>
1029<div class="section" id="s-now">
1030<span id="s-std:templatetag-now"></span><span id="now"></span><span id="std:templatetag-now"></span><h3><code class="docutils literal notranslate"><span class="pre">now</span></code><a class="headerlink" href="#now" title="Permalink to this headline">¶</a></h3>
1031<p>Displays the current date and/or time, using a format according to the given
1032string. Such string can contain format specifiers characters as described
1033in the <a class="reference internal" href="#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">date</span></code></a> filter section.</p>
1034<p>Example:</p>
1035<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>It is <span class="cp">{%</span> <span class="k">now</span> <span class="s2">"jS F Y H:i"</span> <span class="cp">%}</span>
1036</pre></div>
1037</div>
1038<p>Note that you can backslash-escape a format string if you want to use the
1039“raw†value. In this example, both “o†and “f†are backslash-escaped, because
1040otherwise each is a format string that displays the year and the time,
1041respectively:</p>
1042<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>It is the <span class="cp">{%</span> <span class="k">now</span> <span class="s2">"jS \o\f F"</span> <span class="cp">%}</span>
1043</pre></div>
1044</div>
1045<p>This would display as “It is the 4th of Septemberâ€.</p>
1046<div class="admonition note">
1047<p class="first admonition-title">Note</p>
1048<p>The format passed can also be one of the predefined ones
1049<a class="reference internal" href="../../settings/#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">DATE_FORMAT</span></code></a>, <a class="reference internal" href="../../settings/#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">DATETIME_FORMAT</span></code></a>,
1050<a class="reference internal" href="../../settings/#std:setting-SHORT_DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">SHORT_DATE_FORMAT</span></code></a> or <a class="reference internal" href="../../settings/#std:setting-SHORT_DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">SHORT_DATETIME_FORMAT</span></code></a>.
1051The predefined formats may vary depending on the current locale and
1052if <a class="reference internal" href="../../../topics/i18n/formatting/"><span class="doc">Format localization</span></a> is enabled, e.g.:</p>
1053<div class="last highlight-html+django notranslate"><div class="highlight"><pre><span></span>It is <span class="cp">{%</span> <span class="k">now</span> <span class="s2">"SHORT_DATETIME_FORMAT"</span> <span class="cp">%}</span>
1054</pre></div>
1055</div>
1056</div>
1057<p>You can also use the syntax <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">now</span> <span class="pre">"Y"</span> <span class="pre">as</span> <span class="pre">current_year</span> <span class="pre">%}</span></code> to store the
1058output (as a string) inside a variable. This is useful if you want to use
1059<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">now</span> <span class="pre">%}</span></code> inside a template tag like <a class="reference internal" href="../../../topics/i18n/translation/#std:templatetag-blocktrans"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">blocktrans</span></code></a> for example:</p>
1060<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">now</span> <span class="s2">"Y"</span> <span class="k">as</span> <span class="nv">current_year</span> <span class="cp">%}</span>
1061<span class="cp">{%</span> <span class="k">blocktrans</span> <span class="cp">%}</span>Copyright <span class="cp">{{</span> <span class="nv">current_year</span> <span class="cp">}}{%</span> <span class="k">endblocktrans</span> <span class="cp">%}</span>
1062</pre></div>
1063</div>
1064</div>
1065<div class="section" id="s-regroup">
1066<span id="s-std:templatetag-regroup"></span><span id="regroup"></span><span id="std:templatetag-regroup"></span><h3><code class="docutils literal notranslate"><span class="pre">regroup</span></code><a class="headerlink" href="#regroup" title="Permalink to this headline">¶</a></h3>
1067<p>Regroups a list of alike objects by a common attribute.</p>
1068<p>This complex tag is best illustrated by way of an example: say that <code class="docutils literal notranslate"><span class="pre">cities</span></code>
1069is a list of cities represented by dictionaries containing <code class="docutils literal notranslate"><span class="pre">"name"</span></code>,
1070<code class="docutils literal notranslate"><span class="pre">"population"</span></code>, and <code class="docutils literal notranslate"><span class="pre">"country"</span></code> keys:</p>
1071<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">cities</span> <span class="o">=</span> <span class="p">[</span>
1072 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Mumbai'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'19,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'India'</span><span class="p">},</span>
1073 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Calcutta'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'15,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'India'</span><span class="p">},</span>
1074 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'New York'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'20,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'USA'</span><span class="p">},</span>
1075 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Chicago'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'7,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'USA'</span><span class="p">},</span>
1076 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Tokyo'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'33,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'Japan'</span><span class="p">},</span>
1077<span class="p">]</span>
1078</pre></div>
1079</div>
1080<p>…and you’d like to display a hierarchical list that is ordered by country,
1081like this:</p>
1082<ul class="simple">
1083<li>India<ul>
1084<li>Mumbai: 19,000,000</li>
1085<li>Calcutta: 15,000,000</li>
1086</ul>
1087</li>
1088<li>USA<ul>
1089<li>New York: 20,000,000</li>
1090<li>Chicago: 7,000,000</li>
1091</ul>
1092</li>
1093<li>Japan<ul>
1094<li>Tokyo: 33,000,000</li>
1095</ul>
1096</li>
1097</ul>
1098<p>You can use the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">regroup</span> <span class="pre">%}</span></code> tag to group the list of cities by country.
1099The following snippet of template code would accomplish this:</p>
1100<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">regroup</span> <span class="nv">cities</span> <span class="nv">by</span> <span class="nv">country</span> <span class="k">as</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1101
1102<span class="p"><</span><span class="nt">ul</span><span class="p">></span>
1103<span class="cp">{%</span> <span class="k">for</span> <span class="nv">country</span> <span class="k">in</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1104 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">country.grouper</span> <span class="cp">}}</span>
1105 <span class="p"><</span><span class="nt">ul</span><span class="p">></span>
1106 <span class="cp">{%</span> <span class="k">for</span> <span class="nv">city</span> <span class="k">in</span> <span class="nv">country.list</span> <span class="cp">%}</span>
1107 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">city.name</span> <span class="cp">}}</span>: <span class="cp">{{</span> <span class="nv">city.population</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">li</span><span class="p">></span>
1108 <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1109 <span class="p"></</span><span class="nt">ul</span><span class="p">></span>
1110 <span class="p"></</span><span class="nt">li</span><span class="p">></span>
1111<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1112<span class="p"></</span><span class="nt">ul</span><span class="p">></span>
1113</pre></div>
1114</div>
1115<p>Let’s walk through this example. <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">regroup</span> <span class="pre">%}</span></code> takes three arguments: the
1116list you want to regroup, the attribute to group by, and the name of the
1117resulting list. Here, we’re regrouping the <code class="docutils literal notranslate"><span class="pre">cities</span></code> list by the <code class="docutils literal notranslate"><span class="pre">country</span></code>
1118attribute and calling the result <code class="docutils literal notranslate"><span class="pre">country_list</span></code>.</p>
1119<p><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">regroup</span> <span class="pre">%}</span></code> produces a list (in this case, <code class="docutils literal notranslate"><span class="pre">country_list</span></code>) of
1120<strong>group objects</strong>. Group objects are instances of
1121<a class="reference external" href="https://docs.python.org/3/library/collections.html#collections.namedtuple" title="(in Python v3.6)"><code class="xref py py-func docutils literal notranslate"><span class="pre">namedtuple()</span></code></a> with two fields:</p>
1122<ul class="simple">
1123<li><code class="docutils literal notranslate"><span class="pre">grouper</span></code> – the item that was grouped by (e.g., the string “India†or
1124“Japanâ€).</li>
1125<li><code class="docutils literal notranslate"><span class="pre">list</span></code> – a list of all items in this group (e.g., a list of all cities
1126with country=’India’).</li>
1127</ul>
1128<div class="versionchanged">
1129<span class="title">Changed in Django 1.11:</span> <p>The group object was changed from a dictionary to a
1130<a class="reference external" href="https://docs.python.org/3/library/collections.html#collections.namedtuple" title="(in Python v3.6)"><code class="xref py py-func docutils literal notranslate"><span class="pre">namedtuple()</span></code></a>.</p>
1131</div>
1132<p>Because <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">regroup</span> <span class="pre">%}</span></code> produces <a class="reference external" href="https://docs.python.org/3/library/collections.html#collections.namedtuple" title="(in Python v3.6)"><code class="xref py py-func docutils literal notranslate"><span class="pre">namedtuple()</span></code></a> objects,
1133you can also write the previous example as:</p>
1134<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">regroup</span> <span class="nv">cities</span> <span class="nv">by</span> <span class="nv">country</span> <span class="k">as</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1135
1136<span class="p"><</span><span class="nt">ul</span><span class="p">></span>
1137<span class="cp">{%</span> <span class="k">for</span> <span class="nv">country</span><span class="o">,</span> <span class="nv">local_cities</span> <span class="k">in</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1138 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">country</span> <span class="cp">}}</span>
1139 <span class="p"><</span><span class="nt">ul</span><span class="p">></span>
1140 <span class="cp">{%</span> <span class="k">for</span> <span class="nv">city</span> <span class="k">in</span> <span class="nv">local_cities</span> <span class="cp">%}</span>
1141 <span class="p"><</span><span class="nt">li</span><span class="p">></span><span class="cp">{{</span> <span class="nv">city.name</span> <span class="cp">}}</span>: <span class="cp">{{</span> <span class="nv">city.population</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">li</span><span class="p">></span>
1142 <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1143 <span class="p"></</span><span class="nt">ul</span><span class="p">></span>
1144 <span class="p"></</span><span class="nt">li</span><span class="p">></span>
1145<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1146<span class="p"></</span><span class="nt">ul</span><span class="p">></span>
1147</pre></div>
1148</div>
1149<p>Note that <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">regroup</span> <span class="pre">%}</span></code> does not order its input! Our example relies on
1150the fact that the <code class="docutils literal notranslate"><span class="pre">cities</span></code> list was ordered by <code class="docutils literal notranslate"><span class="pre">country</span></code> in the first place.
1151If the <code class="docutils literal notranslate"><span class="pre">cities</span></code> list did <em>not</em> order its members by <code class="docutils literal notranslate"><span class="pre">country</span></code>, the
1152regrouping would naively display more than one group for a single country. For
1153example, say the <code class="docutils literal notranslate"><span class="pre">cities</span></code> list was set to this (note that the countries are not
1154grouped together):</p>
1155<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">cities</span> <span class="o">=</span> <span class="p">[</span>
1156 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Mumbai'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'19,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'India'</span><span class="p">},</span>
1157 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'New York'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'20,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'USA'</span><span class="p">},</span>
1158 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Calcutta'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'15,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'India'</span><span class="p">},</span>
1159 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Chicago'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'7,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'USA'</span><span class="p">},</span>
1160 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Tokyo'</span><span class="p">,</span> <span class="s1">'population'</span><span class="p">:</span> <span class="s1">'33,000,000'</span><span class="p">,</span> <span class="s1">'country'</span><span class="p">:</span> <span class="s1">'Japan'</span><span class="p">},</span>
1161<span class="p">]</span>
1162</pre></div>
1163</div>
1164<p>With this input for <code class="docutils literal notranslate"><span class="pre">cities</span></code>, the example <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">regroup</span> <span class="pre">%}</span></code> template code
1165above would result in the following output:</p>
1166<ul class="simple">
1167<li>India<ul>
1168<li>Mumbai: 19,000,000</li>
1169</ul>
1170</li>
1171<li>USA<ul>
1172<li>New York: 20,000,000</li>
1173</ul>
1174</li>
1175<li>India<ul>
1176<li>Calcutta: 15,000,000</li>
1177</ul>
1178</li>
1179<li>USA<ul>
1180<li>Chicago: 7,000,000</li>
1181</ul>
1182</li>
1183<li>Japan<ul>
1184<li>Tokyo: 33,000,000</li>
1185</ul>
1186</li>
1187</ul>
1188<p>The easiest solution to this gotcha is to make sure in your view code that the
1189data is ordered according to how you want to display it.</p>
1190<p>Another solution is to sort the data in the template using the
1191<a class="reference internal" href="#std:templatefilter-dictsort"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">dictsort</span></code></a> filter, if your data is in a list of dictionaries:</p>
1192<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">regroup</span> <span class="nv">cities</span><span class="o">|</span><span class="nf">dictsort</span><span class="s2">:"country"</span> <span class="nv">by</span> <span class="nv">country</span> <span class="k">as</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1193</pre></div>
1194</div>
1195<div class="section" id="s-grouping-on-other-properties">
1196<span id="grouping-on-other-properties"></span><h4>Grouping on other properties<a class="headerlink" href="#grouping-on-other-properties" title="Permalink to this headline">¶</a></h4>
1197<p>Any valid template lookup is a legal grouping attribute for the regroup
1198tag, including methods, attributes, dictionary keys and list items. For
1199example, if the “country†field is a foreign key to a class with
1200an attribute “description,†you could use:</p>
1201<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">regroup</span> <span class="nv">cities</span> <span class="nv">by</span> <span class="nv">country.description</span> <span class="k">as</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1202</pre></div>
1203</div>
1204<p>Or, if <code class="docutils literal notranslate"><span class="pre">country</span></code> is a field with <code class="docutils literal notranslate"><span class="pre">choices</span></code>, it will have a
1205<a class="reference internal" href="../../models/instances/#django.db.models.Model.get_FOO_display" title="django.db.models.Model.get_FOO_display"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_FOO_display()</span></code></a> method available as an
1206attribute, allowing you to group on the display string rather than the
1207<code class="docutils literal notranslate"><span class="pre">choices</span></code> key:</p>
1208<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">regroup</span> <span class="nv">cities</span> <span class="nv">by</span> <span class="nv">get_country_display</span> <span class="k">as</span> <span class="nv">country_list</span> <span class="cp">%}</span>
1209</pre></div>
1210</div>
1211<p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">country.grouper</span> <span class="pre">}}</span></code> will now display the value fields from the
1212<code class="docutils literal notranslate"><span class="pre">choices</span></code> set rather than the keys.</p>
1213</div>
1214</div>
1215<div class="section" id="s-resetcycle">
1216<span id="s-std:templatetag-resetcycle"></span><span id="resetcycle"></span><span id="std:templatetag-resetcycle"></span><h3><code class="docutils literal notranslate"><span class="pre">resetcycle</span></code><a class="headerlink" href="#resetcycle" title="Permalink to this headline">¶</a></h3>
1217<div class="versionadded">
1218<span class="title">New in Django 1.11.</span> </div>
1219<p>Resets a previous <a class="reference internal" href="#cycle">cycle</a> so that it restarts from its first item at its next
1220encounter. Without arguments, <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">resetcycle</span> <span class="pre">%}</span></code> will reset the last
1221<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">cycle</span> <span class="pre">%}</span></code> defined in the template.</p>
1222<p>Example usage:</p>
1223<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">coach</span> <span class="k">in</span> <span class="nv">coach_list</span> <span class="cp">%}</span>
1224 <span class="p"><</span><span class="nt">h1</span><span class="p">></span><span class="cp">{{</span> <span class="nv">coach.name</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">h1</span><span class="p">></span>
1225 <span class="cp">{%</span> <span class="k">for</span> <span class="nv">athlete</span> <span class="k">in</span> <span class="nv">coach.athlete_set.all</span> <span class="cp">%}</span>
1226 <span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'odd'</span> <span class="s1">'even'</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span><span class="cp">{{</span> <span class="nv">athlete.name</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">p</span><span class="p">></span>
1227 <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1228 <span class="cp">{%</span> <span class="k">resetcycle</span> <span class="cp">%}</span>
1229<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1230</pre></div>
1231</div>
1232<p>This example would return this HTML:</p>
1233<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">h1</span><span class="p">></span>José Mourinho<span class="p"></</span><span class="nt">h1</span><span class="p">></span>
1234<span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"odd"</span><span class="p">></span>Thibaut Courtois<span class="p"></</span><span class="nt">p</span><span class="p">></span>
1235<span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"even"</span><span class="p">></span>John Terry<span class="p"></</span><span class="nt">p</span><span class="p">></span>
1236<span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"odd"</span><span class="p">></span>Eden Hazard<span class="p"></</span><span class="nt">p</span><span class="p">></span>
1237
1238<span class="p"><</span><span class="nt">h1</span><span class="p">></span>Carlo Ancelotti<span class="p"></</span><span class="nt">h1</span><span class="p">></span>
1239<span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"odd"</span><span class="p">></span>Manuel Neuer<span class="p"></</span><span class="nt">p</span><span class="p">></span>
1240<span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"even"</span><span class="p">></span>Thomas Müller<span class="p"></</span><span class="nt">p</span><span class="p">></span>
1241</pre></div>
1242</div>
1243<p>Notice how the first block ends with <code class="docutils literal notranslate"><span class="pre">class="odd"</span></code> and the new one starts
1244with <code class="docutils literal notranslate"><span class="pre">class="odd"</span></code>. Without the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">resetcycle</span> <span class="pre">%}</span></code> tag, the second block
1245would start with <code class="docutils literal notranslate"><span class="pre">class="even"</span></code>.</p>
1246<p>You can also reset named cycle tags:</p>
1247<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">item</span> <span class="k">in</span> <span class="nv">list</span> <span class="cp">%}</span>
1248 <span class="p"><</span><span class="nt">p</span> <span class="na">class</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'odd'</span> <span class="s1">'even'</span> <span class="k">as</span> <span class="nv">stripe</span> <span class="cp">%}</span><span class="s"> </span><span class="cp">{%</span> <span class="k">cycle</span> <span class="s1">'major'</span> <span class="s1">'minor'</span> <span class="s1">'minor'</span> <span class="s1">'minor'</span> <span class="s1">'minor'</span> <span class="k">as</span> <span class="nv">tick</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>
1249 <span class="cp">{{</span> <span class="nv">item.data</span> <span class="cp">}}</span>
1250 <span class="p"></</span><span class="nt">p</span><span class="p">></span>
1251 <span class="cp">{%</span> <span class="k">ifchanged</span> <span class="nv">item.category</span> <span class="cp">%}</span>
1252 <span class="p"><</span><span class="nt">h1</span><span class="p">></span><span class="cp">{{</span> <span class="nv">item.category</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">h1</span><span class="p">></span>
1253 <span class="cp">{%</span> <span class="k">if</span> <span class="k">not</span> <span class="nb">forloop</span><span class="nv">.first</span> <span class="cp">%}{%</span> <span class="k">resetcycle</span> <span class="nv">tick</span> <span class="cp">%}{%</span> <span class="k">endif</span> <span class="cp">%}</span>
1254 <span class="cp">{%</span> <span class="k">endifchanged</span> <span class="cp">%}</span>
1255<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1256</pre></div>
1257</div>
1258<p>In this example, we have both the alternating odd/even rows and a “major†row
1259every fifth row. Only the five-row cycle is reset when a category changes.</p>
1260</div>
1261<div class="section" id="s-spaceless">
1262<span id="s-std:templatetag-spaceless"></span><span id="spaceless"></span><span id="std:templatetag-spaceless"></span><h3><code class="docutils literal notranslate"><span class="pre">spaceless</span></code><a class="headerlink" href="#spaceless" title="Permalink to this headline">¶</a></h3>
1263<p>Removes whitespace between HTML tags. This includes tab
1264characters and newlines.</p>
1265<p>Example usage:</p>
1266<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">spaceless</span> <span class="cp">%}</span>
1267 <span class="p"><</span><span class="nt">p</span><span class="p">></span>
1268 <span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"foo/"</span><span class="p">></span>Foo<span class="p"></</span><span class="nt">a</span><span class="p">></span>
1269 <span class="p"></</span><span class="nt">p</span><span class="p">></span>
1270<span class="cp">{%</span> <span class="k">endspaceless</span> <span class="cp">%}</span>
1271</pre></div>
1272</div>
1273<p>This example would return this HTML:</p>
1274<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">p</span><span class="p">><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"foo/"</span><span class="p">></span>Foo<span class="p"></</span><span class="nt">a</span><span class="p">></</span><span class="nt">p</span><span class="p">></span>
1275</pre></div>
1276</div>
1277<p>Only space between <em>tags</em> is removed – not space between tags and text. In
1278this example, the space around <code class="docutils literal notranslate"><span class="pre">Hello</span></code> won’t be stripped:</p>
1279<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">spaceless</span> <span class="cp">%}</span>
1280 <span class="p"><</span><span class="nt">strong</span><span class="p">></span>
1281 Hello
1282 <span class="p"></</span><span class="nt">strong</span><span class="p">></span>
1283<span class="cp">{%</span> <span class="k">endspaceless</span> <span class="cp">%}</span>
1284</pre></div>
1285</div>
1286</div>
1287<div class="section" id="s-templatetag">
1288<span id="s-std:templatetag-templatetag"></span><span id="templatetag"></span><span id="std:templatetag-templatetag"></span><h3><code class="docutils literal notranslate"><span class="pre">templatetag</span></code><a class="headerlink" href="#templatetag" title="Permalink to this headline">¶</a></h3>
1289<p>Outputs one of the syntax characters used to compose template tags.</p>
1290<p>Since the template system has no concept of “escapingâ€, to display one of the
1291bits used in template tags, you must use the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">templatetag</span> <span class="pre">%}</span></code> tag.</p>
1292<p>The argument tells which template bit to output:</p>
1293<table class="docutils">
1294<colgroup>
1295<col width="72%" />
1296<col width="28%" />
1297</colgroup>
1298<thead valign="bottom">
1299<tr class="row-odd"><th class="head">Argument</th>
1300<th class="head">Outputs</th>
1301</tr>
1302</thead>
1303<tbody valign="top">
1304<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">openblock</span></code></td>
1305<td><code class="docutils literal notranslate"><span class="pre">{%</span></code></td>
1306</tr>
1307<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">closeblock</span></code></td>
1308<td><code class="docutils literal notranslate"><span class="pre">%}</span></code></td>
1309</tr>
1310<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">openvariable</span></code></td>
1311<td><code class="docutils literal notranslate"><span class="pre">{{</span></code></td>
1312</tr>
1313<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">closevariable</span></code></td>
1314<td><code class="docutils literal notranslate"><span class="pre">}}</span></code></td>
1315</tr>
1316<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">openbrace</span></code></td>
1317<td><code class="docutils literal notranslate"><span class="pre">{</span></code></td>
1318</tr>
1319<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">closebrace</span></code></td>
1320<td><code class="docutils literal notranslate"><span class="pre">}</span></code></td>
1321</tr>
1322<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">opencomment</span></code></td>
1323<td><code class="docutils literal notranslate"><span class="pre">{#</span></code></td>
1324</tr>
1325<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">closecomment</span></code></td>
1326<td><code class="docutils literal notranslate"><span class="pre">#}</span></code></td>
1327</tr>
1328</tbody>
1329</table>
1330<p>Sample usage:</p>
1331<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">templatetag</span> <span class="nv">openblock</span> <span class="cp">%}</span> url 'entry_list' <span class="cp">{%</span> <span class="k">templatetag</span> <span class="nv">closeblock</span> <span class="cp">%}</span>
1332</pre></div>
1333</div>
1334</div>
1335<div class="section" id="s-url">
1336<span id="s-std:templatetag-url"></span><span id="url"></span><span id="std:templatetag-url"></span><h3><code class="docutils literal notranslate"><span class="pre">url</span></code><a class="headerlink" href="#url" title="Permalink to this headline">¶</a></h3>
1337<p>Returns an absolute path reference (a URL without the domain name) matching a
1338given view and optional parameters. Any special characters in the resulting
1339path will be encoded using <a class="reference internal" href="../../utils/#django.utils.encoding.iri_to_uri" title="django.utils.encoding.iri_to_uri"><code class="xref py py-func docutils literal notranslate"><span class="pre">iri_to_uri()</span></code></a>.</p>
1340<p>This is a way to output links without violating the DRY principle by having to
1341hard-code URLs in your templates:</p>
1342<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">'some-url-name'</span> <span class="nv">v1</span> <span class="nv">v2</span> <span class="cp">%}</span>
1343</pre></div>
1344</div>
1345<p>The first argument is a <a class="reference internal" href="../../urls/#django.conf.urls.url" title="django.conf.urls.url"><code class="xref py py-func docutils literal notranslate"><span class="pre">url()</span></code></a> <code class="docutils literal notranslate"><span class="pre">name</span></code>. It can be a
1346quoted literal or any other context variable. Additional arguments are optional
1347and should be space-separated values that will be used as arguments in the URL.
1348The example above shows passing positional arguments. Alternatively you may
1349use keyword syntax:</p>
1350<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">'some-url-name'</span> <span class="nv">arg1</span><span class="o">=</span><span class="nv">v1</span> <span class="nv">arg2</span><span class="o">=</span><span class="nv">v2</span> <span class="cp">%}</span>
1351</pre></div>
1352</div>
1353<p>Do not mix both positional and keyword syntax in a single call. All arguments
1354required by the URLconf should be present.</p>
1355<p>For example, suppose you have a view, <code class="docutils literal notranslate"><span class="pre">app_views.client</span></code>, whose URLconf
1356takes a client ID (here, <code class="docutils literal notranslate"><span class="pre">client()</span></code> is a method inside the views file
1357<code class="docutils literal notranslate"><span class="pre">app_views.py</span></code>). The URLconf line might look like this:</p>
1358<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="s1">'^client/([0-9]+)/$'</span><span class="p">,</span> <span class="n">app_views</span><span class="o">.</span><span class="n">client</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'app-views-client'</span><span class="p">)</span>
1359</pre></div>
1360</div>
1361<p>If this app’s URLconf is included into the project’s URLconf under a path
1362such as this:</p>
1363<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="s1">'^clients/'</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="s1">'project_name.app_name.urls'</span><span class="p">))</span>
1364</pre></div>
1365</div>
1366<p>…then, in a template, you can create a link to this view like this:</p>
1367<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">'app-views-client'</span> <span class="nv">client.id</span> <span class="cp">%}</span>
1368</pre></div>
1369</div>
1370<p>The template tag will output the string <code class="docutils literal notranslate"><span class="pre">/clients/client/123/</span></code>.</p>
1371<p>Note that if the URL you’re reversing doesn’t exist, you’ll get an
1372<a class="reference internal" href="../../exceptions/#django.urls.NoReverseMatch" title="django.urls.NoReverseMatch"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NoReverseMatch</span></code></a> exception raised, which will cause your
1373site to display an error page.</p>
1374<p>If you’d like to retrieve a URL without displaying it, you can use a slightly
1375different call:</p>
1376<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">'some-url-name'</span> <span class="nv">arg</span> <span class="nv">arg2</span> <span class="k">as</span> <span class="nv">the_url</span> <span class="cp">%}</span>
1377
1378<span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">the_url</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span>I'm linking to <span class="cp">{{</span> <span class="nv">the_url</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">a</span><span class="p">></span>
1379</pre></div>
1380</div>
1381<p>The scope of the variable created by the <code class="docutils literal notranslate"><span class="pre">as</span> <span class="pre">var</span></code> syntax is the
1382<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">block</span> <span class="pre">%}</span></code> in which the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">url</span> <span class="pre">%}</span></code> tag appears.</p>
1383<p>This <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">url</span> <span class="pre">...</span> <span class="pre">as</span> <span class="pre">var</span> <span class="pre">%}</span></code> syntax will <em>not</em> cause an error if the view is
1384missing. In practice you’ll use this to link to views that are optional:</p>
1385<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">'some-url-name'</span> <span class="k">as</span> <span class="nv">the_url</span> <span class="cp">%}</span>
1386<span class="cp">{%</span> <span class="k">if</span> <span class="nv">the_url</span> <span class="cp">%}</span>
1387 <span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">the_url</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span>Link to optional stuff<span class="p"></</span><span class="nt">a</span><span class="p">></span>
1388<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span>
1389</pre></div>
1390</div>
1391<p>If you’d like to retrieve a namespaced URL, specify the fully qualified name:</p>
1392<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">'myapp:view-name'</span> <span class="cp">%}</span>
1393</pre></div>
1394</div>
1395<p>This will follow the normal <a class="reference internal" href="../../../topics/http/urls/#topics-http-reversing-url-namespaces"><span class="std std-ref">namespaced URL resolution strategy</span></a>, including using any hints provided
1396by the context as to the current application.</p>
1397<div class="admonition warning">
1398<p class="first admonition-title">Warning</p>
1399<p class="last">Don’t forget to put quotes around the <a class="reference internal" href="../../urls/#django.conf.urls.url" title="django.conf.urls.url"><code class="xref py py-func docutils literal notranslate"><span class="pre">url()</span></code></a>
1400<code class="docutils literal notranslate"><span class="pre">name</span></code>, otherwise the value will be interpreted as a context variable!</p>
1401</div>
1402</div>
1403<div class="section" id="s-verbatim">
1404<span id="s-std:templatetag-verbatim"></span><span id="verbatim"></span><span id="std:templatetag-verbatim"></span><h3><code class="docutils literal notranslate"><span class="pre">verbatim</span></code><a class="headerlink" href="#verbatim" title="Permalink to this headline">¶</a></h3>
1405<p>Stops the template engine from rendering the contents of this block tag.</p>
1406<p>A common use is to allow a JavaScript template layer that collides with
1407Django’s syntax. For example:</p>
1408<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">verbatim</span> <span class="cp">%}</span>
1409 <span class="cp">{{</span><span class="k">if</span> <span class="nv">dying</span><span class="cp">}}</span>Still alive.<span class="cp">{{</span><span class="o">/</span><span class="k">if</span><span class="cp">}}</span>
1410<span class="cp">{%</span> <span class="k">endverbatim</span> <span class="cp">%}</span>
1411</pre></div>
1412</div>
1413<p>You can also designate a specific closing tag, allowing the use of
1414<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">endverbatim</span> <span class="pre">%}</span></code> as part of the unrendered contents:</p>
1415<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">verbatim</span> <span class="nv">myblock</span> <span class="cp">%}</span>
1416 Avoid template rendering via the <span class="cp">{%</span> <span class="k">verbatim</span> <span class="cp">%}{%</span> <span class="k">endverbatim</span> <span class="cp">%}</span> block.
1417<span class="cp">{%</span> <span class="k">endverbatim</span> <span class="nv">myblock</span> <span class="cp">%}</span>
1418</pre></div>
1419</div>
1420</div>
1421<div class="section" id="s-widthratio">
1422<span id="s-std:templatetag-widthratio"></span><span id="widthratio"></span><span id="std:templatetag-widthratio"></span><h3><code class="docutils literal notranslate"><span class="pre">widthratio</span></code><a class="headerlink" href="#widthratio" title="Permalink to this headline">¶</a></h3>
1423<p>For creating bar charts and such, this tag calculates the ratio of a given
1424value to a maximum value, and then applies that ratio to a constant.</p>
1425<p>For example:</p>
1426<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"bar.png"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Bar"</span>
1427 <span class="na">height</span><span class="o">=</span><span class="s">"10"</span> <span class="na">width</span><span class="o">=</span><span class="s">"quot;</span><span class="cp">{%</span> <span class="k">widthratio</span> <span class="nv">this_value</span> <span class="nv">max_value</span> <span class="nv">max_width</span> <span class="cp">%}</span><span class="s">"</span> <span class="p">/></span>
1428</pre></div>
1429</div>
1430<p>If <code class="docutils literal notranslate"><span class="pre">this_value</span></code> is 175, <code class="docutils literal notranslate"><span class="pre">max_value</span></code> is 200, and <code class="docutils literal notranslate"><span class="pre">max_width</span></code> is 100, the
1431image in the above example will be 88 pixels wide
1432(because 175/200 = .875; .875 * 100 = 87.5 which is rounded up to 88).</p>
1433<p>In some cases you might want to capture the result of <code class="docutils literal notranslate"><span class="pre">widthratio</span></code> in a
1434variable. It can be useful, for instance, in a <a class="reference internal" href="../../../topics/i18n/translation/#std:templatetag-blocktrans"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">blocktrans</span></code></a> like this:</p>
1435<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">widthratio</span> <span class="nv">this_value</span> <span class="nv">max_value</span> <span class="nv">max_width</span> <span class="k">as</span> <span class="nv">width</span> <span class="cp">%}</span>
1436<span class="cp">{%</span> <span class="k">blocktrans</span> <span class="cp">%}</span>The width is: <span class="cp">{{</span> <span class="nv">width</span> <span class="cp">}}{%</span> <span class="k">endblocktrans</span> <span class="cp">%}</span>
1437</pre></div>
1438</div>
1439</div>
1440<div class="section" id="s-with">
1441<span id="s-std:templatetag-with"></span><span id="with"></span><span id="std:templatetag-with"></span><h3><code class="docutils literal notranslate"><span class="pre">with</span></code><a class="headerlink" href="#with" title="Permalink to this headline">¶</a></h3>
1442<p>Caches a complex variable under a simpler name. This is useful when accessing
1443an “expensive†method (e.g., one that hits the database) multiple times.</p>
1444<p>For example:</p>
1445<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">with</span> <span class="nv">total</span><span class="o">=</span><span class="nv">business.employees.count</span> <span class="cp">%}</span>
1446 <span class="cp">{{</span> <span class="nv">total</span> <span class="cp">}}</span> employee<span class="cp">{{</span> <span class="nv">total</span><span class="o">|</span><span class="nf">pluralize</span> <span class="cp">}}</span>
1447<span class="cp">{%</span> <span class="k">endwith</span> <span class="cp">%}</span>
1448</pre></div>
1449</div>
1450<p>The populated variable (in the example above, <code class="docutils literal notranslate"><span class="pre">total</span></code>) is only available
1451between the <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">with</span> <span class="pre">%}</span></code> and <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">endwith</span> <span class="pre">%}</span></code> tags.</p>
1452<p>You can assign more than one context variable:</p>
1453<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">with</span> <span class="nv">alpha</span><span class="o">=</span><span class="m">1</span> <span class="nv">beta</span><span class="o">=</span><span class="m">2</span> <span class="cp">%}</span>
1454 ...
1455<span class="cp">{%</span> <span class="k">endwith</span> <span class="cp">%}</span>
1456</pre></div>
1457</div>
1458<div class="admonition note">
1459<p class="first admonition-title">Note</p>
1460<p class="last">The previous more verbose format is still supported:
1461<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">with</span> <span class="pre">business.employees.count</span> <span class="pre">as</span> <span class="pre">total</span> <span class="pre">%}</span></code></p>
1462</div>
1463</div>
1464</div>
1465<div class="section" id="s-built-in-filter-reference">
1466<span id="s-ref-templates-builtins-filters"></span><span id="built-in-filter-reference"></span><span id="ref-templates-builtins-filters"></span><h2>Built-in filter reference<a class="headerlink" href="#built-in-filter-reference" title="Permalink to this headline">¶</a></h2>
1467<div class="section" id="s-add">
1468<span id="s-std:templatefilter-add"></span><span id="add"></span><span id="std:templatefilter-add"></span><h3><code class="docutils literal notranslate"><span class="pre">add</span></code><a class="headerlink" href="#add" title="Permalink to this headline">¶</a></h3>
1469<p>Adds the argument to the value.</p>
1470<p>For example:</p>
1471<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">add</span><span class="s2">:"2"</span> <span class="cp">}}</span>
1472</pre></div>
1473</div>
1474<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">4</span></code>, then the output will be <code class="docutils literal notranslate"><span class="pre">6</span></code>.</p>
1475<p>This filter will first try to coerce both values to integers. If this fails,
1476it’ll attempt to add the values together anyway. This will work on some data
1477types (strings, list, etc.) and fail on others. If it fails, the result will
1478be an empty string.</p>
1479<p>For example, if we have:</p>
1480<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">first</span><span class="o">|</span><span class="nf">add</span><span class="o">:</span><span class="nv">second</span> <span class="cp">}}</span>
1481</pre></div>
1482</div>
1483<p>and <code class="docutils literal notranslate"><span class="pre">first</span></code> is <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">2,</span> <span class="pre">3]</span></code> and <code class="docutils literal notranslate"><span class="pre">second</span></code> is <code class="docutils literal notranslate"><span class="pre">[4,</span> <span class="pre">5,</span> <span class="pre">6]</span></code>, then the
1484output will be <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">2,</span> <span class="pre">3,</span> <span class="pre">4,</span> <span class="pre">5,</span> <span class="pre">6]</span></code>.</p>
1485<div class="admonition warning">
1486<p class="first admonition-title">Warning</p>
1487<p class="last">Strings that can be coerced to integers will be <strong>summed</strong>, not
1488concatenated, as in the first example above.</p>
1489</div>
1490</div>
1491<div class="section" id="s-addslashes">
1492<span id="s-std:templatefilter-addslashes"></span><span id="addslashes"></span><span id="std:templatefilter-addslashes"></span><h3><code class="docutils literal notranslate"><span class="pre">addslashes</span></code><a class="headerlink" href="#addslashes" title="Permalink to this headline">¶</a></h3>
1493<p>Adds slashes before quotes. Useful for escaping strings in CSV, for example.</p>
1494<p>For example:</p>
1495<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">addslashes</span> <span class="cp">}}</span>
1496</pre></div>
1497</div>
1498<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"I'm</span> <span class="pre">using</span> <span class="pre">Django"</span></code>, the output will be
1499<code class="docutils literal notranslate"><span class="pre">"I\'m</span> <span class="pre">using</span> <span class="pre">Django"</span></code>.</p>
1500</div>
1501<div class="section" id="s-capfirst">
1502<span id="s-std:templatefilter-capfirst"></span><span id="capfirst"></span><span id="std:templatefilter-capfirst"></span><h3><code class="docutils literal notranslate"><span class="pre">capfirst</span></code><a class="headerlink" href="#capfirst" title="Permalink to this headline">¶</a></h3>
1503<p>Capitalizes the first character of the value. If the first character is not
1504a letter, this filter has no effect.</p>
1505<p>For example:</p>
1506<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">capfirst</span> <span class="cp">}}</span>
1507</pre></div>
1508</div>
1509<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"django"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"Django"</span></code>.</p>
1510</div>
1511<div class="section" id="s-center">
1512<span id="s-std:templatefilter-center"></span><span id="center"></span><span id="std:templatefilter-center"></span><h3><code class="docutils literal notranslate"><span class="pre">center</span></code><a class="headerlink" href="#center" title="Permalink to this headline">¶</a></h3>
1513<p>Centers the value in a field of a given width.</p>
1514<p>For example:</p>
1515<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>"<span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">center</span><span class="s2">:"15"</span> <span class="cp">}}</span>"
1516</pre></div>
1517</div>
1518<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Django"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"</span>     <span class="pre">Django</span>    <span class="pre">"</span></code>.</p>
1519</div>
1520<div class="section" id="s-cut">
1521<span id="s-std:templatefilter-cut"></span><span id="cut"></span><span id="std:templatefilter-cut"></span><h3><code class="docutils literal notranslate"><span class="pre">cut</span></code><a class="headerlink" href="#cut" title="Permalink to this headline">¶</a></h3>
1522<p>Removes all values of arg from the given string.</p>
1523<p>For example:</p>
1524<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">cut</span><span class="s2">:" "</span> <span class="cp">}}</span>
1525</pre></div>
1526</div>
1527<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"String</span> <span class="pre">with</span> <span class="pre">spaces"</span></code>, the output will be
1528<code class="docutils literal notranslate"><span class="pre">"Stringwithspaces"</span></code>.</p>
1529</div>
1530<div class="section" id="s-date">
1531<span id="s-std:templatefilter-date"></span><span id="date"></span><span id="std:templatefilter-date"></span><h3><code class="docutils literal notranslate"><span class="pre">date</span></code><a class="headerlink" href="#date" title="Permalink to this headline">¶</a></h3>
1532<p>Formats a date according to the given format.</p>
1533<p>Uses a similar format as PHP’s <code class="docutils literal notranslate"><span class="pre">date()</span></code> function (<a class="reference external" href="https://php.net/date">https://php.net/date</a>)
1534with some differences.</p>
1535<div class="admonition note">
1536<p class="first admonition-title">Note</p>
1537<p class="last">These format characters are not used in Django outside of templates. They
1538were designed to be compatible with PHP to ease transitioning for designers.</p>
1539</div>
1540<p id="date-and-time-formatting-specifiers">Available format strings:</p>
1541<table class="docutils">
1542<colgroup>
1543<col width="12%" />
1544<col width="31%" />
1545<col width="57%" />
1546</colgroup>
1547<thead valign="bottom">
1548<tr class="row-odd"><th class="head">Format character</th>
1549<th class="head">Description</th>
1550<th class="head">Example output</th>
1551</tr>
1552</thead>
1553<tbody valign="top">
1554<tr class="row-even"><td>a</td>
1555<td><code class="docutils literal notranslate"><span class="pre">'a.m.'</span></code> or <code class="docutils literal notranslate"><span class="pre">'p.m.'</span></code> (Note that
1556this is slightly different than PHP’s
1557output, because this includes periods
1558to match Associated Press style.)</td>
1559<td><code class="docutils literal notranslate"><span class="pre">'a.m.'</span></code></td>
1560</tr>
1561<tr class="row-odd"><td>A</td>
1562<td><code class="docutils literal notranslate"><span class="pre">'AM'</span></code> or <code class="docutils literal notranslate"><span class="pre">'PM'</span></code>.</td>
1563<td><code class="docutils literal notranslate"><span class="pre">'AM'</span></code></td>
1564</tr>
1565<tr class="row-even"><td>b</td>
1566<td>Month, textual, 3 letters, lowercase.</td>
1567<td><code class="docutils literal notranslate"><span class="pre">'jan'</span></code></td>
1568</tr>
1569<tr class="row-odd"><td>B</td>
1570<td>Not implemented.</td>
1571<td> </td>
1572</tr>
1573<tr class="row-even"><td>c</td>
1574<td>ISO 8601 format. (Note: unlike others
1575formatters, such as “Zâ€, “O†or “râ€,
1576the “c†formatter will not add timezone
1577offset if value is a naive datetime
1578(see <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.tzinfo" title="(in Python v3.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.tzinfo</span></code></a>).</td>
1579<td><code class="docutils literal notranslate"><span class="pre">2008-01-02T10:30:00.000123+02:00</span></code>,
1580or <code class="docutils literal notranslate"><span class="pre">2008-01-02T10:30:00.000123</span></code> if the datetime is naive</td>
1581</tr>
1582<tr class="row-odd"><td>d</td>
1583<td>Day of the month, 2 digits with
1584leading zeros.</td>
1585<td><code class="docutils literal notranslate"><span class="pre">'01'</span></code> to <code class="docutils literal notranslate"><span class="pre">'31'</span></code></td>
1586</tr>
1587<tr class="row-even"><td>D</td>
1588<td>Day of the week, textual, 3 letters.</td>
1589<td><code class="docutils literal notranslate"><span class="pre">'Fri'</span></code></td>
1590</tr>
1591<tr class="row-odd"><td>e</td>
1592<td>Timezone name. Could be in any format,
1593or might return an empty string,
1594depending on the datetime.</td>
1595<td><code class="docutils literal notranslate"><span class="pre">''</span></code>, <code class="docutils literal notranslate"><span class="pre">'GMT'</span></code>, <code class="docutils literal notranslate"><span class="pre">'-500'</span></code>, <code class="docutils literal notranslate"><span class="pre">'US/Eastern'</span></code>, etc.</td>
1596</tr>
1597<tr class="row-even"><td>E</td>
1598<td>Month, locale specific alternative
1599representation usually used for long
1600date representation.</td>
1601<td><code class="docutils literal notranslate"><span class="pre">'listopada'</span></code> (for Polish locale, as opposed to <code class="docutils literal notranslate"><span class="pre">'Listopad'</span></code>)</td>
1602</tr>
1603<tr class="row-odd"><td>f</td>
1604<td>Time, in 12-hour hours and minutes,
1605with minutes left off if they’re zero.
1606Proprietary extension.</td>
1607<td><code class="docutils literal notranslate"><span class="pre">'1'</span></code>, <code class="docutils literal notranslate"><span class="pre">'1:30'</span></code></td>
1608</tr>
1609<tr class="row-even"><td>F</td>
1610<td>Month, textual, long.</td>
1611<td><code class="docutils literal notranslate"><span class="pre">'January'</span></code></td>
1612</tr>
1613<tr class="row-odd"><td>g</td>
1614<td>Hour, 12-hour format without leading
1615zeros.</td>
1616<td><code class="docutils literal notranslate"><span class="pre">'1'</span></code> to <code class="docutils literal notranslate"><span class="pre">'12'</span></code></td>
1617</tr>
1618<tr class="row-even"><td>G</td>
1619<td>Hour, 24-hour format without leading
1620zeros.</td>
1621<td><code class="docutils literal notranslate"><span class="pre">'0'</span></code> to <code class="docutils literal notranslate"><span class="pre">'23'</span></code></td>
1622</tr>
1623<tr class="row-odd"><td>h</td>
1624<td>Hour, 12-hour format.</td>
1625<td><code class="docutils literal notranslate"><span class="pre">'01'</span></code> to <code class="docutils literal notranslate"><span class="pre">'12'</span></code></td>
1626</tr>
1627<tr class="row-even"><td>H</td>
1628<td>Hour, 24-hour format.</td>
1629<td><code class="docutils literal notranslate"><span class="pre">'00'</span></code> to <code class="docutils literal notranslate"><span class="pre">'23'</span></code></td>
1630</tr>
1631<tr class="row-odd"><td>i</td>
1632<td>Minutes.</td>
1633<td><code class="docutils literal notranslate"><span class="pre">'00'</span></code> to <code class="docutils literal notranslate"><span class="pre">'59'</span></code></td>
1634</tr>
1635<tr class="row-even"><td>I</td>
1636<td>Daylight Savings Time, whether it’s
1637in effect or not.</td>
1638<td><code class="docutils literal notranslate"><span class="pre">'1'</span></code> or <code class="docutils literal notranslate"><span class="pre">'0'</span></code></td>
1639</tr>
1640<tr class="row-odd"><td>j</td>
1641<td>Day of the month without leading
1642zeros.</td>
1643<td><code class="docutils literal notranslate"><span class="pre">'1'</span></code> to <code class="docutils literal notranslate"><span class="pre">'31'</span></code></td>
1644</tr>
1645<tr class="row-even"><td>l</td>
1646<td>Day of the week, textual, long.</td>
1647<td><code class="docutils literal notranslate"><span class="pre">'Friday'</span></code></td>
1648</tr>
1649<tr class="row-odd"><td>L</td>
1650<td>Boolean for whether it’s a leap year.</td>
1651<td><code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code></td>
1652</tr>
1653<tr class="row-even"><td>m</td>
1654<td>Month, 2 digits with leading zeros.</td>
1655<td><code class="docutils literal notranslate"><span class="pre">'01'</span></code> to <code class="docutils literal notranslate"><span class="pre">'12'</span></code></td>
1656</tr>
1657<tr class="row-odd"><td>M</td>
1658<td>Month, textual, 3 letters.</td>
1659<td><code class="docutils literal notranslate"><span class="pre">'Jan'</span></code></td>
1660</tr>
1661<tr class="row-even"><td>n</td>
1662<td>Month without leading zeros.</td>
1663<td><code class="docutils literal notranslate"><span class="pre">'1'</span></code> to <code class="docutils literal notranslate"><span class="pre">'12'</span></code></td>
1664</tr>
1665<tr class="row-odd"><td>N</td>
1666<td>Month abbreviation in Associated Press
1667style. Proprietary extension.</td>
1668<td><code class="docutils literal notranslate"><span class="pre">'Jan.'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Feb.'</span></code>, <code class="docutils literal notranslate"><span class="pre">'March'</span></code>, <code class="docutils literal notranslate"><span class="pre">'May'</span></code></td>
1669</tr>
1670<tr class="row-even"><td>o</td>
1671<td>ISO-8601 week-numbering year,
1672corresponding to the ISO-8601 week
1673number (W) which uses leap weeks. See Y
1674for the more common year format.</td>
1675<td><code class="docutils literal notranslate"><span class="pre">'1999'</span></code></td>
1676</tr>
1677<tr class="row-odd"><td>O</td>
1678<td>Difference to Greenwich time in hours.</td>
1679<td><code class="docutils literal notranslate"><span class="pre">'+0200'</span></code></td>
1680</tr>
1681<tr class="row-even"><td>P</td>
1682<td>Time, in 12-hour hours, minutes and
1683‘a.m.’/’p.m.’, with minutes left off
1684if they’re zero and the special-case
1685strings ‘midnight’ and ‘noon’ if
1686appropriate. Proprietary extension.</td>
1687<td><code class="docutils literal notranslate"><span class="pre">'1</span> <span class="pre">a.m.'</span></code>, <code class="docutils literal notranslate"><span class="pre">'1:30</span> <span class="pre">p.m.'</span></code>, <code class="docutils literal notranslate"><span class="pre">'midnight'</span></code>, <code class="docutils literal notranslate"><span class="pre">'noon'</span></code>, <code class="docutils literal notranslate"><span class="pre">'12:30</span> <span class="pre">p.m.'</span></code></td>
1688</tr>
1689<tr class="row-odd"><td>r</td>
1690<td><span class="target" id="index-0"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc5322.html"><strong>RFC 5322</strong></a> formatted date.</td>
1691<td><code class="docutils literal notranslate"><span class="pre">'Thu,</span> <span class="pre">21</span> <span class="pre">Dec</span> <span class="pre">2000</span> <span class="pre">16:01:07</span> <span class="pre">+0200'</span></code></td>
1692</tr>
1693<tr class="row-even"><td>s</td>
1694<td>Seconds, 2 digits with leading zeros.</td>
1695<td><code class="docutils literal notranslate"><span class="pre">'00'</span></code> to <code class="docutils literal notranslate"><span class="pre">'59'</span></code></td>
1696</tr>
1697<tr class="row-odd"><td>S</td>
1698<td>English ordinal suffix for day of the
1699month, 2 characters.</td>
1700<td><code class="docutils literal notranslate"><span class="pre">'st'</span></code>, <code class="docutils literal notranslate"><span class="pre">'nd'</span></code>, <code class="docutils literal notranslate"><span class="pre">'rd'</span></code> or <code class="docutils literal notranslate"><span class="pre">'th'</span></code></td>
1701</tr>
1702<tr class="row-even"><td>t</td>
1703<td>Number of days in the given month.</td>
1704<td><code class="docutils literal notranslate"><span class="pre">28</span></code> to <code class="docutils literal notranslate"><span class="pre">31</span></code></td>
1705</tr>
1706<tr class="row-odd"><td>T</td>
1707<td>Time zone of this machine.</td>
1708<td><code class="docutils literal notranslate"><span class="pre">'EST'</span></code>, <code class="docutils literal notranslate"><span class="pre">'MDT'</span></code></td>
1709</tr>
1710<tr class="row-even"><td>u</td>
1711<td>Microseconds.</td>
1712<td><code class="docutils literal notranslate"><span class="pre">000000</span></code> to <code class="docutils literal notranslate"><span class="pre">999999</span></code></td>
1713</tr>
1714<tr class="row-odd"><td>U</td>
1715<td>Seconds since the Unix Epoch
1716(January 1 1970 00:00:00 UTC).</td>
1717<td> </td>
1718</tr>
1719<tr class="row-even"><td>w</td>
1720<td>Day of the week, digits without
1721leading zeros.</td>
1722<td><code class="docutils literal notranslate"><span class="pre">'0'</span></code> (Sunday) to <code class="docutils literal notranslate"><span class="pre">'6'</span></code> (Saturday)</td>
1723</tr>
1724<tr class="row-odd"><td>W</td>
1725<td>ISO-8601 week number of year, with
1726weeks starting on Monday.</td>
1727<td><code class="docutils literal notranslate"><span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">53</span></code></td>
1728</tr>
1729<tr class="row-even"><td>y</td>
1730<td>Year, 2 digits.</td>
1731<td><code class="docutils literal notranslate"><span class="pre">'99'</span></code></td>
1732</tr>
1733<tr class="row-odd"><td>Y</td>
1734<td>Year, 4 digits.</td>
1735<td><code class="docutils literal notranslate"><span class="pre">'1999'</span></code></td>
1736</tr>
1737<tr class="row-even"><td>z</td>
1738<td>Day of the year.</td>
1739<td><code class="docutils literal notranslate"><span class="pre">0</span></code> to <code class="docutils literal notranslate"><span class="pre">365</span></code></td>
1740</tr>
1741<tr class="row-odd"><td>Z</td>
1742<td>Time zone offset in seconds. The
1743offset for timezones west of UTC is
1744always negative, and for those east of
1745UTC is always positive.</td>
1746<td><code class="docutils literal notranslate"><span class="pre">-43200</span></code> to <code class="docutils literal notranslate"><span class="pre">43200</span></code></td>
1747</tr>
1748</tbody>
1749</table>
1750<p>For example:</p>
1751<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"D d M Y"</span> <span class="cp">}}</span>
1752</pre></div>
1753</div>
1754<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is a <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a> object (e.g., the result of
1755<code class="docutils literal notranslate"><span class="pre">datetime.datetime.now()</span></code>), the output will be the string
1756<code class="docutils literal notranslate"><span class="pre">'Wed</span> <span class="pre">09</span> <span class="pre">Jan</span> <span class="pre">2008'</span></code>.</p>
1757<p>The format passed can be one of the predefined ones <a class="reference internal" href="../../settings/#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">DATE_FORMAT</span></code></a>,
1758<a class="reference internal" href="../../settings/#std:setting-DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">DATETIME_FORMAT</span></code></a>, <a class="reference internal" href="../../settings/#std:setting-SHORT_DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">SHORT_DATE_FORMAT</span></code></a> or
1759<a class="reference internal" href="../../settings/#std:setting-SHORT_DATETIME_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">SHORT_DATETIME_FORMAT</span></code></a>, or a custom format that uses the format
1760specifiers shown in the table above. Note that predefined formats may vary
1761depending on the current locale.</p>
1762<p>Assuming that <a class="reference internal" href="../../settings/#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate"><span class="pre">USE_L10N</span></code></a> is <code class="docutils literal notranslate"><span class="pre">True</span></code> and <a class="reference internal" href="../../settings/#std:setting-LANGUAGE_CODE"><code class="xref std std-setting docutils literal notranslate"><span class="pre">LANGUAGE_CODE</span></code></a> is,
1763for example, <code class="docutils literal notranslate"><span class="pre">"es"</span></code>, then for:</p>
1764<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"SHORT_DATE_FORMAT"</span> <span class="cp">}}</span>
1765</pre></div>
1766</div>
1767<p>the output would be the string <code class="docutils literal notranslate"><span class="pre">"09/01/2008"</span></code> (the <code class="docutils literal notranslate"><span class="pre">"SHORT_DATE_FORMAT"</span></code>
1768format specifier for the <code class="docutils literal notranslate"><span class="pre">es</span></code> locale as shipped with Django is <code class="docutils literal notranslate"><span class="pre">"d/m/Y"</span></code>).</p>
1769<p>When used without a format string, the <code class="docutils literal notranslate"><span class="pre">DATE_FORMAT</span></code> format specifier is
1770used. Assuming the same settings as the previous example:</p>
1771<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">date</span> <span class="cp">}}</span>
1772</pre></div>
1773</div>
1774<p>outputs <code class="docutils literal notranslate"><span class="pre">9</span> <span class="pre">de</span> <span class="pre">Enero</span> <span class="pre">de</span> <span class="pre">2008</span></code> (the <code class="docutils literal notranslate"><span class="pre">DATE_FORMAT</span></code> format specifier for the
1775<code class="docutils literal notranslate"><span class="pre">es</span></code> locale is <code class="docutils literal notranslate"><span class="pre">r'j</span> <span class="pre">\d\e</span> <span class="pre">F</span> <span class="pre">\d\e</span> <span class="pre">Y'</span></code>.</p>
1776<div class="versionchanged">
1777<span class="title">Changed in Django 1.10:</span> <p>In older versions, the <a class="reference internal" href="../../settings/#std:setting-DATE_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">DATE_FORMAT</span></code></a> setting (without
1778localization) is always used when a format string isn’t given.</p>
1779</div>
1780<p>You can combine <code class="docutils literal notranslate"><span class="pre">date</span></code> with the <a class="reference internal" href="#std:templatefilter-time"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">time</span></code></a> filter to render a full
1781representation of a <code class="docutils literal notranslate"><span class="pre">datetime</span></code> value. E.g.:</p>
1782<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">date</span><span class="s2">:"D d M Y"</span> <span class="cp">}}</span> <span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">time</span><span class="s2">:"H:i"</span> <span class="cp">}}</span>
1783</pre></div>
1784</div>
1785</div>
1786<div class="section" id="s-default">
1787<span id="s-std:templatefilter-default"></span><span id="default"></span><span id="std:templatefilter-default"></span><h3><code class="docutils literal notranslate"><span class="pre">default</span></code><a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>
1788<p>If value evaluates to <code class="docutils literal notranslate"><span class="pre">False</span></code>, uses the given default. Otherwise, uses the
1789value.</p>
1790<p>For example:</p>
1791<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">default</span><span class="s2">:"nothing"</span> <span class="cp">}}</span>
1792</pre></div>
1793</div>
1794<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">""</span></code> (the empty string), the output will be <code class="docutils literal notranslate"><span class="pre">nothing</span></code>.</p>
1795</div>
1796<div class="section" id="s-default-if-none">
1797<span id="s-std:templatefilter-default_if_none"></span><span id="default-if-none"></span><span id="std:templatefilter-default_if_none"></span><h3><code class="docutils literal notranslate"><span class="pre">default_if_none</span></code><a class="headerlink" href="#default-if-none" title="Permalink to this headline">¶</a></h3>
1798<p>If (and only if) value is <code class="docutils literal notranslate"><span class="pre">None</span></code>, uses the given default. Otherwise, uses the
1799value.</p>
1800<p>Note that if an empty string is given, the default value will <em>not</em> be used.
1801Use the <a class="reference internal" href="#std:templatefilter-default"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">default</span></code></a> filter if you want to fallback for empty strings.</p>
1802<p>For example:</p>
1803<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">default_if_none</span><span class="s2">:"nothing"</span> <span class="cp">}}</span>
1804</pre></div>
1805</div>
1806<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">nothing</span></code>.</p>
1807</div>
1808<div class="section" id="s-dictsort">
1809<span id="s-std:templatefilter-dictsort"></span><span id="dictsort"></span><span id="std:templatefilter-dictsort"></span><h3><code class="docutils literal notranslate"><span class="pre">dictsort</span></code><a class="headerlink" href="#dictsort" title="Permalink to this headline">¶</a></h3>
1810<p>Takes a list of dictionaries and returns that list sorted by the key given in
1811the argument.</p>
1812<p>For example:</p>
1813<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">dictsort</span><span class="s2">:"name"</span> <span class="cp">}}</span>
1814</pre></div>
1815</div>
1816<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is:</p>
1817<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
1818 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'zed'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">19</span><span class="p">},</span>
1819 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'amy'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">22</span><span class="p">},</span>
1820 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'joe'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">31</span><span class="p">},</span>
1821<span class="p">]</span>
1822</pre></div>
1823</div>
1824<p>then the output would be:</p>
1825<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
1826 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'amy'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">22</span><span class="p">},</span>
1827 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'joe'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">31</span><span class="p">},</span>
1828 <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'zed'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">19</span><span class="p">},</span>
1829<span class="p">]</span>
1830</pre></div>
1831</div>
1832<p>You can also do more complicated things like:</p>
1833<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">book</span> <span class="k">in</span> <span class="nv">books</span><span class="o">|</span><span class="nf">dictsort</span><span class="s2">:"author.age"</span> <span class="cp">%}</span>
1834 * <span class="cp">{{</span> <span class="nv">book.title</span> <span class="cp">}}</span> (<span class="cp">{{</span> <span class="nv">book.author.name</span> <span class="cp">}}</span>)
1835<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
1836</pre></div>
1837</div>
1838<p>If <code class="docutils literal notranslate"><span class="pre">books</span></code> is:</p>
1839<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
1840 <span class="p">{</span><span class="s1">'title'</span><span class="p">:</span> <span class="s1">'1984'</span><span class="p">,</span> <span class="s1">'author'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'George'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">45</span><span class="p">}},</span>
1841 <span class="p">{</span><span class="s1">'title'</span><span class="p">:</span> <span class="s1">'Timequake'</span><span class="p">,</span> <span class="s1">'author'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Kurt'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">75</span><span class="p">}},</span>
1842 <span class="p">{</span><span class="s1">'title'</span><span class="p">:</span> <span class="s1">'Alice'</span><span class="p">,</span> <span class="s1">'author'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Lewis'</span><span class="p">,</span> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">33</span><span class="p">}},</span>
1843<span class="p">]</span>
1844</pre></div>
1845</div>
1846<p>then the output would be:</p>
1847<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>* Alice (Lewis)
1848* 1984 (George)
1849* Timequake (Kurt)
1850</pre></div>
1851</div>
1852<p><code class="docutils literal notranslate"><span class="pre">dictsort</span></code> can also order a list of lists (or any other object implementing
1853<code class="docutils literal notranslate"><span class="pre">__getitem__()</span></code>) by elements at specified index. For example:</p>
1854<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">dictsort</span><span class="o">:</span><span class="m">0</span> <span class="cp">}}</span>
1855</pre></div>
1856</div>
1857<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is:</p>
1858<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
1859 <span class="p">(</span><span class="s1">'a'</span><span class="p">,</span> <span class="s1">'42'</span><span class="p">),</span>
1860 <span class="p">(</span><span class="s1">'c'</span><span class="p">,</span> <span class="s1">'string'</span><span class="p">),</span>
1861 <span class="p">(</span><span class="s1">'b'</span><span class="p">,</span> <span class="s1">'foo'</span><span class="p">),</span>
1862<span class="p">]</span>
1863</pre></div>
1864</div>
1865<p>then the output would be:</p>
1866<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
1867 <span class="p">(</span><span class="s1">'a'</span><span class="p">,</span> <span class="s1">'42'</span><span class="p">),</span>
1868 <span class="p">(</span><span class="s1">'b'</span><span class="p">,</span> <span class="s1">'foo'</span><span class="p">),</span>
1869 <span class="p">(</span><span class="s1">'c'</span><span class="p">,</span> <span class="s1">'string'</span><span class="p">),</span>
1870<span class="p">]</span>
1871</pre></div>
1872</div>
1873<p>You must pass the index as an integer rather than a string. The following
1874produce empty output:</p>
1875<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">values</span><span class="o">|</span><span class="nf">dictsort</span><span class="s2">:"0"</span> <span class="cp">}}</span>
1876</pre></div>
1877</div>
1878<div class="versionchanged">
1879<span class="title">Changed in Django 1.10:</span> <p>The ability to order a list of lists was added.</p>
1880</div>
1881</div>
1882<div class="section" id="s-dictsortreversed">
1883<span id="s-std:templatefilter-dictsortreversed"></span><span id="dictsortreversed"></span><span id="std:templatefilter-dictsortreversed"></span><h3><code class="docutils literal notranslate"><span class="pre">dictsortreversed</span></code><a class="headerlink" href="#dictsortreversed" title="Permalink to this headline">¶</a></h3>
1884<p>Takes a list of dictionaries and returns that list sorted in reverse order by
1885the key given in the argument. This works exactly the same as the above filter,
1886but the returned value will be in reverse order.</p>
1887</div>
1888<div class="section" id="s-divisibleby">
1889<span id="s-std:templatefilter-divisibleby"></span><span id="divisibleby"></span><span id="std:templatefilter-divisibleby"></span><h3><code class="docutils literal notranslate"><span class="pre">divisibleby</span></code><a class="headerlink" href="#divisibleby" title="Permalink to this headline">¶</a></h3>
1890<p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the value is divisible by the argument.</p>
1891<p>For example:</p>
1892<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">divisibleby</span><span class="s2">:"3"</span> <span class="cp">}}</span>
1893</pre></div>
1894</div>
1895<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">21</span></code>, the output would be <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
1896</div>
1897<div class="section" id="s-escape">
1898<span id="s-std:templatefilter-escape"></span><span id="escape"></span><span id="std:templatefilter-escape"></span><h3><code class="docutils literal notranslate"><span class="pre">escape</span></code><a class="headerlink" href="#escape" title="Permalink to this headline">¶</a></h3>
1899<p>Escapes a string’s HTML. Specifically, it makes these replacements:</p>
1900<ul class="simple">
1901<li><code class="docutils literal notranslate"><span class="pre"><</span></code> is converted to <code class="docutils literal notranslate"><span class="pre">&lt;</span></code></li>
1902<li><code class="docutils literal notranslate"><span class="pre">></span></code> is converted to <code class="docutils literal notranslate"><span class="pre">&gt;</span></code></li>
1903<li><code class="docutils literal notranslate"><span class="pre">'</span></code> (single quote) is converted to <code class="docutils literal notranslate"><span class="pre">&#39;</span></code></li>
1904<li><code class="docutils literal notranslate"><span class="pre">"</span></code> (double quote) is converted to <code class="docutils literal notranslate"><span class="pre">&quot;</span></code></li>
1905<li><code class="docutils literal notranslate"><span class="pre">&</span></code> is converted to <code class="docutils literal notranslate"><span class="pre">&amp;</span></code></li>
1906</ul>
1907<p>The escaping is only applied when the string is output, so it does not matter
1908where in a chained sequence of filters you put <code class="docutils literal notranslate"><span class="pre">escape</span></code>: it will always be
1909applied as though it were the last filter. If you want escaping to be applied
1910immediately, use the <a class="reference internal" href="#std:templatefilter-force_escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">force_escape</span></code></a> filter.</p>
1911<p>Applying <code class="docutils literal notranslate"><span class="pre">escape</span></code> to a variable that would normally have auto-escaping
1912applied to the result will only result in one round of escaping being done. So
1913it is safe to use this function even in auto-escaping environments. If you want
1914multiple escaping passes to be applied, use the <a class="reference internal" href="#std:templatefilter-force_escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">force_escape</span></code></a> filter.</p>
1915<p>For example, you can apply <code class="docutils literal notranslate"><span class="pre">escape</span></code> to fields when <a class="reference internal" href="#std:templatetag-autoescape"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">autoescape</span></code></a> is off:</p>
1916<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">autoescape</span> <span class="nv">off</span> <span class="cp">%}</span>
1917 <span class="cp">{{</span> <span class="nv">title</span><span class="o">|</span><span class="nf">escape</span> <span class="cp">}}</span>
1918<span class="cp">{%</span> <span class="k">endautoescape</span> <span class="cp">%}</span>
1919</pre></div>
1920</div>
1921<div class="deprecated">
1922<p><span class="versionmodified">Deprecated since version 1.10: </span>The “lazy†behavior of the <code class="docutils literal notranslate"><span class="pre">escape</span></code> filter is deprecated. It will change
1923to immediately apply <a class="reference internal" href="../../utils/#django.utils.html.conditional_escape" title="django.utils.html.conditional_escape"><code class="xref py py-func docutils literal notranslate"><span class="pre">conditional_escape()</span></code></a> in
1924Django 2.0.</p>
1925</div>
1926</div>
1927<div class="section" id="s-escapejs">
1928<span id="s-std:templatefilter-escapejs"></span><span id="escapejs"></span><span id="std:templatefilter-escapejs"></span><h3><code class="docutils literal notranslate"><span class="pre">escapejs</span></code><a class="headerlink" href="#escapejs" title="Permalink to this headline">¶</a></h3>
1929<p>Escapes characters for use in JavaScript strings. This does <em>not</em> make the
1930string safe for use in HTML, but does protect you from syntax errors when using
1931templates to generate JavaScript/JSON.</p>
1932<p>For example:</p>
1933<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">escapejs</span> <span class="cp">}}</span>
1934</pre></div>
1935</div>
1936<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"testing\r\njavascript</span> <span class="pre">\'string"</span> <span class="pre"><b>escaping</b>"</span></code>,
1937the output will be <code class="docutils literal notranslate"><span class="pre">"testing\\u000D\\u000Ajavascript</span> <span class="pre">\\u0027string\\u0022</span> <span class="pre">\\u003Cb\\u003Eescaping\\u003C/b\\u003E"</span></code>.</p>
1938</div>
1939<div class="section" id="s-filesizeformat">
1940<span id="s-std:templatefilter-filesizeformat"></span><span id="filesizeformat"></span><span id="std:templatefilter-filesizeformat"></span><h3><code class="docutils literal notranslate"><span class="pre">filesizeformat</span></code><a class="headerlink" href="#filesizeformat" title="Permalink to this headline">¶</a></h3>
1941<p>Formats the value like a ‘human-readable’ file size (i.e. <code class="docutils literal notranslate"><span class="pre">'13</span> <span class="pre">KB'</span></code>,
1942<code class="docutils literal notranslate"><span class="pre">'4.1</span> <span class="pre">MB'</span></code>, <code class="docutils literal notranslate"><span class="pre">'102</span> <span class="pre">bytes'</span></code>, etc.).</p>
1943<p>For example:</p>
1944<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">filesizeformat</span> <span class="cp">}}</span>
1945</pre></div>
1946</div>
1947<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is 123456789, the output would be <code class="docutils literal notranslate"><span class="pre">117.7</span> <span class="pre">MB</span></code>.</p>
1948<div class="admonition-file-sizes-and-si-units admonition">
1949<p class="first admonition-title">File sizes and SI units</p>
1950<p class="last">Strictly speaking, <code class="docutils literal notranslate"><span class="pre">filesizeformat</span></code> does not conform to the International
1951System of Units which recommends using KiB, MiB, GiB, etc. when byte sizes
1952are calculated in powers of 1024 (which is the case here). Instead, Django
1953uses traditional unit names (KB, MB, GB, etc.) corresponding to names that
1954are more commonly used.</p>
1955</div>
1956</div>
1957<div class="section" id="s-first">
1958<span id="s-std:templatefilter-first"></span><span id="first"></span><span id="std:templatefilter-first"></span><h3><code class="docutils literal notranslate"><span class="pre">first</span></code><a class="headerlink" href="#first" title="Permalink to this headline">¶</a></h3>
1959<p>Returns the first item in a list.</p>
1960<p>For example:</p>
1961<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">first</span> <span class="cp">}}</span>
1962</pre></div>
1963</div>
1964<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is the list <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c']</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">'a'</span></code>.</p>
1965</div>
1966<div class="section" id="s-floatformat">
1967<span id="s-std:templatefilter-floatformat"></span><span id="floatformat"></span><span id="std:templatefilter-floatformat"></span><h3><code class="docutils literal notranslate"><span class="pre">floatformat</span></code><a class="headerlink" href="#floatformat" title="Permalink to this headline">¶</a></h3>
1968<p>When used without an argument, rounds a floating-point number to one decimal
1969place – but only if there’s a decimal part to be displayed. For example:</p>
1970<table class="docutils">
1971<colgroup>
1972<col width="26%" />
1973<col width="57%" />
1974<col width="17%" />
1975</colgroup>
1976<thead valign="bottom">
1977<tr class="row-odd"><th class="head"><code class="docutils literal notranslate"><span class="pre">value</span></code></th>
1978<th class="head">Template</th>
1979<th class="head">Output</th>
1980</tr>
1981</thead>
1982<tbody valign="top">
1983<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.23234</span></code></td>
1984<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat</span> <span class="pre">}}</span></code></td>
1985<td><code class="docutils literal notranslate"><span class="pre">34.2</span></code></td>
1986</tr>
1987<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">34.00000</span></code></td>
1988<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat</span> <span class="pre">}}</span></code></td>
1989<td><code class="docutils literal notranslate"><span class="pre">34</span></code></td>
1990</tr>
1991<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.26000</span></code></td>
1992<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat</span> <span class="pre">}}</span></code></td>
1993<td><code class="docutils literal notranslate"><span class="pre">34.3</span></code></td>
1994</tr>
1995</tbody>
1996</table>
1997<p>If used with a numeric integer argument, <code class="docutils literal notranslate"><span class="pre">floatformat</span></code> rounds a number to
1998that many decimal places. For example:</p>
1999<table class="docutils">
2000<colgroup>
2001<col width="24%" />
2002<col width="57%" />
2003<col width="20%" />
2004</colgroup>
2005<thead valign="bottom">
2006<tr class="row-odd"><th class="head"><code class="docutils literal notranslate"><span class="pre">value</span></code></th>
2007<th class="head">Template</th>
2008<th class="head">Output</th>
2009</tr>
2010</thead>
2011<tbody valign="top">
2012<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.23234</span></code></td>
2013<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:3</span> <span class="pre">}}</span></code></td>
2014<td><code class="docutils literal notranslate"><span class="pre">34.232</span></code></td>
2015</tr>
2016<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">34.00000</span></code></td>
2017<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:3</span> <span class="pre">}}</span></code></td>
2018<td><code class="docutils literal notranslate"><span class="pre">34.000</span></code></td>
2019</tr>
2020<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.26000</span></code></td>
2021<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:3</span> <span class="pre">}}</span></code></td>
2022<td><code class="docutils literal notranslate"><span class="pre">34.260</span></code></td>
2023</tr>
2024</tbody>
2025</table>
2026<p>Particularly useful is passing 0 (zero) as the argument which will round the
2027float to the nearest integer.</p>
2028<table class="docutils">
2029<colgroup>
2030<col width="22%" />
2031<col width="59%" />
2032<col width="19%" />
2033</colgroup>
2034<thead valign="bottom">
2035<tr class="row-odd"><th class="head"><code class="docutils literal notranslate"><span class="pre">value</span></code></th>
2036<th class="head">Template</th>
2037<th class="head">Output</th>
2038</tr>
2039</thead>
2040<tbody valign="top">
2041<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.23234</span></code></td>
2042<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:"0"</span> <span class="pre">}}</span></code></td>
2043<td><code class="docutils literal notranslate"><span class="pre">34</span></code></td>
2044</tr>
2045<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">34.00000</span></code></td>
2046<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:"0"</span> <span class="pre">}}</span></code></td>
2047<td><code class="docutils literal notranslate"><span class="pre">34</span></code></td>
2048</tr>
2049<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">39.56000</span></code></td>
2050<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:"0"</span> <span class="pre">}}</span></code></td>
2051<td><code class="docutils literal notranslate"><span class="pre">40</span></code></td>
2052</tr>
2053</tbody>
2054</table>
2055<p>If the argument passed to <code class="docutils literal notranslate"><span class="pre">floatformat</span></code> is negative, it will round a number
2056to that many decimal places – but only if there’s a decimal part to be
2057displayed. For example:</p>
2058<table class="docutils">
2059<colgroup>
2060<col width="22%" />
2061<col width="59%" />
2062<col width="19%" />
2063</colgroup>
2064<thead valign="bottom">
2065<tr class="row-odd"><th class="head"><code class="docutils literal notranslate"><span class="pre">value</span></code></th>
2066<th class="head">Template</th>
2067<th class="head">Output</th>
2068</tr>
2069</thead>
2070<tbody valign="top">
2071<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.23234</span></code></td>
2072<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:"-3"</span> <span class="pre">}}</span></code></td>
2073<td><code class="docutils literal notranslate"><span class="pre">34.232</span></code></td>
2074</tr>
2075<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">34.00000</span></code></td>
2076<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:"-3"</span> <span class="pre">}}</span></code></td>
2077<td><code class="docutils literal notranslate"><span class="pre">34</span></code></td>
2078</tr>
2079<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">34.26000</span></code></td>
2080<td><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">value|floatformat:"-3"</span> <span class="pre">}}</span></code></td>
2081<td><code class="docutils literal notranslate"><span class="pre">34.260</span></code></td>
2082</tr>
2083</tbody>
2084</table>
2085<p>Using <code class="docutils literal notranslate"><span class="pre">floatformat</span></code> with no argument is equivalent to using <code class="docutils literal notranslate"><span class="pre">floatformat</span></code>
2086with an argument of <code class="docutils literal notranslate"><span class="pre">-1</span></code>.</p>
2087</div>
2088<div class="section" id="s-force-escape">
2089<span id="s-std:templatefilter-force_escape"></span><span id="force-escape"></span><span id="std:templatefilter-force_escape"></span><h3><code class="docutils literal notranslate"><span class="pre">force_escape</span></code><a class="headerlink" href="#force-escape" title="Permalink to this headline">¶</a></h3>
2090<p>Applies HTML escaping to a string (see the <a class="reference internal" href="#std:templatefilter-escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">escape</span></code></a> filter for
2091details). This filter is applied <em>immediately</em> and returns a new, escaped
2092string. This is useful in the rare cases where you need multiple escaping or
2093want to apply other filters to the escaped results. Normally, you want to use
2094the <a class="reference internal" href="#std:templatefilter-escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">escape</span></code></a> filter.</p>
2095<p>For example, if you want to catch the <code class="docutils literal notranslate"><span class="pre"><p></span></code> HTML elements created by
2096the <a class="reference internal" href="#std:templatefilter-linebreaks"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">linebreaks</span></code></a> filter:</p>
2097<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">autoescape</span> <span class="nv">off</span> <span class="cp">%}</span>
2098 <span class="cp">{{</span> <span class="nv">body</span><span class="o">|</span><span class="nf">linebreaks</span><span class="o">|</span><span class="nf">force_escape</span> <span class="cp">}}</span>
2099<span class="cp">{%</span> <span class="k">endautoescape</span> <span class="cp">%}</span>
2100</pre></div>
2101</div>
2102</div>
2103<div class="section" id="s-get-digit">
2104<span id="s-std:templatefilter-get_digit"></span><span id="get-digit"></span><span id="std:templatefilter-get_digit"></span><h3><code class="docutils literal notranslate"><span class="pre">get_digit</span></code><a class="headerlink" href="#get-digit" title="Permalink to this headline">¶</a></h3>
2105<p>Given a whole number, returns the requested digit, where 1 is the right-most
2106digit, 2 is the second-right-most digit, etc. Returns the original value for
2107invalid input (if input or argument is not an integer, or if argument is less
2108than 1). Otherwise, output is always an integer.</p>
2109<p>For example:</p>
2110<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">get_digit</span><span class="s2">:"2"</span> <span class="cp">}}</span>
2111</pre></div>
2112</div>
2113<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">123456789</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">8</span></code>.</p>
2114</div>
2115<div class="section" id="s-iriencode">
2116<span id="s-std:templatefilter-iriencode"></span><span id="iriencode"></span><span id="std:templatefilter-iriencode"></span><h3><code class="docutils literal notranslate"><span class="pre">iriencode</span></code><a class="headerlink" href="#iriencode" title="Permalink to this headline">¶</a></h3>
2117<p>Converts an IRI (Internationalized Resource Identifier) to a string that is
2118suitable for including in a URL. This is necessary if you’re trying to use
2119strings containing non-ASCII characters in a URL.</p>
2120<p>It’s safe to use this filter on a string that has already gone through the
2121<a class="reference internal" href="#std:templatefilter-urlencode"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">urlencode</span></code></a> filter.</p>
2122<p>For example:</p>
2123<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">iriencode</span> <span class="cp">}}</span>
2124</pre></div>
2125</div>
2126<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"?test=1&me=2"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"?test=1&amp;me=2"</span></code>.</p>
2127</div>
2128<div class="section" id="s-join">
2129<span id="s-std:templatefilter-join"></span><span id="join"></span><span id="std:templatefilter-join"></span><h3><code class="docutils literal notranslate"><span class="pre">join</span></code><a class="headerlink" href="#join" title="Permalink to this headline">¶</a></h3>
2130<p>Joins a list with a string, like Python’s <code class="docutils literal notranslate"><span class="pre">str.join(list)</span></code></p>
2131<p>For example:</p>
2132<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">join</span><span class="s2">:" // "</span> <span class="cp">}}</span>
2133</pre></div>
2134</div>
2135<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is the list <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c']</span></code>, the output will be the string
2136<code class="docutils literal notranslate"><span class="pre">"a</span> <span class="pre">//</span> <span class="pre">b</span> <span class="pre">//</span> <span class="pre">c"</span></code>.</p>
2137</div>
2138<div class="section" id="s-last">
2139<span id="s-std:templatefilter-last"></span><span id="last"></span><span id="std:templatefilter-last"></span><h3><code class="docutils literal notranslate"><span class="pre">last</span></code><a class="headerlink" href="#last" title="Permalink to this headline">¶</a></h3>
2140<p>Returns the last item in a list.</p>
2141<p>For example:</p>
2142<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">last</span> <span class="cp">}}</span>
2143</pre></div>
2144</div>
2145<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is the list <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c',</span> <span class="pre">'d']</span></code>, the output will be the
2146string <code class="docutils literal notranslate"><span class="pre">"d"</span></code>.</p>
2147</div>
2148<div class="section" id="s-length">
2149<span id="s-std:templatefilter-length"></span><span id="length"></span><span id="std:templatefilter-length"></span><h3><code class="docutils literal notranslate"><span class="pre">length</span></code><a class="headerlink" href="#length" title="Permalink to this headline">¶</a></h3>
2150<p>Returns the length of the value. This works for both strings and lists.</p>
2151<p>For example:</p>
2152<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">length</span> <span class="cp">}}</span>
2153</pre></div>
2154</div>
2155<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c',</span> <span class="pre">'d']</span></code> or <code class="docutils literal notranslate"><span class="pre">"abcd"</span></code>, the output will be
2156<code class="docutils literal notranslate"><span class="pre">4</span></code>.</p>
2157<p>The filter returns <code class="docutils literal notranslate"><span class="pre">0</span></code> for an undefined variable.</p>
2158</div>
2159<div class="section" id="s-length-is">
2160<span id="s-std:templatefilter-length_is"></span><span id="length-is"></span><span id="std:templatefilter-length_is"></span><h3><code class="docutils literal notranslate"><span class="pre">length_is</span></code><a class="headerlink" href="#length-is" title="Permalink to this headline">¶</a></h3>
2161<p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the value’s length is the argument, or <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
2162<p>For example:</p>
2163<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">length_is</span><span class="s2">:"4"</span> <span class="cp">}}</span>
2164</pre></div>
2165</div>
2166<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c',</span> <span class="pre">'d']</span></code> or <code class="docutils literal notranslate"><span class="pre">"abcd"</span></code>, the output will be
2167<code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
2168</div>
2169<div class="section" id="s-linebreaks">
2170<span id="s-std:templatefilter-linebreaks"></span><span id="linebreaks"></span><span id="std:templatefilter-linebreaks"></span><h3><code class="docutils literal notranslate"><span class="pre">linebreaks</span></code><a class="headerlink" href="#linebreaks" title="Permalink to this headline">¶</a></h3>
2171<p>Replaces line breaks in plain text with appropriate HTML; a single
2172newline becomes an HTML line break (<code class="docutils literal notranslate"><span class="pre"><br</span> <span class="pre">/></span></code>) and a new line
2173followed by a blank line becomes a paragraph break (<code class="docutils literal notranslate"><span class="pre"></p></span></code>).</p>
2174<p>For example:</p>
2175<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">linebreaks</span> <span class="cp">}}</span>
2176</pre></div>
2177</div>
2178<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">Joel\nis</span> <span class="pre">a</span> <span class="pre">slug</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre"><p>Joel<br</span> <span class="pre">/>is</span> <span class="pre">a</span>
2179<span class="pre">slug</p></span></code>.</p>
2180</div>
2181<div class="section" id="s-linebreaksbr">
2182<span id="s-std:templatefilter-linebreaksbr"></span><span id="linebreaksbr"></span><span id="std:templatefilter-linebreaksbr"></span><h3><code class="docutils literal notranslate"><span class="pre">linebreaksbr</span></code><a class="headerlink" href="#linebreaksbr" title="Permalink to this headline">¶</a></h3>
2183<p>Converts all newlines in a piece of plain text to HTML line breaks
2184(<code class="docutils literal notranslate"><span class="pre"><br</span> <span class="pre">/></span></code>).</p>
2185<p>For example:</p>
2186<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">linebreaksbr</span> <span class="cp">}}</span>
2187</pre></div>
2188</div>
2189<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">Joel\nis</span> <span class="pre">a</span> <span class="pre">slug</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">Joel<br</span> <span class="pre">/>is</span> <span class="pre">a</span>
2190<span class="pre">slug</span></code>.</p>
2191</div>
2192<div class="section" id="s-linenumbers">
2193<span id="s-std:templatefilter-linenumbers"></span><span id="linenumbers"></span><span id="std:templatefilter-linenumbers"></span><h3><code class="docutils literal notranslate"><span class="pre">linenumbers</span></code><a class="headerlink" href="#linenumbers" title="Permalink to this headline">¶</a></h3>
2194<p>Displays text with line numbers.</p>
2195<p>For example:</p>
2196<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">linenumbers</span> <span class="cp">}}</span>
2197</pre></div>
2198</div>
2199<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is:</p>
2200<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>one
2201two
2202three
2203</pre></div>
2204</div>
2205<p>the output will be:</p>
2206<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>1. one
22072. two
22083. three
2209</pre></div>
2210</div>
2211</div>
2212<div class="section" id="s-ljust">
2213<span id="s-std:templatefilter-ljust"></span><span id="ljust"></span><span id="std:templatefilter-ljust"></span><h3><code class="docutils literal notranslate"><span class="pre">ljust</span></code><a class="headerlink" href="#ljust" title="Permalink to this headline">¶</a></h3>
2214<p>Left-aligns the value in a field of a given width.</p>
2215<p><strong>Argument:</strong> field size</p>
2216<p>For example:</p>
2217<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>"<span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">ljust</span><span class="s2">:"10"</span> <span class="cp">}}</span>"
2218</pre></div>
2219</div>
2220<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">Django</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"Django</span>    <span class="pre">"</span></code>.</p>
2221</div>
2222<div class="section" id="s-lower">
2223<span id="s-std:templatefilter-lower"></span><span id="lower"></span><span id="std:templatefilter-lower"></span><h3><code class="docutils literal notranslate"><span class="pre">lower</span></code><a class="headerlink" href="#lower" title="Permalink to this headline">¶</a></h3>
2224<p>Converts a string into all lowercase.</p>
2225<p>For example:</p>
2226<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">lower</span> <span class="cp">}}</span>
2227</pre></div>
2228</div>
2229<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">Totally</span> <span class="pre">LOVING</span> <span class="pre">this</span> <span class="pre">Album!</span></code>, the output will be
2230<code class="docutils literal notranslate"><span class="pre">totally</span> <span class="pre">loving</span> <span class="pre">this</span> <span class="pre">album!</span></code>.</p>
2231</div>
2232<div class="section" id="s-make-list">
2233<span id="s-std:templatefilter-make_list"></span><span id="make-list"></span><span id="std:templatefilter-make_list"></span><h3><code class="docutils literal notranslate"><span class="pre">make_list</span></code><a class="headerlink" href="#make-list" title="Permalink to this headline">¶</a></h3>
2234<p>Returns the value turned into a list. For a string, it’s a list of characters.
2235For an integer, the argument is cast into an unicode string before creating a
2236list.</p>
2237<p>For example:</p>
2238<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">make_list</span> <span class="cp">}}</span>
2239</pre></div>
2240</div>
2241<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is the string <code class="docutils literal notranslate"><span class="pre">"Joel"</span></code>, the output would be the list
2242<code class="docutils literal notranslate"><span class="pre">['J',</span> <span class="pre">'o',</span> <span class="pre">'e',</span> <span class="pre">'l']</span></code>. If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">123</span></code>, the output will be the
2243list <code class="docutils literal notranslate"><span class="pre">['1',</span> <span class="pre">'2',</span> <span class="pre">'3']</span></code>.</p>
2244</div>
2245<div class="section" id="s-phone2numeric">
2246<span id="s-std:templatefilter-phone2numeric"></span><span id="phone2numeric"></span><span id="std:templatefilter-phone2numeric"></span><h3><code class="docutils literal notranslate"><span class="pre">phone2numeric</span></code><a class="headerlink" href="#phone2numeric" title="Permalink to this headline">¶</a></h3>
2247<p>Converts a phone number (possibly containing letters) to its numerical
2248equivalent.</p>
2249<p>The input doesn’t have to be a valid phone number. This will happily convert
2250any string.</p>
2251<p>For example:</p>
2252<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">phone2numeric</span> <span class="cp">}}</span>
2253</pre></div>
2254</div>
2255<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">800-COLLECT</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">800-2655328</span></code>.</p>
2256</div>
2257<div class="section" id="s-pluralize">
2258<span id="s-std:templatefilter-pluralize"></span><span id="pluralize"></span><span id="std:templatefilter-pluralize"></span><h3><code class="docutils literal notranslate"><span class="pre">pluralize</span></code><a class="headerlink" href="#pluralize" title="Permalink to this headline">¶</a></h3>
2259<p>Returns a plural suffix if the value is not 1. By default, this suffix is
2260<code class="docutils literal notranslate"><span class="pre">'s'</span></code>.</p>
2261<p>Example:</p>
2262<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>You have <span class="cp">{{</span> <span class="nv">num_messages</span> <span class="cp">}}</span> message<span class="cp">{{</span> <span class="nv">num_messages</span><span class="o">|</span><span class="nf">pluralize</span> <span class="cp">}}</span>.
2263</pre></div>
2264</div>
2265<p>If <code class="docutils literal notranslate"><span class="pre">num_messages</span></code> is <code class="docutils literal notranslate"><span class="pre">1</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">You</span> <span class="pre">have</span> <span class="pre">1</span> <span class="pre">message.</span></code>
2266If <code class="docutils literal notranslate"><span class="pre">num_messages</span></code> is <code class="docutils literal notranslate"><span class="pre">2</span></code> the output will be <code class="docutils literal notranslate"><span class="pre">You</span> <span class="pre">have</span> <span class="pre">2</span> <span class="pre">messages.</span></code></p>
2267<p>For words that require a suffix other than <code class="docutils literal notranslate"><span class="pre">'s'</span></code>, you can provide an alternate
2268suffix as a parameter to the filter.</p>
2269<p>Example:</p>
2270<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>You have <span class="cp">{{</span> <span class="nv">num_walruses</span> <span class="cp">}}</span> walrus<span class="cp">{{</span> <span class="nv">num_walruses</span><span class="o">|</span><span class="nf">pluralize</span><span class="s2">:"es"</span> <span class="cp">}}</span>.
2271</pre></div>
2272</div>
2273<p>For words that don’t pluralize by simple suffix, you can specify both a
2274singular and plural suffix, separated by a comma.</p>
2275<p>Example:</p>
2276<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>You have <span class="cp">{{</span> <span class="nv">num_cherries</span> <span class="cp">}}</span> cherr<span class="cp">{{</span> <span class="nv">num_cherries</span><span class="o">|</span><span class="nf">pluralize</span><span class="s2">:"y,ies"</span> <span class="cp">}}</span>.
2277</pre></div>
2278</div>
2279<div class="admonition note">
2280<p class="first admonition-title">Note</p>
2281<p class="last">Use <a class="reference internal" href="../../../topics/i18n/translation/#std:templatetag-blocktrans"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">blocktrans</span></code></a> to pluralize translated strings.</p>
2282</div>
2283</div>
2284<div class="section" id="s-pprint">
2285<span id="s-std:templatefilter-pprint"></span><span id="pprint"></span><span id="std:templatefilter-pprint"></span><h3><code class="docutils literal notranslate"><span class="pre">pprint</span></code><a class="headerlink" href="#pprint" title="Permalink to this headline">¶</a></h3>
2286<p>A wrapper around <a class="reference external" href="https://docs.python.org/3/library/pprint.html#pprint.pprint" title="(in Python v3.6)"><code class="xref py py-func docutils literal notranslate"><span class="pre">pprint.pprint()</span></code></a> – for debugging, really.</p>
2287</div>
2288<div class="section" id="s-random">
2289<span id="s-std:templatefilter-random"></span><span id="random"></span><span id="std:templatefilter-random"></span><h3><code class="docutils literal notranslate"><span class="pre">random</span></code><a class="headerlink" href="#random" title="Permalink to this headline">¶</a></h3>
2290<p>Returns a random item from the given list.</p>
2291<p>For example:</p>
2292<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">random</span> <span class="cp">}}</span>
2293</pre></div>
2294</div>
2295<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is the list <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c',</span> <span class="pre">'d']</span></code>, the output could be <code class="docutils literal notranslate"><span class="pre">"b"</span></code>.</p>
2296</div>
2297<div class="section" id="s-rjust">
2298<span id="s-std:templatefilter-rjust"></span><span id="rjust"></span><span id="std:templatefilter-rjust"></span><h3><code class="docutils literal notranslate"><span class="pre">rjust</span></code><a class="headerlink" href="#rjust" title="Permalink to this headline">¶</a></h3>
2299<p>Right-aligns the value in a field of a given width.</p>
2300<p><strong>Argument:</strong> field size</p>
2301<p>For example:</p>
2302<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>"<span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">rjust</span><span class="s2">:"10"</span> <span class="cp">}}</span>"
2303</pre></div>
2304</div>
2305<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">Django</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"</span>    <span class="pre">Django"</span></code>.</p>
2306</div>
2307<div class="section" id="s-safe">
2308<span id="s-std:templatefilter-safe"></span><span id="safe"></span><span id="std:templatefilter-safe"></span><h3><code class="docutils literal notranslate"><span class="pre">safe</span></code><a class="headerlink" href="#safe" title="Permalink to this headline">¶</a></h3>
2309<p>Marks a string as not requiring further HTML escaping prior to output. When
2310autoescaping is off, this filter has no effect.</p>
2311<div class="admonition note">
2312<p class="first admonition-title">Note</p>
2313<p>If you are chaining filters, a filter applied after <code class="docutils literal notranslate"><span class="pre">safe</span></code> can
2314make the contents unsafe again. For example, the following code
2315prints the variable as is, unescaped:</p>
2316<div class="last highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">var</span><span class="o">|</span><span class="nf">safe</span><span class="o">|</span><span class="nf">escape</span> <span class="cp">}}</span>
2317</pre></div>
2318</div>
2319</div>
2320</div>
2321<div class="section" id="s-safeseq">
2322<span id="s-std:templatefilter-safeseq"></span><span id="safeseq"></span><span id="std:templatefilter-safeseq"></span><h3><code class="docutils literal notranslate"><span class="pre">safeseq</span></code><a class="headerlink" href="#safeseq" title="Permalink to this headline">¶</a></h3>
2323<p>Applies the <a class="reference internal" href="#std:templatefilter-safe"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">safe</span></code></a> filter to each element of a sequence. Useful in
2324conjunction with other filters that operate on sequences, such as
2325<a class="reference internal" href="#std:templatefilter-join"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">join</span></code></a>. For example:</p>
2326<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">some_list</span><span class="o">|</span><span class="nf">safeseq</span><span class="o">|</span><span class="nf">join</span><span class="s2">:", "</span> <span class="cp">}}</span>
2327</pre></div>
2328</div>
2329<p>You couldn’t use the <a class="reference internal" href="#std:templatefilter-safe"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">safe</span></code></a> filter directly in this case, as it would
2330first convert the variable into a string, rather than working with the
2331individual elements of the sequence.</p>
2332</div>
2333<div class="section" id="s-slice">
2334<span id="s-std:templatefilter-slice"></span><span id="slice"></span><span id="std:templatefilter-slice"></span><h3><code class="docutils literal notranslate"><span class="pre">slice</span></code><a class="headerlink" href="#slice" title="Permalink to this headline">¶</a></h3>
2335<p>Returns a slice of the list.</p>
2336<p>Uses the same syntax as Python’s list slicing. See
2337<a class="reference external" href="http://www.diveintopython3.net/native-datatypes.html#slicinglists">http://www.diveintopython3.net/native-datatypes.html#slicinglists</a>
2338for an introduction.</p>
2339<p>Example:</p>
2340<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">some_list</span><span class="o">|</span><span class="nf">slice</span><span class="s2">:":2"</span> <span class="cp">}}</span>
2341</pre></div>
2342</div>
2343<p>If <code class="docutils literal notranslate"><span class="pre">some_list</span></code> is <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b',</span> <span class="pre">'c']</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">['a',</span> <span class="pre">'b']</span></code>.</p>
2344</div>
2345<div class="section" id="s-slugify">
2346<span id="s-std:templatefilter-slugify"></span><span id="slugify"></span><span id="std:templatefilter-slugify"></span><h3><code class="docutils literal notranslate"><span class="pre">slugify</span></code><a class="headerlink" href="#slugify" title="Permalink to this headline">¶</a></h3>
2347<p>Converts to ASCII. Converts spaces to hyphens. Removes characters that aren’t
2348alphanumerics, underscores, or hyphens. Converts to lowercase. Also strips
2349leading and trailing whitespace.</p>
2350<p>For example:</p>
2351<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">slugify</span> <span class="cp">}}</span>
2352</pre></div>
2353</div>
2354<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"joel-is-a-slug"</span></code>.</p>
2355</div>
2356<div class="section" id="s-stringformat">
2357<span id="s-std:templatefilter-stringformat"></span><span id="stringformat"></span><span id="std:templatefilter-stringformat"></span><h3><code class="docutils literal notranslate"><span class="pre">stringformat</span></code><a class="headerlink" href="#stringformat" title="Permalink to this headline">¶</a></h3>
2358<p>Formats the variable according to the argument, a string formatting specifier.
2359This specifier uses the <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#old-string-formatting" title="(in Python v3.6)"><span>printf-style String Formatting</span></a> syntax, with the exception
2360that the leading “%†is dropped.</p>
2361<p>For example:</p>
2362<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">stringformat</span><span class="s2">:"E"</span> <span class="cp">}}</span>
2363</pre></div>
2364</div>
2365<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">10</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">1.000000E+01</span></code>.</p>
2366</div>
2367<div class="section" id="s-striptags">
2368<span id="s-std:templatefilter-striptags"></span><span id="striptags"></span><span id="std:templatefilter-striptags"></span><h3><code class="docutils literal notranslate"><span class="pre">striptags</span></code><a class="headerlink" href="#striptags" title="Permalink to this headline">¶</a></h3>
2369<p>Makes all possible efforts to strip all [X]HTML tags.</p>
2370<p>For example:</p>
2371<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">striptags</span> <span class="cp">}}</span>
2372</pre></div>
2373</div>
2374<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"<b>Joel</b></span> <span class="pre"><button>is</button></span> <span class="pre">a</span> <span class="pre"><span>slug</span>"</span></code>, the
2375output will be <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug"</span></code>.</p>
2376<div class="admonition-no-safety-guarantee admonition">
2377<p class="first admonition-title">No safety guarantee</p>
2378<p class="last">Note that <code class="docutils literal notranslate"><span class="pre">striptags</span></code> doesn’t give any guarantee about its output being
2379HTML safe, particularly with non valid HTML input. So <strong>NEVER</strong> apply the
2380<code class="docutils literal notranslate"><span class="pre">safe</span></code> filter to a <code class="docutils literal notranslate"><span class="pre">striptags</span></code> output. If you are looking for something
2381more robust, you can use the <code class="docutils literal notranslate"><span class="pre">bleach</span></code> Python library, notably its
2382<a class="reference external" href="https://bleach.readthedocs.io/en/latest/clean.html">clean</a> method.</p>
2383</div>
2384</div>
2385<div class="section" id="s-time">
2386<span id="s-std:templatefilter-time"></span><span id="time"></span><span id="std:templatefilter-time"></span><h3><code class="docutils literal notranslate"><span class="pre">time</span></code><a class="headerlink" href="#time" title="Permalink to this headline">¶</a></h3>
2387<p>Formats a time according to the given format.</p>
2388<p>Given format can be the predefined one <a class="reference internal" href="../../settings/#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">TIME_FORMAT</span></code></a>, or a custom
2389format, same as the <a class="reference internal" href="#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">date</span></code></a> filter. Note that the predefined format
2390is locale-dependent.</p>
2391<p>For example:</p>
2392<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">time</span><span class="s2">:"H:i"</span> <span class="cp">}}</span>
2393</pre></div>
2394</div>
2395<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">datetime.datetime.now()</span></code>, the output will be
2396the string <code class="docutils literal notranslate"><span class="pre">"01:23"</span></code>.</p>
2397<p>Another example:</p>
2398<p>Assuming that <a class="reference internal" href="../../settings/#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate"><span class="pre">USE_L10N</span></code></a> is <code class="docutils literal notranslate"><span class="pre">True</span></code> and <a class="reference internal" href="../../settings/#std:setting-LANGUAGE_CODE"><code class="xref std std-setting docutils literal notranslate"><span class="pre">LANGUAGE_CODE</span></code></a> is,
2399for example, <code class="docutils literal notranslate"><span class="pre">"de"</span></code>, then for:</p>
2400<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">time</span><span class="s2">:"TIME_FORMAT"</span> <span class="cp">}}</span>
2401</pre></div>
2402</div>
2403<p>the output will be the string <code class="docutils literal notranslate"><span class="pre">"01:23"</span></code> (The <code class="docutils literal notranslate"><span class="pre">"TIME_FORMAT"</span></code> format
2404specifier for the <code class="docutils literal notranslate"><span class="pre">de</span></code> locale as shipped with Django is <code class="docutils literal notranslate"><span class="pre">"H:i"</span></code>).</p>
2405<p>The <code class="docutils literal notranslate"><span class="pre">time</span></code> filter will only accept parameters in the format string that
2406relate to the time of day, not the date (for obvious reasons). If you need to
2407format a <code class="docutils literal notranslate"><span class="pre">date</span></code> value, use the <a class="reference internal" href="#std:templatefilter-date"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">date</span></code></a> filter instead (or along
2408<code class="docutils literal notranslate"><span class="pre">time</span></code> if you need to render a full <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a> value).</p>
2409<p>There is one exception the above rule: When passed a <code class="docutils literal notranslate"><span class="pre">datetime</span></code> value with
2410attached timezone information (a <a class="reference internal" href="../../../topics/i18n/timezones/#naive-vs-aware-datetimes"><span class="std std-ref">time-zone-aware</span></a> <code class="docutils literal notranslate"><span class="pre">datetime</span></code> instance) the <code class="docutils literal notranslate"><span class="pre">time</span></code> filter will
2411accept the timezone-related <a class="reference internal" href="#date-and-time-formatting-specifiers"><span class="std std-ref">format specifiers</span></a> <code class="docutils literal notranslate"><span class="pre">'e'</span></code>, <code class="docutils literal notranslate"><span class="pre">'O'</span></code> , <code class="docutils literal notranslate"><span class="pre">'T'</span></code> and <code class="docutils literal notranslate"><span class="pre">'Z'</span></code>.</p>
2412<p>When used without a format string, the <code class="docutils literal notranslate"><span class="pre">TIME_FORMAT</span></code> format specifier is
2413used:</p>
2414<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">time</span> <span class="cp">}}</span>
2415</pre></div>
2416</div>
2417<p>is the same as:</p>
2418<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">time</span><span class="s2">:"TIME_FORMAT"</span> <span class="cp">}}</span>
2419</pre></div>
2420</div>
2421<div class="versionchanged">
2422<span class="title">Changed in Django 1.10:</span> <p>In older versions, the <a class="reference internal" href="../../settings/#std:setting-TIME_FORMAT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">TIME_FORMAT</span></code></a> setting (without
2423localization) is always used when a format string isn’t given.</p>
2424</div>
2425</div>
2426<div class="section" id="s-timesince">
2427<span id="s-std:templatefilter-timesince"></span><span id="timesince"></span><span id="std:templatefilter-timesince"></span><h3><code class="docutils literal notranslate"><span class="pre">timesince</span></code><a class="headerlink" href="#timesince" title="Permalink to this headline">¶</a></h3>
2428<p>Formats a date as the time since that date (e.g., “4 days, 6 hoursâ€).</p>
2429<p>Takes an optional argument that is a variable containing the date to use as
2430the comparison point (without the argument, the comparison point is <em>now</em>).
2431For example, if <code class="docutils literal notranslate"><span class="pre">blog_date</span></code> is a date instance representing midnight on 1
2432June 2006, and <code class="docutils literal notranslate"><span class="pre">comment_date</span></code> is a date instance for 08:00 on 1 June 2006,
2433then the following would return “8 hoursâ€:</p>
2434<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">blog_date</span><span class="o">|</span><span class="nf">timesince</span><span class="o">:</span><span class="nv">comment_date</span> <span class="cp">}}</span>
2435</pre></div>
2436</div>
2437<p>Comparing offset-naive and offset-aware datetimes will return an empty string.</p>
2438<p>Minutes is the smallest unit used, and “0 minutes†will be returned for any
2439date that is in the future relative to the comparison point.</p>
2440</div>
2441<div class="section" id="s-timeuntil">
2442<span id="s-std:templatefilter-timeuntil"></span><span id="timeuntil"></span><span id="std:templatefilter-timeuntil"></span><h3><code class="docutils literal notranslate"><span class="pre">timeuntil</span></code><a class="headerlink" href="#timeuntil" title="Permalink to this headline">¶</a></h3>
2443<p>Similar to <code class="docutils literal notranslate"><span class="pre">timesince</span></code>, except that it measures the time from now until the
2444given date or datetime. For example, if today is 1 June 2006 and
2445<code class="docutils literal notranslate"><span class="pre">conference_date</span></code> is a date instance holding 29 June 2006, then
2446<code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">conference_date|timeuntil</span> <span class="pre">}}</span></code> will return “4 weeksâ€.</p>
2447<p>Takes an optional argument that is a variable containing the date to use as
2448the comparison point (instead of <em>now</em>). If <code class="docutils literal notranslate"><span class="pre">from_date</span></code> contains 22 June
24492006, then the following will return “1 weekâ€:</p>
2450<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">conference_date</span><span class="o">|</span><span class="nf">timeuntil</span><span class="o">:</span><span class="nv">from_date</span> <span class="cp">}}</span>
2451</pre></div>
2452</div>
2453<p>Comparing offset-naive and offset-aware datetimes will return an empty string.</p>
2454<p>Minutes is the smallest unit used, and “0 minutes†will be returned for any
2455date that is in the past relative to the comparison point.</p>
2456</div>
2457<div class="section" id="s-title">
2458<span id="s-std:templatefilter-title"></span><span id="title"></span><span id="std:templatefilter-title"></span><h3><code class="docutils literal notranslate"><span class="pre">title</span></code><a class="headerlink" href="#title" title="Permalink to this headline">¶</a></h3>
2459<p>Converts a string into titlecase by making words start with an uppercase
2460character and the remaining characters lowercase. This tag makes no effort to
2461keep “trivial words†in lowercase.</p>
2462<p>For example:</p>
2463<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">title</span> <span class="cp">}}</span>
2464</pre></div>
2465</div>
2466<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"my</span> <span class="pre">FIRST</span> <span class="pre">post"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"My</span> <span class="pre">First</span> <span class="pre">Post"</span></code>.</p>
2467</div>
2468<div class="section" id="s-truncatechars">
2469<span id="s-std:templatefilter-truncatechars"></span><span id="truncatechars"></span><span id="std:templatefilter-truncatechars"></span><h3><code class="docutils literal notranslate"><span class="pre">truncatechars</span></code><a class="headerlink" href="#truncatechars" title="Permalink to this headline">¶</a></h3>
2470<p>Truncates a string if it is longer than the specified number of characters.
2471Truncated strings will end with a translatable ellipsis sequence (“…â€).</p>
2472<p><strong>Argument:</strong> Number of characters to truncate to</p>
2473<p>For example:</p>
2474<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">truncatechars</span><span class="o">:</span><span class="m">9</span> <span class="cp">}}</span>
2475</pre></div>
2476</div>
2477<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">i..."</span></code>.</p>
2478</div>
2479<div class="section" id="s-truncatechars-html">
2480<span id="s-std:templatefilter-truncatechars_html"></span><span id="truncatechars-html"></span><span id="std:templatefilter-truncatechars_html"></span><h3><code class="docutils literal notranslate"><span class="pre">truncatechars_html</span></code><a class="headerlink" href="#truncatechars-html" title="Permalink to this headline">¶</a></h3>
2481<p>Similar to <a class="reference internal" href="#std:templatefilter-truncatechars"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">truncatechars</span></code></a>, except that it is aware of HTML tags. Any
2482tags that are opened in the string and not closed before the truncation point
2483are closed immediately after the truncation.</p>
2484<p>For example:</p>
2485<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">truncatechars_html</span><span class="o">:</span><span class="m">9</span> <span class="cp">}}</span>
2486</pre></div>
2487</div>
2488<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"<p>Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug</p>"</span></code>, the output will be
2489<code class="docutils literal notranslate"><span class="pre">"<p>Joel</span> <span class="pre">i...</p>"</span></code>.</p>
2490<p>Newlines in the HTML content will be preserved.</p>
2491</div>
2492<div class="section" id="s-truncatewords">
2493<span id="s-std:templatefilter-truncatewords"></span><span id="truncatewords"></span><span id="std:templatefilter-truncatewords"></span><h3><code class="docutils literal notranslate"><span class="pre">truncatewords</span></code><a class="headerlink" href="#truncatewords" title="Permalink to this headline">¶</a></h3>
2494<p>Truncates a string after a certain number of words.</p>
2495<p><strong>Argument:</strong> Number of words to truncate after</p>
2496<p>For example:</p>
2497<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">truncatewords</span><span class="o">:</span><span class="m">2</span> <span class="cp">}}</span>
2498</pre></div>
2499</div>
2500<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">..."</span></code>.</p>
2501<p>Newlines within the string will be removed.</p>
2502</div>
2503<div class="section" id="s-truncatewords-html">
2504<span id="s-std:templatefilter-truncatewords_html"></span><span id="truncatewords-html"></span><span id="std:templatefilter-truncatewords_html"></span><h3><code class="docutils literal notranslate"><span class="pre">truncatewords_html</span></code><a class="headerlink" href="#truncatewords-html" title="Permalink to this headline">¶</a></h3>
2505<p>Similar to <a class="reference internal" href="#std:templatefilter-truncatewords"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">truncatewords</span></code></a>, except that it is aware of HTML tags. Any
2506tags that are opened in the string and not closed before the truncation point,
2507are closed immediately after the truncation.</p>
2508<p>This is less efficient than <a class="reference internal" href="#std:templatefilter-truncatewords"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">truncatewords</span></code></a>, so should only be used
2509when it is being passed HTML text.</p>
2510<p>For example:</p>
2511<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">truncatewords_html</span><span class="o">:</span><span class="m">2</span> <span class="cp">}}</span>
2512</pre></div>
2513</div>
2514<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"<p>Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug</p>"</span></code>, the output will be
2515<code class="docutils literal notranslate"><span class="pre">"<p>Joel</span> <span class="pre">is</span> <span class="pre">...</p>"</span></code>.</p>
2516<p>Newlines in the HTML content will be preserved.</p>
2517</div>
2518<div class="section" id="s-unordered-list">
2519<span id="s-std:templatefilter-unordered_list"></span><span id="unordered-list"></span><span id="std:templatefilter-unordered_list"></span><h3><code class="docutils literal notranslate"><span class="pre">unordered_list</span></code><a class="headerlink" href="#unordered-list" title="Permalink to this headline">¶</a></h3>
2520<p>Recursively takes a self-nested list and returns an HTML unordered list –
2521WITHOUT opening and closing <ul> tags.</p>
2522<p>The list is assumed to be in the proper format. For example, if <code class="docutils literal notranslate"><span class="pre">var</span></code>
2523contains <code class="docutils literal notranslate"><span class="pre">['States',</span> <span class="pre">['Kansas',</span> <span class="pre">['Lawrence',</span> <span class="pre">'Topeka'],</span> <span class="pre">'Illinois']]</span></code>, then
2524<code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">var|unordered_list</span> <span class="pre">}}</span></code> would return:</p>
2525<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">li</span><span class="p">></span>States
2526<span class="p"><</span><span class="nt">ul</span><span class="p">></span>
2527 <span class="p"><</span><span class="nt">li</span><span class="p">></span>Kansas
2528 <span class="p"><</span><span class="nt">ul</span><span class="p">></span>
2529 <span class="p"><</span><span class="nt">li</span><span class="p">></span>Lawrence<span class="p"></</span><span class="nt">li</span><span class="p">></span>
2530 <span class="p"><</span><span class="nt">li</span><span class="p">></span>Topeka<span class="p"></</span><span class="nt">li</span><span class="p">></span>
2531 <span class="p"></</span><span class="nt">ul</span><span class="p">></span>
2532 <span class="p"></</span><span class="nt">li</span><span class="p">></span>
2533 <span class="p"><</span><span class="nt">li</span><span class="p">></span>Illinois<span class="p"></</span><span class="nt">li</span><span class="p">></span>
2534<span class="p"></</span><span class="nt">ul</span><span class="p">></span>
2535<span class="p"></</span><span class="nt">li</span><span class="p">></span>
2536</pre></div>
2537</div>
2538</div>
2539<div class="section" id="s-upper">
2540<span id="s-std:templatefilter-upper"></span><span id="upper"></span><span id="std:templatefilter-upper"></span><h3><code class="docutils literal notranslate"><span class="pre">upper</span></code><a class="headerlink" href="#upper" title="Permalink to this headline">¶</a></h3>
2541<p>Converts a string into all uppercase.</p>
2542<p>For example:</p>
2543<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">upper</span> <span class="cp">}}</span>
2544</pre></div>
2545</div>
2546<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">"JOEL</span> <span class="pre">IS</span> <span class="pre">A</span> <span class="pre">SLUG"</span></code>.</p>
2547</div>
2548<div class="section" id="s-urlencode">
2549<span id="s-std:templatefilter-urlencode"></span><span id="urlencode"></span><span id="std:templatefilter-urlencode"></span><h3><code class="docutils literal notranslate"><span class="pre">urlencode</span></code><a class="headerlink" href="#urlencode" title="Permalink to this headline">¶</a></h3>
2550<p>Escapes a value for use in a URL.</p>
2551<p>For example:</p>
2552<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">urlencode</span> <span class="cp">}}</span>
2553</pre></div>
2554</div>
2555<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"https://www.example.org/foo?a=b&c=d"</span></code>, the output will be
2556<code class="docutils literal notranslate"><span class="pre">"https%3A//www.example.org/foo%3Fa%3Db%26c%3Dd"</span></code>.</p>
2557<p>An optional argument containing the characters which should not be escaped can
2558be provided.</p>
2559<p>If not provided, the ‘/’ character is assumed safe. An empty string can be
2560provided when <em>all</em> characters should be escaped. For example:</p>
2561<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">urlencode</span><span class="s2">:""</span> <span class="cp">}}</span>
2562</pre></div>
2563</div>
2564<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"https://www.example.org/"</span></code>, the output will be
2565<code class="docutils literal notranslate"><span class="pre">"https%3A%2F%2Fwww.example.org%2F"</span></code>.</p>
2566</div>
2567<div class="section" id="s-urlize">
2568<span id="s-std:templatefilter-urlize"></span><span id="urlize"></span><span id="std:templatefilter-urlize"></span><h3><code class="docutils literal notranslate"><span class="pre">urlize</span></code><a class="headerlink" href="#urlize" title="Permalink to this headline">¶</a></h3>
2569<p>Converts URLs and email addresses in text into clickable links.</p>
2570<p>This template tag works on links prefixed with <code class="docutils literal notranslate"><span class="pre">http://</span></code>, <code class="docutils literal notranslate"><span class="pre">https://</span></code>, or
2571<code class="docutils literal notranslate"><span class="pre">www.</span></code>. For example, <code class="docutils literal notranslate"><span class="pre">https://goo.gl/aia1t</span></code> will get converted but
2572<code class="docutils literal notranslate"><span class="pre">goo.gl/aia1t</span></code> won’t.</p>
2573<p>It also supports domain-only links ending in one of the original top level
2574domains (<code class="docutils literal notranslate"><span class="pre">.com</span></code>, <code class="docutils literal notranslate"><span class="pre">.edu</span></code>, <code class="docutils literal notranslate"><span class="pre">.gov</span></code>, <code class="docutils literal notranslate"><span class="pre">.int</span></code>, <code class="docutils literal notranslate"><span class="pre">.mil</span></code>, <code class="docutils literal notranslate"><span class="pre">.net</span></code>, and
2575<code class="docutils literal notranslate"><span class="pre">.org</span></code>). For example, <code class="docutils literal notranslate"><span class="pre">djangoproject.com</span></code> gets converted.</p>
2576<p>Links can have trailing punctuation (periods, commas, close-parens) and leading
2577punctuation (opening parens), and <code class="docutils literal notranslate"><span class="pre">urlize</span></code> will still do the right thing.</p>
2578<p>Links generated by <code class="docutils literal notranslate"><span class="pre">urlize</span></code> have a <code class="docutils literal notranslate"><span class="pre">rel="nofollow"</span></code> attribute added
2579to them.</p>
2580<p>For example:</p>
2581<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">urlize</span> <span class="cp">}}</span>
2582</pre></div>
2583</div>
2584<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Check</span> <span class="pre">out</span> <span class="pre">www.djangoproject.com"</span></code>, the output will be
2585<code class="docutils literal notranslate"><span class="pre">"Check</span> <span class="pre">out</span> <span class="pre"><a</span> <span class="pre">href="http://www.djangoproject.com"</span>
2586<span class="pre">rel="nofollow">www.djangoproject.com</a>"</span></code>.</p>
2587<p>In addition to web links, <code class="docutils literal notranslate"><span class="pre">urlize</span></code> also converts email addresses into
2588<code class="docutils literal notranslate"><span class="pre">mailto:</span></code> links. If <code class="docutils literal notranslate"><span class="pre">value</span></code> is
2589<code class="docutils literal notranslate"><span class="pre">"Send</span> <span class="pre">questions</span> <span class="pre">to</span> <span class="pre">foo@example.com"</span></code>, the output will be
2590<code class="docutils literal notranslate"><span class="pre">"Send</span> <span class="pre">questions</span> <span class="pre">to</span> <span class="pre"><a</span> <span class="pre">href="mailto:foo@example.com">foo@example.com</a>"</span></code>.</p>
2591<p>The <code class="docutils literal notranslate"><span class="pre">urlize</span></code> filter also takes an optional parameter <code class="docutils literal notranslate"><span class="pre">autoescape</span></code>. If
2592<code class="docutils literal notranslate"><span class="pre">autoescape</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, the link text and URLs will be escaped using
2593Django’s built-in <a class="reference internal" href="#std:templatefilter-escape"><code class="xref std std-tfilter docutils literal notranslate"><span class="pre">escape</span></code></a> filter. The default value for
2594<code class="docutils literal notranslate"><span class="pre">autoescape</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
2595<div class="admonition note">
2596<p class="first admonition-title">Note</p>
2597<p class="last">If <code class="docutils literal notranslate"><span class="pre">urlize</span></code> is applied to text that already contains HTML markup,
2598things won’t work as expected. Apply this filter only to plain text.</p>
2599</div>
2600</div>
2601<div class="section" id="s-urlizetrunc">
2602<span id="s-std:templatefilter-urlizetrunc"></span><span id="urlizetrunc"></span><span id="std:templatefilter-urlizetrunc"></span><h3><code class="docutils literal notranslate"><span class="pre">urlizetrunc</span></code><a class="headerlink" href="#urlizetrunc" title="Permalink to this headline">¶</a></h3>
2603<p>Converts URLs and email addresses into clickable links just like <a class="reference internal" href="#urlize">urlize</a>, but
2604truncates URLs longer than the given character limit.</p>
2605<p><strong>Argument:</strong> Number of characters that link text should be truncated to,
2606including the ellipsis that’s added if truncation is necessary.</p>
2607<p>For example:</p>
2608<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">urlizetrunc</span><span class="o">:</span><span class="m">15</span> <span class="cp">}}</span>
2609</pre></div>
2610</div>
2611<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Check</span> <span class="pre">out</span> <span class="pre">www.djangoproject.com"</span></code>, the output would be
2612<code class="docutils literal notranslate"><span class="pre">'Check</span> <span class="pre">out</span> <span class="pre"><a</span> <span class="pre">href="http://www.djangoproject.com"</span>
2613<span class="pre">rel="nofollow">www.djangopr...</a>'</span></code>.</p>
2614<p>As with <a class="reference internal" href="#urlize">urlize</a>, this filter should only be applied to plain text.</p>
2615</div>
2616<div class="section" id="s-wordcount">
2617<span id="s-std:templatefilter-wordcount"></span><span id="wordcount"></span><span id="std:templatefilter-wordcount"></span><h3><code class="docutils literal notranslate"><span class="pre">wordcount</span></code><a class="headerlink" href="#wordcount" title="Permalink to this headline">¶</a></h3>
2618<p>Returns the number of words.</p>
2619<p>For example:</p>
2620<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">wordcount</span> <span class="cp">}}</span>
2621</pre></div>
2622</div>
2623<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">"Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug"</span></code>, the output will be <code class="docutils literal notranslate"><span class="pre">4</span></code>.</p>
2624</div>
2625<div class="section" id="s-wordwrap">
2626<span id="s-std:templatefilter-wordwrap"></span><span id="wordwrap"></span><span id="std:templatefilter-wordwrap"></span><h3><code class="docutils literal notranslate"><span class="pre">wordwrap</span></code><a class="headerlink" href="#wordwrap" title="Permalink to this headline">¶</a></h3>
2627<p>Wraps words at specified line length.</p>
2628<p><strong>Argument:</strong> number of characters at which to wrap the text</p>
2629<p>For example:</p>
2630<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">wordwrap</span><span class="o">:</span><span class="m">5</span> <span class="cp">}}</span>
2631</pre></div>
2632</div>
2633<p>If <code class="docutils literal notranslate"><span class="pre">value</span></code> is <code class="docutils literal notranslate"><span class="pre">Joel</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">slug</span></code>, the output would be:</p>
2634<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span>Joel
2635is a
2636slug
2637</pre></div>
2638</div>
2639</div>
2640<div class="section" id="s-yesno">
2641<span id="s-std:templatefilter-yesno"></span><span id="yesno"></span><span id="std:templatefilter-yesno"></span><h3><code class="docutils literal notranslate"><span class="pre">yesno</span></code><a class="headerlink" href="#yesno" title="Permalink to this headline">¶</a></h3>
2642<p>Maps values for <code class="docutils literal notranslate"><span class="pre">True</span></code>, <code class="docutils literal notranslate"><span class="pre">False</span></code>, and (optionally) <code class="docutils literal notranslate"><span class="pre">None</span></code>, to the strings
2643“yesâ€, “noâ€, “maybeâ€, or a custom mapping passed as a comma-separated list, and
2644returns one of those strings according to the value:</p>
2645<p>For example:</p>
2646<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">yesno</span><span class="s2">:"yeah,no,maybe"</span> <span class="cp">}}</span>
2647</pre></div>
2648</div>
2649<table class="docutils">
2650<colgroup>
2651<col width="13%" />
2652<col width="29%" />
2653<col width="57%" />
2654</colgroup>
2655<thead valign="bottom">
2656<tr class="row-odd"><th class="head">Value</th>
2657<th class="head">Argument</th>
2658<th class="head">Outputs</th>
2659</tr>
2660</thead>
2661<tbody valign="top">
2662<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">True</span></code></td>
2663<td> </td>
2664<td><code class="docutils literal notranslate"><span class="pre">yes</span></code></td>
2665</tr>
2666<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">True</span></code></td>
2667<td><code class="docutils literal notranslate"><span class="pre">"yeah,no,maybe"</span></code></td>
2668<td><code class="docutils literal notranslate"><span class="pre">yeah</span></code></td>
2669</tr>
2670<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">False</span></code></td>
2671<td><code class="docutils literal notranslate"><span class="pre">"yeah,no,maybe"</span></code></td>
2672<td><code class="docutils literal notranslate"><span class="pre">no</span></code></td>
2673</tr>
2674<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">None</span></code></td>
2675<td><code class="docutils literal notranslate"><span class="pre">"yeah,no,maybe"</span></code></td>
2676<td><code class="docutils literal notranslate"><span class="pre">maybe</span></code></td>
2677</tr>
2678<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">None</span></code></td>
2679<td><code class="docutils literal notranslate"><span class="pre">"yeah,no"</span></code></td>
2680<td><code class="docutils literal notranslate"><span class="pre">no</span></code> (converts <code class="docutils literal notranslate"><span class="pre">None</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>
2681if no mapping for <code class="docutils literal notranslate"><span class="pre">None</span></code> is given)</td>
2682</tr>
2683</tbody>
2684</table>
2685</div>
2686</div>
2687<div class="section" id="s-internationalization-tags-and-filters">
2688<span id="internationalization-tags-and-filters"></span><h2>Internationalization tags and filters<a class="headerlink" href="#internationalization-tags-and-filters" title="Permalink to this headline">¶</a></h2>
2689<p>Django provides template tags and filters to control each aspect of
2690<a class="reference internal" href="../../../topics/i18n/"><span class="doc">internationalization</span></a> in templates. They allow for
2691granular control of translations, formatting, and time zone conversions.</p>
2692<div class="section" id="s-i18n">
2693<span id="i18n"></span><h3><code class="docutils literal notranslate"><span class="pre">i18n</span></code><a class="headerlink" href="#i18n" title="Permalink to this headline">¶</a></h3>
2694<p>This library allows specifying translatable text in templates.
2695To enable it, set <a class="reference internal" href="../../settings/#std:setting-USE_I18N"><code class="xref std std-setting docutils literal notranslate"><span class="pre">USE_I18N</span></code></a> to <code class="docutils literal notranslate"><span class="pre">True</span></code>, then load it with
2696<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">load</span> <span class="pre">i18n</span> <span class="pre">%}</span></code>.</p>
2697<p>See <a class="reference internal" href="../../../topics/i18n/translation/#specifying-translation-strings-in-template-code"><span class="std std-ref">Internationalization: in template code</span></a>.</p>
2698</div>
2699<div class="section" id="s-l10n">
2700<span id="l10n"></span><h3><code class="docutils literal notranslate"><span class="pre">l10n</span></code><a class="headerlink" href="#l10n" title="Permalink to this headline">¶</a></h3>
2701<p>This library provides control over the localization of values in templates.
2702You only need to load the library using <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">load</span> <span class="pre">l10n</span> <span class="pre">%}</span></code>, but you’ll often
2703set <a class="reference internal" href="../../settings/#std:setting-USE_L10N"><code class="xref std std-setting docutils literal notranslate"><span class="pre">USE_L10N</span></code></a> to <code class="docutils literal notranslate"><span class="pre">True</span></code> so that localization is active by default.</p>
2704<p>See <a class="reference internal" href="../../../topics/i18n/formatting/#topic-l10n-templates"><span class="std std-ref">Controlling localization in templates</span></a>.</p>
2705</div>
2706<div class="section" id="s-tz">
2707<span id="tz"></span><h3><code class="docutils literal notranslate"><span class="pre">tz</span></code><a class="headerlink" href="#tz" title="Permalink to this headline">¶</a></h3>
2708<p>This library provides control over time zone conversions in templates.
2709Like <code class="docutils literal notranslate"><span class="pre">l10n</span></code>, you only need to load the library using <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">load</span> <span class="pre">tz</span> <span class="pre">%}</span></code>,
2710but you’ll usually also set <a class="reference internal" href="../../settings/#std:setting-USE_TZ"><code class="xref std std-setting docutils literal notranslate"><span class="pre">USE_TZ</span></code></a> to <code class="docutils literal notranslate"><span class="pre">True</span></code> so that conversion
2711to local time happens by default.</p>
2712<p>See <a class="reference internal" href="../../../topics/i18n/timezones/#time-zones-in-templates"><span class="std std-ref">Time zone aware output in templates</span></a>.</p>
2713</div>
2714</div>
2715<div class="section" id="s-other-tags-and-filters-libraries">
2716<span id="other-tags-and-filters-libraries"></span><h2>Other tags and filters libraries<a class="headerlink" href="#other-tags-and-filters-libraries" title="Permalink to this headline">¶</a></h2>
2717<p>Django comes with a couple of other template-tag libraries that you have to
2718enable explicitly in your <a class="reference internal" href="../../settings/#std:setting-INSTALLED_APPS"><code class="xref std std-setting docutils literal notranslate"><span class="pre">INSTALLED_APPS</span></code></a> setting and enable in your
2719template with the <a class="reference internal" href="#std:templatetag-load"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">{%</span> <span class="pre">load</span> <span class="pre">%}</span></code></a> tag.</p>
2720<div class="section" id="s-django-contrib-humanize">
2721<span id="django-contrib-humanize"></span><h3><code class="docutils literal notranslate"><span class="pre">django.contrib.humanize</span></code><a class="headerlink" href="#django-contrib-humanize" title="Permalink to this headline">¶</a></h3>
2722<p>A set of Django template filters useful for adding a “human touch†to data. See
2723<a class="reference internal" href="../../contrib/humanize/"><span class="doc">django.contrib.humanize</span></a>.</p>
2724</div>
2725<div class="section" id="s-static">
2726<span id="static"></span><h3><code class="docutils literal notranslate"><span class="pre">static</span></code><a class="headerlink" href="#static" title="Permalink to this headline">¶</a></h3>
2727<div class="section" id="s-std:templatetag-static">
2728<span id="s-id6"></span><span id="std:templatetag-static"></span><span id="id6"></span><h4><code class="docutils literal notranslate"><span class="pre">static</span></code><a class="headerlink" href="#std:templatetag-static" title="Permalink to this headline">¶</a></h4>
2729<p>To link to static files that are saved in <a class="reference internal" href="../../settings/#std:setting-STATIC_ROOT"><code class="xref std std-setting docutils literal notranslate"><span class="pre">STATIC_ROOT</span></code></a> Django ships
2730with a <a class="reference internal" href="#std:templatetag-static"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">static</span></code></a> template tag. If the <a class="reference internal" href="../../contrib/staticfiles/#module-django.contrib.staticfiles" title="django.contrib.staticfiles: An app for handling static files."><code class="xref py py-mod docutils literal notranslate"><span class="pre">django.contrib.staticfiles</span></code></a>
2731app is installed, the tag will serve files using <code class="docutils literal notranslate"><span class="pre">url()</span></code> method of the
2732storage specified by <a class="reference internal" href="../../settings/#std:setting-STATICFILES_STORAGE"><code class="xref std std-setting docutils literal notranslate"><span class="pre">STATICFILES_STORAGE</span></code></a>. For example:</p>
2733<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="cp">%}</span>
2734<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">static</span> <span class="s2">"images/hi.jpg"</span> <span class="cp">%}</span><span class="s">"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Hi!"</span> <span class="p">/></span>
2735</pre></div>
2736</div>
2737<p>It is also able to consume standard context variables, e.g. assuming a
2738<code class="docutils literal notranslate"><span class="pre">user_stylesheet</span></code> variable is passed to the template:</p>
2739<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="cp">%}</span>
2740<span class="p"><</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">"quot;stylesheet"</span> <span class="na">href</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">static</span> <span class="nv">user_stylesheet</span> <span class="cp">%}</span><span class="s">"</span> <span class="na">type</span><span class="o">=</span><span class="s">"text/css"</span> <span class="na">media</span><span class="o">=</span><span class="s">"screen"</span> <span class="p">/></span>
2741</pre></div>
2742</div>
2743<p>If you’d like to retrieve a static URL without displaying it, you can use a
2744slightly different call:</p>
2745<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="cp">%}</span>
2746<span class="cp">{%</span> <span class="k">static</span> <span class="s2">"images/hi.jpg"</span> <span class="k">as</span> <span class="nv">myphoto</span> <span class="cp">%}</span>
2747<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">myphoto</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></</span><span class="nt">img</span><span class="p">></span>
2748</pre></div>
2749</div>
2750<div class="admonition-using-jinja2-templates admonition">
2751<p class="first admonition-title">Using Jinja2 templates?</p>
2752<p class="last">See <a class="reference internal" href="../../../topics/templates/#django.template.backends.jinja2.Jinja2" title="django.template.backends.jinja2.Jinja2"><code class="xref py py-class docutils literal notranslate"><span class="pre">Jinja2</span></code></a> for information on
2753using the <code class="docutils literal notranslate"><span class="pre">static</span></code> tag with Jinja2.</p>
2754</div>
2755<div class="versionchanged">
2756<span class="title">Changed in Django 1.10:</span> <p>In older versions, you had to use <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">load</span> <span class="pre">static</span> <span class="pre">from</span> <span class="pre">staticfiles</span> <span class="pre">%}</span></code> in
2757your template to serve files from the storage defined in
2758<a class="reference internal" href="../../settings/#std:setting-STATICFILES_STORAGE"><code class="xref std std-setting docutils literal notranslate"><span class="pre">STATICFILES_STORAGE</span></code></a>. This is no longer required.</p>
2759</div>
2760</div>
2761<div class="section" id="s-get-static-prefix">
2762<span id="s-std:templatetag-get_static_prefix"></span><span id="get-static-prefix"></span><span id="std:templatetag-get_static_prefix"></span><h4><code class="docutils literal notranslate"><span class="pre">get_static_prefix</span></code><a class="headerlink" href="#get-static-prefix" title="Permalink to this headline">¶</a></h4>
2763<p>You should prefer the <a class="reference internal" href="#std:templatetag-static"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">static</span></code></a> template tag, but if you need more control
2764over exactly where and how <a class="reference internal" href="../../settings/#std:setting-STATIC_URL"><code class="xref std std-setting docutils literal notranslate"><span class="pre">STATIC_URL</span></code></a> is injected into the template,
2765you can use the <a class="reference internal" href="#std:templatetag-get_static_prefix"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">get_static_prefix</span></code></a> template tag:</p>
2766<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="cp">%}</span>
2767<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">get_static_prefix</span> <span class="cp">%}</span><span class="s">images/hi.jpg"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Hi!"</span> <span class="p">/></span>
2768</pre></div>
2769</div>
2770<p>There’s also a second form you can use to avoid extra processing if you need
2771the value multiple times:</p>
2772<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="cp">%}</span>
2773<span class="cp">{%</span> <span class="k">get_static_prefix</span> <span class="k">as</span> <span class="nv">STATIC_PREFIX</span> <span class="cp">%}</span>
2774
2775<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">STATIC_PREFIX</span> <span class="cp">}}</span><span class="s">images/hi.jpg"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Hi!"</span> <span class="p">/></span>
2776<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">STATIC_PREFIX</span> <span class="cp">}}</span><span class="s">images/hi2.jpg"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Hello!"</span> <span class="p">/></span>
2777</pre></div>
2778</div>
2779</div>
2780<div class="section" id="s-get-media-prefix">
2781<span id="s-std:templatetag-get_media_prefix"></span><span id="get-media-prefix"></span><span id="std:templatetag-get_media_prefix"></span><h4><code class="docutils literal notranslate"><span class="pre">get_media_prefix</span></code><a class="headerlink" href="#get-media-prefix" title="Permalink to this headline">¶</a></h4>
2782<p>Similar to the <a class="reference internal" href="#std:templatetag-get_static_prefix"><code class="xref std std-ttag docutils literal notranslate"><span class="pre">get_static_prefix</span></code></a>, <code class="docutils literal notranslate"><span class="pre">get_media_prefix</span></code> populates a
2783template variable with the media prefix <a class="reference internal" href="../../settings/#std:setting-MEDIA_URL"><code class="xref std std-setting docutils literal notranslate"><span class="pre">MEDIA_URL</span></code></a>, e.g.:</p>
2784<div class="highlight-html+django notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="cp">%}</span>
2785<span class="p"><</span><span class="nt">body</span> <span class="na">data-media-url</span><span class="o">=</span><span class="s">"</span><span class="cp">{%</span> <span class="k">get_media_prefix</span> <span class="cp">%}</span><span class="s">"</span><span class="p">></span>
2786</pre></div>
2787</div>
2788<p>By storing the value in a data attribute, we ensure it’s escaped appropriately
2789if we want to use it in a JavaScript context.</p>
2790</div>
2791</div>
2792</div>
2793</div>
2794
2795</div>
2796
2797
2798
2799<div class="browse-horizontal">
2800
2801 <div class="left"><a href="../language/"><i class="icon icon-chevron-left"></i> The Django template language</a></div>
2802
2803
2804 <div class="right"><a href="../api/">The Django template language: for Python programmers <i class="icon icon-chevron-right"></i></a></div>
2805
2806</div>
2807
2808
2809
2810 <a href="#top" class="backtotop"><i class="icon icon-chevron-up"></i> Back to Top</a>
2811 </div>
2812
2813
2814<h1 class="visuallyhidden">Additional Information</h1>
2815<div role="complementary">
2816
2817
2818
2819<form action="https://docs.djangoproject.com/en/1.11/search/" class="search form-input" role="search">
2820 <label class="visuallyhidden" for="news-search">Search:</label>
2821 <input type="search" name="q" id="id_q" placeholder="Search 1.11 documentation" />
2822
2823 <button type="submit">
2824 <i class="icon icon-search"></i>
2825 <span class="visuallyhidden">Search</span>
2826 </button>
2827</form>
2828
2829
2830
2831
2832
2833
2834 <div class="fundraising-sidebar">
2835 <h2>Support Django!</h2>
2836
2837 <div class="small-heart">
2838 <img src="/s/img/small-fundraising-heart.d255f6e934e5.png" alt="Support Django!" />
2839 </div>
2840
2841 <div class="small-cta">
2842 <ul class="list-links-small">
2843 <li><a href="https://www.djangoproject.com/fundraising/">
2844 RochApps donated to the Django Software Foundation to
2845 support Django development. Donate today!
2846 </a></li>
2847 </ul>
2848 </div>
2849 </div>
2850
2851
2852
2853
2854 <h2>Contents</h2>
2855
2856 <ul>
2857<li><a class="reference internal" href="#">Built-in template tags and filters</a><ul>
2858<li><a class="reference internal" href="#built-in-tag-reference">Built-in tag reference</a><ul>
2859<li><a class="reference internal" href="#autoescape"><code class="docutils literal notranslate"><span class="pre">autoescape</span></code></a></li>
2860<li><a class="reference internal" href="#block"><code class="docutils literal notranslate"><span class="pre">block</span></code></a></li>
2861<li><a class="reference internal" href="#comment"><code class="docutils literal notranslate"><span class="pre">comment</span></code></a></li>
2862<li><a class="reference internal" href="#csrf-token"><code class="docutils literal notranslate"><span class="pre">csrf_token</span></code></a></li>
2863<li><a class="reference internal" href="#cycle"><code class="docutils literal notranslate"><span class="pre">cycle</span></code></a></li>
2864<li><a class="reference internal" href="#debug"><code class="docutils literal notranslate"><span class="pre">debug</span></code></a></li>
2865<li><a class="reference internal" href="#extends"><code class="docutils literal notranslate"><span class="pre">extends</span></code></a></li>
2866<li><a class="reference internal" href="#filter"><code class="docutils literal notranslate"><span class="pre">filter</span></code></a></li>
2867<li><a class="reference internal" href="#firstof"><code class="docutils literal notranslate"><span class="pre">firstof</span></code></a></li>
2868<li><a class="reference internal" href="#for"><code class="docutils literal notranslate"><span class="pre">for</span></code></a></li>
2869<li><a class="reference internal" href="#for-empty"><code class="docutils literal notranslate"><span class="pre">for</span></code> … <code class="docutils literal notranslate"><span class="pre">empty</span></code></a></li>
2870<li><a class="reference internal" href="#if"><code class="docutils literal notranslate"><span class="pre">if</span></code></a><ul>
2871<li><a class="reference internal" href="#boolean-operators">Boolean operators</a><ul>
2872<li><a class="reference internal" href="#operator"><code class="docutils literal notranslate"><span class="pre">==</span></code> operator</a></li>
2873<li><a class="reference internal" href="#id1"><code class="docutils literal notranslate"><span class="pre">!=</span></code> operator</a></li>
2874<li><a class="reference internal" href="#id2"><code class="docutils literal notranslate"><span class="pre"><</span></code> operator</a></li>
2875<li><a class="reference internal" href="#id3"><code class="docutils literal notranslate"><span class="pre">></span></code> operator</a></li>
2876<li><a class="reference internal" href="#id4"><code class="docutils literal notranslate"><span class="pre"><=</span></code> operator</a></li>
2877<li><a class="reference internal" href="#id5"><code class="docutils literal notranslate"><span class="pre">>=</span></code> operator</a></li>
2878<li><a class="reference internal" href="#in-operator"><code class="docutils literal notranslate"><span class="pre">in</span></code> operator</a></li>
2879<li><a class="reference internal" href="#not-in-operator"><code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code> operator</a></li>
2880<li><a class="reference internal" href="#is-operator"><code class="docutils literal notranslate"><span class="pre">is</span></code> operator</a></li>
2881<li><a class="reference internal" href="#is-not-operator"><code class="docutils literal notranslate"><span class="pre">is</span> <span class="pre">not</span></code> operator</a></li>
2882</ul>
2883</li>
2884<li><a class="reference internal" href="#filters">Filters</a></li>
2885<li><a class="reference internal" href="#complex-expressions">Complex expressions</a></li>
2886</ul>
2887</li>
2888<li><a class="reference internal" href="#ifequal-and-ifnotequal"><code class="docutils literal notranslate"><span class="pre">ifequal</span></code> and <code class="docutils literal notranslate"><span class="pre">ifnotequal</span></code></a></li>
2889<li><a class="reference internal" href="#ifchanged"><code class="docutils literal notranslate"><span class="pre">ifchanged</span></code></a></li>
2890<li><a class="reference internal" href="#include"><code class="docutils literal notranslate"><span class="pre">include</span></code></a></li>
2891<li><a class="reference internal" href="#load"><code class="docutils literal notranslate"><span class="pre">load</span></code></a></li>
2892<li><a class="reference internal" href="#lorem"><code class="docutils literal notranslate"><span class="pre">lorem</span></code></a></li>
2893<li><a class="reference internal" href="#now"><code class="docutils literal notranslate"><span class="pre">now</span></code></a></li>
2894<li><a class="reference internal" href="#regroup"><code class="docutils literal notranslate"><span class="pre">regroup</span></code></a><ul>
2895<li><a class="reference internal" href="#grouping-on-other-properties">Grouping on other properties</a></li>
2896</ul>
2897</li>
2898<li><a class="reference internal" href="#resetcycle"><code class="docutils literal notranslate"><span class="pre">resetcycle</span></code></a></li>
2899<li><a class="reference internal" href="#spaceless"><code class="docutils literal notranslate"><span class="pre">spaceless</span></code></a></li>
2900<li><a class="reference internal" href="#templatetag"><code class="docutils literal notranslate"><span class="pre">templatetag</span></code></a></li>
2901<li><a class="reference internal" href="#url"><code class="docutils literal notranslate"><span class="pre">url</span></code></a></li>
2902<li><a class="reference internal" href="#verbatim"><code class="docutils literal notranslate"><span class="pre">verbatim</span></code></a></li>
2903<li><a class="reference internal" href="#widthratio"><code class="docutils literal notranslate"><span class="pre">widthratio</span></code></a></li>
2904<li><a class="reference internal" href="#with"><code class="docutils literal notranslate"><span class="pre">with</span></code></a></li>
2905</ul>
2906</li>
2907<li><a class="reference internal" href="#built-in-filter-reference">Built-in filter reference</a><ul>
2908<li><a class="reference internal" href="#add"><code class="docutils literal notranslate"><span class="pre">add</span></code></a></li>
2909<li><a class="reference internal" href="#addslashes"><code class="docutils literal notranslate"><span class="pre">addslashes</span></code></a></li>
2910<li><a class="reference internal" href="#capfirst"><code class="docutils literal notranslate"><span class="pre">capfirst</span></code></a></li>
2911<li><a class="reference internal" href="#center"><code class="docutils literal notranslate"><span class="pre">center</span></code></a></li>
2912<li><a class="reference internal" href="#cut"><code class="docutils literal notranslate"><span class="pre">cut</span></code></a></li>
2913<li><a class="reference internal" href="#date"><code class="docutils literal notranslate"><span class="pre">date</span></code></a></li>
2914<li><a class="reference internal" href="#default"><code class="docutils literal notranslate"><span class="pre">default</span></code></a></li>
2915<li><a class="reference internal" href="#default-if-none"><code class="docutils literal notranslate"><span class="pre">default_if_none</span></code></a></li>
2916<li><a class="reference internal" href="#dictsort"><code class="docutils literal notranslate"><span class="pre">dictsort</span></code></a></li>
2917<li><a class="reference internal" href="#dictsortreversed"><code class="docutils literal notranslate"><span class="pre">dictsortreversed</span></code></a></li>
2918<li><a class="reference internal" href="#divisibleby"><code class="docutils literal notranslate"><span class="pre">divisibleby</span></code></a></li>
2919<li><a class="reference internal" href="#escape"><code class="docutils literal notranslate"><span class="pre">escape</span></code></a></li>
2920<li><a class="reference internal" href="#escapejs"><code class="docutils literal notranslate"><span class="pre">escapejs</span></code></a></li>
2921<li><a class="reference internal" href="#filesizeformat"><code class="docutils literal notranslate"><span class="pre">filesizeformat</span></code></a></li>
2922<li><a class="reference internal" href="#first"><code class="docutils literal notranslate"><span class="pre">first</span></code></a></li>
2923<li><a class="reference internal" href="#floatformat"><code class="docutils literal notranslate"><span class="pre">floatformat</span></code></a></li>
2924<li><a class="reference internal" href="#force-escape"><code class="docutils literal notranslate"><span class="pre">force_escape</span></code></a></li>
2925<li><a class="reference internal" href="#get-digit"><code class="docutils literal notranslate"><span class="pre">get_digit</span></code></a></li>
2926<li><a class="reference internal" href="#iriencode"><code class="docutils literal notranslate"><span class="pre">iriencode</span></code></a></li>
2927<li><a class="reference internal" href="#join"><code class="docutils literal notranslate"><span class="pre">join</span></code></a></li>
2928<li><a class="reference internal" href="#last"><code class="docutils literal notranslate"><span class="pre">last</span></code></a></li>
2929<li><a class="reference internal" href="#length"><code class="docutils literal notranslate"><span class="pre">length</span></code></a></li>
2930<li><a class="reference internal" href="#length-is"><code class="docutils literal notranslate"><span class="pre">length_is</span></code></a></li>
2931<li><a class="reference internal" href="#linebreaks"><code class="docutils literal notranslate"><span class="pre">linebreaks</span></code></a></li>
2932<li><a class="reference internal" href="#linebreaksbr"><code class="docutils literal notranslate"><span class="pre">linebreaksbr</span></code></a></li>
2933<li><a class="reference internal" href="#linenumbers"><code class="docutils literal notranslate"><span class="pre">linenumbers</span></code></a></li>
2934<li><a class="reference internal" href="#ljust"><code class="docutils literal notranslate"><span class="pre">ljust</span></code></a></li>
2935<li><a class="reference internal" href="#lower"><code class="docutils literal notranslate"><span class="pre">lower</span></code></a></li>
2936<li><a class="reference internal" href="#make-list"><code class="docutils literal notranslate"><span class="pre">make_list</span></code></a></li>
2937<li><a class="reference internal" href="#phone2numeric"><code class="docutils literal notranslate"><span class="pre">phone2numeric</span></code></a></li>
2938<li><a class="reference internal" href="#pluralize"><code class="docutils literal notranslate"><span class="pre">pluralize</span></code></a></li>
2939<li><a class="reference internal" href="#pprint"><code class="docutils literal notranslate"><span class="pre">pprint</span></code></a></li>
2940<li><a class="reference internal" href="#random"><code class="docutils literal notranslate"><span class="pre">random</span></code></a></li>
2941<li><a class="reference internal" href="#rjust"><code class="docutils literal notranslate"><span class="pre">rjust</span></code></a></li>
2942<li><a class="reference internal" href="#safe"><code class="docutils literal notranslate"><span class="pre">safe</span></code></a></li>
2943<li><a class="reference internal" href="#safeseq"><code class="docutils literal notranslate"><span class="pre">safeseq</span></code></a></li>
2944<li><a class="reference internal" href="#slice"><code class="docutils literal notranslate"><span class="pre">slice</span></code></a></li>
2945<li><a class="reference internal" href="#slugify"><code class="docutils literal notranslate"><span class="pre">slugify</span></code></a></li>
2946<li><a class="reference internal" href="#stringformat"><code class="docutils literal notranslate"><span class="pre">stringformat</span></code></a></li>
2947<li><a class="reference internal" href="#striptags"><code class="docutils literal notranslate"><span class="pre">striptags</span></code></a></li>
2948<li><a class="reference internal" href="#time"><code class="docutils literal notranslate"><span class="pre">time</span></code></a></li>
2949<li><a class="reference internal" href="#timesince"><code class="docutils literal notranslate"><span class="pre">timesince</span></code></a></li>
2950<li><a class="reference internal" href="#timeuntil"><code class="docutils literal notranslate"><span class="pre">timeuntil</span></code></a></li>
2951<li><a class="reference internal" href="#title"><code class="docutils literal notranslate"><span class="pre">title</span></code></a></li>
2952<li><a class="reference internal" href="#truncatechars"><code class="docutils literal notranslate"><span class="pre">truncatechars</span></code></a></li>
2953<li><a class="reference internal" href="#truncatechars-html"><code class="docutils literal notranslate"><span class="pre">truncatechars_html</span></code></a></li>
2954<li><a class="reference internal" href="#truncatewords"><code class="docutils literal notranslate"><span class="pre">truncatewords</span></code></a></li>
2955<li><a class="reference internal" href="#truncatewords-html"><code class="docutils literal notranslate"><span class="pre">truncatewords_html</span></code></a></li>
2956<li><a class="reference internal" href="#unordered-list"><code class="docutils literal notranslate"><span class="pre">unordered_list</span></code></a></li>
2957<li><a class="reference internal" href="#upper"><code class="docutils literal notranslate"><span class="pre">upper</span></code></a></li>
2958<li><a class="reference internal" href="#urlencode"><code class="docutils literal notranslate"><span class="pre">urlencode</span></code></a></li>
2959<li><a class="reference internal" href="#urlize"><code class="docutils literal notranslate"><span class="pre">urlize</span></code></a></li>
2960<li><a class="reference internal" href="#urlizetrunc"><code class="docutils literal notranslate"><span class="pre">urlizetrunc</span></code></a></li>
2961<li><a class="reference internal" href="#wordcount"><code class="docutils literal notranslate"><span class="pre">wordcount</span></code></a></li>
2962<li><a class="reference internal" href="#wordwrap"><code class="docutils literal notranslate"><span class="pre">wordwrap</span></code></a></li>
2963<li><a class="reference internal" href="#yesno"><code class="docutils literal notranslate"><span class="pre">yesno</span></code></a></li>
2964</ul>
2965</li>
2966<li><a class="reference internal" href="#internationalization-tags-and-filters">Internationalization tags and filters</a><ul>
2967<li><a class="reference internal" href="#i18n"><code class="docutils literal notranslate"><span class="pre">i18n</span></code></a></li>
2968<li><a class="reference internal" href="#l10n"><code class="docutils literal notranslate"><span class="pre">l10n</span></code></a></li>
2969<li><a class="reference internal" href="#tz"><code class="docutils literal notranslate"><span class="pre">tz</span></code></a></li>
2970</ul>
2971</li>
2972<li><a class="reference internal" href="#other-tags-and-filters-libraries">Other tags and filters libraries</a><ul>
2973<li><a class="reference internal" href="#django-contrib-humanize"><code class="docutils literal notranslate"><span class="pre">django.contrib.humanize</span></code></a></li>
2974<li><a class="reference internal" href="#static"><code class="docutils literal notranslate"><span class="pre">static</span></code></a><ul>
2975<li><a class="reference internal" href="#std:templatetag-static"><code class="docutils literal notranslate"><span class="pre">static</span></code></a></li>
2976<li><a class="reference internal" href="#get-static-prefix"><code class="docutils literal notranslate"><span class="pre">get_static_prefix</span></code></a></li>
2977<li><a class="reference internal" href="#get-media-prefix"><code class="docutils literal notranslate"><span class="pre">get_media_prefix</span></code></a></li>
2978</ul>
2979</li>
2980</ul>
2981</li>
2982</ul>
2983</li>
2984</ul>
2985
2986
2987
2988
2989
2990 <h2>Browse</h2>
2991 <ul>
2992
2993
2994 <li>Prev: <a href="../language/">The Django template language</a></li>
2995
2996
2997 <li>Next: <a href="../api/">The Django template language: for Python programmers</a></li>
2998
2999 <li><a href="https://docs.djangoproject.com/en/1.11/contents/">Table of contents</a></li>
3000
3001 <li><a href="https://docs.djangoproject.com/en/1.11/genindex/">General Index</a></li>
3002
3003 <li><a href="https://docs.djangoproject.com/en/1.11/py-modindex/">Python Module Index</a></li>
3004
3005
3006 </ul>
3007
3008
3009
3010 <h2>You are here:</h2>
3011 <ul>
3012 <li>
3013 <a href="https://docs.djangoproject.com/en/1.11/">Django 1.11 documentation</a>
3014
3015 <ul><li><a href="../../">API Reference</a>
3016
3017 <ul><li><a href="../">Templates</a>
3018
3019 <ul><li>Built-in template tags and filters</li></ul>
3020 </li></ul></li></ul>
3021 </li>
3022 </ul>
3023
3024
3025
3026 <h2 id="getting-help-sidebar">Getting help</h2>
3027 <dl class="list-links">
3028 <dt><a href="https://docs.djangoproject.com/en/1.11/faq/">FAQ</a></dt>
3029 <dd>Try the FAQ — it's got answers to many common questions.</dd>
3030
3031 <dt><a href="/en/stable/genindex/">Index</a>, <a href="/en/stable/py-modindex/">Module Index</a>, or <a href="/en/stable/contents/">Table of Contents</a></dt>
3032 <dd>Handy when looking for specific information.</dd>
3033
3034 <dt><a href="https://groups.google.com/group/django-users/">django-users mailing list</a></dt>
3035 <dd>Search for information in the archives of the django-users mailing list, or post a question.</dd>
3036
3037 <dt><a href="irc://irc.freenode.net/django">#django IRC channel</a></dt>
3038 <dd>Ask a question in the #django IRC channel, or search the IRC logs to see if it’s been asked before.</dd>
3039
3040 <dt><a href="https://code.djangoproject.com/">Ticket tracker</a></dt>
3041 <dd>Report bugs with Django or Django documentation in our ticket tracker.</dd>
3042 </dl>
3043
3044
3045
3046 <h2>Download:</h2>
3047 <p>
3048 Offline (Django 1.11):
3049 <a href="/m/docs/django-docs-1.11-en.zip">HTML</a> |
3050 <a href="https://media.readthedocs.org/pdf/django/1.11.x/django.pdf">PDF</a> |
3051 <a href="https://media.readthedocs.org/epub/django/1.11.x/django.epub">ePub</a>
3052 <br>
3053 <span class="quiet">
3054 Provided by <a href="https://readthedocs.org/">Read the Docs</a>.
3055 </span>
3056 </p>
3057
3058</div>
3059
3060
3061
3062 </div>
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073<div role="contentinfo">
3074 <div class="subfooter">
3075 <div class="container">
3076 <h1 class="visuallyhidden">Django Links</h1>
3077
3078 <div class="col learn">
3079 <h2>Learn More</h2>
3080 <ul>
3081 <li><a href="https://www.djangoproject.com/start/overview/">About Django</a></li>
3082
3083 <li><a href="https://www.djangoproject.com/start/">Getting Started with Django</a></li>
3084 <li><a href="https://docs.djangoproject.com/en/dev/internals/organization/">Team Organization</a></li>
3085 <li><a href="https://www.djangoproject.com/foundation/">Django Software Foundation</a></li>
3086 <li><a href="https://www.djangoproject.com/conduct/">Code of Conduct</a></li>
3087 <li><a href="https://www.djangoproject.com/diversity/">Diversity Statement</a></li>
3088 </ul>
3089 </div>
3090
3091 <div class="col involved">
3092 <h2>Get Involved</h2>
3093 <ul>
3094 <li><a href="https://www.djangoproject.com/community/">Join a Group</a></li>
3095 <li><a href="https://docs.djangoproject.com/en/dev/internals/contributing/">Contribute to Django</a></li>
3096 <li><a href="https://docs.djangoproject.com/en/dev/internals/contributing/bugs-and-features/">Submit a Bug</a></li>
3097 <li><a href="https://docs.djangoproject.com/en/dev/internals/security/#reporting-security-issues">Report a Security Issue</a></li>
3098 </ul>
3099 </div>
3100
3101 <div class="col follow last-child">
3102 <h2>Follow Us</h2>
3103 <ul>
3104 <li><a href="https://github.com/django">GitHub</a></li>
3105 <li><a href="https://twitter.com/djangoproject">Twitter</a></li>
3106 <li><a href="https://www.djangoproject.com/rss/weblog/">News RSS</a></li>
3107 <li><a href="https://groups.google.com/forum/#!forum/django-users">Django Users Mailing List</a></li>
3108 </ul>
3109 </div>
3110
3111 </div>
3112 </div>
3113
3114 <div class="footer">
3115 <div class="container">
3116 <div class="footer-logo">
3117 <a class="logo" href="https://www.djangoproject.com/">Django</a>
3118 </div>
3119 <ul class="thanks">
3120 <li>
3121 <span>Hosting by</span> <a class="rackspace" href="https://www.rackspace.com">Rackspace</a>
3122 </li>
3123 <li class="design"><span>Design by</span> <a class="threespot" href="https://www.threespot.com">Threespot</a> <span class="ampersand">&</span> <a class="andrevv" href="http://andrevv.com/"></a></li>
3124 </ul>
3125 <p class="copyright">© 2005-2018
3126 <a href="https://www.djangoproject.com/foundation/"> Django Software
3127 Foundation</a> and individual contributors. Django is a
3128 <a href="https://www.djangoproject.com/trademarks/">registered
3129 trademark</a> of the Django Software Foundation.
3130 </p>
3131 </div>
3132 </div>
3133
3134</div>
3135
3136
3137
3138
3139 <script>
3140 function extless(input) {
3141 return input.replace(/(.*)\.[^.]+$/, '$1');
3142 }
3143 var require = {
3144 shim: {
3145 'jquery': [],
3146 'jquery.inview': ["jquery"],
3147 'jquery.payment': ["jquery"],
3148 'jquery.flot': ["jquery"],
3149 'jquery.unveil': ["jquery"],
3150 'stripe': {
3151 exports: 'Stripe'
3152 }
3153 },
3154 paths: {
3155 "jquery": extless("/s/js/lib/jquery/dist/jquery.min.87e69028f78d.js"),
3156 "jquery.inview": extless("/s/js/lib/jquery.inview/jquery.inview.min.4edba1c65592.js"),
3157 "jquery.payment": extless("/s/js/lib/jquery.payment/lib/jquery.payment.e99c05ca79ae.js"),
3158 "jquery.unveil": extless("/s/js/lib/unveil/jquery.unveil.min.ac79eb277093.js"),
3159 "jquery.flot": extless("/s/js/lib/jquery-flot/jquery.flot.min.9964206e9d7f.js"),
3160 "clipboard": extless("/s/js/lib/clipboard/dist/clipboard.min.bd70fd596a23.js"),
3161 "mod/floating-warning": extless("/s/js/mod/floating-warning.a21b2abd2884.js"),
3162 "mod/list-collapsing": extless("/s/js/mod/list-collapsing.c1a08d3ef9e9.js"),
3163 "mod/list-feature": extless("/s/js/mod/list-feature.73529480f25b.js"),
3164 "mod/mobile-menu": extless("/s/js/mod/mobile-menu.841726ee903a.js"),
3165 "mod/version-switcher": extless("/s/js/mod/version-switcher.c28bb83972bb.js"),
3166 "mod/search-key": extless("/s/js/mod/search-key.f3c0a6fcfedd.js"),
3167 "mod/stripe-custom-checkout": extless("/s/js/mod/stripe-custom-checkout.aac1352045b7.js"),
3168 "mod/stripe-change-card": extless("/s/js/mod/stripe-change-card.682c710317a8.js"),
3169 "mod/console-tabs": extless("/s/js/mod/console-tabs.70ce882faaf3.js"),
3170 "stripe-checkout": "https://checkout.stripe.com/checkout",
3171 "stripe": "https://js.stripe.com/v2/?" // ? needed due to require.js
3172 }
3173 };
3174 </script>
3175 <script data-main="/s/js/main.c16237f43ba2.js" src="/s/js/lib/require.177879fbe7dd.js"></script>
3176
3177
3178
3179
3180 </body>
3181</html>