Rename General File Directory to Library-Specific File Directory #12037

tomeg09 · 2024-10-20T04:31:29Z

Describe the changes you have made here: what, why, ..

Per issue koppor#571, there was a request to rename "general file directory" to "Library-specific file directory". This has been updated in the following places:

Within the internal code: this has been renamed to "Library Specific File Directory" (or librarySpecificFileDirectory, LIBRARY_SPECIFIC_FILE_DIRECTORY, etc).
Within the test base: all associated tests where this has been updated have been changed (I have therefore declared that I "created tests" as the testing library may require PR approver's scrutiny.
A localisation for "Library-specific File Directory" was added for English. I have left the localisation for "General File Directory" in place. I have not added localisations for other languages.

Screenshots of the change reflected in the UI:

Documentation updates:
User Docs: see Docs PR#535
Developer Docs: this file makes reference to the general file directory and requires updating.

Lines in question are:

Library → Library properties, items General file directory, and User-specific file directory. (plus screenshot)

JabRef uses these 3 directories to search for the files: JabRef starts in the user-specific file directory, then the general file directory, and, finally, the main file directory

Either, each user can set his directory in the "Main file directory". In case the group also shares papers and thus there are two directories (the private one and a group-shared one), one can set a directory within the library (the "General file directory")

If no match is found, it uses the "General file directory" of the bib file. If that is not found, it uses the one configured at File → Preferences → Linked files.

It is also possible to achieve this result by setting . as "General file directory" in the library properties.

Relative file directories obviously only work in the library properties for a bib file, e.g. a.bib Library → Library properties → General file directory → papers.

Mandatory checks

I own the copyright of the code submitted and I licence it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

…to "Library File Directory"

… that were previously missed.

…c File Directory". Have followed convention for "User-Specific File Directory" where this is referred to outside of UI prompts as "Library File Directory"

koppor

I think the name of variables and UI text should be consistent. Please add “specific“ where appropriate!

src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesViewModel.java

koppor · 2024-10-20T15:08:54Z

src/main/java/org/jabref/model/database/BibDatabaseContext.java

        generalFileDirectory.ifPresent(fileDirs::add);

        // fileDirs.isEmpty() is true after these two if there are no directories set in the BIB file itself:
        //   1) no user-specific file directory set (in the metadata of the bib file) and
-        //   2) no general file directory is set (in the metadata of the bib file)
+        //   2) no library file directory is set (in the metadata of the bib file)


When reading this, I think. everywhere, the “-specific“ should be added. Also in constants, getters, ...

koppor · 2024-10-23T20:50:53Z

@tomeg09 Any chance to get my wish implemented soon? #12059 needs this change!

tomeg09 · 2024-10-24T01:50:37Z

@tomeg09 Any chance to get my wish implemented soon? #12059 needs this change!

@koppor - working on this now

…ary-specific File Directory'

…File Directory"

… library-specific file directory

…directory

1. removed unused general file directory key 2. made Library-specific file directory key all-lowercase per unit test requirements.

koppor

Looks good! Can you add a CHANGELOG.md entry, too?

tomeg09 · 2024-10-24T06:31:30Z

CHANGELOG.md

@@ -65,6 +65,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We changed instances of 'Search Selected' to 'Search Pre-configured' in Web Search Preferences UI. [#11871](https://github.com/JabRef/jabref/pull/11871)
 - We added a new CSS style class `main-table` for the main table. [#11881](https://github.com/JabRef/jabref/pull/11881)
 - When renaming a file, the old extension is now used if there is none provided in the new name. [#11903](https://github.com/JabRef/jabref/issues/11903)
+- We changed the name of the library-based file directory from 'General File Directory' to 'Library-specific File Directory' per issue [#571](https://github.com/koppor/jabref/issues/571)


@koppor I had already added a CHANGELOG.md entry. Please let me know if this needs to be adjusted.

Ah, my mobile client kind of hid it. Thank you for the quick note!

tomeg09 and others added 11 commits October 15, 2024 15:26

Change enum & localisation preferences from "General File Directory" …

6e15691

…to "Library File Directory"

change 'generalFileDirectory' to 'libraryFileDirectory' in codebase

4d200aa

change 'generalFileDirectory' to 'libraryFileDirectory' in test code

fea698a

Merge branch 'JabRef:main' into fix-naming

1226465

Merge branch 'JabRef:main' into fix-naming

5e6540c

Merge branch 'JabRef:main' into fix-naming

83e116e

Merge branch 'JabRef:main' into fix-naming

e9aa9d0

Merge branch 'JabRef:main' into fix-naming

42fbaed

change 'General file directory' to 'Library file directory' in places…

8c60495

… that were previously missed.

amendment to prior commits: should show up in GUI as "Library-specifi…

66a4c61

…c File Directory". Have followed convention for "User-Specific File Directory" where this is referred to outside of UI prompts as "Library File Directory"

update CHANGELOG.md to document activity in this branch.

92d65bb

koppor requested changes Oct 20, 2024

View reviewed changes

Merge branch 'JabRef:main' into rename-to-library-specific-directory

2f18413

koppor added the status: changes required Pull requests that are not yet complete label Oct 23, 2024

koppor mentioned this pull request Oct 23, 2024

Fix for issue 571: File folders: Move between global and user-specific #12059

Draft

7 tasks

tomeg09 added 4 commits October 24, 2024 12:59

Additional/missed locations: change 'General File Directory' to 'Libr…

336a4e8

…ary-specific File Directory'

Per Koppor's instructions: unify front/back end to "Library-specific …

83ee3bc

…File Directory"

update code comments to reflect change from library file directory to…

daa8090

… library-specific file directory

Merge branch 'refs/heads/fix-naming' into rename-to-library-specific-…

d302bb1

…directory

tomeg09 added a commit to tomeg09/jabref-user-documentation that referenced this pull request Oct 24, 2024

amended user docs per jabref PR JabRef/jabref#12037

18b4d2f

tomeg09 mentioned this pull request Oct 24, 2024

Amend user docs per code repo PR #12037 JabRef/user-documentation#535

Merged

updated en localisation per unit tests:

bd45c1d

1. removed unused general file directory key 2. made Library-specific file directory key all-lowercase per unit test requirements.

tomeg09 marked this pull request as ready for review October 24, 2024 02:58

tomeg09 requested a review from koppor October 24, 2024 02:58

koppor reviewed Oct 24, 2024

View reviewed changes

tomeg09 commented Oct 24, 2024

View reviewed changes

koppor approved these changes Oct 24, 2024

View reviewed changes

koppor added this pull request to the merge queue Oct 24, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 24, 2024

koppor added this pull request to the merge queue Oct 24, 2024

Merged via the queue into JabRef:main with commit 404394f Oct 24, 2024
23 checks passed

tomeg09 changed the title ~~WIP: Rename General File Directory to Library-Specific File Directory~~ Rename General File Directory to Library-Specific File Directory Oct 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename General File Directory to Library-Specific File Directory #12037

Rename General File Directory to Library-Specific File Directory #12037

tomeg09 commented Oct 20, 2024 •

edited

Loading

koppor left a comment

koppor Oct 20, 2024

koppor commented Oct 23, 2024

tomeg09 commented Oct 24, 2024

koppor left a comment

tomeg09 Oct 24, 2024 •

edited

Loading

koppor Oct 24, 2024

Rename General File Directory to Library-Specific File Directory #12037

Rename General File Directory to Library-Specific File Directory #12037

Conversation

tomeg09 commented Oct 20, 2024 • edited Loading

Mandatory checks

koppor left a comment

Choose a reason for hiding this comment

koppor Oct 20, 2024

Choose a reason for hiding this comment

koppor commented Oct 23, 2024

tomeg09 commented Oct 24, 2024

koppor left a comment

Choose a reason for hiding this comment

tomeg09 Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

koppor Oct 24, 2024

Choose a reason for hiding this comment

tomeg09 commented Oct 20, 2024 •

edited

Loading

tomeg09 Oct 24, 2024 •

edited

Loading