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

Metadata + Terms - Support Markdown syntax #4647

Closed
mheppler opened this issue May 4, 2018 · 3 comments
Closed

Metadata + Terms - Support Markdown syntax #4647

mheppler opened this issue May 4, 2018 · 3 comments

Comments

@mheppler
Copy link
Contributor

mheppler commented May 4, 2018

I thought we had an old issue requesting this, but I could not find it. Seeing this comment from @pdurbin on #4645 caused me to shudder a little bit.

As you observed (and as I think I said wrong in my reply on the forum), you can retrieve "Terms of Use" via API like this (truncated example reformatted a bit):

curl -s 'https://dataverse.harvard.edu/api/datasets/:persistentId?persistentId=hdl:1902.1/00875' | jq '.data.latestVersion.termsOfUse' | cut -c-300

"<div style=\"padding-left: 30px;\"> <ul style=\"list-style-type: decimal;\" ><li> The Murray Archive (the Distributor) has granted me a revocable license to use this dataset solely for the purposes of conducting research, and the Distributor may terminate this license at any time and for any reason...

The API returns the dataset Terms of Use, which includes HTML formatting to improve the layout in the UI. However that HTML does not improve the UX in the API.

In order to get the best of both worlds, we need to support Markdown, a lightweight markup language with plain text formatting syntax. This is what GitHub supports right here in the comment input, and it will make it easier for contributors to add text for metadata and terms that look great in the UI and API.

@pameyer
Copy link
Contributor

pameyer commented May 4, 2018

@mheppler any thoughts on Dataverse recognizing markdown as a filetype in datasets? (nm - looks like I was confused, and this is already the case)

@pdurbin
Copy link
Member

pdurbin commented May 4, 2018

@mheppler it's been over three years since I made the argument for supporting Markdown in #1320 (comment) so I'm not surprised the conversation wasn't top of mind for you, but I still very much think we should support Markdown. Of course, to my knowledge no one in the community has asked for Markdown support. Comments on this issue are welcome to indicate interest.

@djbrooke
Copy link
Contributor

Closing as duplicate of #6383

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

No branches or pull requests

4 participants