Skip to content

Describe the external changes review dialog #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
koppor wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Describe the external changes review dialog #664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions en/collaborative-work/sharedbibfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,14 @@
* Define a sort order \(`year`, `author`, `title` is recommended\)..
* Check `Enable save formatters`, and defines these actions, to help enforcing a consistent format for the entries.


## Reviewing external changes

When the `bib` file changes on disk while it is open, JabRef shows a notification "External changes detected" with two actions:

Check warning on line 18 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.TooWordy] 'it is' is too wordy.

Raw Output:
{"message": "[write-good.TooWordy] 'it is' is too wordy.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 18, "column": 43}}}, "severity": "WARNING"}

* **Dismiss changes** closes the notification. The next save overwrites the file with the in-memory library.
* **Review changes** opens the External Changes Resolver, listing every difference between the file on disk and the library in memory. Select a change and choose **Accept** (take the version from disk), **Deny** (keep the in-memory version), or **Merge...** (for modified entries: combine both versions field by field).

The dialog closes automatically once every change is resolved, and the decisions are applied to the library. If all changes were accepted, the library matches the file on disk and is not marked as changed; otherwise it is marked as changed and needs to be saved.

Check warning on line 23 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'be saved' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'be saved' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 23, "column": 254}}}, "severity": "WARNING"}

Check warning on line 23 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'is marked' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is marked' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 23, "column": 220}}}, "severity": "WARNING"}

Check warning on line 23 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.TooWordy] 'it is' is too wordy.

Raw Output:
{"message": "[write-good.TooWordy] 'it is' is too wordy.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 23, "column": 217}}}, "severity": "WARNING"}

Check warning on line 23 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'were accepted' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'were accepted' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 23, "column": 125}}}, "severity": "WARNING"}

Check warning on line 23 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'are applied' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'are applied' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 23, "column": 82}}}, "severity": "WARNING"}

Check warning on line 23 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'is resolved' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is resolved' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 23, "column": 51}}}, "severity": "WARNING"}

Closing the dialog before all changes are resolved applies nothing: the library stays as it was, and the notification remains so the review can be resumed later.

Check warning on line 25 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'be resumed' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'be resumed' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 25, "column": 145}}}, "severity": "WARNING"}

Check warning on line 25 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.TooWordy] 'it was' is too wordy.

Raw Output:
{"message": "[write-good.TooWordy] 'it was' is too wordy.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 25, "column": 90}}}, "severity": "WARNING"}

Check warning on line 25 in en/collaborative-work/sharedbibfile.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 馃惗
[write-good.Passive] 'are resolved' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'are resolved' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/sharedbibfile.md", "range": {"start": {"line": 25, "column": 39}}}, "severity": "WARNING"}
Loading