Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into allowReordering
Browse files Browse the repository at this point in the history
* upstream/master: (110 commits)
  Fix DOI import in RIS Importer
  Rename bibtexkey (#6545)
  check if fields are empty
  fix comment checkstyle arght
  Fix XMP Exctrator not returning empty optional
  Fix Group hit counter calculation preferences (#6554)
  add changelog entry
  Make test concise
  Add test for getXmpMetadata with no description
  guidelines updated
  lint and hint for JEE
  Update eclipse setting
  Bump checkstyle from 8.32 to 8.33
  Bump classgraph from 4.8.78 to 4.8.80
  Add more menu items to library context menu (#6551)
  Squashed 'src/main/resources/csl-styles/' changes from 586e0b8..c5f14e2
  Correct return description in javadoc
  iterate to get all selected leaf nodes
  check if metadata has start and end tag
  Update RisImporterTest.java
  ...
  • Loading branch information
Siedlerchr committed Jun 6, 2020
2 parents 28aaa0c + 5676d65 commit 815050f
Show file tree
Hide file tree
Showing 221 changed files with 13,091 additions and 4,362 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ jobs:
key: ${{ runner.os }}-gradle-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
- name: Run checkstyle
run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh
- name: Run markdown-lint
uses: avto-dev/markdown-lint@v1
with:
args: CHANGELOG.md README.md docs/
config: '.markdownlint.yml'
tests:
name: Unit tests
runs-on: ubuntu-latest
Expand Down
2 changes: 2 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,5 @@ Gennadiy Stakhovskiy <GennadiyStakhovskiy@gmail.com>
Mootez Saad <34676841+MootezSaaD@users.noreply.github.com>
Mootez Saad <34676841+MootezSaaD@users.noreply.github.com> <mootez.saad@medtech.tn>
Chen Yuheng <pass@chenyuheng.cn>
Dominik Voigt <43381984+DominikVoigt@users.noreply.github.com>
Carl Christian Snethlage <50491877+calixtus@users.noreply.github.com> <cc.snethlage@gmail.com>
18 changes: 18 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
default: true

# Using h2 has side effects in GitBook's toc. Thus, we sometimes switch from h1 to h3
MD001: false

MD012:
# 2 are required, because GitBook adss two blank lines at the end of a file
maximum: 2

MD013: false

# The FAQs state questions - we allow them
MD026:
punctuation: ".,;:!"

MD033:
# we have <a> tags with ids
allowed_elements: ['a']
4 changes: 4 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Andreas Buhr
Andreas Rudert
Andrew Collins
Andrew Levit
André Schlichting
Andrés Sánchez
Anh Nghia Tran
Anita Armbruster
Expand All @@ -40,6 +41,7 @@ August Janse
Ayachi Nene
Bartosz J. Kaczkowski
Bartłomiej Dach
Baruch Oltman
Behrouz Javanmardi
Benedikt Tutzer
Benjamin Köhler
Expand Down Expand Up @@ -96,6 +98,7 @@ Dimitra Karadima
Domenico Cufalo
Dominik Schrempf
Dominik Traczyk
Dominik Voigt
Dominik Waßenhoven
Douglas Nassif Roma Junior
Eduard Braun
Expand Down Expand Up @@ -260,6 +263,7 @@ Nick S. Weatherley
Nico Schlömer
Nicolas Pavillon
Nikita Borovikov
Niklas Schmitt
nikmilpv
NikodemKch
Niv Ierushalmi
Expand Down
19 changes: 17 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve

### Added

- We added support for importing ris file and load DOI [#6530](https://github.com/JabRef/jabref/issues/6530)
- We added the Library properties to a context menu on the library tabs [#6485](https://github.com/JabRef/jabref/issues/6485)
- We added a new field in the preferences in 'BibTeX key generator' for unwanted characters that can be user-specified. [#6295](https://github.com/JabRef/jabref/issues/6295)
- We added support for searching ShortScience for an entry through the user's browser. [#6018](https://github.com/JabRef/jabref/pull/6018)
- We updated EditionChecker to permit edition to start with a number. [#6144](https://github.com/JabRef/jabref/issues/6144)
Expand All @@ -24,6 +26,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed the bug when strike the delete key in the text field. [#6421](https://github.com/JabRef/jabref/issues/6421)
- We added a BibTex key modifier for truncating strings. [#3915](https://github.com/JabRef/jabref/issues/3915)
- We added support for jumping to target entry when typing letter/digit after sorting a column in maintable [#6146](https://github.com/JabRef/jabref/issues/6146)
- We added a new fetcher to enable users to search all available E-Libraries simultaneously. [koppor#369](https://github.com/koppor/jabref/issues/369)
- We added the field "entrytype" to the export sort criteria [#6531](https://github.com/JabRef/jabref/pull/6531)

### Changed

Expand All @@ -37,9 +41,12 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We improved the error message for invalid jstyles. [#6303](https://github.com/JabRef/jabref/issues/6303)
- We changed the section name of 'Advanced' to 'Network' in the preferences and removed some obsolete options.[#6489](https://github.com/JabRef/jabref/pull/6489)
- We improved the context menu of the column "Linked identifiers" of the main table, by truncating their texts, if they are too long. [#6499](https://github.com/JabRef/jabref/issues/6499)
- We merged the main table tabs in the preferences dialog. [#6518](https://github.com/JabRef/jabref/pull/6518)
- We changed the command line option 'generateBibtexKeys' to the more generic term 'generateCitationKeys' while the short option remains 'g'.[#6545](https://github.com/JabRef/jabref/pull/6545)

### Fixed

- We fixed to only search file links in the BIB file location directory when preferences has corresponding checkbox checked. [#5891](https://github.com/JabRef/jabref/issues/5891)
- We fixed wrong button order (Apply and Cancel) in ManageProtectedTermsDialog.
- We fixed an issue with incompatible characters at BibTeX key [#6257](https://github.com/JabRef/jabref/issues/6257)
- We fixed an issue where dash (`-`) was reported as illegal BibTeX key [#6295](https://github.com/JabRef/jabref/issues/6295)
Expand All @@ -63,14 +70,20 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed an issue where JabRef switched to discrete graphics under macOS [#5935](https://github.com/JabRef/jabref/issues/5935)
- We fixed an issue where the Preferences entry preview will be unexpected modified leads to Value too long exception [#6198](https://github.com/JabRef/jabref/issues/6198)
- We fixed an issue where custom jstyles for Open/LibreOffice would only be valid if a layout line for the entry type `default` was at the end of the layout section [#6303](https://github.com/JabRef/jabref/issues/6303)
- We fixed an issue where a new entry is not shown in the library if a search is active [#6297](https://github.com/JabRef/jabref/issues/6297)
- We fixed an issue where long directory names created from patterns could create an exception. [#3915](https://github.com/JabRef/jabref/issues/3915)
- We fixed an issue where sort on numeric cases was broken. [#6349](https://github.com/JabRef/jabref/issues/6349)
- We fixed an issue where year and month fields were not cleared when converting to biblatex [#6224](https://github.com/JabRef/jabref/issues/6224)
- We fixed an issue where an "Not on FX thread" exception occured when saving on linux [#6453](https://github.com/JabRef/jabref/issues/6453)
- We fixed an issue where the library sort order was lost. [#6091](https://github.com/JabRef/jabref/issues/6091)
- We fixed an issue where brackets in regular expressions were not working. [6469](https://github.com/JabRef/jabref/pull/6469)
- We fixed an issue where multiple background task popups stacked over each other.. [#6472](https://github.com/JabRef/jabref/issues/6472)
- We fixed an issue where LaTeX citations for specific commands (\autocites) of biblatex-mla were not recognized. [#6476](https://github.com/JabRef/jabref/issues/6476)
- We fixed an issue where drag and drop was not working on empty database. [#6487](https://github.com/JabRef/jabref/issues/6487)
- We fixed an issue where the name fields were not updated after the preferences changed. [#6515](https://github.com/JabRef/jabref/issues/6515)
- We fixed an issue where "null" appeared in generated BibTeX keys. [#6459](https://github.com/JabRef/jabref/issues/6459)
- We fixed an issue where the authors' names were incorrectly displayed in the authors' column when they were bracketed. [#6465](https://github.com/JabRef/jabref/issues/6465) [#6459](https://github.com/JabRef/jabref/issues/6459)
- We fixed an issue where importing certain unlinked files would result in an exception [#5815](https://github.com/JabRef/jabref/issues/5815)

### Removed

Expand Down Expand Up @@ -127,6 +140,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed an issue where the blue and red text colors in the Merge entries dialog were not quite visible [#6334](https://github.com/JabRef/jabref/issues/6334)
- We fixed an issue where underscore character was removed from the file name in the Recent Libraries list in File menu [#6383](https://github.com/JabRef/jabref/issues/6383)
- We fixed an issue where few keyboard shortcuts regarding new entries were missing [#6403](https://github.com/JabRef/jabref/issues/6403)

### Removed

- Ampersands are no longer escaped by default in the `bib` file. If you want to keep the current behaviour, you can use the new "Escape Ampersands" formatter as a save action. [#5869](https://github.com/JabRef/jabref/issues/5869)
Expand Down Expand Up @@ -302,8 +316,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed an issue where some journal names were wrongly marked as abbreviated. [#4115](https://github.com/JabRef/jabref/issues/4115)
- We fixed an issue where the custom file column were sorted incorrectly. [#3119](https://github.com/JabRef/jabref/issues/3119)
- We improved the parsing of author names whose infix is abbreviated without a dot. [#4864](https://github.com/JabRef/jabref/issues/4864)
- We fixed an issues where the entry losses focus when a field is edited and at the same time used for sorting. https://github.com/JabRef/jabref/issues/3373
- We fixed an issue where the menu on Mac OS was not displayed in the usual Mac-specific way. https://github.com/JabRef/jabref/issues/3146
- We fixed an issues where the entry losses focus when a field is edited and at the same time used for sorting. [#3373](https://github.com/JabRef/jabref/issues/3373)
- We fixed an issue where the menu on Mac OS was not displayed in the usual Mac-specific way. [#3146](https://github.com/JabRef/jabref/issues/3146)
- We improved the integrity check for page numbers. [#4113](https://github.com/JabRef/jabref/issues/4113) and [feature request in the forum](http://discourse.jabref.org/t/pages-field-allow-use-of-en-dash/1199)
- We fixed an issue where the order of fields in customized entry types was not saved correctly. [#4033](http://github.com/JabRef/jabref/issues/4033)
- We fixed an issue where renaming a group did not change the group name in the interface. [#3189](https://github.com/JabRef/jabref/issues/3189)
Expand Down Expand Up @@ -340,6 +354,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed an issue where the "Attach file" dialog, in the right-click menu for an entry, started on the working directory instead of the user's main directory. [#4995](https://github.com/JabRef/jabref/issues/4995)
- We fixed an issue where the JabRef Icon in the macOS launchpad was not displayed correctly [#5003](https://github.com/JabRef/jabref/issues/5003)
- We fixed an issue where the "Search for unlinked local files" would throw an exception when parsing the content of a PDF-file with missing "series" information [#5128](https://github.com/JabRef/jabref/issues/5128)
- We fixed an issue where the XMP Importer would incorrectly return an empty default entry when importing pdfs [#6577](https://github.com/JabRef/jabref/issues/6577)

### Removed

Expand Down
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
JabRef is an open-source, cross-platform citation and reference management tool.

Stay on top of your literature: JabRef helps you to collect and organize sources, find the paper you need and discover the latest research.
![main table](https://www.jabref.org/img/jabref-5-0-maintable.png)
![main table](http://www.jabref.org/img/jabref-mainscreen.png)

## Features

JabRef is a cross-platform application that works on Windows, Linux and Mac OS X. It is available free of charge and is actively developed.
JabRef supports you in every step of your research work.
JabRef is available free of charge and is actively developed.
It supports you in every step of your research work.

### Collect

Expand All @@ -33,7 +33,7 @@ JabRef supports you in every step of your research work.

### Cite

- Native [BibTeX] and [Biblatex] support
- Native BibTeX and Biblatex support
- Cite-as-you-write functionality for external applications such as Emacs, Kile, LyX, Texmaker, TeXstudio, Vim and WinEdt.
- Format references in one of the many thousand built-in citation styles or create your style
- Support for Word and LibreOffice/OpenOffice for inserting and formatting citations
Expand All @@ -47,11 +47,9 @@ JabRef supports you in every step of your research work.
## Installation

Fresh development builds are available at [builds.jabref.org](https://builds.jabref.org/master/).
The [latest stable release is available at FossHub](https://www.fosshub.com/JabRef.html).
The [latest stable release is available at FossHub](https://downloads.jabref.org/).

- Windows: JabRef offers an installer, which also adds a shortcut to JabRef to your start menu. Please also see our [Windows FAQ](https://docs.jabref.org/faq/faqwindows)
- Linux: Please see our [Installation Guide](https://docs.jabref.org/general/installation).
- Mac OS X: Please see our [Mac OS X FAQ](https://docs.jabref.org/faq/faqosx).
Please see our [Installation Guide](https://docs.jabref.org/installation).

## Bug Reports, Suggestions, Other Feedback

Expand Down Expand Up @@ -98,8 +96,4 @@ For IntelliJ IDEA, just import the project via a Gradle Import by pointing at th

`gradlew test` executes all tests. We use [Github Actions](https://github.com/JabRef/jabref/actions) for executing the tests after each commit. For developing, it is sufficient to locally only run the associated test for the classes you changed. Github will report any other failure.

[BibTeX]: https://www.ctan.org/pkg/bibtex
[Biblatex]: https://www.ctan.org/pkg/biblatex
[install4j]: https://www.ej-technologies.com/products/install4j/overview.html
[JabRef]: https://www.jabref.org
[JavaFX]: https://en.wikipedia.org/wiki/JavaFX
14 changes: 7 additions & 7 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ dependencies {
implementation group: 'org.apache.tika', name: 'tika-core', version: '1.24.1'

// required for reading write-protected PDFs - see https://github.com/JabRef/jabref/pull/942#issuecomment-209252635
implementation 'org.bouncycastle:bcprov-jdk15on:1.65'
implementation 'org.bouncycastle:bcprov-jdk15on:1.65.01'

implementation 'commons-cli:commons-cli:1.4'

Expand Down Expand Up @@ -192,11 +192,11 @@ dependencies {
exclude module: "log4j-core"
}

implementation 'com.vladsch.flexmark:flexmark:0.61.30'
implementation 'com.vladsch.flexmark:flexmark-ext-gfm-strikethrough:0.61.30'
implementation 'com.vladsch.flexmark:flexmark-ext-gfm-tasklist:0.61.30'
implementation 'com.vladsch.flexmark:flexmark:0.62.0'
implementation 'com.vladsch.flexmark:flexmark-ext-gfm-strikethrough:0.62.0'
implementation 'com.vladsch.flexmark:flexmark-ext-gfm-tasklist:0.62.0'

testImplementation 'io.github.classgraph:classgraph:4.8.78'
testImplementation 'io.github.classgraph:classgraph:4.8.80'
testImplementation 'org.junit.jupiter:junit-jupiter:5.6.2'
testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.6.2'
testImplementation 'org.junit.platform:junit-platform-launcher:1.6.2'
Expand All @@ -207,12 +207,12 @@ dependencies {
testImplementation 'org.mockito:mockito-core:3.3.3'
testImplementation 'org.xmlunit:xmlunit-core:2.7.0'
testImplementation 'org.xmlunit:xmlunit-matchers:2.7.0'
testImplementation 'com.tngtech.archunit:archunit-junit5-api:0.13.1'
testImplementation 'com.tngtech.archunit:archunit-junit5-api:0.14.1'
testImplementation "org.testfx:testfx-core:4.0.17-alpha-SNAPSHOT"
testImplementation "org.testfx:testfx-junit5:4.0.17-alpha-SNAPSHOT"
testImplementation "org.hamcrest:hamcrest-library:2.2"

checkstyle 'com.puppycrawl.tools:checkstyle:8.32'
checkstyle 'com.puppycrawl.tools:checkstyle:8.33'
xjc group: 'org.glassfish.jaxb', name: 'jaxb-xjc', version: '2.3.3'
jython 'org.python:jython-standalone:2.7.2'
}
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This log lists the decisions for JabRef.
* [ADR-0007](adr/0007-human-readable-changelog.md) - Provide a human-readable changelog
* [ADR-0008](adr/0008-use-public-final-instead-of-getters.md) - Use public final instead of getters to offer access to immutable variables
* [ADR-0009](adr/0009-use-plain-junit5-for-testing.md) - Use Plain JUnit5 for advanced test assertions
* [ADR-0010](0010-use-h2-as-internal-database.md) - Use H2 as Internal SQL Database
* [ADR-0010](adr/0010-use-h2-as-internal-database.md) - Use H2 as Internal SQL Database

For new ADRs, please use [template.md](adr/template.md) as basis. More information on MADR is available at [https://adr.github.io/madr/](https://adr.github.io/madr/). General information about architectural decision records is available at [https://adr.github.io/](https://adr.github.io/).

1 change: 1 addition & 0 deletions docs/adr/0004-use-mariadb-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ The [MySQL Connector](https://www.mysql.com/de/products/connector/) is distribut
* Good, because it stems from the same development team than MySQL
* Bad, because the "Universal FOSS Exception" makes licensing more complicated.

<!-- markdownlint-disable-file MD024 -->
1 change: 1 addition & 0 deletions docs/adr/0006-only-translated-strings-in-language-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@ Chosen option: "Only translated strings in language file", because comes out bes

* Related to [ADR-0001](0001-use-crowdin-for-translations.md).

<!-- markdownlint-disable-file MD024 -->
28 changes: 14 additions & 14 deletions docs/adr/template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# \[short title of solved problem and solution\]

* Status: \[proposed \| rejected \| accepted \| deprecated \|\| superseded by [ADR-0005](https://github.com/JabRef/jabref/tree/8c07a88a823a84aebe987cdb717f318ed00a872d/docs/adr/0005-example.md)\]
* Deciders: \[list everyone involved in the decision\]
* Date: \[YYYY-MM-DD when the decision was last updated\]
* Status: \[proposed \| rejected \| accepted \| deprecated \|\| superseded by [ADR-0005](0005-fully-support-utf8-only-for-latex-files.md)\]
* Deciders: \[list everyone involved in the decision\]
* Date: \[YYYY-MM-DD when the decision was last updated\]

Technical Story: \[description \| ticket/issue URL\]
Technical Story: \[description \| ticket/issue URL\]

## Context and Problem Statement

Expand All @@ -14,14 +14,14 @@ Technical Story: \[description \| ticket/issue URL\]

* \[driver 1, e.g., a force, facing concern, …\]
* \[driver 2, e.g., a force, facing concern, …\]
*
*

## Considered Options

* \[option 1\]
* \[option 2\]
* \[option 3\]
*
*

## Decision Outcome

Expand All @@ -41,33 +41,33 @@ Chosen option: "\[option 1\]", because \[justification. e.g., only option, which

### \[option 1\]

\[example \| description \| pointer to more information \|\]
\[example \| description \| pointer to more information \|\]

* Good, because \[argument a\]
* Good, because \[argument b\]
* Bad, because \[argument c\]
*
*

### \[option 2\]

\[example \| description \| pointer to more information \|\]
\[example \| description \| pointer to more information \|\]

* Good, because \[argument a\]
* Good, because \[argument b\]
* Bad, because \[argument c\]
*
*

### \[option 3\]

\[example \| description \| pointer to more information \|\]
\[example \| description \| pointer to more information \|\]

* Good, because \[argument a\]
* Good, because \[argument b\]
* Bad, because \[argument c\]
*
*

## Links

* \[Link type\] \[Link to ADR\]
*
* \[Link type\] \[Link to ADR\]
*

Loading

0 comments on commit 815050f

Please sign in to comment.