【プログラミング備忘録】Djangoのテンプレートをパーツ化して読み込む方法

Anker PowerCor

Anker PowerCore モバイルバッテリー 20000mAh iPhone iPad Android

created by Rinker

Anker

¥3,990 (2025/01/05 12:09:11時点 Amazon調べ-詳細)

旅行には必須の大容量モバイルバッテリー！

【最新機種】GoPro hero11 Black

【最新機種】GoPro HERO13 Black【完全防水】

created by Rinker

¥61,300 (2025/01/05 20:59:47時点楽天市場調べ-詳細)

最新機種でVlogの思い出を撮影しよう！

ペヤングソースやきそば 120g×18個

created by Rinker

ペヤング

¥3,280 (2025/01/05 12:33:38時点 Amazon調べ-詳細)

とりあえず保存食として買っておけば間違いなし！

レッドブルエナジードリンク 250ml×24本

created by Rinker

Red Bull(レッドブル)

¥4,000 (2025/01/05 12:33:39時点 Amazon調べ-詳細)

翼を授けよう！

ドラゴンクエストメタリックモンスターズギャラリーメタルキング

created by Rinker

スクウェア・エニックス(SQUARE ENIX)

¥3,940 (2025/01/05 12:41:47時点 Amazon調べ-詳細)

みんな大好き経験値の塊をデスクに常備しておこう！

MOFT X 【新型ミニマム版】 iPhone対応スマホスタンド

created by Rinker

MOFT

Amazon一番人気のスマホスタンド！カード類も収納出来てかさ張らないのでオススメです！

サンディスク microSD 128GB

サンディスク microSD 128GB UHS-I Class10 Nintendo Switch SanDisk Ultra SDSQUA4-128G-EPK

created by Rinker

SanDisk

¥3,279 (2025/01/05 12:33:41時点 Amazon調べ-詳細)

スマホからSwitchまで使える大容量MicroSDカード！

目次 [閉じる]

1 Templateのパーツ化
- 1.1 パーツ化の必要性
- 1.2 include
  - 1.2.1 使い方
  - 1.2.2 確認
2 終わりに

Templateのパーツ化

パーツ化の必要性

WebサイトやWebシステムを作成していると複数ページの中で似たような記述をする必要がある部分が出てくると思います。

headタグ/footerタグ/navタグ/汎用パーツ(プログレスサークル等)・・・

これらの情報をすべてのページのHTMLに同じように記述すると、修正が必要になった場合に同じ修正をHTML数分行わないといけなくなるので、保守がとても大変になってします。

include

上記のような懸念の解消機能として、Djangoのtemplateにはインクルード機能が搭載されています。

この機能を利用することで、HTMLの任意の部分に別のHTMLの情報を追加することが可能になります。
なので、汎用的なHTMLをパーツとして部分切り出しして管理した上で、各HTMLにてインクルードするようにすれば、一箇所修正すればすべてのページに修正が適用されるので、保守がとても簡単になります。

使い方

インクルード機能を利用するには、HTMLを挿入したい部分に以下のカスタムタグを追記してください。

{% include "{挿入したHTMLへのパス}" %}

1	{% include "{挿入したHTMLへのパス}" %}

今回は例として以下のようなディレクトリ構造でtemplate/sample/index.htmlからtemplate/parts/common.htmlをインクルードしてみます。

birdBreeder
├── admin.py
├── apps.py
├── static
│   ├── css
│   │   ├── materialize.css
│   │   ├── materialize.min.css
│   │   └── style.css
│   ├── image
│   │   └── icon.png
│   └── js
│       ├── index.js
│       ├── materialize.js
│       └── materialize.min.js
├── templates
│   ├── base.html
│   ├── parts
│   │   └── common.html
│   └── sample
│       └── index.html
├── urls
│   └── main.py
└── views
    ├── main.py
    └── sample
        └── main.py

birdBreeder

├── admin.py

├── apps.py

├── static

│ ├── css

│ │ ├── materialize.css

│ │ ├── materialize.min.css

│ │ └── style.css

│ ├── image

│ │ └── icon.png

│ └── js

│ ├── index.js

│ ├── materialize.js

│ └── materialize.min.js

├── templates

│ ├── base.html

│ ├── parts

│ │ └── common.html

│ └── sample

│ └── index.html

├── urls

│ └── main.py

└── views

├── main.py

└── sample

└── main.py

まずは以下のようなパーツHTMLを用意します。

<div>
  <p>
    共通パーツだよ！
  </p>
</div>

<div>

<p>

共通パーツだよ！

</p>

</div>

次に、上記パーツを読み込むインクルード指定を追加します。

~省略~
<div>
  {% include 'parts/common.html' %}
</div>
~省略~

~省略~

<div>

{% include 'parts/common.html' %}

</div>

~省略~

確認

では、実際にブラウザにアクセスして読み込まれているか確認してみましょう。

正常にインクルードされていますね。

終わりに

DjangoのTemplate周りは他にも便利な機能がいろいろあるので、少しずつ紹介していけたらなと思います♪

【プログラミング備忘録】Djangoのテンプレートをパーツ化して読み込む方法

Anker PowerCor

【最新機種】GoPro hero11 Black

ペヤング ソースやきそば 120g×18個

レッドブル エナジードリンク 250ml×24本

ドラゴンクエスト メタリックモンスターズギャラリー メタルキング

MOFT X 【新型 ミニマム版】 iPhone対応 スマホスタンド

サンディスク microSD 128GB

Templateのパーツ化

パーツ化の必要性

include

使い方

確認

終わりに

CATEGORIES & TAGS

ペヤングソースやきそば 120g×18個

レッドブルエナジードリンク 250ml×24本

ドラゴンクエストメタリックモンスターズギャラリーメタルキング

MOFT X 【新型ミニマム版】 iPhone対応スマホスタンド