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

Software item type #69

Open
rmzelle opened this issue Oct 20, 2015 · 21 comments
Open

Software item type #69

rmzelle opened this issue Oct 20, 2015 · 21 comments

Comments

@rmzelle
Copy link
Collaborator

rmzelle commented Oct 20, 2015

Per https://github.com/citation-style-language/styles/pull/1704/files#r41761578

(@adam3smith)

@adam3smith
Copy link
Collaborator

Software is increasingly being cited
http://blog.datacite.org/software-citation-workflows/
And both Mendeley and Zotero have computer program item types. This seems like an obvious addition.

@rmzelle
Copy link
Collaborator Author

rmzelle commented Oct 21, 2015

Preferred CSL item type name? "program", "computer_program", "software"? I think I prefer "program".

@bdarcus
Copy link
Collaborator

bdarcus commented Oct 21, 2015

Program could be confusing.

http://dictionary.reference.com/browse/program

On Wed, Oct 21, 2015 at 9:51 AM, Rintze M. Zelle notifications@github.com
wrote:

Preferred CSL item type name? "program", "computer_program", "software"? I
think I prefer "program".


Reply to this email directly or view it on GitHub
#69 (comment).

@rmzelle
Copy link
Collaborator Author

rmzelle commented Oct 21, 2015

Is "software" too general? Otherwise I guess we'll go with "computer_program", then.

@adam3smith
Copy link
Collaborator

I actually like software, don't see how that'd be too general (if anything that's a plus), and it's nice and pithy.

@rmzelle
Copy link
Collaborator Author

rmzelle commented Oct 21, 2015

Fine with me!

@slint
Copy link

slint commented Dec 14, 2016

@rmzelle Is there any status update (or PR in https://github.com/citation-style-language/schema) for this "software" type addition?

@adam3smith
Copy link
Collaborator

no -- item type additions happen in new CSL releases and those take time to prepare (no need for a PR -- the work here is not the actual change in the schema, which is trivial, but reaching agreement on what should and shouldn't be in a next release).

@rmzelle
Copy link
Collaborator Author

rmzelle commented Dec 14, 2016

While I've been procrastinating for over 4 years now when it comes to working on a new CSL release, I have some good hopes we can rekindle the fire and push out a (small) update in 2017.

One reason I didn't feel much pressure is that adding new item types wasn't really feasible for Zotero 4.0.x, but this situation is about to change now that Zotero 5.0 has nearly arrived (while there are many more programs that use CSL, I didn't want to leave Zotero out in the cold, since they've been one of CSL's biggest institutional supporters). That's what I tell myself, anyways.

@njsmith
Copy link

njsmith commented Dec 15, 2016

I'm lurking on this issue because I'm hoping to see a solution for projects like duecredit that need a standard interchange format for citations, and in particular software citations -- right now AFAICT there really isn't any reasonable format for them to use.

@rmzelle
Copy link
Collaborator Author

rmzelle commented Dec 15, 2016

@njsmith, yes, we're aware of the high interest in the community to improve software citation, so a new item type for software will almost certainly be added to the next CSL release. Can't provide a more precise ETA right now, though.

@tjhei
Copy link

tjhei commented Mar 31, 2017

I am curious if there are any updates regarding a software citation type. I found my way here from zenodo.org, which can not display the correct type and chooses to show software DOIs as "[data set]" because of this. Thanks!

@rmzelle
Copy link
Collaborator Author

rmzelle commented Mar 31, 2017

Status is still the same as above.

@timjim333
Copy link

Hi, is this still a work in progress? =) Thanks! As a workaround, is this something we can pull and modify?

@denismaier
Copy link

My impression is there's been a consensus that this should be implemented, right? If yes, can we move this to accepted?

@dstillman
Copy link
Member

We renamed Computer Program to Software a while ago in Zotero. Is there anything else we need to do here?

@bwiernik
Copy link
Collaborator

We need to map it to CSL 1.0.2 software.

Also, I don't know that we really need both System (medium) and Programming Language (genre) fields. This sort of information is generally just cited with a single label like "Computer program", "Software", "R package", "Python package", etc.

I don't ever see references to System (Windows, Linux, MacOS) in citations, and the Programming Language label is confusing. Should it contain, e.g., "R" or "R package" (the latter being what would be cited). What about something like an R Package that has both R and C++ code in it?

I think consolidating these fields to just "Type" or "Software Type" (mapped to genre) would make sense.

Or perhaps for backwards compatibility, add "Software Type" (genre) and remove the CSL mappings for System and Programming Language. Perhaps migrate Programming Language to that field (and maybe System instead if Programming Language is empty).

@dstillman
Copy link
Member

We definitely want to keep Programming Language, since it's fairly important for non-citation usage, and we save to that from GitHub (e.g., "Python"). We could consider duplicating "Programming Language" values into "Type", but I wouldn't want to just move them.

"System" should probably be "Platform" for clarity.

@dstillman
Copy link
Member

Should we try to populate "Type" from the GitHub translator? If all we have is, say, "Python"?

The Type fields in general are kind of unfortunate — it seems like they're often tied to style requirements, which sort of breaks the fundamental model of data vs. presentation and means we can't generate correct citations out of the box…

@bwiernik
Copy link
Collaborator

I would suggest the following:

  • Remove mapping of System and Programming Language
  • Duplicate Programming Language in Type
  • Rename System to Platform

I don't think that the Type fields are that much of a nuisance. The only style that is quite prescriptive about the exact wording of types is APA, and even there it got a lot more flexible in terms of what is allowable in 7th edition—phrases like "computer software" are sort of like fallbacks if there isn't a more specific term (e.g., "Python package"). Other styles are really flexible about exact phrasing.

The biggest limitation about Type/Format fields (genre/medium) at the moment I think is that they aren't localizable. That could be fixed with field-level language tags in a future version.

@bwiernik
Copy link
Collaborator

Should we try to populate "Type" from the GitHub translator? If all we have is, say, "Python"?

I think populating "Type" from the GitHub and CRAN translators would be good. "Programming language" + " package" would work a huge amount of the time, as least for the commonly most cited languages (R, Python, Julia, Matlab). Do you have a sample of GitHub programming lanugage field data?

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

No branches or pull requests

10 participants