Kozea/WeasyPrint

Linking ::footnote-calls?

Open

#1,545 opened on Jan 19, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (6,291 stars) (630 forks)batch import
featuregood first issue

Description

I don't think this is particularly clearly specified in the spec, but it would be nice if there were a way to link from a ::footnote-call site to the footnote (and potentially back). In practice these should generally be on the same page and not too hard to spot, but it's a nice usability feature, and notably, one that TeX seems to have.

I can see two paths to this:

  1. There's some sort of syntax that can be used to wrap the ::footnote-call element, and we can manually make links.
  2. We just automatically link footnote call sites to their footnotes (and vice versa?).

It doesn't seem as though Prince does this either, so it's not necessarily a bug in WeasyPrint, but it would be a nice feature.

Contributor guide

Tech stack
pythoncss
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonCSSWeasyPrint internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue proposes adding linking from footnote call to footnote and possibly back. Research the CSS GCPM specification for footnote call and explore if WeasyPrint already has any linking mechanism. Look at the existing footnote implementation in WeasyPrint's source code (likely in weasyprint/formatting structure or similar). Consider how Prince and TeX handle this. The two approaches are wrapping the footnote call element in a manual link or automatic linking. Start by examining the rendering of footnote call elements and identify where to inject hyperlinks.