Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable annotating contributor roles #75

Closed
wants to merge 24 commits into from

Conversation

cthoyt
Copy link
Contributor

@cthoyt cthoyt commented Sep 2, 2024

Closes #73

This PR enables annotating author roles using the Contribution Role Taxonomy (CRediT). It also enables (optionally) annotating the contribution degree, as suggested by JATS.

It does the following:

  • Add contribution list to end of default.latex (after reference list)
  • Add contribution list to end of preprint.latex (after reference list)

Demo

Here's what this looks like at the end of the main PDF build:

Screenshot 2024-09-02 at 13 19 52

Future Work

Future work for future PRs:

  1. Work with Crossref to get a reasonable model for capturing this. Crossref is currently discussing supporting this.
  2. Upstream JATS generation in pandoc, started in Add CRediT roles to JATS jgm/pandoc#10153
  3. See how this fits in the ConTeXt template, if this gets picked up by the journals

@cthoyt
Copy link
Contributor Author

cthoyt commented Sep 2, 2024

@tarleb this one is also ready for a first review

Copy link
Collaborator

@tarleb tarleb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super neat, thank you! I added a few inline comments.

data/filters/prepare-credit.lua Show resolved Hide resolved
for _, roleDict in ipairs(author.roles) do
role = roleDict.type[1].text
if invalidRole(role) then
error("invalid role for author " .. author.name .. ": " .. role)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how errors are handled by editorial-bot. @xuanxu, what happens if the conversion fails, would the authors see this error message?

data/filters/prepare-credit.lua Outdated Show resolved Hide resolved
cthoyt added a commit to y0-causal-inference/y0 that referenced this pull request Sep 8, 2024
@cthoyt cthoyt mentioned this pull request Sep 17, 2024
2 tasks
@cthoyt
Copy link
Contributor Author

cthoyt commented Sep 17, 2024

closing this one in favor of #87

@cthoyt cthoyt closed this Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable annotating Contributor Roles Taxonomy (CRediT) to authors
2 participants