Merge branch 'main' into LuceneSearch

.github/workflows/add-greeting-to-issue.yml

@@ -24,6 +24,8 @@ jobs:
 
           Newcomers, we're excited to have you on board. Start by exploring our [Contributing](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md) guidelines, and don't forget to check out our [workspace setup guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace) to get started smoothly.
 
+          In case you encounter failing tests during development, please check our [developer FAQs](https://devdocs.jabref.org/code-howtos/faq.html)!
+
           Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on [JabRef's Gitter chat](https://gitter.im/JabRef/jabref). And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.
 
           Happy coding! 🚀

CHANGELOG.md

@@ -18,6 +18,8 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - The dialog for [adding an entry using reference text](https://docs.jabref.org/collect/newentryfromplaintext) is now filled with the clipboard contents as default. [#11565](https://github.com/JabRef/jabref/pull/11565)
 - Added minimal support for [biblatex data annotation](https://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/biblatex.pdf#subsection.3.7) fields in `.layout` files. [#11505](https://github.com/JabRef/jabref/issues/11505)
 - Added saving of selected options in the [Lookup -> Search for unlinked local files dialog](https://docs.jabref.org/collect/findunlinkedfiles#link-the-pdfs-to-your-bib-library). [#11439](https://github.com/JabRef/jabref/issues/11439)
+- We fixed ans issue where text in Dark mode inside "Citation information" was not readable [#11512](https://github.com/JabRef/jabref/issues/11512)
+- We enabled creating a new file link manually. [#11017](https://github.com/JabRef/jabref/issues/11017)
 - We added a toggle button to invert the selected groups. [#9073](https://github.com/JabRef/jabref/issues/9073)
 - We reintroduced the floating search in the main table. [#4237](https://github.com/JabRef/jabref/issues/4237)
 - We fixed an issue where the selection of an entry in the table lost after searching for a group. [#3176](https://github.com/JabRef/jabref/issues/3176)
@@ -31,19 +33,21 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - JabRef does not show finished background tasks in the status bar popup. [#11574](https://github.com/JabRef/jabref/pull/11574)
 - We enhanced the indexing speed. [#11502](https://github.com/JabRef/jabref/pull/11502)
 - ⚠️ Renamed command line parameters `embeddBibfileInPdf` to `embedBibFileInPdf`, `writeMetadatatoPdf` to `writeMetadataToPdf`, and `writeXMPtoPdf` to `writeXmpToPdf`. [#11575](https://github.com/JabRef/jabref/pull/11575)
+- The browse button for a Custom theme now opens in the directory of the current used CSS file [#11597](https://github.com/JabRef/jabref/pull/11597)
 
 ### Fixed
 
 - We fixed an issue where the "Check for updates" preference was not saved. [#11485](https://github.com/JabRef/jabref/pull/11485)
 - We fixed an issue where an exception was thrown after changing "show preview as a tab" in the preferences. [#11515](https://github.com/JabRef/jabref/pull/11515)
+- We fixed an issue where JabRef put file paths as absolute path when an entry was created using drag and drop of a PDF file. [#11173](https://github.com/JabRef/jabref/issues/11173)
 - We fixed an issue that online and offline mode for new library creation were handled incorrectly. [#11565](https://github.com/JabRef/jabref/pull/11565)
 - We fixed an issue with colors in the search bar when dark theme is enabled. [#11569](https://github.com/JabRef/jabref/issues/11569)
 - We fixed an issue where a new unsaved library was not marked with an asterisk. [#11519](https://github.com/JabRef/jabref/pull/11519)
 - We fixed an issue where JabRef starts without window decorations. [#11440](https://github.com/JabRef/jabref/pull/11440)
 
 ### Removed
 
-
+- We removed support for importing using the SilverPlatterImporter (`Record INSPEC`). [#11576](https://github.com/JabRef/jabref/pull/11576)
 
 
 

PRIVACY.md

@@ -1,6 +1,6 @@
 # Privacy Policy
 
-Last updated: 2023-08-24
+Last updated: 2024-08-06
 
 Your privacy is a fundamental right JabRef e.V. respects and supports.
 By using JabRef and its related online services, you choose to share some of your personal information.
@@ -58,6 +58,7 @@ These third-party services are the following:
 | [IACR](https://www.iacr.org/)                                                                                                | <https://www.iacr.org/privacy.html> |
 | [IEEEXplore](https://ieeexplore.ieee.org/Xplore/home.jsp)                                                                    | <https://www.ieee.org/security-privacy.html> |
 | [INSPIRE](https://inspirehep.net/)                                                                                           | <https://cern.service-now.com/service-portal?id=privacy_policy&se=INSPIRE-Online&notice=main> |
+| [ISIDORE](https://isidore.science/)                                                                                          | <https://isidore.science/credit> |
 | [JSTOR](https://www.jstor.org/)                                                                                              | <https://www.ithaka.org/privacypolicy/> |
 | [Library of Congress](https://lccn.loc.gov/)                                                                                 | <https://www.loc.gov/legal/> |
 | [National Library of Medicine](https://www.ncbi.nlm.nih.gov/)                                                                | <https://www.nlm.nih.gov/web_policies.html> |
@@ -73,9 +74,8 @@ These third-party services are the following:
 | [The SAO/NASA Astrophysics Data System](https://ui.adsabs.harvard.edu/)                                                      | <https://ui.adsabs.harvard.edu/help/privacy/> |
 | [Unpaywall](https://unpaywall.org/)                                                                                          | <https://unpaywall.org/legal/privacy> |
 | [zbMATH Open](https://www.zbmath.org)                                                                                        | <https://zbmath.org/privacy-policy/> |
-| [ISIDORE](https://isidore.science/)                                                                                          | <https://isidore.science/credit> |
 
-[1]: *Note: The Mr. DLib service is used for the related articles tab in the entry editor and collects also your language, your browser and operating system (by default*disabled*).*
+[1]: *Note: The Mr. DLib service is used for the related articles tab in the entry editor and collects also your language, your browser and operating system (*disabled* by default).*
 
 ## JabRef Browser Extension
 

docs/code-howtos/faq.md

@@ -19,7 +19,7 @@ Following is a list of common errors encountered by developers which lead to fai
       Read more about the background and format of localization in JabRef [here](https://devdocs.jabref.org/code-howtos/localization.html).
 
 * `org.jabref.logic.l10n.LocalizationConsistencyTest` `findObsoleteLocalizationKeys` <span style="color:red">FAILED</span>
-  * <span style="color:green">Fix</span>: There are localization keys [localization properties file](https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties) that are not used in the code, probably due to the removal of existing code. Navigate to the unused key-value pairs in the file and remove them. You can always click on the details of the failing test to pinpoint which keys are unused.
+  * <span style="color:green">Fix</span>: There are localization keys in the [localization properties file](https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties) that are not used in the code, probably due to the removal of existing code. Navigate to the unused key-value pairs in the file and remove them. You can always click on the details of the failing test to pinpoint which keys are unused.
     Read more about the background and format of localization in JabRef [here](https://devdocs.jabref.org/code-howtos/localization.html).
 
 * `org.jabref.logic.citationstyle.CitationStyle` `discoverCitationStyles` <span style="color:red">ERROR: Could not find any citation style. Tried with /ieee.csl.</span>

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md

@@ -43,7 +43,8 @@ Press <kbd>Alt</kbd>+<kbd>0</kbd> to open the commit dialog.
 Unfortunately, IntelliJ has no support for ignored sub modules [[IDEA-285237](https://youtrack.jetbrains.com/issue/IDEA-285237/ignored-changes-in-submodules-are-still-visible-in-the-commit-window)].
 Fortunately, there is a workaround:
 
-Go to **File > Settings... > Version Control > Directory Mappings**.
+Go to **File > Settings... > Version Control > Directory Mappings**.<br>
+**Note:** In some MacBooks, `Settings` can be found at the "IntelliJ" button of the app menu instead of at "File".
 
 Currently, it looks as follows:
 
@@ -60,3 +61,5 @@ This will make these directories "Unregistered roots:", which is fine.
 {% figure caption:"Directory Mappings having three unregistered roots" %}
 ![Directory Mappings having three repositories unregsitered](intellij-directory-mappings-unregistered-roots.png)
 {% endfigure %}
+
+<!-- markdownlint-disable-file MD033 -->

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md

@@ -8,7 +8,8 @@ nav_order: 12
 
 ## Ensure that JDK 21 is available to IntelliJ
 
-Ensure you have a Java 21 SDK configured by navigating to **File > Project Structure... > Platform Settings > SDKs**.
+Ensure you have a Java 21 SDK configured by navigating to **File > Project Structure... > Platform Settings > SDKs**.<br>
+**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 21 is missing." %}
 ![Plattform Settings - SDKs](intellij-choose-jdk-adoptopenjdk-on-windows-project-settings.png)
@@ -193,3 +194,5 @@ A right-click on "BibEntryTests" enables the debugger to start.
 {% figure caption:"Run window for the BibEntry test case" %}
 ![Run window for the BibEntry test case](guidelines-intellij-tests-are-green.png)
 {% endfigure %}
+
+<!-- markdownlint-disable-file MD033 -->

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.md

@@ -12,7 +12,8 @@ Install the [CheckStyle-IDEA plugin](http://plugins.jetbrains.com/plugin/1065?pr
 Navigate to **File > Settings... > Plugins"**.
 On the top, click on "Marketplace".
 Then, search for "Checkstyle".
-Click on "Install" choose "CheckStyle-IDEA".
+Click on "Install" choose "CheckStyle-IDEA".<br>
+**Note:** In some MacBooks, `Settings` can be found at the "IntelliJ" button of the app menu instead of at "File".
 
 {% figure caption:"Install CheckStyle" %}
 ![Install CheckStyle](guidelines-intellij-install-checkstyle.png)
@@ -159,3 +160,5 @@ Press "OK".
 > Finally, you have Checkstyle running locally so that you can check for styling errors before submitting the pull request.
 
 Got it running? GREAT! You are ready to lurk the code and contribute to JabRef. Please make sure to also read our [contribution guide](https://devdocs.jabref.org/contributing#contribute-code).
+
+<!-- markdownlint-disable-file MD033 -->

scripts/vms/README.md

@@ -13,14 +13,14 @@ This folder contains directories making use of [Vagrant](https://www.vagrantup.c
 
 ### Setup VM
 
-1. `cd` into `ubuntu`
+1. `cd` into `{vmdir}`, e..g, `cd ubuntu`
 2. Start the vm `vagrant up`
-3. Store ssh configuration: `vagrant ssh-config > default`
+3. Linux machines: Store ssh configuration: `vagrant ssh-config > default`
 
 ### Use VM
 
 You can use the UI offered by the VirtualBox client.
-You can also do `ssh -Y -F vagrant-ssh default` to SSH into the machine.
+On Linux, you can also do `ssh -Y -F vagrant-ssh default` to SSH into the machine.
 
 If asked for a password, this is `vagrant`.
 
@@ -31,8 +31,12 @@ Then, everything is removed.
 
 ## Available VMs
 
-- `ubuntu`: Ubuntu with JabRef snap and libreoffice-connection pre-installed. One has to install the [JabRef Browser Extension](https://addons.mozilla.org/en-US/firefox/addon/jabref/) manually.
-- `fedora`: Fedora 39 with KDE plasma and JDK. During the build, the JabRef sources will be fetched and an initial build will be triggered. Login and then type `startx`. Now KDE Plasma should start. Open Konsole. Then `cd jabref`. Then `./gradlew run`.
+| VM                                              | JabRef  | Browser | LibreOffice |
+|-------------------------------------------------|---------|---------|-------------|
+| [`fedora`](fedora/)                             | source  | --      | --          |
+| [`Linux Mint (Cinnamon)`](linux-mint-cinnamon/) | source  | Firefox | yes         |
+| [`ubuntu`](ubuntu/)                             | snap    | Firefox | yes         |
+| [`windows`](windows/)                           | source  | Edge    | --          |
 
 ## Troubleshooting
 

scripts/vms/fedora/README.md

@@ -0,0 +1,6 @@
+# Fedora VM
+
+Fedora 39 with KDE plasma and JDK.
+During the build, the JabRef sources will be fetched and an initial build will be triggered.
+
+Login and then type `startx`. Now KDE Plasma should start. Open Konsole. Then `cd jabref`. Then `./gradlew run`.

scripts/vms/linux-mint-cinnamon/README.md

@@ -0,0 +1,23 @@
+# Linux Mint Cinnamon VM
+
+[Linux Mint](https://linuxmint.com/) with JabRef snap and libreoffice-connection pre-installed.
+
+Uses <https://portal.cloud.hashicorp.com/vagrant/discover/aaronvonawesome/linux-mint-21-cinnamon>.
+
+Start JabRef by following steps:
+
+- 1. Open termminal
+- 2. `cd jabref`
+- 3. `./gradlew run`
+
+## Alternative
+
+We could have build our own image.
+First creating an image using packer with <https://github.com/rmoesbergen/packer-linuxmint>.
+Then, building a `Vagrantfile` on top of it.
+Seemed to be too much issues for the users.
+
+1. Install packer
+2. `packer plugins install github.com/hashicorp/virtualbox`
+3. `packer plugins install github.com/hashicorp/vagrant`
+4. `packer build -var-file=mint-cinnamon-22.json core_template.json`

scripts/vms/linux-mint-cinnamon/Vagrantfile

@@ -0,0 +1,33 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+
+  # https://portal.cloud.hashicorp.com/vagrant/discover/aaronvonawesome/linux-mint-21-cinnamon
+  config.vm.box = "aaronvonawesome/linux-mint-21-cinnamon"
+  config.vm.box_version = "4.0.1"
+
+  config.vm.network :forwarded_port, guest: 80, host: 8080, auto_correct: true
+
+  config.vm.provider "virtualbox" do |v|
+    v.name = "jabref-linux-mint-cinnamon"
+    v.gui = true
+    v.customize ["modifyvm", :id, "--memory", "2048", "--cpus", "2"]
+  end
+
+  config.vm.provision "shell", inline: <<-SHELL
+    sudo apt-get install -y git
+  SHELL
+
+  config.vm.provision "shell", privileged: false, inline: <<-SHELL
+    curl -s "https://get.sdkman.io" | bash
+    source "$HOME/.sdkman/bin/sdkman-init.sh"
+    sdk install java 21.0.4-tem < /dev/null
+    git clone --recurse-submodules https://github.com/JabRef/jabref.git
+    cd jabref
+    sdk use java 21.0.4-tem
+    ./gradlew jar
+  SHELL
+
+  config.ssh.forward_x11 = true
+end

scripts/vms/ubuntu/README.md

@@ -0,0 +1,5 @@
+# Ubuntu VM
+
+Ubuntu with JabRef snap and libreoffice-connection pre-installed.
+
+One has to install the [JabRef Browser Extension](https://addons.mozilla.org/en-US/firefox/addon/jabref/) manually.

scripts/vms/ubuntu/Vagrantfile

@@ -28,17 +28,18 @@ Vagrant.configure("2") do |config|
     v.customize ["modifyvm", :id, "--memory", "2048", "--cpus", "2"]
   end
 
-  # Update package index
-  config.vm.provision "shell", inline: "sudo apt-get update"
-  config.vm.provision "shell", inline: "sudo apt-get upgrade -y"
-
-  # Install latest development build of JabRef
-  config.vm.provision "shell", inline: "sudo snap install --edge jabref"
-
-  # Enable LibreOffice connection
-  config.vm.provision "shell", inline: "sudo apt-get install -y libreoffice-java-common"
-  config.vm.provision "shell", inline: "sudo mkdir -p /usr/lib/mozilla/native-messaging-hosts"
-  config.vm.provision "shell", inline: "snap connect jabref:hostfs-mozilla-native-messaging-jabref"
+  config.vm.provision "shell", inline: <<-SHELL
+    # Update package index
+    sudo apt-get update
+    sudo apt-get upgrade -y
+
+    # Install latest development build of JabRef
+    sudo snap install --edge jabref
+
+    sudo apt-get install -y libreoffice-java-common
+    sudo mkdir -p /usr/lib/mozilla/native-messaging-hosts
+    snap connect jabref:hostfs-mozilla-native-messaging-jabref
+  SHELL
 
   config.ssh.forward_x11 = true
 end

scripts/vms/windows/README.md

@@ -0,0 +1,49 @@
+# Windows VM
+
+A Windows-based VM to test JabRef.
+As user, you need to ensure to have the proper Windows license to use this VM.
+
+In case you have many CPU cores, you can adapt `vb.cpus` in `Vagrantfile` to a higher number.
+
+One has to install the [JabRef Browser Extension](https://addons.mozilla.org/en-US/firefox/addon/jabref/) manually.
+
+## Troubleshooting
+
+### "Waiting for machine to reboot..."
+
+In case Vagrant reports "Waiting for machine to reboot..." and nothing happens, one has to "power off" the machine, execute `vagrant destory`, and then run `vagrant up` again.
+
+### `fatal: early EOF`
+
+```console
+jabref-windows-sandbox: Cloning into 'jabref'...
+jabref-windows-sandbox: error: RPC failed; curl 92 HTTP/2 stream 5 was not closed cleanly: CANCEL (err 8)
+jabref-windows-sandbox: error: 6846 bytes of body are still expected
+jabref-windows-sandbox: fetch-pack: unexpected disconnect while reading sideband packet
+jabref-windows-sandbox: fatal: early EOF
+jabref-windows-sandbox: fatal: fetch-pack: invalid index-pack output
+```
+
+The `git clone` command did not work.
+
+Login, open `cmd` and then execute following commands:
+
+```cmd
+git clone --recurse-submodules https://github.com/JabRef/jabref.git
+cd jabref
+gradlew run
+```
+
+## Background
+
+`Vagrantfile` is based on [SeisoLLC/windows-sandbox](https://github.com/SeisoLLC/windows-sandbox/tree/main).
+
+The most use image seems to be the [Windows 10 image by `gusztavvargadr`](https://portal.cloud.hashicorp.com/vagrant/discover/gusztavvargadr/windows-10).
+List of all images at <https://portal.cloud.hashicorp.com/vagrant/discover/gusztavvargadr>.
+
+[Chocolatey](https://chocolatey.org/) is used instead of [winget-cli](https://learn.microsoft.com/en-us/windows/package-manager/), because Chocolatey installation does not hit GitHub's rate limits during unattended installation.
+
+## Atlernatives
+
+- Atlernative Vagrant images: <https://app.vagrantup.com/boxes/search?q=windows+10&utf8=%E2%9C%93>.
+- [Windows Sandbox](https://learn.microsoft.com/en-us/windows/security/application-security/application-isolation/windows-sandbox/windows-sandbox-overview)

scripts/vms/windows/Vagrantfile

@@ -0,0 +1,47 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+NAME = "jabref-windows-sandbox"
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "gusztavvargadr/windows-10"
+  config.vm.box_url = "https://app.vagrantup.com/gusztavvargadr/boxes/windows-10"
+  config.vm.hostname = NAME
+
+  config.vm.provider "virtualbox" do |vb|
+    vb.name = NAME
+
+    vb.memory = 6000
+    vb.cpus = 2
+
+    vb.customize ['modifyvm', :id, '--clipboard-mode', 'bidirectional']
+    vb.gui = true
+  end
+
+  config.vm.provision "shell", privileged: "true", powershell_elevated_interactive: "true", inline: <<-SHELL
+    # Install chocolatey
+    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
+    choco feature enable -n=allowGlobalConfirmation
+
+    choco install libericajdk
+    choco install git.install -y --params "/GitAndUnixToolsOnPath /WindowsTerminal /WindowsTerminalProfile"
+
+    # Required by AI functionaltiy
+    choco choco install vcredist140
+
+    # choco install firefox
+    # choco install libreoffice-fresh
+  SHELL
+
+  config.vm.provision "shell", reboot: true
+
+  config.vm.provision "shell", privileged: "false", inline: <<-SHELL
+    cd \\users\\vagrant
+    git clone --recurse-submodules https://github.com/JabRef/jabref.git
+    # cd jabref
+    # .\\gradlew jar
+  SHELL
+
+  # Used to set the Vagrant machine name
+  config.vm.define NAME do |t|
+  end
+end