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
- Add
- Update your page templates to include
{% include "wagtail_footnotes/includes/footnotes.html" %}
- Make and run migrations:
./manage.py makemigrations ./manage.py migrate
Settings
WAGTAIL_FOOTNOTES_TEXT_FEATURES
- Default:
["bold", "italic", "link"]
- Use this to update a list of Rich Text features allowed in the footnote text.
- Default:
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
wagtail-footnotes-0.8.1.tar.gz
(10.3 kB
view hashes)
Built Distribution
Close
Hashes for wagtail_footnotes-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4e44b70bd732879932f0c025c64a6a157eeb53593f2dd90f30db388bf59274a |
|
MD5 | 6c8dfa71eab9cc696152d57a5aaf5d7a |
|
BLAKE2b-256 | c7977e2aecc9f8d5e5315dd8d47f24e1255a6a3605fd0164dea88bf96a9b5b94 |