What is the Django way of creating a reusable template?
Example: Suppose a lot of my pages contain a “Latest News” box and following the DRY principle, I would like to define it once and reuse it in the other pages. How would I do this with Django (or Jinja2) templates?
Reading through Django’s Template Documentation I get the impression that Django templates offer “top-down” inheritance where the sub-template itself determines in which super-template it is going to be embedded:
<!-- Super-template (not valid, for illustration): -->
<html>
<head><title>Title</title></head>
<body>{% block content %}{% endblock %}</body>
</html>
<!-- Sub-template: -->
{% extends "base.html" %}
{% block content %}
<div class="latest-news">News</div>
{% endblock %}
So what is the technique to reuse a block (a sub-template) in several places?
The most flexible way to reuse template fragments is to define an inclusion_tag. You can pass arguments to your custom tag, process them a bit in Python, then bounce back to a template. Direct inclusion only works for fragments that don’t depend on the surrounding context.
Quick example from the docs:
In
app/templatetags/poll_extras.pyregister the tag with a decoration:In
app/templates/results.html:Calling the tag: