You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Merge remote-tracking branch 'upstream/master' into convertRemainingTest
# By Tobias Diez (11) and others
# Via GitHub (30) and others
* upstream/master: (70 commits)
Use Platform.runLater
Fixes#5485
Bump com.github.ben-manes.versions from 0.26.0 to 0.27.0
Bump src/main/resources/csl-styles from `68a697b` to `c3fd4bd`
Bump byte-buddy-parent from 1.10.1 to 1.10.2
Bump mariadb-java-client from 2.5.0 to 2.5.1
Bump classgraph from 4.8.48 to 4.8.52
Bump org.beryx.jlink from 2.16.0 to 2.16.2
Updated CHANGELOG.md
Open entry editor by default on start-up
Amend the reference to JabRefReferences initialization (#5487)
Fix for issue 5463 (#5481)
Rename index.md to README.md
Fix not on fx thread error for custom entry types
Refactor to sorted set (#5477)
Removed a duplicate name (closes#5476)
Remove unnecessary sort (#5470)
lint CONTRIBUTING.md (#5473)
Mark OOSTyle as invalid if no defaultStyle (#5471)
Fix highlight problem in entry preview
...
# Conflicts:
# build.gradle
Copy file name to clipboardExpand all lines: CHANGELOG.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,9 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
15
15
16
16
- We added a short DOI field formatter which shortens DOI to more human-readable form. [koppor#343](https://github.com/koppor/jabref/issues/343)
17
17
- We improved the display of group memberships by adding multiple colored bars if the entry belongs to more than one group. [#4574](https://github.com/JabRef/jabref/issues/4574)
18
+
- We added an option to show the preview as an extra tab in the entry editor (instead of in a split view). [#5244](https://github.com/JabRef/jabref/issues/5244)
19
+
- A custom Open/LibreOffice jstyle file now requires a layout line for the entry type `default`[#5452](https://github.com/JabRef/jabref/issues/5452)
20
+
- The entry editor is now open by default when JabRef starts up. [#5460](https://github.com/JabRef/jabref/issues/5460)
18
21
19
22
### Fixed
20
23
@@ -30,17 +33,23 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
30
33
- We fixed an error where the number of matched entries shown in the group pane was not updated correctly. [#4441](https://github.com/JabRef/jabref/issues/4441)
31
34
- We fixed an issue where empty keywords lead to a strange display of automatic keyword groups. [#5333](https://github.com/JabRef/jabref/issues/5333)
32
35
- We fixed an error where the default color of a new group was white instead of dark gray. [#4868](https://github.com/JabRef/jabref/issues/4868)
36
+
- We fixed an issue where the first field in the entry editor got the focus while performing a different action (like searching). [#5084](https://github.com/JabRef/jabref/issues/5084)
37
+
- We fixed an issue where multiple entries were highlighted in the web search result after scrolling. [#5035](https://github.com/JabRef/jabref/issues/5035)
38
+
- We fixed an issue where the hover indication in the web search pane was not working. [#5277](https://github.com/JabRef/jabref/issues/5277)
33
39
- We fixed an error mentioning "javafx.controls/com.sun.javafx.scene.control" that was thrown when interacting with the toolbar.
34
40
- We fixed an error where a cleared search was restored after switching libraries. [#4846](https://github.com/JabRef/jabref/issues/4846)
35
41
- We fixed an exception which occurred when trying to open a non-existing file from the "Recent files"-menu [#5334](https://github.com/JabRef/jabref/issues/5334)
42
+
- We fixed an issues where the search highlight in the entry preview did not worked. [#5069](https://github.com/JabRef/jabref/issues/5069)
36
43
- The context menu for fields in the entry editor is back. [#5254](https://github.com/JabRef/jabref/issues/5254)
37
44
- We fixed an exception which occurred when trying to open a non-existing file from the "Recent files"-menu [#5334](https://github.com/JabRef/jabref/issues/5334)
38
45
- We fixed a problem where the "editor" information has been duplicated during saving a .bib-Database. [#5359](https://github.com/JabRef/jabref/issues/5359)
39
46
- We re-introduced the feature to switch between different preview styles. [#5221](https://github.com/JabRef/jabref/issues/5221)
40
47
- We fixed various issues (including [#5263](https://github.com/JabRef/jabref/issues/5263)) related to copying entries to the clipboard
41
-
42
-
43
-
48
+
- We fixed some display errors in the preferences dialog and replaced some of the controls [#5033](https://github.com/JabRef/jabref/pull/5033)[#5047](https://github.com/JabRef/jabref/pull/5047)[#5062](https://github.com/JabRef/jabref/pull/5062)[#5141](https://github.com/JabRef/jabref/pull/5141)[#5185](https://github.com/JabRef/jabref/pull/5185)[#5265](https://github.com/JabRef/jabref/pull/5265)[#5315](https://github.com/JabRef/jabref/pull/5315)[#5360](https://github.com/JabRef/jabref/pull/5360)
49
+
- We fixed an exception which occurred when trying to import entries without an open library. [#5447](https://github.com/JabRef/jabref/issues/5447)
50
+
- After successful import of one or multiple bib entries the main table scrolls to the first imported entry [#5383](https://github.com/JabRef/jabref/issues/5383)
51
+
- We fixed an exception which occurred when an invalid jstyle was loaded. [#5452](https://github.com/JabRef/jabref/issues/5452)
52
+
- We fixed an error where the preview theme did not adapt to the "Dark" mode [#5463](https://github.com/JabRef/jabref/issues/5463)
After reading through this guide, check out some good first issues to contribute to by clicking here: [Good First Issues](https://github.com/JabRef/jabref/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
2
4
3
5
## Understanding the basics
6
+
4
7
We welcome contributions to JabRef and encourage you to follow the GitHub workflow specified below. If you are not familiar with this type of workflow, take a look at GitHub's excellent overview on the [GitHub flow](https://guides.github.com/introduction/flow/index.html) and the explanation of [Feature Branch Workflow](https://atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow) for the idea behind this kind of development.
8
+
5
9
1. Get the JabRef code on your local machine. Detailed instructions about this step can be found in our [guidelines for setting up a local workspace](https://github.com/JabRef/jabref/wiki/Guidelines-for-setting-up-a-local-workspace).
6
10
1. Fork the JabRef into your GitHub account.
7
11
2. Clone your forked repository on your local machine.
8
-
3.**Create a new branch** (such as `fix-for-issue-121`). Be sure to create a **separate branch** for each improvement you implement.
9
-
4. Do your work on the **new branch - not the master branch.** Refer to our [code howtos](https://github.com/JabRef/jabref/wiki/Code-Howtos) if you have questions about your implementation.
10
-
5. Create a pull request. For an overview of pull requests, take a look at GitHub's [pull request help documentation](https://help.github.com/articles/about-pull-requests/).
11
-
12
-
In case you have any questions, do not hesitate to write one of our [JabRef developers](https://github.com/orgs/JabRef/teams/developers) an email. We should also be online at [gitter](https://gitter.im/JabRef/jabref).
12
+
2.**Create a new branch** (such as `fix-for-issue-121`). Be sure to create a **separate branch** for each improvement you implement.
13
+
3. Do your work on the **new branch - not the master branch.** Refer to our [code howtos](https://github.com/JabRef/jabref/wiki/Code-Howtos) if you have questions about your implementation.
14
+
4. Create a pull request. For an overview of pull requests, take a look at GitHub's [pull request help documentation](https://help.github.com/articles/about-pull-requests/).
15
+
5. In case your pull request is not yet complete or not yet ready for review, consider creating a [draft pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) instead.
13
16
17
+
In case you have any questions, do not hesitate to write one of our [JabRef developers](https://github.com/orgs/JabRef/teams/developers) an email.
18
+
We should also be online at [gitter](https://gitter.im/JabRef/jabref).
14
19
15
20
## Formal requirements for a pull request
21
+
16
22
The main goal of the formal requirements is to provide credit to you and to be able to understand the patch.
17
23
18
24
### Add your change to CHANGELOG.md
25
+
19
26
You should edit the [CHANGELOG.md](CHANGELOG.md) located in the root directory of the JabRef source.
20
27
Add a line with your changes in the appropriate section.
21
28
22
29
If you did internal refactorings or improvements not visible to the user (e.g., UI, .bib file), then you don't need to put an entry there.
23
30
24
-
25
31
#### Key format
32
+
26
33
Example: `<kbd>Ctrl</kbd> + <kbd>Enter</kbd>`
27
34
28
35
In case you add keys to the changelog, please follow these rules:
@@ -32,10 +39,10 @@ In case you add keys to the changelog, please follow these rules:
32
39
- Combined keys separated by `+`
33
40
- Spaces before and after separator `+`
34
41
35
-
36
42
### Author credits
37
-
You will be given credit in the `AUTHORS` file in the root of the repository and the 'About' pages inside the main application.
38
-
We will periodically update the contributors list inside `AUTHORS`.
43
+
44
+
You will be given credit in the [`AUTHORS`](AUTHORS) file in the root of the repository and the 'About' pages inside the main application.
45
+
We will periodically update the contributors list inside [`AUTHORS`](AUTHORS).
39
46
This is done by an automatic shell script `scripts/generate-authors.sh`.
40
47
41
48
If you want to add yourself directly with your pull request please run this script.
@@ -48,37 +55,37 @@ The contribution information is tracked via the version control system.
48
55
49
56
Your contribution is considered being made under [MIT license](https://tldrlegal.com/license/mit-license).
50
57
51
-
52
58
### Write a good commit message
59
+
53
60
See [good commit message] or [commit guidelines section of Pro Git].
54
-
The first line of your commit message is automatically taken as title for the pull-request.
61
+
The first line of your commit message is automatically taken as the title for the pull-request.
55
62
All other lines make up the body of the pull request. Add the words `fixes #xxx` to your PR to auto-close the corresponding issue.
56
63
57
-
58
64
### Test your code
59
-
We know that writing test cases causes a lot of time.
60
-
Nevertheless, we rely on our test cases to ensure that a bug fix or a feature implementation doesn't break anything.
61
-
In case you do not have time to add a test case, we nevertheless ask you to run `gradlew check` to ensure that your change doesn't break anything else.
62
65
66
+
We know that writing test cases takes a lot of time.
67
+
Nevertheless, we rely on our test cases to ensure that a bug fix or a feature implementation doesn't break anything.
68
+
In case you do not have time to add a test case, we nevertheless ask you to at least run `gradlew check` to ensure that your change doesn't break anything else.
63
69
64
70
### When adding a library
71
+
65
72
Please try to use a version available at jCenter and add it to `build.gradle`.
66
73
In any case, describe the library at [external-libraries.txt](external-libraries.txt).
67
74
We need that information for our package maintainers (e.g., those of the [debian package](https://tracker.debian.org/pkg/jabref)).
68
75
Also add a txt file stating the license in `libraries/`.
69
76
It is used at `gradlew processResources` to generate the About.html files.
70
77
You can see the result in `build\resources\main\help\en\About.html` or when clicking Help -> About.
71
78
72
-
73
79
### When making an architectural decision
80
+
74
81
In case you add a library or do major code rewrites, we ask you to document your decision.
75
82
Recommended reading: <https://adr.github.io/>.
76
83
77
84
We simply ask to create a new markdown file in `docs/adr` following the template presented at <https://adr.github.io/madr/>.
78
85
79
86
In case you want to directly add a comment to a class, simply use following template (based on [sustainable architectural decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions)):
Tests fail. In the test output a snippet is generated which must be added to the English translation file.
99
+
100
+
Add new `Localization.lang("KEY")` to a Java file.
101
+
The tests will fail. In the test output a snippet is generated, which must be added to the English translation file.
95
102
96
103
Example:
97
104
98
-
```
105
+
```text
99
106
java.lang.AssertionError: DETECTED LANGUAGE KEYS WHICH ARE NOT IN THE ENGLISH LANGUAGE FILE
100
107
PASTE THESE INTO THE ENGLISH LANGUAGE FILE
101
108
[
@@ -105,20 +112,20 @@ Expected :[]
105
112
Actual :[Opens\ JabRef's\ Twitter\ page (src\main\java\org\jabref\gui\JabRefFrame.java LANG)]
106
113
```
107
114
108
-
Add snippet to English translation file located at `src/main/resources/l10n/JabRef_en.properties`.
115
+
Add the above snippet to the English translation file located at `src/main/resources/l10n/JabRef_en.properties`.
109
116
[Crowdin](http://translate.jabref.org/) will automatically pick up the new string and add it to the other translations.
110
117
111
118
You can also directly run the specific test in your IDE.
112
119
The test "LocalizationConsistencyTest" is placed under `src/test/java/net.sf.jabref.logic.l10n/LocalizationConsistencyTest.java`
113
120
Find more information in the [JabRef Wiki](https://github.com/JabRef/jabref/wiki/Code-Howtos#using-localization-correctly).
114
121
115
-
116
122
### Create a pull request
123
+
117
124
Create a pull request on GitHub.
118
125
For text inspirations, consider [How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request).
119
126
120
-
You can add the prefix `[WIP]`to indicate that the pull request is not yet complete, but you want to discuss something or inform about the current state of affairs.
121
-
127
+
If you want to indicate that a pull request is not yet complete**before** creating the pull request, you may consider creating a [draft pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
128
+
Alternatively, once the PR has been created, you can add the prefix `[WIP]` (which stands for "Work in Progress") to indicate that the pull request is not yet complete, but you want to discuss something or inform about the current state of affairs.
122
129
123
130
[commit guidelines section of Pro Git]: http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ JabRef supports you in every step of your research work.
34
34
35
35
#### Organize
36
36
37
-
- Group your research into hierarchical collections and organize research items based on keywords/tags, search terms or your own manual assignments
37
+
- Group your research into hierarchical collections and organize research items based on keywords/tags, search terms or your manual assignments
38
38
- Advanced search and filter features
39
39
- Complete and fix bibliographic data by comparing with curated online catalogues such as Google Scholar, Springer or MathSciNet
40
40
- Customizable citation key generator
@@ -48,12 +48,12 @@ JabRef supports you in every step of your research work.
48
48
49
49
- Native [BibTeX] and [Biblatex] support
50
50
- Cite-as-you-write functionality for external applications such as Emacs, Kile, LyX, Texmaker, TeXstudio, Vim and WinEdt.
51
-
- Format references in one of the many thousand built-in citation styles or create your own style
51
+
- Format references in one of the many thousand built-in citation styles or create your style
52
52
- Support for Word and LibreOffice/OpenOffice for inserting and formatting citations
53
53
54
54
#### Share
55
55
56
-
- Many built-in export options or create your own export format
56
+
- Many built-in export options or create your export format
57
57
- Library is saved as a simple text file and thus it is easy to share with others via Dropbox and is version-control friendly
58
58
- Work in a team: sync the contents of your library via a SQL database
59
59
@@ -91,7 +91,7 @@ An explanation of donation possibilities and usage of donations is available at
91
91
92
92
> Not a programmer? [Learn how to help.](http://contribute.jabref.org)
93
93
94
-
Want to be part of a free and open-source project that tens of thousands scientist use every day? Check out the ways you can contribute, below:
94
+
Want to be part of a free and open-source project that tens of thousands of scientists use every day? Check out the ways you can contribute, below:
95
95
- For details on how to contribute, have a look at our [guidelines for contributing](CONTRIBUTING.md).
96
96
- You are welcome to contribute new features. To get your code included into JabRef, just [fork](https://help.github.com/en/articles/fork-a-repo) the JabRef repository, make your changes, and create a [pull request](https://help.github.com/en/articles/about-pull-requests).
97
97
- To work on existing JabRef issues, check out our [issue tracker](https://github.com/JabRef/jabref/issues). New to open source contributing? Look for issues with the ["good first issue"](https://github.com/JabRef/jabref/labels/good%20first%20issue) label to get started.
0 commit comments