Wagtail Footnotes
Add footnotes functionality to your Wagtail project.
Usage
- Add the app to
INSTALLED_APPS:
INSTALLED_APPS = [
# ...
"wagtail_footnotes",
# ...
]
- Add the footnotes
urls.pyto 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
RichTextBlocks- Add
"footnotes"to thefeaturesarg for eachRichTextBlockthat you want to have this functionality - You will also need to change any
RichTextBlocks 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
Fnbutton 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.jsmatches 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
NoneTypeerror 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
2 maintainers
Metadata
2 maintainers
Release files for wagtail-footnotes 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wagtail_footnotes-0.10.0.tar.gz | 10.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wagtail_footnotes-0.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.9 kB
Release files / wagtail_footnotes-0.10.0.tar.gz
| Download URL | wagtail_footnotes-0.10.0.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c3a05b90e015b5a9e3796a0a35faecc0a43a70de77493ae1ca936c822fbcada5
|
|
BLAKE2b-256 checksum How to use checksums |
dda1667985f428c69c36f1c07fbf731ef50ea35ed3cfae6f493c5145a3c7c0f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / wagtail_footnotes-0.10.0-py3-none-any.whl
| Download URL | wagtail_footnotes-0.10.0-py3-none-any.whl |
|---|---|
| Size | 12.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fefdf0c5c25e7bea261c2f96c8f0bdc4a9209810b299074e97f4a6a20e452d62
|
|
BLAKE2b-256 checksum How to use checksums |
dfead723688d64e087a5a77c408506ba776fccb314891c9b916781d6f185d511
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
