Graphical Java application for managing BibTeX and BibLaTeX (.bib) databases
Java TeX Python Perl Shell XSLT
Latest commit 9e48a5f Jan 15, 2017 @bartsch-dev bartsch-dev committed with tobiasdiez Save deletion of current searchquery (#2469)
* save deletion of current searchquery

* fix issues
Permalink
Failed to load latest commit information.
.github simplify update output and fix printing of special characters Sep 28, 2016
buildres Installer Code Signing #1879 (#2320) Dec 2, 2016
config Add intellij code style (#2337) Dec 10, 2016
gradle/wrapper Update gradle from 3.2.1 to 3.3 Jan 5, 2017
lib Switch to LGoodDatePicker (#2340) Dec 5, 2016
licenses Support newlines when using a CitationStyle (#2165) Oct 16, 2016
scripts Fix typo Dec 17, 2016
src Save deletion of current searchquery (#2469) Jan 15, 2017
.editorconfig Add trim_trailing_whitespace to .editorconfig Dec 13, 2016
.gitattributes Fix typo Jan 5, 2017
.gitignore Use https://www.gitignore.io/ for .gitignore Dec 13, 2016
.mailmap Update AUTHORS Dec 16, 2016
.travis.yml Enable modernizer test Dec 14, 2016
AUTHORS Result of generate-authors.sh Dec 24, 2016
CHANGELOG.md Save deletion of current searchquery (#2469) Jan 15, 2017
CONTRIBUTING.md Add key format of #2275 as requirement to CONTRIBUTING.md Nov 22, 2016
DEVELOPERS Fix authors UTF8 display (#1954) Sep 11, 2016
LICENSE.md Announce switch from GPL to MIT in CONTRIBUTING.md and README.md Aug 8, 2016
README.md Show development information Dec 24, 2016
build.gradle Update dev dependencies (mockito, wiremock, assertj) Jan 15, 2017
circle.yml Installer Code Signing #1879 (#2320) Dec 2, 2016
codecov.yml Update codecov.yml to disable PR comments May 11, 2016
eclipse.gradle Class variable declarations and method declarations are now separated… Dec 2, 2016
external-libraries.txt Fix typo and add ref to debian's license text Dec 16, 2016
gradlew Update gradle from 3.2.1 to 3.3 Jan 5, 2017
gradlew.bat Update gradle from 3.0 to 3.1 Oct 11, 2016
jabref.install4j Revert "Remove JVM arguments" Dec 22, 2016
localization.gradle Fix localization task hints (#2031) Sep 25, 2016
settings.gradle Javadoc for the whole project can be built using gradle Mar 17, 2014
xjc.gradle [WIP] Rewrite mods exporter and add test (#2088) Sep 28, 2016

README.md

JabRef Development Version

Build Status Dependency Status codecov.io Donation Issue Stats Issue Stats

This version is a development version. Features may not work as expected.

Development builds are available at builds.jabref.org whereas the latest release is available via GitHub.

Explanation of donation possibilities and usage of donations is available at our donations page.

We use install4j, the multi-platform installer builder.

Background

JabRef is a graphical Java application for editing BibTeX and Biblatex .bib databases. JabRef lets you organize your entries into overlapping logical groups, and with a single click limit your view to a single group or an intersection or union of several groups. You can customize the entry information shown in the main window, and sort by any of the standard BibTeX fields. JabRef can autogenerate BibTeX keys for your entries. JabRef also lets you easily link to PDF or web sources for your reference entries.

JabRef can import from and export to several formats, and you can customize export filters. JabRef can be run as a command line application to convert from any import format to any export format.

Bug Reports, Suggestions, Other Feedback

We are thankful for any bug reports or other feedback.

If there are features you want included in JabRef, tell us in our forum!

If you have questions regarding the usage, or you want to give general feedback the forum is also the right place for this: discourse.jabref.org

You can use our GitHub issue tracker to send in bug reports and suggestions.

To get your code added to JabRef, just fork JabRef and create a pull request. For details see CONTRIBUTING.

Installing and Running

Requirements

JabRef runs on any system equipped with the Java Virtual Machine (1.8 or newer), which can be downloaded at no cost from Oracle.

Installing and Running, Mac OS X:

Please see our Mac OS X FAQ.

Installing and Running, Windows:

JabRef offers an installer, which also adds a shortcut to JabRef to your start menu.

Please also see our Windows FAQ

Installing and Running, General:

JabRef can be downloaded as an executable .jar file. Try to double click the jar file or execute the following command: java -jar <path to jar>

Documentation

JabRef comes with an online help, accessed by pressing F1 or clicking on a question mark icon. The help is are probably not exhaustive enough to satisfy everyone yet, but it should help sort out the most important issues about using the program. If you choose languages other than English, some or all help pages may appear in your chosen languages.

Building JabRef From Source

If you want a step-by-step tutorial, please check this guideline

To compile JabRef from source, you need a Java compiler supporting Java 1.8 and JAVA_HOME pointing to this JDK. You have to set GRADLE_OPTS to -Dfile.encoding=UTF-8 as gradle uses the JVM's platform encoding.

To run it, just execute gradlew run. When you want to develop, it is necessary to generate additional sources using gradlew generateSource and then generate the Eclipse gradlew eclipse. For IntelliJ IDEA, just import the project via a Gradle Import by pointing at the build.gradle.

Testing

gradlew test executes the normal unit tests. If you want to test the UI, execute gradlew integrationTest. Sources for the integration test are kept in src/integrationTest.

Release Process

Building a release requires install4j. We've got an Open Source License. Releasing is done using CircleCI. A full release howto is available in our wiki.

License

Since version 3.6, JabRef is licensed under the MIT license. See the LICENSE.md for the full MIT license.

JabRef also uses libraries distributed by other parties. See external libraries for details.