Add enhanced reviewer credits with ORCID support #113
Conversation
Allow reviewers to be credited in published papers with full names and ORCID identifiers. Reviewers can be specified in the paper's YAML frontmatter with either: - Full name + ORCID (name links to ORCID profile with badge) - Name only (plain text, no link) Key features: - Supports same name formats as authors (simple name or structured given-names/surname with aliases) - ORCID validation with checksum verification - Backward compatible with existing GitHub handle workflow - Works in both LaTeX and ConTeXt outputs Files added: - data/filters/normalize/reviewers.lua: Name and ORCID normalization - docs/reviewers.md: Complete usage documentation - test/metadata-reviewers-enhanced.yaml: Test case Files modified: - data/filters/normalize-metadata.lua: Call reviewer normalization - data/templates/default.latex: Display reviewers with ORCID links - data/templates/default.context: Display reviewers with ORCID links 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
👋 @tarleb – as you might be able to tell, me and Claude tried to implement support for a new YAML frontmatter segment to enable reviewers to be described properly in the paper. I have literally never written a line of Lua in my life, so please be warned 🙈 |
| $for(reviewers)$ | ||
| \useURL[$it$][https://github.com/$it$][][@$it$] | ||
| \from[$it$] | ||
| $if(reviewers.name)$ |
There was a problem hiding this comment.
I think we can ignore changes in the ConTeXt template, as it's currently unused. Probably best to remove the whole file to lessen the maintenance burden.
Side note: we could try again using Typst instead of ConTeXt. There appears to be a lot of enthusiasm for that, it would speed up PDF compilation considerably, and the PDFs are accessible by default. Maybe someone with enough time and enthusiasm would be willing to re-create the JOSS layout in Typst? I could handle the rest.
| **Without ORCID:** | ||
| ``` | ||
| Reviewers: | ||
| • Anonymous Reviewer |
There was a problem hiding this comment.
The "Anonymous Reviewer" seems misleading": isn't the name is included, but just not linked?
| @@ -0,0 +1,167 @@ | |||
| local List = require 'pandoc.List' | |||
There was a problem hiding this comment.
A lot of this is taken from data/filters/normalize-author-names.lua and from data/filters/normalize/authors.lua. It would be better to require those file (or to factor out some of that code).
Tbh, I forgot why there are two files with similar names that effectively do one task. I should probably clean that up.
Summary
This PR adds support for crediting reviewers in published papers with full names and ORCID identifiers.
Motivation
Currently, reviewers are only identified by GitHub handles. This enhancement allows proper academic credit for peer review work by displaying reviewer names and linking to their ORCID profiles.
Changes
New Features
Backward Compatibility
Files Added
data/filters/normalize/reviewers.lua: Name and ORCID normalization logicdocs/reviewers.md: Complete usage documentationtest/metadata-reviewers-enhanced.yaml: Test case demonstrating new formatFiles Modified
data/filters/normalize-metadata.lua: Integrated reviewer normalizationdata/templates/default.latex: Display reviewers with ORCID linksdata/templates/default.context: Display reviewers with ORCID linksExample Usage
Important Notes
Testing
Tested with
test/metadata-reviewers-enhanced.yamlwhich demonstrates: