[GrandComicsDatabase/gcd-django] Render Notes consistently with shared sanitized Markdown (PR #769)
jhunterjActual
Group-membership Notes and several other Notes displays showed raw Markdown or plain text while existing Notes supported formatting. This change applies consistent Markdown rendering across catalog details, related tables, appearance and reprint annotations, collection items, and other Notes displays.
Shared rich_text.html and notes.html partials, a reusable MarkdownColumn, and common block/inline renderers replace duplicated rendering patterns, including existing biographies and descriptions. Source text remains unchanged for exports and revision diffs. Inline annotations retain valid HTML, and rendered content no longer receives duplicate line-break conversion.
Rendering and Markdownx previews share an allowlist sanitizer. Display rendering sanitizes unconditionally before marking HTML safe. This adds nh3>=0.3,<0.4; deployments must install the updated requirements. Supported formatting is retained, while scripts, event handlers, unsafe URL schemes, and arbitrary styles are removed. No database migration or source-data conversion is required.
Validation:
- 65 focused Notes/reprint tests passed, including formatting, sanitization, inline markup, exports, and page rendering.
- 70 changed/new templates compiled; changed Python files passed Flake8.
- Django system checks passed, and the migration dry run found no changes.
- Local synthetic group, membership, and character pages returned HTTP 200 with formatted Notes; browser checks covered links and layout.
- Staged diff whitespace check passed.
The full test suite and production content were not validated. Existing Django and pygraph/pkg_resources deprecation warnings are tracked separately.
You can view, comment on, or merge this pull request online at:
https://github.com/GrandComicsDatabase/gcd-django/pull/769
Commit Summary
- 31f5b5a Render Notes consistently with shared sanitized Markdown
File Changes
(84 files)
- M apps/gcd/markdown_extension.py (119)
- M apps/gcd/models/publisher.py (8)
- M apps/gcd/models/reprint.py (4)
- M apps/gcd/models/story.py (29)
- M apps/gcd/models/support_tables.py (14)
- M apps/gcd/templatetags/credits.py (38)
- M apps/gcd/templatetags/display.py (5)
- A apps/gcd/tests/test_notes_rendering.py (267)
- M apps/oi/forms/series.py (17)
- M apps/oi/forms/support.py (3)
- M apps/oi/models.py (6)
- M apps/oi/templatetags/compare.py (25)
- M apps/voting/templates/voting/agenda.html (4)
- M requirements.txt (1)
- M settings.py (3)
- A templates/gcd/bits/notes.html (1)
- A templates/gcd/bits/rich_text.html (1)
- M templates/gcd/bits/tw_character_list.html (2)
- M templates/gcd/bits/tw_front_page_content.html (2)
- M templates/gcd/bits/tw_issue_data.html (2)
- M templates/gcd/bits/tw_story_characters.html (2)
- M templates/gcd/details/award.html (2)
- M templates/gcd/details/brand.html (6)
- M templates/gcd/details/brand_group.html (4)
- M templates/gcd/details/brand_uses.html (2)
- M templates/gcd/details/character.html (12)
- M templates/gcd/details/character_relation.html (2)
- M templates/gcd/details/creator.html (22)
- M templates/gcd/details/creator_art_influence.html (2)
- M templates/gcd/details/creator_degree.html (2)
- M templates/gcd/details/creator_membership.html (2)
- M templates/gcd/details/creator_non_comic_work.html (2)
- M templates/gcd/details/creator_relation.html (2)
- M templates/gcd/details/creator_school.html (2)
- M templates/gcd/details/creator_signature.html (2)
- M templates/gcd/details/feature.html (2)
- M templates/gcd/details/feature_logo.html (2)
- M templates/gcd/details/feature_relation.html (2)
- M templates/gcd/details/group.html (8)
- M templates/gcd/details/group_membership.html (2)
- M templates/gcd/details/group_relation.html (2)
- M templates/gcd/details/indicia_printer.html (2)
- M templates/gcd/details/indicia_publisher.html (2)
- M templates/gcd/details/issue.html (2)
- M templates/gcd/details/printer.html (2)
- M templates/gcd/details/publisher.html (2)
- M templates/gcd/details/received_award.html (2)
- M templates/gcd/details/series.html (4)
- M templates/gcd/details/single_story.html (6)
- M templates/gcd/details/tw_award.html (2)
- M templates/gcd/details/tw_brand_emblem.html (4)
- M templates/gcd/details/tw_brand_group.html (2)
- M templates/gcd/details/tw_brand_use.html (2)
- M templates/gcd/details/tw_character.html (12)
- M templates/gcd/details/tw_character_relation.html (2)
- M templates/gcd/details/tw_creator.html (25)
- M templates/gcd/details/tw_creator_art_influence.html (2)
- M templates/gcd/details/tw_creator_degree.html (2)
- M templates/gcd/details/tw_creator_membership.html (2)
- M templates/gcd/details/tw_creator_non_comic_work.html (2)
- M templates/gcd/details/tw_creator_relation.html (2)
- M templates/gcd/details/tw_creator_school.html (2)
- M templates/gcd/details/tw_creator_signature.html (2)
- M templates/gcd/details/tw_feature.html (4)
- M templates/gcd/details/tw_feature_logo.html (2)
- M templates/gcd/details/tw_feature_relation.html (2)
- M templates/gcd/details/tw_group.html (12)
- M templates/gcd/details/tw_group_membership.html (2)
- M templates/gcd/details/tw_group_relation.html (2)
- M templates/gcd/details/tw_indicia_printer.html (2)
- M templates/gcd/details/tw_indicia_publisher.html (2)
- M templates/gcd/details/tw_issue.html (2)
- M templates/gcd/details/tw_printer.html (2)
- M templates/gcd/details/tw_publisher.html (2)
- M templates/gcd/details/tw_received_award.html (2)
- M templates/gcd/details/tw_series.html (4)
- M templates/gcd/details/tw_single_story.html (4)
- M templates/gcd/details/tw_story_arc.html (10)
- M templates/gcd/details/tw_story_arc_relation.html (2)
- M templates/gcd/details/tw_universe.html (4)
- M templates/gcd/details/universe.html (4)
- M templates/mycomics/collection_item.html (2)
- M templates/oi/edit/list_issue_reprints.html (2)
- M templates/projects/issue_cover_notes.html (2)
Patch Links:
- https://github.com/GrandComicsDatabase/gcd-django/pull/769.patch
- https://github.com/GrandComicsDatabase/gcd-django/pull/769.diff
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
jhunterjActual left a comment (GrandComicsDatabase/gcd-django#769)I noticed this problem after this edit was discarded: https://www.comics.org/changeset/8521014/compare/
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
gemini-code-assist[bot]
@gemini-code-assist[bot] commented on this pull request.
Code Review
This pull request refactors the Markdown rendering system by introducing the nh3 library for HTML sanitization and defining separate render_markdown and render_markdown_inline functions to handle block and inline formatting safely. It updates numerous models, template tags, and templates to utilize these functions, and adds a comprehensive test suite. The review feedback highlights several instances where using render_markdown inside list items (
- ) introduces unwanted block-level paragraph tags and vertical padding, suggesting the use of render_markdown_inline instead to maintain a compact layout.
In apps/gcd/templatetags/credits.py:
> @@ -324,7 +319,7 @@ def __format_credit(story, credit, computed_value='', tailwind=False,
values = split_reprint_string(credit_value)
credit_value = '<ul>'
for value in values:
- credit_value += '<li>' + esc(value)
+ credit_value += '<li>' + render_markdown(value)
Using render_markdown inside list items (<li>) wraps the content in block-level <p class="pt-4"> tags, which introduces unwanted top padding and margins. Since these are compact list items, consider using render_markdown_inline instead to keep the list layout clean and compact.
- credit_value += '<li>' + render_markdown(value) + credit_value += '<li>' + render_markdown_inline(value)
In apps/gcd/templatetags/credits.py:
> + reprint_note += ('<li> ' + render_markdown(string) +
+ ' </li>')
Using render_markdown inside <li> wraps the reprint notes in block-level <p class="pt-4"> tags, which adds unwanted vertical spacing in the list. Consider using render_markdown_inline to keep the reprint notes compact.
reprint_note += ('<li> ' + render_markdown_inline(string) +\n ' </li>')
In apps/gcd/templatetags/credits.py:
> + reprint_note += ('<li> ' + render_markdown(string) +
+ ' </li>')
Using render_markdown inside <li> wraps the reprint notes in block-level <p class="pt-4"> tags, which adds unwanted vertical spacing in the list. Consider using render_markdown_inline to keep the reprint notes compact.
reprint_note += ('<li> ' + render_markdown_inline(string) +\n ' </li>')
In apps/gcd/templatetags/credits.py:
> @@ -877,7 +865,7 @@ def show_reprints(story, bare_value=False):
if story.reprint_notes:
for string in split_reprint_string(story.reprint_notes):
string = string.strip()
- reprint += '<li> ' + esc(string) + ' </li>'
+ reprint += '<li> ' + render_markdown(string) + ' </li>'
Using render_markdown inside <li> wraps the reprint notes in block-level <p class="pt-4"> tags, which adds unwanted vertical spacing in the list. Consider using render_markdown_inline to keep the reprint notes compact.
- reprint += '<li> ' + render_markdown(string) + ' </li>' + reprint += '<li> ' + render_markdown_inline(string) + ' </li>'
In apps/oi/templatetags/compare.py:
> @@ -12,8 +12,9 @@
sum_page_counts, show_barcode, \
show_isbn
from apps.gcd.templatetags.credits import format_page_count, \
- split_reprint_string, \
- render_markdown
+ split_reprint_string
+
+from apps.gcd.markdown_extension import render_markdown
Import render_markdown_inline from apps.gcd.markdown_extension to support rendering reprint notes compactly in the comparison view.
-from apps.gcd.markdown_extension import render_markdown +from apps.gcd.markdown_extension import render_markdown, render_markdown_inline
In apps/oi/templatetags/compare.py:
> elif field == 'reprint_notes':
reprint = ''
if value.strip() != '':
for string in split_reprint_string(value):
string = string.strip()
- reprint += '<li> ' + esc(string) + ' </li>'
+ reprint += '<li> ' + render_markdown(string) + ' </li>'
Using render_markdown inside <li> wraps the reprint notes in block-level <p class="pt-4"> tags, which adds unwanted vertical spacing in the list. Consider using render_markdown_inline to keep the reprint notes compact.
- reprint += '<li> ' + render_markdown(string) + ' </li>' + reprint += '<li> ' + render_markdown_inline(string) + ' </li>'
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- 32f9626 Update apps/gcd/templatetags/credits.py
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- e5e1517 Update apps/gcd/templatetags/credits.py
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- 8b1e5b8 Update apps/oi/templatetags/compare.py
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- e809aa0 Update apps/oi/templatetags/compare.py
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- e0451ef Keep reprint note lists compact and cover rendering paths
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual commented on this pull request.
In apps/gcd/templatetags/credits.py:
> + reprint_note += ('<li> ' + render_markdown(string) +
+ ' </li>')
Addressed in the applied suggestions and e0451ef. All flagged reprint-note paths now use render_markdown_inline. Six regression cases verify compact markup while preserving formatting, links, paragraph breaks, and directional filtering. The focused run passed 68 tests.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual commented on this pull request.
In apps/gcd/templatetags/credits.py:
> + reprint_note += ('<li> ' + render_markdown(string) +
+ ' </li>')
Addressed in the applied suggestions and e0451ef. All flagged reprint-note paths now use render_markdown_inline. Six regression cases verify compact markup while preserving formatting, links, paragraph breaks, and directional filtering. The focused run passed 68 tests.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
JochenGCD
@jochengcd commented on this pull request.
In apps/gcd/models/reprint.py:
> @@ -115,7 +115,9 @@ def get_compare_string(self, base_issue):
esc(issue.full_name())))
if self.notes:
- reprint = '%s [%s]' % (reprint, esc(self.notes))
The notes in a reprint do not use markdown.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
JochenGCD
@jochengcd commented on this pull request.
> @@ -122,12 +124,14 @@ def character_notes(character):
note = ' (%s)' % note
if character.role:
- note += ' (%s)' % character.role
+ note += ' (%s)' % (esc(character.role) if html else character.role)
Same here, short notes do not use markdown. Only the fields on the model.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
JochenGCD
@jochengcd commented on this pull request.
> @@ -39,8 +40,8 @@ def __init__(self, *args, **kwargs):
super(RuntimeAddSeriesRevisionForm, self).__init__(*args,
**kwargs)
self.fields['is_singleton'].help_text += \
- ' Series notes for an added singleton series will be '\
Two space indentation is correct here. We use four for a logical new line, two for line breaks.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual commented on this pull request.
In apps/gcd/models/reprint.py:
> @@ -115,7 +115,9 @@ def get_compare_string(self, base_issue):
esc(issue.full_name())))
if self.notes:
- reprint = '%s [%s]' % (reprint, esc(self.notes))
People are currently using the Notes markdown and gcd links in Notes fields where they aren't supported, which makes them display the "raw" markdown and link coding. This was to standardize Notes fields.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
JochenGCD
@jochengcd commented on this pull request.
In apps/gcd/models/reprint.py:
> @@ -115,7 +115,9 @@ def get_compare_string(self, base_issue):
esc(issue.full_name())))
if self.notes:
- reprint = '%s [%s]' % (reprint, esc(self.notes))
I get that.
But these other notes fields are intended to be short and inline.
The example is an unneeded note. In which issue someone joins a group should come from the database (which can be automated), but not a note.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- a8159ca Preserve plain text in short Notes annotations
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual commented on this pull request.
> @@ -39,8 +40,8 @@ def __init__(self, *args, **kwargs):
super(RuntimeAddSeriesRevisionForm, self).__init__(*args,
**kwargs)
self.fields['is_singleton'].help_text += \
- ' Series notes for an added singleton series will be '\
Returned to the standard
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual commented on this pull request.
> @@ -122,12 +124,14 @@ def character_notes(character):
note = ' (%s)' % note
if character.role:
- note += ' (%s)' % character.role
+ note += ' (%s)' % (esc(character.role) if html else character.role)
Fixed
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual commented on this pull request.
In apps/gcd/models/reprint.py:
> @@ -115,7 +115,9 @@ def get_compare_string(self, base_issue):
esc(issue.full_name())))
if self.notes:
- reprint = '%s [%s]' % (reprint, esc(self.notes))
I see it now. Fixed.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
JochenGCD
jochengcd left a comment (GrandComicsDatabase/gcd-django#769)Can you please explain and document what the sanitization is doing ?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
@jhunterjActual pushed 1 commit.
- 5cd736b Document Markdown sanitization policy and compatibility
—
View it on GitHub or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.
jhunterjActual
jhunterjActual left a comment (GrandComicsDatabase/gcd-django#769)Can you please explain and document what the sanitization is doing ?
Added with 5cd736b
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.