Skip to content

GSOC 2021 Microsoft Word Integration

Jump to bottom
Mohit edited this page Aug 23, 2021 · 11 revisions
Student Mohit
Organization JabRef
Primary repository JabRef Word Addin
Project name Microsoft Word Integration
Project mentors Tobias Diez, Christoph, Jonatan Asketrop
Project page Google Summer of Code 2021 Project Page
Status Complete

Project summary

The primary goal of this project was to create an office addin that would allow JabRef users to insert citations, change citation style, and generate a bibliography without leaving the word document.

My work during the GSoC period

  • Initialized and configured Office Addin project for adhering to best practices (GraphQL, and ESLint/Prettier)
  • Features implemented during the GSoC period
    • Insert citation
    • Edit citation
    • Change citation style
    • Create Bibliography
    • Data synchronization

Insert citation in the document

  • To insert a citation in the document, place the cursor at the location where you want the citation to appear.
  • From the list of references under the Library tab, select the reference you want to use.
  • As you select the references, the insert citation button will pop up.
  • Click on the insert citation button to insert the citation.

insert citation

Edit citation

  • To edit a citation, click on the citation you want to edit in the document.
  • When you click on a citation, all of the references in that citation will be selected in the library tab.
  • Make changes that you want. As you make changes, the save Change button will pop up.
  • Click on the save changes button to update the citation.

Edit citation

Change citation style

  • To change the citation style, select the citation style tab.
  • Click on the style you want to use.
  • When you change the citation style, all of the citations and bibliography in the document will be updated accordingly.

change citation style

Create bibliography

  • To create bibliographies from all the references in the document, click on the add bib button in the bottom bar

create bibliography

Data synchronization

  • JabRef addin always keeps your citations and bibliography data in sync with your jabref library. For example, you made some changes in the JabRef desktop app, then whenever you initialize addin in a document, all citations and bibliography in that document are synced with your jabref library.

What's left to do or can be done?

  • JabRef addin currently only supports some of the most common citations. It would be really nice if it supports all of the citation styles.
  • A message interface to show error/success/info messages to the users.

Commits

All of the commits I’ve sent during the GSoC period can be found at: https://github.com/JabRef/JabRef-Word-Addin/commits?author=mohit038

Out of the project

121 Implemented forgot password in jabrefonline

120 Added Redis to store session Id

7523 Fixed click behavior

7547 UI improvements

7550 UI improvements

Conclusion

Overall, working on this project was really fun! I’m pretty happy with the outcome and hoping that the community and the users of JabRef will like it.

I’m really thankful to Google and JabRef for providing me with such a great opportunity which helped me grow quite a bit!. And most importantly, greatly thankful to Tobias Diez, Christoph, and Jonatan Asketrop, who were my mentors throughout the GSoC period. You were the greatest mentors I could’ve asked for!

Since working with the JabRef was great, and now that I’m kind of warmed up working on JabRef addin, my plan is to keep hacking on JabRef addin.

Statistics

Total commits 15
Lines added 53900
Lines removed 39000

Blog posts

Project blogpost

Clone this wiki locally