Skip to content
Browser extension for JabRef to allow importing of new items directly from the browser.
JavaScript CSS HTML Shell TSQL XSLT
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.dependabot Create config.yml Oct 20, 2019
.github Create FUNDING.yml Nov 8, 2019
Zotero Allow to resave the same webpage Nov 21, 2019
data Improve error message Nov 21, 2019
screenshots Add screenshot from Chrome Nov 10, 2019
zotero-connectors Allow to resave the same webpage Nov 21, 2019
.gitignore
.gitmodules Remove zotero submodule Nov 19, 2019
JabFox.sublime-project Rename files Feb 14, 2016
LICENSE License under AGPLv3 Mar 30, 2018
README.md Update readme with firefox json url (#103) Nov 26, 2019
background.js Improve logging Nov 20, 2019
bibtexConverter.js Rename to JabRef Browser Extension Nov 7, 2019
connector.js Improve error message Nov 21, 2019
gulpfile.js Convert gulp processing to git patch Nov 20, 2019
install_linux.sh Chromium install script (#86) Nov 7, 2019
manifest.json Finish rename Nov 7, 2019
package-lock.json Bump bluebird from 3.7.1 to 3.7.2 Dec 2, 2019
package.json Bump bluebird from 3.7.1 to 3.7.2 Dec 2, 2019
web-ext-config.js Chromium install script (#86) Nov 7, 2019

README.md

JabRef Browser Extension

Browser extension for users of the bibliographic reference manager JabRef. It automatically identifies and extracts bibliographic information on websites and sends them to JabRef with one click.

When you find an interesting article through Google Scholar, the arXiv or journal websites, this browser extension allows you to add those references to JabRef. Even links to accompanying PDFs are sent to JabRef, where those documents can easily be downloaded, renamed and placed in the correct folder. A wide range of publisher sites, library catalogs and databases are supported.

Please post any issues or suggestions here on GitHub.

Installation and Configuration

Windows

  1. Make sure you have at least JabRef 4.2 installed.
  2. Install the JabRef browser extension. Firefox.
  3. On Windows 7, please upgrade Powershell.
Manual installation on Windows (only necessary when you don't use the installer to install/update JabRef)
  1. Download the following files and copy them to the same directory as JabRef.exe

  2. Make sure that the correct file name of the JabRef .jar file is specified in JabRef.ps1 under $jabRefJarFileName.

  3. Run the following command from the console (with the correct path to the jabref.json file):

    For Firefox support:

    REG ADD "HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\NativeMessagingHosts\org.jabref.jabref" /ve /d "C:\path\to\jabref.json" /f
    

    For Chrome/Opera support

    REG ADD "HKEY_LOCAL_MACHINE\SOFTWARE\Google\Chrome\NativeMessagingHosts\org.jabref.jabref" /ve /d "C:\path\to\jabref.json" /f
    

    You may need to change the root HKEY_LOCAL_MACHINE to HKEY_CURRENT_USER if you don't have admin rights.

Linux

  1. Download and install the Debian package of the current development version of JabRef 5.0.
  2. Install the JabRef browser extension: Firefox.
Manual installation on Linux (only necessary when you don't use the `deb` file to install/update JabRef)
  1. Download org.jabref.jabref.json and put it into
    • /usr/lib/mozilla/native-messaging-hosts/org.jabref.jabref.json to install with admin rights for all users
    • ~/.mozilla/native-messaging-hosts/org.jabref.jabref.json to install without admin rights for the current user

Mac OS

  1. Download and install the DMG package of the current development version of JabRef 5.0.
  2. Install the JabRef browser extension: Firefox
  3. Download org.jabref.jabref.json and put it into
    • /Library/Application Support/Mozilla/NativeMessagingHosts/org.jabref.jabref.json to install with admin rights for all users
    • ~/Library/Application Support/Mozilla/NativeMessagingHosts/org.jabref.jabref.json to install without admin rights for the current user

Usage

After the installation, you should be able to import bibliographic references into JabRef directly from your browser. Just visit a publisher site or some other website containing bibliographic information (for example, the arXiv) and click the JabRef symbol in the Firefox search bar (or press Alt+Shift+J). Once the JabRef browser extension has extracted the references and downloaded the associated PDF's, the import window of JabRef opens.

You might want to configure JabRef so that new entries are always imported in an already opened instance of JabRef. For this, activate "Remote operation" under the Advanced tab in the JabRef Preferences.

About this Add-On

Internally, this browser extension uses the magic of Zotero's site translators. Thus most of the credit has to go to the Zotero development team and to the many authors of the site translators collection. Note that this browser extension does not make any changes to the Zotero database and thus both plug-ins coexist happily with each other.

Contributing to the Development

JabRef browser extension uses the WebExtensions API.

Preparation:

  1. Install Node.js (e.g., choco install nodejs)
  2. Install gulp and web-ext: npm install --global gulp-cli web-ext
  3. Fork the repository.
  4. Start browser with the add-on activated: Firefox: npm run dev:firefox Chrome: npm run dev:opera

Now just follow the typical steps to contribute code:

  1. Create your feature branch: git checkout -b my-new-feature
  2. Build and run the add-on as described above.
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

To update dependencies:

  • npm outdated gives an overview of outdated packages (doc)

  • npm-upgrade updates all packages

  • npm install install updated packages

  •  git subtree pull --prefix zotero-connectors https://github.com/zotero/zotero-connectors.git master --squash
     git subtree pull --prefix zotero-connectors/src/zotero https://github.com/zotero/zotero.git master --squash
    

    updates zotero-connectors submodule

  • gulp update-zotero-scripts copies and post-processes Zotero scripts from zotero-connectors to Zotero folder

You can’t perform that action at this time.