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

Add "authors" array property to publications. #108

Open
jaufgang opened this issue Aug 15, 2019 · 5 comments
Open

Add "authors" array property to publications. #108

jaufgang opened this issue Aug 15, 2019 · 5 comments

Comments

@jaufgang
Copy link

Please add am "authors" array property to publications.

Any properly formatted publication citation should include the author name(s). I guess this property was left out of this schema because it is assumed that the author is the person whose resume it is on, but often publications can have multiple co-authors, and it should be possible to list them here.

@stp-ip
Copy link
Member

stp-ip commented Aug 15, 2019

That's a good point. Probably fell through. Thanks for suggestion. Happy to get a PR that makes this possible :)

@stp-ip
Copy link
Member

stp-ip commented Sep 5, 2019

Thinking further on this. A few questions and would love your insights.
Should we consider books a publication?
Array for authors and a role field similar to projects?

This would lead to something like this:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "publications": {
      "description": "list of publications",
      "items": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "description": "name of the publication",
            "type": "string"
          },
          "publisher": {
            "description": "name of the publisher",
            "type": "string"
          },
          "publicationDate": {
            "description": "date of publication",
            "format": "date",
            "type": "string"
          },
          "roles": {
            "description": "specify your role on this publication",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "coAuthors": {
            "description": "specify co-authors",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "resources": {
            "description": "multiple resources with label",
            "items": {
              "additionalProperties": false,
              "properties": {
                "label": {
                  "description": "label of the resource",
                  "type": "string"
                },
                "url": {
                  "description": "url of the resource",
                  "format": "uri",
                  "type": "string"
                }
              },
              "required": [
                "url",
                "label"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "summary": {
            "description": "short summary of the publication",
            "type": "string"
          },
          "url": {
            "description": "url of the publication",
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "name",
          "publisher"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "publications"
  ],
  "title": "Resumic resume Schema",
  "type": "object"
}

With data such as:

{
  "publications": [
    {
      "name": "Learning Resumic",
      "publisher": "Open Source Publisher",
      "publicationDate": "1337-01-01",
      "resources": [
        {
          "label": "link",
          "url": "https://example.com"
        },
        {
          "label": "reviews",
          "url": "https://example.com"
        }
      ],
      "summary": "Awesome book about Resumic",
      "url": "https://example.com/learning-resumic",
      "roles": [
        "reviewer"
      ],
      "coAuthors": [
        "Co-author #1",
        "Co-author #2"
      ]
    }
  ]
}

So by default the resume owner is assumed to have authored given publication, but he can add an array of co-authors and additionally add his given role, if he is not the main author.

This is similar to how projects are done.

Happy for other suggestions or feedback on that approach @jaufgang

@stp-ip
Copy link
Member

stp-ip commented Sep 5, 2019

Legal also has this notion of coAuthor, but also defines the main Author. Will revise this within legal to just have coAuthor and a roles array I think.

@stp-ip
Copy link
Member

stp-ip commented Dec 12, 2019

One way would be to push towards coRoles, but usually the important things are your own role and the coAuthors not the other editors etc. So probably should be ok with just coAuthor.

@ttben
Copy link

ttben commented Mar 20, 2020

Hi! Researcher here :)

Should we consider books a publication?

Yes!

What I suggest for publications is to go as follows:

{
   "releaseDate":"string",
   "publisher":"string",
   "title":"string",
   "type":"string (or a enumeration)",
   "authors":[
      "string"
   ],
   "link"?:"string",
   "doi"?:"string"
}

If you need feedback on this, do not hesitate!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants