Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into importerbackgroun…
Browse files Browse the repository at this point in the history
…dtask

* upstream/master:
  Remove obsolete registry patch file (#7316)
  Fix AUTHORS
  GitBook: [master] one page modified
  Remove broken Sonarqube integration (#7315)
  GitBook: [master] 5 pages and 32 assets modified
  docs: update license year (#7314)
  Add javafx version number + update javafx (#7312)
  Add missing authors
  • Loading branch information
Siedlerchr committed Jan 8, 2021
2 parents 266a8c3 + 5eb38c4 commit 81e7b44
Show file tree
Hide file tree
Showing 30 changed files with 19 additions and 179 deletions.
1 change: 1 addition & 0 deletions .mailmap
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,4 @@ ZhouSky <11711923@mail.sustech.edu.cn>
Vincent Gagnon <vincentgagnon53@gmail.com>
Tom Warnke <Toromtomtom@users.noreply.github.com>
Eric Lau <919023+skeric@users.noreply.github.com>
Isabel Beckenbach <68125288+ibe-314@users.noreply.github.com>
1 change: 0 additions & 1 deletion .sonarcloud.properties

This file was deleted.

2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ Igor Steinmacher
Illes Solt
Ingvar Jackal
Isaac Roles
Isabel Beckenbach
Jackson Ryan
Jan Frederik Maas
Jan Kubovy
Expand Down Expand Up @@ -358,6 +359,7 @@ Scott Pogatetz
Scott Townsend
Seb Wills
Serban Iordache
Shadow Devil
Shikun Xiong
ShiqingLiu
Shitikanth
Expand Down
Binary file removed JabRef-downgrade-regpatch.reg
Binary file not shown.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright © 2003-2020 [JabRef Authors](https://github.com/JabRef/jabref/blob/master/AUTHORS)
Copyright © 2003-2021 [JabRef Authors](https://github.com/JabRef/jabref/blob/master/AUTHORS)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ configurations {
}

javafx {
version = "15"
version = "15.0.1"
modules = [ 'javafx.controls', 'javafx.fxml', 'javafx.web', 'javafx.swing' ]
}

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The package `org.jabref.cli` is responsible for handling the command line option

During development, one can configure IntelliJ to pass command line parameters:

![IntelliJ-run-configuration](.gitbook/assets/intellij-run-configuration-command-line%20%282%29%20%281%29.png)
![IntelliJ-run-configuration](.gitbook/assets/intellij-run-configuration-command-line%20%282%29%20%282%29%20%281%29.png)

Passing command line arguments using gradle is currently not possible as all arguments \(such as `-Dfile.encoding=windows-1252`\) are passed to the application.

Expand Down
12 changes: 4 additions & 8 deletions docs/getting-into-the-code/code-howtos.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Principles:
Localization.lang("Something went wrong...", ioe);
}
```

* Never, ever throw and catch `Exception` or `Throwable`
* Errors should only be logged when they are finally caught \(i.e., logged only once\). See **Logging** for details.
* If the Exception message is intended to be shown to the User in the UI \(see below\) provide also a localizedMessage \(see `JabRefException`\).
Expand Down Expand Up @@ -187,7 +186,7 @@ The tests check whether translation strings appear correctly in the resource bun
2. Create an empty &lt;locale code&gt;.properties file
3. Configure the new language in [Crowdin](https://crowdin.com/project/jabref)

If the language is a variant of a language `zh_CN` or `pt_BR` it is necessary to add a language mapping for Crowdin to the crowdin.yml file in the root. Of course the properties file also has to be named according to the language code and locale.
If the language is a variant of a language `zh_CN` or `pt_BR` it is necessary to add a language mapping for Crowdin to the crowdin.yml file in the root. Of course the properties file also has to be named according to the language code and locale.

## Cleanup and Formatters

Expand Down Expand Up @@ -401,18 +400,15 @@ All radio buttons that should be grouped together need to have a ToggleGroup def

### JavaFX Dialogs

All dialogs should be displayed to the user via `DialogService` interface methods.
`DialogService` provides methods to display various dialogs (including custom ones) to the user.
It also ensures the displayed dialog opens on the correct window via `initOwner()` (for cases where the user has multiple screens).
The following code snippet demonstrates how a custom dialog is displayed to the user:
All dialogs should be displayed to the user via `DialogService` interface methods. `DialogService` provides methods to display various dialogs \(including custom ones\) to the user. It also ensures the displayed dialog opens on the correct window via `initOwner()` \(for cases where the user has multiple screens\). The following code snippet demonstrates how a custom dialog is displayed to the user:

```java
dialogService.showCustomDialog(new DocumentViewerView());
```

If an instance of `DialogService` is unavailable within current class/scope in which the dialog needs to be displayed,
`DialogService` can be instantiated via the code snippet shown as follows:
If an instance of `DialogService` is unavailable within current class/scope in which the dialog needs to be displayed, `DialogService` can be instantiated via the code snippet shown as follows:

```java
DialogService dialogService = Injector.instantiateModelOrService(DialogService.class);
```

Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ To prepare IntelliJ's build system two additional steps are required:

To have autoformat working properly in the context of line wrapping, "Wrap at right margin" has to be disabled as shown below. Details are found in [IntelliJ issue 240517](https://youtrack.jetbrains.com/issue/IDEA-240517).

![Disable wrapping at right margin to prevent JavaDoc to be wrapped](../.gitbook/assets/intellij-wrap-at-right-margin%20%281%29.png)
![Disable wrapping at right margin to prevent JavaDoc to be wrapped](../.gitbook/assets/intellij-wrap-at-right-margin%20%284%29%20%281%29.png)

#### Using Gradle from within IntelliJ IDEA

Expand Down Expand Up @@ -155,7 +155,7 @@ To use IntelliJ IDEA's internal build system when you build JabRef through **Bui
* In **File \| Settings \| Build, Execution, Deployment \| Build Tools \| Gradle** the setting "Build and run using" and "Test using" is set to "IntelliJ IDEA".
* Ignore the Gradle project "buildSrc" by clicking the button **Select Project Data To Import** in the Gradle Tool Window and unchecking the folder "buildSrc".

![Ignore the Gradle project &quot;buildSrc&quot;](../.gitbook/assets/intellij-gradle-config-ignore-buildSrc%20%282%29.png)
![Ignore the Gradle project &quot;buildSrc&quot;](../.gitbook/assets/intellij-gradle-config-ignore-buildSrc%20%282%29%20%282%29.png)

* Delete `org.jabref.gui.logging.plugins.Log4jPlugins` \(location: `generated\org\jabref\gui\logging\plugins\Log4jPlugins.java`\). Otherwise, you will see following error:

Expand Down Expand Up @@ -214,7 +214,7 @@ Make sure your Eclipse installation us up to date.
4. Create a run/debug configuration for the main class `org.jabref.gui.JabRefLauncher` and/or for `org.jabref.gui.JabRefMain` \(both can be used equivalently\)
* Remark: The run/debug configuration needs to be added by right clicking the class \(e.g. JabRefLauncher or JabRefMain\) otherwise it will not work.

![Creating the run/debug configuration by right clicking on the class](../.gitbook/assets/eclipse-create-run-config%20%281%29.png)
![Creating the run/debug configuration by right clicking on the class](../.gitbook/assets/eclipse-create-run-config%20%281%29%20%283%29.png)

* In the tab "Arguments" of the run/debug configuration, enter the following runtime VM arguments:

Expand Down
4 changes: 2 additions & 2 deletions docs/teaching.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There is no special process for student contributions. We want to discuss it nev

The process for accepting contributions is as below. The syntax is [BPMN](https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation) modeled using [bpmn.io](https://bpmn.io/).

[![process](.gitbook/assets/contribution-process-reviews%20%281%29.svg)](https://github.com/JabRef/jabref/tree/ed275b62fe7dac57a086e43802e36deb93c63e31/docs/images/contribution-process-reviews.svg)
[![process](.gitbook/assets/contribution-process-reviews%20%282%29%20%281%29.svg)](https://github.com/JabRef/jabref/tree/ed275b62fe7dac57a086e43802e36deb93c63e31/docs/images/contribution-process-reviews.svg)

In short, the contribution is **reviewed by two JabRef developers**. Typically, they have constructive feedback on their contribution. This means, that the contributors get comments on their contribution enabling them to level-up their coding skill. Incorporating improvements takes time, too. The benefit is two-fold: a\) contributors improve their coding skills and b\) JabRef's code quality improves. All in all, we ask to respect the aims of the JabRef team and to reserve time to incorporate the reviewer's comments.

Expand All @@ -46,7 +46,7 @@ GitHub describes that in their page [Understanding the GitHub flow](https://guid

Newcomers contributing in the context of a university teaching experience are invited to follow the process described above. In case the capacity of the instructing university allows, we propose a three-step approach. First, the contributors prepare their contribution as usual. Then, they submit the pull request _to a separate repository_. There, the instructor reviews the pull request and provides feedback. This happens in a loop until the instructor shows the green light. Then, the pull request can be submitted to the main JabRef repository. This will help to reduce the load on the JabRef team and improve the quality of the initial pull request.

[![process with instructor](.gitbook/assets/contribution-process-reviews-with-instructor%20%281%29.svg)](https://github.com/JabRef/jabref/tree/ed275b62fe7dac57a086e43802e36deb93c63e31/docs/images/contribution-process-reviews-with-instructor.svg)
[![process with instructor](.gitbook/assets/contribution-process-reviews-with-instructor%20%281%29%20%282%29.svg)](https://github.com/JabRef/jabref/tree/ed275b62fe7dac57a086e43802e36deb93c63e31/docs/images/contribution-process-reviews-with-instructor.svg)

## Past courses

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/jabref/gui/help/AboutDialogViewModel.java
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ public AboutDialogViewModel(DialogService dialogService, ClipBoardManager clipBo
authors.set(buildInfo.authors);
license.set(Localization.lang("License") + ":");
changelogUrl = buildInfo.version.getChangelogUrl();
versionInfo = String.format("JabRef %s%n%s %s %s %nJava %s", buildInfo.version, BuildInfo.OS,
BuildInfo.OS_VERSION, BuildInfo.OS_ARCH, BuildInfo.JAVA_VERSION);
versionInfo = String.format("JabRef %s%n%s %s %s %nJava %s %nJavaFX %s", buildInfo.version, BuildInfo.OS,
BuildInfo.OS_VERSION, BuildInfo.OS_ARCH, BuildInfo.JAVA_VERSION, BuildInfo.JAVAFX_VERSION);
}

public String getDevelopmentVersion() {
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/org/jabref/logic/util/BuildInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ public final class BuildInfo {
public static final String OS_VERSION = System.getProperty("os.version", UNKNOWN_VERSION).toLowerCase(Locale.ROOT);
public static final String OS_ARCH = System.getProperty("os.arch", UNKNOWN_VERSION).toLowerCase(Locale.ROOT);
public static final String JAVA_VERSION = System.getProperty("java.version", UNKNOWN_VERSION).toLowerCase(Locale.ROOT);
public static final String JAVAFX_VERSION = System.getProperty("javafx.runtime.version", UNKNOWN_VERSION).toLowerCase(Locale.ROOT);


public final Version version;
public final String authors;
Expand Down
82 changes: 0 additions & 82 deletions src/main/java/org/jabref/logic/util/JavaVersion.java

This file was deleted.

78 changes: 0 additions & 78 deletions src/test/java/org/jabref/logic/util/JavaVersionTest.java

This file was deleted.

0 comments on commit 81e7b44

Please sign in to comment.