Spike: Provide ways in the Hypothesis client for a publisher to override document metadata

[mkdir-washington-edu]

Problem you are trying to address with this feature

See Slack conversation here: https://hypothes-is.slack.com/archives/C4K6M7P5E/p1628089045073400.

OSF (and presumably other folks) currently has a need to override document metadata on PDFs that appear with the Hypothesis Sidebar over them. These preprints get annotated by a scholarly community and the documents go through multiple revisions. In order to a) keep the annotations on those documents after they change and b) store those documents in multiple locations and behind some unfriendly URLs OSF overrides both the document URL and the PDF fingerprint when folks annotate.

This has caused an issue when browsers changed their privacy settings and the URL getting sent to us was being truncated. Now there are several OSF-related documents (at psyrxiv, metarxiv, and possibly other sites) that have established document equivalence through the identical, truncated URL.

Your solution

Per the Slack conversation above, Rob's idea is, in the Hypothesis client, to provide stable, documented ways of overriding document metadata.

Additional information

A gist that summarizes the issues from OSF's point of view: https://gist.github.com/felliott/758af271ceb13d7a10700597dbf254bb

JavaScript code in the OSF PDF viewer that does the aforementioned overriding: https://github.com/CenterForOpenScience/modular-file-renderer/blob/20.0.1/mfr/server/static/js/mfr.child.hypothesis.js#L28

Example of an affected article: https://osf.io/preprints/metaarxiv/cd5j9/

[mkdir-washington-edu]

When prioritized reach out to the folks in https://app.hubspot.com/contacts/6291320/ticket/503397519/

[mkdir-washington-edu]

Maybe a similar request: https://app.hubspot.com/contacts/6291320/ticket/516310865/