inara icon indicating copy to clipboard operation
inara copied to clipboard

Add enhanced reviewer credits with ORCID support

Open arfon opened this issue 2 months ago • 1 comments

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

  • Reviewers can be specified in the paper's YAML frontmatter with:
    • Full name + ORCID (name links to ORCID profile with badge)
    • Name only (plain text, no link)
  • Supports same name formats as authors (simple name or structured given-names/surname)
  • ORCID validation with checksum verification
  • Works in both LaTeX and ConTeXt outputs

Backward Compatibility

  • Existing workflow with GitHub handles continues to work unchanged
  • No breaking changes to existing papers or workflows

Files Added

  • data/filters/normalize/reviewers.lua: Name and ORCID normalization logic
  • docs/reviewers.md: Complete usage documentation
  • test/metadata-reviewers-enhanced.yaml: Test case demonstrating new format

Files Modified

  • data/filters/normalize-metadata.lua: Integrated reviewer normalization
  • data/templates/default.latex: Display reviewers with ORCID links
  • data/templates/default.context: Display reviewers with ORCID links

Example Usage

reviewers:
  - name: Jane Smith
    orcid: 0000-0001-2345-6789
  - given-names: John
    surname: Doe
    orcid: 0000-0002-3456-7890
  - name: Anonymous Reviewer

Important Notes

  • Reviewer metadata must be added by paper authors/reviewers after review is complete but before publication
  • We are not ORCID members, so cannot automatically update reviewers' ORCID records
  • Reviewers must manually add peer review activities to their ORCID profiles if desired

Testing

Tested with test/metadata-reviewers-enhanced.yaml which demonstrates:

  • Reviewer with full name + ORCID
  • Reviewer with structured name + ORCID
  • Reviewer with name only (no ORCID)

arfon avatar Nov 13 '25 16:11 arfon

:wave: @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 🙈

arfon avatar Nov 13 '25 16:11 arfon