Template includes for reusability in Django

Introduction

Template includes let you reuse parts of your webpage easily. This saves time and keeps your code neat.

You want the same header on many pages.

You have a footer that stays the same everywhere.

You want to reuse a navigation menu on multiple pages.

You want to keep your templates clean by splitting big files.

You want to update one small part and see it change everywhere.

Syntax

Django

{% include 'template_name.html' %}

Use the {% include %} tag inside your Django template where you want to add the reusable part.

The included template can have its own HTML and Django template code.

Examples

This adds the content of header.html here.

Django

{% include 'header.html' %}

This adds the footer section from footer.html.

Django

{% include 'footer.html' %}

This inserts a navigation menu from menu.html.

Django

{% include 'menu.html' %}

Sample Program

This example shows a base template that includes a header and footer from separate files. This way, the header and footer can be reused on many pages.

Django

{# base.html #}
<html lang="en">
  <head>
    <title>My Site</title>
  </head>
  <body>
    {% include 'header.html' %}
    <main>
      <h1>Welcome to my site</h1>
      <p>This is the main content.</p>
    </main>
    {% include 'footer.html' %}
  </body>
</html>

{# header.html #}
<header>
  <nav>
    <ul>
      <li><a href="/">Home</a></li>
      <li><a href="/about/">About</a></li>
      <li><a href="/contact/">Contact</a></li>
    </ul>
  </nav>
</header>

{# footer.html #}
<footer>
  <p>© 2024 My Site. All rights reserved.</p>
</footer>

Important Notes

Included templates can also use variables passed from the parent template.

If the included file is missing, Django will raise an error unless you use the ignore missing option.

Summary

Use {% include %} to add reusable template parts.

This helps keep your templates clean and easy to update.

Common uses are headers, footers, and menus.

Practice

1. What is the main purpose of using {% include %} in Django templates?

easy

A. To reuse parts of templates like headers or footers in multiple pages

B. To execute Python code inside the template

C. To define variables for use in the template

D. To create loops inside the template

Solution

1. Step 1: Understand the role of {% include %}

   This tag is used to insert reusable template parts, such as headers or footers, into other templates.

2. Step 2: Compare with other template features

   Executing Python code or defining variables is done differently, not with {% include %}.

3. Final Answer:

   To reuse parts of templates like headers or footers in multiple pages -> Option A

4. Quick Check:

   Template reuse = To reuse parts of templates like headers or footers in multiple pages [OK]

Hint: Remember: include = reuse template parts like header/footer [OK]

Common Mistakes:

• Thinking include runs Python code
• Confusing include with variable assignment
• Using include to create loops

2. Which of the following is the correct syntax to include a template named menu.html inside another template?

easy

A. {% include menu.html %}

B. {% include 'menu.html' %}

C. {% include "menu.html %}

D. {% include 'menu' %}

Solution

1. Step 1: Check the syntax for including templates

   The correct syntax requires the template name as a quoted string inside the include tag, like {% include 'menu.html' %}.

2. Step 2: Evaluate the options

   {% include menu.html %} misses quotes, {% include "menu.html %} malformed double quotes (missing closing quote), {% include 'menu' %} misses the file extension.

3. Final Answer:

   {% include 'menu.html' %} -> Option B

4. Quick Check:

   Include syntax = {% include 'menu.html' %} [OK]

Hint: Include template name in single quotes inside {% include %} [OK]

Common Mistakes:

• Forgetting quotes around template name
• Omitting file extension
• Using variable name without quotes

3. Given the following templates:

{% raw %}{# base.html #}%

  
    {% include 'header.html' %}
    
Welcome
  
{% endraw %}

And header.html contains:

{% raw %}
Menu
{% endraw %}

What will be the rendered output of base.html?

medium

A. Error: header.html not found

B.

{% include 'header.html' %}
Welcome

C.

Menu
Welcome

D.

Menu
Welcome

Solution

1. Step 1: Understand how {% include %} works

   The include tag inserts the full content of header.html into base.html at the include position.

2. Step 2: Replace include with header content

   Replacing {% include 'header.html' %} with <header><nav>Menu</nav></header> gives the full HTML output.

3. Final Answer:

   <html> <body> <header><nav>Menu</nav></header> <h1>Welcome</h1> </body> </html> -> Option D

4. Quick Check:

   Include inserts full template content =
   Menu

   Welcome

   [OK]

Hint: Include inserts full content exactly where placed [OK]

Common Mistakes:

• Expecting include tag to remain in output
• Assuming partial content inserted
• Thinking include causes error if file exists

4. You wrote {% include header.html %} in your template but get a TemplateSyntaxError. What is the most likely cause?

medium

A. Missing quotes around the template name in the include tag

B. The header.html file does not exist

C. You need to use {% extends %} instead of {% include %}

D. You forgot to load the include tag library

Solution

1. Step 1: Identify syntax rules for include

   The template name must be a quoted string inside the include tag, like {% include 'header.html' %}.

2. Step 2: Analyze the error cause

   Omitting quotes causes TemplateSyntaxError because Django expects a string literal.

3. Final Answer:

   Missing quotes around the template name in the include tag -> Option A

4. Quick Check:

   Quotes required for template name = Missing quotes around the template name in the include tag [OK]

Hint: Always put template names in quotes inside {% include %} [OK]

Common Mistakes:

• Forgetting quotes around template name
• Confusing include with extends
• Assuming include tag needs loading

5. You want to create a reusable navigation menu that highlights the current page. You have menu.html included in multiple templates. How can you pass the current page name to menu.html using {% include %}?

hard

A. {% include 'menu.html' current_page='home' %}

B. {% include 'menu.html' only current_page='home' %}

C. {% include 'menu.html' with current_page='home' %}

D. {% include 'menu.html' as current_page='home' %}

Solution

1. Step 1: Recall how to pass variables with include

   Django allows passing variables to included templates using with keyword inside the include tag.

2. Step 2: Check syntax correctness

   The correct syntax is {% include 'menu.html' with current_page='home' %}. Other options are invalid syntax.

3. Final Answer:

   {% include 'menu.html' with current_page='home' %} -> Option C

4. Quick Check:

   Pass variables with 'with' keyword = {% include 'menu.html' with current_page='home' %} [OK]

Hint: Use 'with' keyword to pass variables in {% include %} [OK]

Common Mistakes:

• Omitting 'with' keyword when passing variables
• Using 'only' incorrectly with variables
• Trying to assign variables with 'as'