Repository navigation
viewer: render footnote attribution via marked-footnote - #18
Open
FrozenEelFanGirl wants to merge 2 commits into
Open
FrozenEelFanGirl wants to merge 2 commits into
FrozenEelFanGirl wants to merge 2 commits into
Conversation
marked's GFM support does not include footnotes, while the spec's per-claim attribution mechanism is markdown footnotes keyed to sources[].id (SPEC section on per-claim attribution). Card bodies that follow that convention render their [^id] markers as literal text in the viewer's detail panel. Register the marked-footnote extension (two lines): load the UMD build in the template next to the existing cytoscape/marked CDN scripts, and call marked.use(markedFootnote()) at the top of the viewer IIFE. The registration is guarded on window.markedFootnote so the viewer keeps working unchanged when the script cannot load (e.g. offline); footnotes then fall back to plain text, as before.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The bundle viewer renders card bodies with
marked.parse(body, { gfm: true })(static/viz.js). marked's GFM support does not include footnotes — but the spec's per-claim attribution mechanism is markdown footnotes keyed tosourcesentries. So a card that follows the spec's own attribution convention shows its[^id]markers as literal text in the viewer's detail panel.Fix (two lines)
src/reference_agent/viewer/templates/viz.html: load the UMD build of marked-footnote from jsdelivr, next to the existing cytoscape/marked CDN scripts;src/reference_agent/viewer/static/viz.js:if (window.markedFootnote) { marked.use(markedFootnote()); }as the first statement of the viewer IIFE.[^id]markers now render as a superscript reference plus the definition block at the end of the body. The guard keeps the viewer working unchanged when the script cannot load (e.g. offline). Pre-generatedbundles/*/viz.htmlpick this up the next time they are regenerated.Verification
Generated a viewer for a small bundle whose concept body uses
[^spec]footnote attribution and opened the result: the reference renders as a link, the definition renders as a footnote block, and the graph/sources/backlinks panels are unaffected. With no network access to the CDN the page behaves exactly as before.