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.7.0
File	Size	Uploaded
wagtail-footnotes-0.7.0.tar.gz	10.1 kB	Jun 30, 2021	Details

Table of built distributions (wheels) for wagtail-footnotes 0.7.0
File	Interpreter	ABI	Platform	Reset
wagtail_footnotes-0.7.0-py3-none-any.whl 11.1 kB Jun 30, 2021	Python 3	none	any	Details

Total release size: 21.3 kB

Download URL	wagtail-footnotes-0.7.0.tar.gz
Size	10.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`1612499f815c55503f394db61eb50962cb2609c2c63d3d47db4e012a1d10a4db`
BLAKE2b-256 checksum How to use checksums	`28dda6459f4b492a3c21bee99f1a9323ec37e4010b234fd49813da81245b3651`
Upload date	Jun 30, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.2`

Download URL	wagtail_footnotes-0.7.0-py3-none-any.whl
Size	11.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`19370e7edee9084564d6d87ae95a7159a8f03ab656bc5843b10d983a2387019a`
BLAKE2b-256 checksum How to use checksums	`32df1f43c6edea817161e135ddf3a300551c033025aa55843bb3d4ae6bada101`
Upload date	Jun 30, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.2`