Skip to main content

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'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
    

Settings

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wagtail-footnotes, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size wagtail_footnotes-0.7.0-py3-none-any.whl (11.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size wagtail-footnotes-0.7.0.tar.gz (10.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page