A Django app for extending the Wagtail Image model to add captions and alt fields as
Project description
Captions for Wagtail Images
A Django app for extending the Wagtail Image model to add captions and alt fields as well as the extraction of IPTC image meta data.
Installing
Install using pip:
pip install wagtailimagecaptions
Settings
In your settings file, add wagtailimagecaptions
to INSTALLED_APPS
:
INSTALLED_APPS = [
# ...
"wagtailimagecaptions",
# ...
]
You will also need to set a custom Image model in your setting files:
# settings.py
WAGTAILIMAGES_IMAGE_MODEL = "wagtailimagecaptions.CaptionedImage"
Migrating
Heads up! If you have existing images, you will need to create a data migration operation to move the old images into the new model.
How to Use
The custom Image model, CaptionedImage
, adds four new fields to the Wagtail Image model: alt
, caption
, credit
, iptc_data
. When a new image is uploaded via Wagtail's media library, the app will attempt to extract any IPTC meta data found in the file and fill
the alt
, caption
and credit
fields. All IPTC meta data extracted is also stored in iptc_data
.
Example use in a template:
{% load wagtailcore_tags %}
<img src="{{ image.url }}" alt="{{ image.alt }}">{{ image.caption|richtext }}
Adding date paths to image uploads.
To add date paths to the image upload path, you can set WAGTIALIMAGECAPTIONS_UPLOAD_TO_DATE_PATH
in your Django settings file with a valid date format.
# settings.py
WAGTIALIMAGECAPTIONS_UPLOAD_TO_DATE_PATH = "%Y/%m"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtailimagecaptions-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78c148ac1a1d51370a0076faa9d49301faa23b4dd6599f209abc48761566066d |
|
MD5 | 0f14fb433f8ae9b1ed0d2cc818f0de29 |
|
BLAKE2b-256 | f225f00697d441f3b80c53736020f26384b253782aa69bb30e4e5f4857ff0ef6 |
Hashes for wagtailimagecaptions-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11e2fdc0348e03f3d8ae0c66c99a936cea8c3820a530700efcfa7fd25308803a |
|
MD5 | e96e5e2404d061d94b9fc5d055c7711a |
|
BLAKE2b-256 | fa04274c689a207eeba11f1a93cdd0c94a9375f01c50fb4d1cfc0220b6cc1c6d |