Add footnotes to rich text in your wagtail pages
Project description
Wagtail Footnotes
This repo contains example code that can be copied and altered to add footnotes to your wagtail pages.
Usage
- Add the app to
INSTALLED_APPS
:INSTALLED_APPS = [ ... "wagtail_footnotes", ... ]
- Add the footnotes
urls.py
to your project'surls.py
:from wagtail_footnotes import urls as footnotes_urls urlpatterns = [ ... path("footnotes/", include(footnotes_urls)), ... ]
Note: The URL NEEDS to be defined as above as it is currently hardcoded in the JS - Update your page models to use the
FootnotesMixin
:from wagtail_footnotes.models import FootnotesMixin class InformationPage(BasePage, FootnotesMixin): ... content_panels = [ ... ] + FootnotesMixin.footnote_panels
- Update your
RichTextBlock
s- Add
"footnotes"
to thefeatures
arg for eachRichTextBlock
that you want to have this functionality. - You will also need to change them from
RichTextBlock
s towagtail_footnotes.blocks.RichTextBlockWithFootnotes
- You can add the footnotes to
RichTextBlock
s across the project by updatingWAGTAILADMIN_RICH_TEXT_EDITORS["default"]["OPTIONS"]["features"]
:WAGTAILADMIN_RICH_TEXT_EDITORS = { "default": { "WIDGET": "wagtail.admin.rich_text.DraftailRichTextArea", "OPTIONS": {"features": ["bold", "italic", "h3", "h4", "ol", "ul", "link", "footnotes"]}, } }
- Add
- Update your page templates to include
{% include "wagtail_footnotes/includes/footnotes.html" %}
- Make and run migrations:
./manage.py makemigrations ./manage.py migrate
Example implementations
Common issues
- I click on the
Fn
button in the editor and it stops working- This is likely because the URL in the JS does not match the URL of the footnotes view. Check the URL in
wagtail_footnotes/static/footnotes/js/footnotes.js
matches the URL you set.
- This is likely because the URL in the JS does not match the URL of the footnotes view. Check the URL in
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
Close
Hashes for wagtail_footnotes-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fb38166f58a4267fdd573817be3fea979c08605b2d45a0db12c715feb09166c |
|
MD5 | d07a16319c5556fb7c97d454f6618ba1 |
|
BLAKE2b-256 | 99f4cdb482874032823717d9c41e9c92f9ed28b6c52682d96c37a08c7e28408a |