Add footnotes to rich text in your wagtail pages
Reason this release was yanked:
Missing templates dir (fixed in 0.2.0)
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 private_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(FootnotesMixin, BasePage): ... content_panels = BasePage.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 "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.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d35a2b788426101bb4c34a8c5534c2047a7086b26fcef3f354b321993925da8f |
|
MD5 | c9221e37f338e86bc4d59018292c9e3f |
|
BLAKE2b-256 | 93ee5780e8f00f23ba92edb21d33f011dd91f6358989eb5db20b94bdb8b4756f |