rmzelle / ref-extractor

Reference Extractor - Extract Zotero/Mendeley references from Microsoft Word files
https://rintze.zelle.me/ref-extractor/
MIT License
332 stars 20 forks source link

DEMO: BibTeX output with citation-js #22

Closed zuphilip closed 6 years ago

zuphilip commented 6 years ago

See also #16.

rmzelle commented 6 years ago

Thanks! Why did you label this as "DEMO"? Not ready for merging? (other than the fact that we'd need to update the on-page documentation and https://github.com/rmzelle/ref-extractor/blob/master/README.md)

It might be nicer to add an additional step after the file selection, and offer the user a drop-down menu of output formats (CSL-JSON, BibTeX, something like citation-apa, and, if Citation.js ever supports it, RIS). That way we'd only need one set of buttons.

We could also add a textarea (below or to the right) to show the extracted metadata in the selected format, which would the added benefit of giving user feedback when a different output format is selected in the dropdown menu.

(this dropdown menu would become the new step 3, and the button would move to step 4:

)

zuphilip commented 6 years ago

I named it DEMO because there are a lot of options how actually to do the integration. Besides from documentation etc. it should be ready to merge, maybe then as an intermediate solution. I like what you outlined with a new intermediate step to choose the format from, but I would leave this to you then to do. Also the textarea could be a nice idea.

Should I rename the PR? Can you take over from here?

rmzelle commented 6 years ago

Covered by #24.

It might be nicer to add an additional step after the file selection, and offer the user a drop-down menu of output formats (CSL-JSON, BibTeX, something like citation-apa, and, if Citation.js ever supports it, RIS).

For some reason I couldn't get a rendered format like "citation-apa" to work in citation.js 0.3.4 (see https://github.com/larsgw/citation.js/issues/142). And it looks like RIS support won't happen until 0.4: https://github.com/larsgw/citation.js/issues/125.

larsgw commented 6 years ago

Concerning RIS, I could create an intermediary beta release, or just a bundle created from the master branch. Do you have a preference?

rmzelle commented 6 years ago

Could you create a beta release? That might make it easier to track down bugs.

On Fri, May 11, 2018 at 03:03 Lars Willighagen notifications@github.com wrote:

Concerning RIS, I could create an intermediary beta release, or just a bundle created from the master branch. Do you have a preference?

— You are receiving this because you modified the open/close state.

Reply to this email directly, view it on GitHub https://github.com/rmzelle/ref-extractor/pull/22#issuecomment-388320447, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEwfyZrg40CScGa2wq-Pnle22yEnSb2ks5txWILgaJpZM4RQFK7 .

larsgw commented 6 years ago

I'll add my replies from the other thread here too:

I released the v0.4.0-3 beta with RIS support, the CDN should load up soon:

(The CDN links work now)

Here's a demo on how to use the RIS output BTW: https://runkit.com/larsgw/citation.js-ris-output-demo

Basically this:

Cite(...).get({
  format: 'string',
  type: 'string',
  style: 'ris'
})

Or, with the new API:

Cite(...).format('ris')

Additionally, you can pass parameters:

Cite(...).format('ris', {
  type: 'text' // alternative: 'object' gives you an object representation
})