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

JSONschema for bibliography file #33

Open
clbarnes opened this issue Mar 24, 2023 · 3 comments · May be fixed by #192
Open

JSONschema for bibliography file #33

clbarnes opened this issue Mar 24, 2023 · 3 comments · May be fixed by #192

Comments

@clbarnes
Copy link

clbarnes commented Mar 24, 2023

Somewhat related to #32; it would be much easier to interact with the YAML file from other languages if there were a programmatic schema for it.

@clbarnes clbarnes changed the title JSONschema for hayagriva file JSONschema for bibliography file Mar 24, 2023
@nichtich
Copy link

A JSON Schema would also help to formalize the partly vague File Format specification. By now some parts are not strictly defined but only shown as examples. This is not related to #32 - JSON Schema just happens to be common with implementations in several programming language to validate both JSON and YAML files.

@bdarcus
Copy link

bdarcus commented Apr 9, 2023

And you can write and maintain the schema in YAML, which is much nicer, given it's support for comments and such, and just run a CI process to create a JSON version.

        institution:
          title: Literal name text; should not be parsed
          # comment
          description: Use for institutional creator names; e.g. 'National Institutes of Health'
          type: string

In general, the additional metadata on the properties will allow editors with support for this to provide auto-completion tooltips and such.

BTW, presumably this means you don't really support corporate names in these author lists?

    author:  ["Doe, Jane", "Some org, Some subunit"]

How would you deal with that?

We've struggled with these questions in CSL.

@mkdjr mkdjr linked a pull request Jul 29, 2024 that will close this issue
@mkdjr
Copy link
Contributor

mkdjr commented Jul 29, 2024

Hey y'all, I've created a JSON specification for Hayagriva in PR #192. Please provide your feedback!

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.

4 participants