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

Nest identifiers in frontmatter #1585

Closed
fwkoch opened this issue Oct 15, 2024 · 1 comment · Fixed by #1589
Closed

Nest identifiers in frontmatter #1585

fwkoch opened this issue Oct 15, 2024 · 1 comment · Fixed by #1589
Assignees

Comments

@fwkoch
Copy link
Collaborator

fwkoch commented Oct 15, 2024

For identifiers, MyST frontmatter already includes MyST id, doi, and arxiv. We just added PubMed identifiers in #1570. There are many other identifiers (we are already looking to add zenodo), and we should not disallow them with our frontmatter validation.

Rather than needing a PR for every new identifier type any user needs, we should introduce identifiers: Record<string, string> to hold arbitrary external identifiers.

A few details:

  • id is the unique MyST ID - this is not part of external identifiers
  • doi is also still a top-level field
    • ideally everything has a DOI, there is no platform dependence, like many other identifiers
    • also, doi shows up elsewhere in the frontmatter, e.g. on issue/volume
  • "known" identifiers (e.g. arxiv, pmid, pmcid, zenodo) may all be defined at the top level, and will coerce under the identifiers key
  • doi, if defined under identifiers, will be lifted to the top level (and raise a warning)
@choldgraf
Copy link
Collaborator

I'd love to use the solution to this as inspiration for how we can similarly extend other parts of the myst engine (e.g. for launch buttons, edit buttons, etc as described in #1584 )

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 a pull request may close this issue.

2 participants