Merge branch 'main' into fix-12810-escape-keyword-separators

Author: Rajas55

README.md

@@ -59,15 +59,15 @@ Please see our [Installation Guide](https://docs.jabref.org/installation).
 
 We are thankful for any bug reports or other feedback.
 If you have ideas for new features you want to be included in JabRef, tell us in [the feature section](http://discourse.jabref.org/c/features) of our forum!
-If you need support in using JabRef, please read [the documentation](https://docs.jabref.org/) first, the [frequently asked questions (FAQ)](https://docs.jabref.org/faq) and also have a look at our [community forum](https://discourse.jabref.org/c/help/7).
+If you need support in using JabRef, please read the [user documentation](https://docs.jabref.org/), especially the [frequently asked questions (FAQ)](https://docs.jabref.org/faq) and also take a look at our [community forum](https://discourse.jabref.org/c/help/7).
 You can use our [GitHub issue tracker](https://github.com/JabRef/jabref/issues) to file bug reports.
 
 An explanation of donation possibilities and usage of donations is available at our [donations page](https://donations.jabref.org).
 
 ## Contributing
 
 Want to be part of a free and open-source project that tens of thousands of researchers use every day?
-Please have a look at our [guidelines for contributing](CONTRIBUTING.md).
+Please take a look at our [guidelines for contributing](CONTRIBUTING.md).
 
 ## Research and Education
 

build.gradle

@@ -235,7 +235,7 @@ dependencies {
     implementation('org.jabref:afterburner.fx:2.0.0') {
         exclude group: 'org.openjfx'
     }
-    implementation 'org.kordamp.ikonli:ikonli-javafx:12.3.1'
+    implementation 'org.kordamp.ikonli:ikonli-javafx:12.4.0'
     implementation 'org.kordamp.ikonli:ikonli-materialdesign2-pack:12.3.1'
     implementation 'com.github.sialcasa.mvvmFX:mvvmfx-validation:f195849ca9' //jitpack
     implementation 'de.saxsys:mvvmfx:1.8.0'
@@ -266,8 +266,8 @@ dependencies {
 
     // region HTTP clients
     implementation 'org.jsoup:jsoup:1.19.1'
-    implementation 'com.konghq:unirest-java-core:4.4.5'
-    implementation 'com.konghq:unirest-modules-gson:4.4.5'
+    implementation 'com.konghq:unirest-java-core:4.4.6'
+    implementation 'com.konghq:unirest-modules-gson:4.4.6'
     implementation 'org.apache.httpcomponents.client5:httpclient5:5.4.3'
     // endregion
 
@@ -281,7 +281,7 @@ dependencies {
     // route all requests to log4j to SLF4J
     implementation 'org.apache.logging.log4j:log4j-to-slf4j:2.24.3'
 
-    implementation('de.undercouch:citeproc-java:3.2.0') {
+    implementation('de.undercouch:citeproc-java:3.2.1') {
         exclude group: 'org.antlr'
     }
 
@@ -383,7 +383,7 @@ dependencies {
 
     testImplementation 'io.github.classgraph:classgraph:4.8.179'
     testImplementation 'org.junit.jupiter:junit-jupiter:5.12.2'
-    testImplementation 'org.junit.platform:junit-platform-launcher:1.12.1'
+    testImplementation 'org.junit.platform:junit-platform-launcher:1.12.2'
 
     testImplementation 'org.mockito:mockito-core:5.17.0'
     testImplementation 'org.xmlunit:xmlunit-core:2.10.0'
@@ -403,7 +403,7 @@ dependencies {
     xjc group: 'org.glassfish.jaxb', name: 'jaxb-xjc', version: '3.0.2'
     xjc group: 'org.glassfish.jaxb', name: 'jaxb-runtime', version: '3.0.2'
 
-    rewrite(platform("org.openrewrite.recipe:rewrite-recipe-bom:3.5.0"))
+    rewrite(platform("org.openrewrite.recipe:rewrite-recipe-bom:3.6.1"))
     rewrite("org.openrewrite.recipe:rewrite-static-analysis")
     rewrite("org.openrewrite.recipe:rewrite-logging-frameworks")
     rewrite("org.openrewrite.recipe:rewrite-testing-frameworks")

docs/code-howtos/cli.md

@@ -0,0 +1,14 @@
+---
+parent: Code Howtos
+---
+# Command Line Interface
+
+The package `org.jabref.cli` is responsible for handling the command line options.
+
+During development, one can configure IntelliJ to pass command line parameters:
+
+![IntelliJ-run-configuration](../images/intellij-run-configuration-command-line.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.
+
+Without [jlink](https://docs.oracle.com/en/java/javase/11/tools/jlink.html), it is not possible to generate a fat jar anymore. During development, the capabilities of the IDE has to be used.

docs/code-howtos/faq.md

@@ -5,6 +5,11 @@ parent: Code Howtos
 
 Following is a list of common errors encountered by developers which lead to failing tests, with their common solutions:
 
+## git hints
+
+* Sync your fork with the JabRef repository: [General howto by GitHub](https://help.github.com/articles/syncing-a-fork/)
+* Branches and pull requests (🇩🇪): [https://github.com/unibas-marcelluethi/software-engineering/blob/master/docs/week2/exercises/practical-exercises.md](https://github.com/unibas-marcelluethi/software-engineering/blob/master/docs/week2/exercises/practical-exercises.md)
+
 ## Failing tests
 
 ### Failing <b>Checkstyle</b> tests
@@ -149,4 +154,10 @@ And similarly for `csl-locales` or `abbrv.jabref.org`.
 
 To avoid this, avoid staging using `git add .` from CLI. Preferably use a GUI-based git manager, such as the one built in IntelliJ or open git gui from the command line. Even if you accidentally stage them, don't commit all files, selectively commit the files you touched using the GUI based tool, and push.
 
+## Q: I get `java: package org.jabref.logic.journals does not exist`
+
+A: You have to ignore `buildSrc/src/main` as source directory in IntelliJ as indicated in our [setup guide](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace).
+
+Also filed as IntelliJ issue [IDEA-240250](https://youtrack.jetbrains.com/issue/IDEA-240250).
+
 <!-- markdownlint-disable-file MD033 -->

docs/code-howtos/groups.md

@@ -0,0 +1,6 @@
+---
+parent: Code Howtos
+---
+# Groups
+
+Diagram showing aspects of groups: [Groups.uml](https://github.com/JabRef/jabref/tree/3b3716b1e05a0d3273c886e102a8efe5e96472e0/docs/Groups.uml).

docs/code-howtos/index.md

@@ -62,7 +62,7 @@ This is implemented in `FileUtil`:
 org.jabref.logic.util.io.FileUtil.relativize(java.nio.file.Path, org.jabref.model.database.BibDatabaseContext, org.jabref.logic.FilePreferences)
 ```
 
-## Setting a Directory for a .bib File
+## Setting a directory for a `.bib` file
 
 * `@comment{jabref-meta: fileDirectory:<directory>`
 * “fileDirectory” is determined by Globals.pref.get(“userFileDir”) (which defaults to “fileDirectory”

docs/getting-into-the-code/development-strategy.md

@@ -12,13 +12,13 @@ Ensure you have a Java 23 SDK configured by navigating to **File > Project Struc
 **Note:** In some MacBooks, `Project Structure` can be found at the "IntelliJ" button of the app menu instead of at "File".
 
 {% figure caption:"JDKs 11, 14, and 15 shown in available SDKs. JDK 23 is missing." %}
-![Plattform Settings - SDKs](intellij-choose-jdk-adoptopenjdk-on-windows-project-settings.png)
+![Platform Settings - SDKs](intellij-choose-jdk-adoptopenjdk-on-windows-project-settings.png)
 {% endfigure %}
 
 If there is another JDK than JDK 23 selected, click on the plus button and choose "Download JDK..."
 
 {% figure caption:"Download JDK..." %}
-![Plattform Settings - SDKs - plus button - Download JDK...](guidelines-select-download-jdk.png)
+![Platform Settings - SDKs - plus button - Download JDK...](guidelines-select-download-jdk.png)
 {% endfigure %}
 
 Select JDK version 23 and then Eclipse Temurin.
@@ -46,7 +46,7 @@ Click "OK" to store the changes.
 Navigate to **File > Settings... > Build, Execution, Deployment > Build Tools > Gradle** and select the "Project SDK" as the Gradle JVM at the bottom.
 If that does not exist, just select JDK 23.
 
-{% figure caption:"Gradle JVM is project SDK (showing "Projekt SDK temurin-23" as example)" %}
+{% figure caption:"Gradle JVM is project SDK (showing "Project SDK temurin-23" as example)" %}
 ![Gradle JVM is project SDK](guidelines-intellij-settings-gradle-gradlejvm-is-projectjvm.png)
 {% endfigure %}
 

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/guidelines-intellij-installs-temurin.png

@@ -30,8 +30,8 @@ It is strongly recommended that you have git installed.
 
 ## Installed IDE
 
-We highly encourage using [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=jabref), because all other IDEs work less good.
-Especially using Visual Studio Code has issues.
+We highly encourage using [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=jabref), as it provides the most reliable experience for this project.
+Other IDEs may have compatibility issues, particularly Visual Studio Code.
 
 IntelliJ's Community Edition works well.
 Most contributors use the Ultimate Edition, because they are students getting that edition for free.