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

Cite Data: Various formats of citation are not accessable via URL #3140

Open
mheppler opened this issue May 25, 2016 · 8 comments
Open

Cite Data: Various formats of citation are not accessable via URL #3140

mheppler opened this issue May 25, 2016 · 8 comments
Labels
Feature: Publishing & Versions Hackathon: More APIs Add new or missing API endpoints Type: Feature a feature request User Role: API User Makes use of APIs

Comments

@mheppler
Copy link
Contributor

In the Widgets project, changes to how a user can access the various formats of the dataset citation were implemented, with the intent to improve the UX. Additional improvements should be made to access these formats directly through a URL.

For example, the URL to access the BibTeX version is:

http://localhost:8080/dataset.xhtml?persistentId=doi:10.5072/FK2/ZLRYYX#

Instead of pointing to the dataset pg, ideally we'd have an URL that is access directly to the BibTex citation version, which could look something like:

http://localhost:8080/dataset.bib?persistentId=doi:10.5072/FK2/ZLRYYX
@pdurbin
Copy link
Member

pdurbin commented May 25, 2016

I don't believe there are any formal requirements for this feature but here are some quick notes from a conversation with @scolapasta

I said I'd spend a couple hours with the code, at least, and see how long I think it would take to implement what's desired. @posixeleni would do acceptance testing.

@pdurbin pdurbin self-assigned this May 25, 2016
@posixeleni
Copy link
Contributor

@pdurbin regarding your #3140 (comment) comment/question about drafts: yes on drafts being able to support export on citations since researchers may want to add their data citation in pre-publication (hence why we already have a DOI reserved).

@pdurbin
Copy link
Member

pdurbin commented May 26, 2016

Related: Include dataset citation in native API #2059

@pdurbin
Copy link
Member

pdurbin commented May 26, 2016

@scolapasta as promised I spent about two hours poking around in the code and I think this is way more than a 2-3 day effort. My guess is two weeks, maybe more. I went ahead and pushed my scratch work to c433395 and I hope that the todo's I left in that commit help explain some of the challenges. I recommend revisiting this issue once the work for #2608 is complete.

@rhijmans
Copy link

I would love to have this feature. That is, the option to programmatically download a RIS file given a URI.

I use the API to download multiple files "bundle"s in the original format but I cannot add a citation file. It looks like I can do that with the "all formats" bundle, but that is not a good option for me (confusion about what the original files are; the need to download different file formats, sometimes file by file to deal with size limitations; additional disk space cost).

@pdurbin pdurbin added the Hackathon: More APIs Add new or missing API endpoints label Feb 28, 2023
@pdurbin
Copy link
Member

pdurbin commented Feb 28, 2023

@rhijmans thanks for the thoughtful comment. As you may have heard, we are planning on rewriting the front end of Dataverse such that we'll need APIs for any functionality that's not currently exposed as APIs (such as downloading citations files). It's early days but I'm sure we'll get to this eventually.

If you (or anyone reading this) is interested in making a pull request, please get in touch! As mentioned above, it looks like I pushed some scratch work a long time ago (c433395) that might help someone get started.

@pdurbin
Copy link
Member

pdurbin commented Apr 25, 2023

@cmbz
Copy link

cmbz commented Sep 9, 2024

2024/09/09: Keeping

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Publishing & Versions Hackathon: More APIs Add new or missing API endpoints Type: Feature a feature request User Role: API User Makes use of APIs
Projects
None yet
Development

No branches or pull requests

6 participants