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.8.1
File	Size	Uploaded
wagtail-footnotes-0.8.1.tar.gz	10.3 kB	Jun 24, 2022	Details

Table of built distributions (wheels) for wagtail-footnotes 0.8.1
File	Interpreter	ABI	Platform	Reset
wagtail_footnotes-0.8.1-py3-none-any.whl 11.3 kB Jun 24, 2022	Python 3	none	any	Details

Total release size: 21.6 kB

Download URL	wagtail-footnotes-0.8.1.tar.gz
Size	10.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`e5fcc99fd0641d9842f9c08314815d717cf6a642ac70250e561c90da8d4a0991`
BLAKE2b-256 checksum How to use checksums	`b2718b4db2b98cb2554885779818ce77d2206f6ecf0918f6be5c8cb845f31e2a`
Upload date	Jun 24, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10`

Download URL	wagtail_footnotes-0.8.1-py3-none-any.whl
Size	11.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b4e44b70bd732879932f0c025c64a6a157eeb53593f2dd90f30db388bf59274a`
BLAKE2b-256 checksum How to use checksums	`c7977e2aecc9f8d5e5315dd8d47f24e1255a6a3605fd0164dea88bf96a9b5b94`
Upload date	Jun 24, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10`