View on GitHub

JabRef FAQs

This page lists FAQs about JabRef. Other sources for support are listed at http://www.jabref.org/#help

View on GitHub

General

Q: My plugins stopped working. What should I do?

A: JabRef v3.0 removed plugin support, because the development team cannot keep up plugin support any more. Nevertheless, plugins can be integrated in JabRef. See issue #152 for the current status and discussion. Please contact the author of the respective plugin and ask him to port his plugin into JabRef’s code.

Q: I am using JabRef in my work. Should I cite JabRef in my publications?

A: You are not obliged to cite JabRef, but we would greatly appreciate it if you do.

@Manual{JabRef_software,
  title = {JabRef},
  author = {{JabRef Development Team}},
  year = {2016},
  url = {http://www.jabref.org}
}

Q: Are there any publications dealing with JabRef?

A: We are collecting all publications we hear about at https://github.com/JabRef/jabref/wiki/JabRef-in-the-media.

Q: JabRef does not start. What should I do?

A: This may be because the preferences need to be reset. Execute java -jar JabRef-X.Y.jar --prdef all -n (with X.Y the version of JabRef). On Windows, if that does not help, execute regedit and delete the folder HKEY\_CURRENT\_USER\SOFTWARE\JavaSoft\Prefs\net\sf\jabref.

Q: Does JabRef support Chinese characters?

A: Yes. Go to Options->Preferences->General->Default Encoding. Set it to UTF8. At “Appearance” set table font as simsun (or any other Chinese font). At “General”, you can change the UI language to Chinese. More information are available at http://yenlung.km.nccu.edu.tw/xms/read_attach.php?id=61 (alternative: https://web.archive.org/web/20111027034912/http://yenlung.math.nccu.edu.tw/~yenlung/notes/latex_in_Windows.pdf).

Q: When I have an instance of Jabref running and double click another BibTeX file it is opened in a new JabRef instance. Is it possible to open it in a new tab in the first instance?

A: Yes. Go to Options -> Preferences -> Advanced -> “Remote operation”. Put a checkmark to “Listen for remote operation on port:”. This option allows new instances of JabRef to detect the instance already running, and pass files to that instead of opening a new window.

Q: BibTeX converts uppercase characters to lowercase in my title field. I know this can be prevented by wrapping uppercase letters in braces, e.g. {T}he life cycle of {A}tlantic salmon, but this is too much work. Can JabRef help?

A: JabRef has a setting that will automatically wrap all capital letters for certain fields in { } - this will make sure they are preserved in the LaTeX output. Under Options -> Preferences -> File -> “Store the following fields with braces around capital letters”, make sure the title field is included. To do this for several fields, write e.g. title;abstract. This setting automatically adds braces when saving the bib file, but you won’t see the braces within JabRef.

Q: I have a DOI. Is it possible to create an entry directly out of the DOI?

A: Yes. Go to Search and click on “Web Search” to enable the Web search. A Web search box appears on the left side of JabRef. The name of a web search is selected (e.g. “ACM Portal”). Click on it and change it to “DOI to BibTeX”. Enter the DOI in the field and press “Fetch”. A search starts and the result is displayed in a new pop up window. One entry should appear. Just push “OK” to insert the entry into the database.

Q: I have an ISBN. Is it possible to create an entry directly out of the ISBN?

A: Yes. Go to Search and click on “Web Search” to enable the Web search. A Web search box appears on the left side of JabRef. The name of a web search is selected (e.g. “ACM Portal”). Click on it and change it to “ISBN to BibTeX”. If a ISBN is not found, head to the online service by Manas Tungare.

Q: I miss a field translator, lastfollowedon, … How can I add such fields?

A: To add this “translator“ to all entry types, you can use Options->Set up general fields and add a “translator” field under one of JabRef’s general field tabs. To add this “translator” to a specific entry type, edit the specific entry type(s) (Options->Customize entry types) and add a “translator“ field under required fields or optional fields, as you like.

Q: How do I prevent JabRef from introducing line breaks in certain fields (such as “title”) when saving the .bib file?

A: Open Options -> Preferences. In the “File” panel, you will find an option called “Do not wrap the following fields when saving”. This option contains a semicolon-separated list of field names. Any field you add to this list will always be stored without introduction of line breaks.

Q: I have a JabRef open. If I open a bibtex file from my web browser, a new JabRef is started. I want the file to be opened in the currently opened JabRef. Is this possible?

A: Yes. Go to Options -> Preferences -> Advanced -> “Remote operation”. Put a checkmark to “Listen for remote operation on port:”. This option allows new instances of JabRef to detect the instance already running, and pass files to that instead of opening a new window. Note: This is the default since JabRef 3.0.

Q: Is it possible to append entries from a BibTeX file, e.g. from my web browser, to the currently opened database?

A: Yes, you can use the parameter --importToOpen bibfile.

A: Yes. You need to override the default file directory for this specific database. Go to File -> Database properties. You can override the Default file directory setting. There, you can either enter the path in General file directory (for it to be valid for all users of the file) or in User-specific file directory (for it to be valid for you only). If you simply enter “.” (a dot, without the quotes), the file directory will be the same as the .bib file directory. To place your files in a subdirectory called subdir, you can enter “./subdir” (without the quotes). Files will automatically be linked with relative paths if the files are placed in the default file directory or in a directory below it.

Q: I want to export my bibliography entries into a simple text file so that I can import them into a spreadsheet easily. Is this possible?

A: Yes. Use File -> Export. Under “Filter:”, choose “OpenOffice/LibreOffice CSV (*.csv)”.

Q: How can I add and remove keywords of multiple entries?

A: Select the entries. Right click. Choose “Manage keywords”. Then you can manage keywords appearing in all selected entries or in any selected entry. New keywords are added to all selected entries.

Q: I want to have a bib-file-specific PDF directory.

A: Right click on the tab of the .bib file. Choose “Database properties”. Then at the field “General file directory” choose the directory specific for the database. If you want to set a directory for you only (so that other users should use the default directory), use the field “User-specific file directory”.

Q: When linking a file, I cannot set the correct type. How can I add new types?

A: Go to Options -> Manage external file types. Here you can add arbitrary types.

Q: Is there a portable version of JabRef?

A: Store the file jabref.jar on the drive. It can be opened directly on any computer offering a Java installation by double clicking the jar file. In Options->Preferences->General, be sure to activate “Load and Save preferences from/to jabref.xml on start-up (memory stick mode)”.

Q: When an organization is provided as author, my BibTeX style doesn’t recognize it. For instance, “European Commission” is converted to “Commission, E.”.

A: Use braces to tell BibTeX to keep your author field as is: {European Commission}. In BibLaTeX, you can use label = {EC} to have EC05 as label for a publication of the European Commission in the year 2005.

Q: Is there a FAQ on BibTeX?

A: Yes, please look at “Bibliographies and citations” at the UK List of TeX Frequently Asked Questions on the Web. For German readers, there is the dante e.V. FAQ.

Q: Where is the RenameFile plugin? How to rename file automatically after importing entries?

A: JabRef does not support plugin anymore (version > 2.11). However the plugin features are progressively integrated. Renaming of files is now part of the “Cleanup Entries” feature (brush button in the toolbar or CTRL+SHIFT+F7). Then, you can rename attached files based on the BibTeX key. You can change the format (pattern) under Options -> Preferences -> Import, by altering the pattern under “Default PDF file link action”.

Q: I have a JabRef database and I would like to export a subset to BibTeX (or BibLaTeX) format. How to do this?

A: Your JabRef database is already a file in BibTeX (or BibLaTeX) format. Simply select the entries to be exported, and then choose File->Save Selected as…. More details on stackexchange.com.

Q: I have a JabRef database and I would like to export the subset corresponding to my LaTeX file. How to do this?

A: Upon compilation, LaTeX generates a file with the extension “.aux”. This files contains the keys of the cited references (among other things). Using this AUX file, JabRef can extract the relevant entries. Choose the menu Tools->New subdatabase based on AUX file. Then select the reference database (among the opened ones), and specify the AUX file.

View on GitHub

Sharing

Q: How does JabRef support me in sharing my libraries?

A: JabRef automatically recognizes a change in the bib file on disk and notifies the user of it. This is cool for network drives. If you use version control, we recommend to right click on the tab of the database, click on “database properties”, and define a sort order on the file. We recommend, year, author, title. In addition, we have many open issues dealing with collaboration.

View on GitHub

JabRef and Linux

Q: JabRef does not start under Linux! What can I do?

A: JabRef works fine under Linux if you use a Java Runtime Environment (JRE) from Oracle version 1.8 and newer (Downloadable here). If running JabRef fails to start nevertheless do the following for troubleshooting:

Run

java -version

from the command line. If this does not report to be a product from Oracle (for instance tells you that it is a GCJ VM) even if you have installed the Oracle JVM then you need to change your setup. This is highly dependent on your distribution, so we cannot give exact advise for everybody.

Under Debian/Ubuntu it works like this (you need to have admin privileges):

sudo update-alternatives --config java

In the dialog that appears select the Oracle JDK or JRE. Alternatively you can also search for the java executable and run that directly. For example, in Ubuntu 12.04 LTS you can find Java at

/usr/lib/jvm/java-6-openjdk/jre/bin/java

If you do not have root-access on the machine, you can install the Oracle JRE in your home directory but need to make sure that you run the correct java executable. For instance, if you installed the JRE into a folder called

java

in your home try

~/java/jre/bin/java -jar JabRef-X.jar

where ‘X’ is the JabRef version.

Q: I am on Debian/Ubuntu and clicking on the JabRef icon works, but I cannot start JabRef from the command line.

What is wrong?

A: You have several Java Virtual Machines installed, and under the command line the wrong one is chosen. Have a look at the previous question that tells you how to change the virtual machine used.

For Ubuntu you may also have a look at the Ubuntu page on Java.

Q: Does JabRef run under free Java (Classpath, Kaffee, GCJ, etc.)?

A: As far as we know, JabRef is not yet running on these free JVMs, due of our dependencies. However, JabRef is reported to run nicely on the IcedTea runtime, which is based on the OpenJDK built with GNU Classpath to fill in missing classes. Some issues have been encountered with the LookAndFell (see Issue #393). Please let us know if newer versions give different results. If you have an idea or the expertise to make JabRef work under Classpath, let us know.

View on GitHub

JabRef and Mac OS X

Q: After downloading and unzipping, OS X shows “the package was damaged and moved to trash”

A: On Mac OS X Lion, it is possible to resolve it by temporarily changing the Gate Keeper security settings under “Security&Privacy” in the system preferences to “Anywhere”. After that you can open the JabRef app. When you have opened it once, you can change the security settings back and you’ll still be able to open the app.

Q: There is no explicit Mac OS X application for JabRef 2.11

A: We were not able to generate a working version of JabRef 2.11 for Mac OS X. Please use the jar of version 2.11, or look at the newer 3.X versions (which fully supports Mac OS X again).

Q: Is it possible to upgrade directly from JabRef 2.x to JabRef 3.x?

A: Due to the change of the installer for 3.x it is required to perform a clean install of any JabRef 3.x version. You are required to remove any previously installed JabRef 2.x application from the “Applications” folder. Then you can install the latest JabRef 3.x version with the installer. As soon you are running on any JabRef 3.x version, you can use the installer to upgrade JabRef.

View on GitHub

JabRef and Windows

Q: How can I use JabRef as backend for Microsoft Word?

A: You can directly use the references in Word’s internal reference manager. Short explanation: Export your bibliography in XML format and replace the Sources.xml in %APPDATA%\Roaming\Microsoft\Bibliography. Long explanation: see Using JabRef references in Word document.

Another option is to use BibteX4Word.

The last option is to use Docear4Word, which is planned to be ported to JabRef (see JabRef4Word).

Q: How can I start or focus JabRef with hotkey Windows+J?

A: Use AutoHotkey and JabRef.ahk provided at koppor’s autohotkey scripts.

View on GitHub

Contributing

Q: I am a programmer. How can I join the JabRef project?

A: We follow the usual GitHub pull request approach. We have a lot of open issues. If you want to be sure to work on something the core developers currently do not handle, check the issues tagged with asking-for-a-pull-request. See our CONTRIBUTING.md for detailed information and further links.

Q: I would like to help translating JabRef to another language. How do I get started?

A: We encourage you to read Translating JabRef.

Q: Can I make a donation? How?

A: Donations keeps us going! You can use Paypal, Flattr or bank transfers. Your institution/company can contribute too, through bank transfer for example. All details are given here.

View on GitHub

Other

Q: My question is not answered here. What can I do?

A: After consulting JabRef’s help and checking whether your question has been regarded as issue, please head over to the mailinglist or to StackExchange.

A: Either click on View on GitHub or fork the www.jabref.org repository, do your changes and create a pull request. Remember not to use your master branch, but name your branch differently.