Integrate BibSonomy

[koppor]

There are many tools out there to share information on publications. Be it summaries and comments on publications or be it some collections of bibliographic entries. ShortSience.org is a platform for post-publication discussion aiming to improve accessibility and reproducibility of research ideas. BibSonomy is a tool to collect bibliographic information. The aim of this task is to integrate both ShortScience and BibSonomy. The ShortScience task is #6015.

Refs #5669, #5665

Details on BibSonomy

BibSonomy is a tool for maintaining references. PUMA is the instance of the University of Stuttgart. For more information, check the related work of CloudRef.

Example usage of BibSonomy:

It was tried at #2157, but the UI technology of JabRef changed. Thus, we stopped working on it.

[stevensdavid]

I could work on this. Do you have any pointers regarding specifics in the implementation?

[calixtus]

Hi, @stevensdavid, welcome to JabRef development. If you are new to JabRef development, we would like you to have a look at the high level development documentation (https://devdocs.jabref.org/).
A good starting point for this issue is certainly #2157. About the gui stuff you can take a look at how @davidemdot implementet the texparser as a dialog and as a tab in the entry browser.

[koppor]

@stevensdavid Are you going to focus on ShortScience or BibSonomy? Regarding BibSonomy, I updated the description above. Proposal for BibSnomoy is:

1. Install an old JabRef version with the BibSonomy plugin.
2. Use JabRef with BibSonomoy and write down the requirements (maybe directly a user documentation at https://github.com/JabRef/user-documentation?)
3. Make UI mockups for the new functionality. Reason: In the old functionality, there was always a popup nagging that test-credentials for BibSonomy are used. This was annoying and I removed the popup at [WIP] Integrate BibSonomy Plugin #2157, but it was not quite finished. Proposal is to restrict the number of interactions with the test key and then guide the user to the preferences to set a BibSonomy key.
4. Discuss the UI mockups with the dev team
5. Cherry-pick the first commit at [WIP] Integrate BibSonomy Plugin #2157 (This is important to attribute the original authors)
6. Implement functionality in JavaFX

Update I narrowed-down this task to BibSonomy. The ShortScience-task is #6015.

[stevensdavid]

@koppor I'm part of a group of 5 MSc students who are working on this as a short project as part of a course. Sadly, our deadline is this Friday so I'm not sure if we'll have enough time to implement thorough support for Bibsonomy. We'll probably still implement some form of mockup though!

I'll ask some questions regarding ShortScience in #6015 - thank you for the details!

[felixlut]

@koppor I'm one of the students mentioned above! We have created some initial mockups for how the new GUI could look, which can be found here. If there is a better place to add these, please let me know!

[koppor]

@felixlut Thank you for the action taken. The place looks right. Please work on a user documentation (pull request on https://github.com/JabRef/user-documentation), too. Maybe as a walk-through using the feature. - Good work!

Comments:

1. Settings: Yes!
2. Full Text and Tag search: "Adding separate entries to the Web Search" is good. The other one is not integrated in JabRef.
3. Tag cloud. Not sure about the second drop down. Maybe, we need to keep it there, because the setting will be changed frequently. Future will tell ^^. You could add Telemetry to it. Maybe you find other code doing that.
4. Filter found entries: Reuse is great.
5. Export to BibSonomy and Deleting entries: Looks OK for a first implementation. Advanced implementatoin: A user has a bibsonomy account with references in there. He connects JabRef to it (already in scope). JabRef automatically fetches the entries and updates them in Bibsonomy. Similar to https://docs.jabref.org/collaborative-work/sqldatabase, but with BibSonomy as "backend".
6. Export to BibSonomy and Deleting entries: "Set read status". JabRef already has "special fields" (https://docs.jabref.org/fields/specialfields) for read status. Maybe, you can use that storage for that BibSonomy feature (maybe data mapping?).
7. Synchronize and Download documents: My comment on "Export to BibSonomy" also applies here: Similar to https://docs.jabref.org/collaborative-work/sqldatabase, but with BibSonomy as "backend"
8. Synchronize conflict resolution: Please look for the "Merge Entries Dialog". Refs Remove "Merge Entries" from Quality Menu #6021. https://docs.jabref.org/finding-sorting-and-cleaning-entries/mergeentries. You can just call it. Refs Show merge entries for modified entries #5688.
9. Proxy Settings: Yes
10. Test-Credentials: Yes. I would open the popup only at WRITE actions. Not at the first interations with BibSonomy. Otherwise, it is very disturbing. You know, the just hopping by and playing around thing. This should be easy and not disturbed by a dialog.

BibSonomy should change the user workflow as less as possible. -- Saying that, the Tag Cloud is prio 3. Prio 1 is the thing you described. Prio 2 is that the user can sync his database with BibSonomy.

[koppor]

Advanced feature: JabRef#324 - I think, this belongs to point 6 on my comment.

In case you have questions while implementing, please do not hesitate to show up on our gitter channel: https://gitter.im/JabRef/jabref

[koppor]

Some links from #152:

• Homepage: http://bitbucket.org/bibsonomy/bibsonomy-jabref-plugin/wiki/Home
• Issue in their bug tracker: http://bitbucket.org/bibsonomy/bibsonomy-jabref-plugin/issues/1912/integrate-code-in-jabref-master-branch

[koppor]

The BibSonomy REST API is available at https://bitbucket.org/bibsonomy/bibsonomy/src/master/bibsonomy-rest-client/