Allow custom footnote reference rendering #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
zerolab
approved these changes
Jul 3, 2024
| "wagtail_footnotes/includes/footnote_reference.html" | ||
| ) | ||
| template = get_template(template_name) | ||
| return template.render({"index": index}) |
There was a problem hiding this comment.
I like the template approach much better than f-strings.
At first I was in two minds about adding a setting over than just the usual pattern of overriding templates from other apps by adding the correct path in your project's templates.
In this case, adding wagtail_footnotes/includes/footnote_reference.html to one's app's templates folder, or a top-level templates folder should override it.
On the other hand, Django, Wagtail and some packages do provide a setting for specific templates too (like the password required template in Wagtail), so this makes it more expressive
There was a problem hiding this comment.
Yeah. I thought about that too. There's nothing with this approach that prevents just overriding wagtail_footnotes/includes/footnote_reference.html. Do you think there be a note about that option in the README?
There was a problem hiding this comment.
No, I think we should guide people towards the setting as the official way of doing it
This change does two things to permit custom rendering of footnote references in the `RichTextBlockWithFootnotes` block: 1. Moves reference rendering from an inner function in the `replace_footnote_tags()` method to a separate `render_footnote_tag()` method on the `RichTextBlockWithFootnotes` block class. This provides an easy extension point for subclasses of `RichTextBlockWithFootnotes` to customize rendering that doesn't require duplication of a lot of other code. 2. The default implementation of `render_footnote_tag` renders using a Django template, optionally set with the `WAGTAIL_FOOTNOTES_REFERENCE_TEMPLATE` setting, allowing users to override rendering by providing a different template to that setting. This is similar in spirit to @an-ant0ni0's proposal in torchbox#27, however we've chosen to move rendering out of Python f-strings altogether and into Django (or any other configured engine's) templates.
willbarton
force-pushed
the
templated-reference-links
branch
from
50e6184
to
87d100a
Compare
|
Fixed the linting issues 🤞🏻 |
zerolab
reviewed
Jul 3, 2024
willbarton
added a commit
to cfpb/consumerfinance.gov
that referenced
this pull request
Aug 14, 2024
This updates wagtail-footnotes to 0.12 and removes our custom `RichTextBlockWithFootnotes` subclass of wagtail-footnotes own `RichTextBlockWithFootnotes`, tests, and switches to using the upstream `RichTextBlockWithFootnotes`. 0.12 includes our changes in torchbox/wagtail-footnotes#70, which were based on this code being removed. This change updates `RichTextBlockWithFootnotes` in-place in old migrations. Removing `v1.blocks.RichTextBlockWithFootnotes` requires these migrations to be updated, and because there are no schema changes, new migrations are not required.
Merged
2 tasks
nickmoreton
pushed a commit
to torchbox-forks/wagtail-footnotes
that referenced
this pull request
Aug 20, 2024
* Allow custom footnote reference rendering This change does two things to permit custom rendering of footnote references in the `RichTextBlockWithFootnotes` block: 1. Moves reference rendering from an inner function in the `replace_footnote_tags()` method to a separate `render_footnote_tag()` method on the `RichTextBlockWithFootnotes` block class. This provides an easy extension point for subclasses of `RichTextBlockWithFootnotes` to customize rendering that doesn't require duplication of a lot of other code. 2. The default implementation of `render_footnote_tag` renders using a Django template, optionally set with the `WAGTAIL_FOOTNOTES_REFERENCE_TEMPLATE` setting, allowing users to override rendering by providing a different template to that setting. This is similar in spirit to @an-ant0ni0's proposal in torchbox#27, however we've chosen to move rendering out of Python f-strings altogether and into Django (or any other configured engine's) templates.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change does two things to permit custom rendering of footnote references in the
RichTextBlockWithFootnotesblock:replace_footnote_tags()method to a separaterender_footnote_tag()method on theRichTextBlockWithFootnotesblock class. This provides an easy extension point for subclasses ofRichTextBlockWithFootnotesto customize rendering that doesn't require duplication of a lot of other code.render_footnote_tagrenders using a Django template, optionally set with theWAGTAIL_FOOTNOTES_REFERENCE_TEMPLATEsetting, allowing users to override rendering by providing a different template to that setting.This is similar in spirit to @an-ant0ni0's proposal in #27, however we've chosen to move rendering out of Python f-strings altogether and into Django (or any other configured engine's) templates.
The motivation here, is we're adopting this package to replace our hand-crafted (😱) footnotes, and our existing style doesn't include
[]brackets around the reference number.This will allow that kind of customization of reference rendering so users can render however their style specifies without having to subclass
RichTextBlockWithFootnotesand include the full code of thereplace_footnote_tags()with a single line f-string change. Instead, users will just have to provide a template.