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

Use BibJSON instead of CSL-JSON #765

Closed
mdoering opened this issue Jun 23, 2020 · 5 comments
Closed

Use BibJSON instead of CSL-JSON #765

mdoering opened this issue Jun 23, 2020 · 5 comments
Labels
API API model related feature request Proposing a new feature currently not existing importer Dataset import related issues low priority
Milestone

Comments

@mdoering
Copy link
Member

CSL-JSON is very flexible and has lots of alternative fields (e.g. small, large, medium, verbatim, ...) and is implemented differently at the major players. It has proven very difficult to work with during implementation. The official biggest benefit to use differetn CSL formats to render different kind of citations also does not work as expected. The Java library is running the javascript reference implementation under the hood and is very slow. It takes a second to generate a single citation string. The JS library itself carries lots of dependencies and is rather large for the frontend. Rendering single citations is not what the library is made for (it builds bibliographies, i.e. list of citations). To do so you need to hack it.

Suggest to use the battle proven BibTex standard or its slightly more modern BibJSON friend, which breaks down authorships to individual authors but otherwise is very close to BibTex ported to JSON.

@mdoering mdoering added importer Dataset import related issues API API model related labels Jun 23, 2020
@mdoering mdoering added this to the Public API milestone Sep 3, 2020
@thomasstjerne
Copy link

The CSL library was only used for rendering and has already been removed from the UI.
However, effort has been put in development of a rather extensive set of forms supporting the CSL standard.
Consider consequences of switching format. Can this be done transparently for the UI with reuse of the existing form set?

@mdoering
Copy link
Member Author

I doubt its exactly the same, but the basics with properties tied to a reference type is the same.

@mdoering
Copy link
Member Author

@mdoering mdoering added low priority feature request Proposing a new feature currently not existing labels Jun 29, 2023
@sommer-gei
Copy link

FYI: here is a comment from one of the developers, from 2020 (and the rest of the discussion may also be interesing)

We developed BibJSON 10 years ago . We tried to get update then but with limited success. I don't think anyone uses it now. So I suspect that none of us would be too worried to see CSL js used.

@mdoering
Copy link
Member Author

Thanks. Yes, I have seen that before. And after using CSL-JSON for some years now I dont think we should make a switch. CSL-JSON does lack some standardisation and isn't exactly the simplest format to work with. But as we sailed most of the rough waters already I dont think we need to swim through yet another sea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API API model related feature request Proposing a new feature currently not existing importer Dataset import related issues low priority
Projects
None yet
Development

No branches or pull requests

3 participants