Add footnotes to rich text in your wagtail pages
Project description
Wagtail Footnotes
Add footnotes functionality to your Wagtail project.
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 has to be defined as above as it is currently hardcoded in the Javascript. - Update your page models to show the footnotes field:
class InformationPage(BasePage): ... content_panels = [ ... InlinePanel("footnotes", label="Footnotes"), ]
- Update your
RichTextBlock
s- Add
"footnotes"
to thefeatures
arg for eachRichTextBlock
that you want to have this functionality - You will also need to change any
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
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
NoneType
error when rendering page.- Make sure you are rendering the field in the template using
{% include_block page.field_name %}
- Make sure you are rendering the field in the template using
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.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e956e3cd5e0b36ac045d9a14ba60b56ee47eea81b63f2e875f780fd23148377 |
|
MD5 | 0266ed2860cbed280122734150fb7dc6 |
|
BLAKE2b-256 | acfeadedc980d18c16c53c970b39acdaeb2a4e99726b4dead1fcce9aaef73120 |