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's urls.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 RichTextBlocks
- Add "footnotes" to the features arg for each RichTextBlock that you want to have this functionality
- You will also need to change any RichTextBlocks to wagtail_footnotes.blocks.RichTextBlockWithFootnotes
Update your page templates to include {% include "wagtail_footnotes/includes/footnotes.html" %}

Make and run migrations:

./manage.py makemigrations
./manage.py migrate

WAGTAIL_FOOTNOTES_TEXT_FEATURES
- Default: ["bold", "italic", "link"]
- Use this to update a list of Rich Text features allowed in the footnote text.

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.
NoneType error when rendering page.
- Make sure you are rendering the field in the template using {% include_block page.field_name %}

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for wagtail-footnotes 0.9.0
File	Size	Uploaded
wagtail-footnotes-0.9.0.tar.gz	11.0 kB	Oct 14, 2022	Details

Table of built distributions (wheels) for wagtail-footnotes 0.9.0
File	Interpreter	ABI	Platform	Reset
wagtail_footnotes-0.9.0-py3-none-any.whl 14.0 kB Oct 14, 2022	Python 3	none	any	Details

Total release size: 25.1 kB

Download URL	wagtail-footnotes-0.9.0.tar.gz
Size	11.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`b9567ed1a9aebae9f822e78472216b41b477a81a696b4dd3ef3c8a463b14bf5a`
BLAKE2b-256 checksum How to use checksums	`4d74f6a8a7f19bf1fdb549b637d4e26142831bd10022628c4505b9f486bcf594`
Upload date	Oct 14, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.15`

Download URL	wagtail_footnotes-0.9.0-py3-none-any.whl
Size	14.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6a7d6af862bdcb704e52134bfcb5ee69e30be3df162cfe46eacd96d93a5bc36d`
BLAKE2b-256 checksum How to use checksums	`d70de5236568e92d5f707ed49471bb8527e394f016ad3348e06a91276e44aef2`
Upload date	Oct 14, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.15`