diff --git a/en/.gitbook/assets/preferences-autosave.png b/en/.gitbook/assets/preferences-autosave.png index 17966b9a4..791d1063b 100644 Binary files a/en/.gitbook/assets/preferences-autosave.png and b/en/.gitbook/assets/preferences-autosave.png differ diff --git a/en/SUMMARY.md b/en/SUMMARY.md index 9a69c3759..83b68ad0e 100644 --- a/en/SUMMARY.md +++ b/en/SUMMARY.md @@ -74,7 +74,7 @@ * [URL and DOI links in JabRef](advanced/externalfiles.md) * [OCR](advanced/OCR.md) * [Command line use and options](advanced/commandline.md) - * [Automatic Backup (.sav and .bak) and Autosave](advanced/autosave.md) + * [Automatic backup (.sav and .bak) and synchronization](advanced/autosave.md) * [XMP metadata support in JabRef](advanced/xmp.md) * [Remote operation](advanced/remote.md) * [Custom themes](advanced/custom-themes.md) diff --git a/en/advanced/autosave.md b/en/advanced/autosave.md index 7676e8e28..55aae34a0 100644 --- a/en/advanced/autosave.md +++ b/en/advanced/autosave.md @@ -1,4 +1,4 @@ -# Automatic Backup (.sav and .bak) and Autosave +# Automatic backup (.sav and .bak) and synchronization {% hint style="info" %} Changelog:\ @@ -13,6 +13,9 @@ Major rework and a change in what .bak and .sav denote. Henceforth,\ JabRef 5.1\ To reduce the amount of configuration options, the possibility to disable the creation of `.bak` files was removed.\ \ +JabRef 6.0\ +Automatic merging of external changes: changes made to the library file outside JabRef are merged into the open library, per library or as a global default.\ +\ JabRef 3.7\ First introduction of the autosave and backup features.\ `.sav` is the automatic backup feature.\ @@ -63,14 +66,23 @@ For shared remote libraries and more advanced history, we recommend to use [git * **Mac OS X:** \ `/Users/username/Library/Application Support/org.jabref/jabref` -## Automatic saving of the current library +## Automatic saving and merging of external changes + +JabRef can keep a local library and its `.bib` file the same in both directions. Two options control this, both off unless you enable them: + +* **Autosave local libraries** (Preferences → General → Saving): changes you make in JabRef are saved to the `.bib` file automatically. No need to click on File → Save or to press Ctrl+S anymore. +* **Automatically merge external changes**: changes another program makes to the `.bib` file (a text editor, a `git pull`, a cloud synchronization client) are merged into the open library automatically. A short notification reports how many changes were merged. If the same entry was also edited in JabRef, the fields changed on disk are still taken over. JabRef only asks you to review external changes when they collide with your own unsaved edits: the same field changed differently in JabRef and in the file, or an entry deleted on one side and changed on the other. The "External changes detected" notification then offers a review of only those items. + +Automatic merging is decided per library: open Library → Library properties → Saving and choose **On** or **Off** for **Automatically merge external changes**. A library set to **Use global setting** follows the preference of the same name in Preferences → General → Saving, which is off by default. The per-library choice is stored in the `.bib` file, so it travels with the library. + +When automatic merging is off, JabRef reports every external change with the "External changes detected" notification and leaves it to you to review or dismiss them. -JabRef offers **automatic saving of the library.** No need to click on File --> Save or pressing Ctrl+S anymore: The opened database are saved automatically without manual intervention. +### Conflicted copies of sync clients -In case the `.bib` file should automatically be saved on each change, you can direct JabRef to do so. This feature needs to be activated in the preferences: +When the library lives in a folder synchronized by Dropbox, Nextcloud, ownCloud, OneDrive, or Syncthing and two machines change it between two syncs, the sync client keeps one version as a "conflicted copy" next to the library (for example `library (conflicted copy 2026-09-03).bib`). With automatic merging enabled and **Merge conflicted copies left by sync clients** switched on (per library in Library properties → Saving, or as the global default in Preferences → General → Saving; off by default), JabRef merges such a copy into the open library with the same rules: silently, unless the same item was changed differently in both. A "Conflicted copy merged" notification then offers to delete the copy; JabRef never deletes it on its own. Copies OneDrive names after another computer are not recognized, since any file with a `-Name` suffix could be an unrelated library.
-

Screenshot of the autosave preferences

+

Screenshot of the saving preferences