Added support for (biblatex) `langid` to be an optional field in entry editor #12071

mag-sun · 2024-10-24T08:17:34Z

Overview:

Integrated 'langid' into all biblatex/bibtex supported entry types as an optional field. This is so formatting of entries can be adapted to the language of the entries. Closes #10868.

Changes implemented:

Added a 'Langid' enum class defining all valid language ids provided by the biblatex documentation ([https://au.mirrors.cicku.me/ctan/macros/latex/contrib/biblatex/doc/biblatex.pdf]).
Added a 'LanguageEditorViewModel' class to handle the gui and dropdown menu.
Introduced 'langid' as an important field in all relevant biblatex entry type definitions.

langid.video.mp4

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.

… into gui and program logic

…en integrated.

koppor

Initial comments.

Please re-iterate on the biblatex smanual and check whether language and origLanguage also have the same values. If yes, your editor can be used if the field proprty FieldProperty.LANGUAGE langauge is present. If not, then this property can just be remoed.

In other words FieldPropety groups fields together and indicates the editor for it. Do not introduce a property if it used for one field only.

CHANGELOG.md

gradle.properties

src/main/java/org/jabref/gui/fieldeditors/optioneditors/LangidEditorViewModel.java

src/main/java/org/jabref/logic/msbib/MSBibEntry.java

src/main/java/org/jabref/model/entry/Langid.java

src/main/java/org/jabref/model/entry/field/FieldProperty.java

src/test/java/org/jabref/model/entry/LangidTest.java

- removed redundant description in CHANGELOG.md - removed unnecessary gradle properties - removed unnecessary tests - fixed formatting/commented out code

gradle.properties

src/test/java/org/jabref/model/entry/LangidTest.java

koppor

Tests are a bit too verbose and not confirming to the one-assertion-per-test rule. Please streamline.

Other comments inside.

src/main/java/org/jabref/model/entry/types/BibtexEntryTypeDefinitions.java

src/main/java/org/jabref/gui/fieldeditors/optioneditors/LangidEditorViewModel.java

src/main/java/org/jabref/model/entry/field/StandardField.java

src/test/java/org/jabref/gui/fieldeditors/optioneditors/LangidEditorViewModelTest.java

CHANGELOG.md

Co-authored-by: Oliver Kopp <[email protected]>

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
The tool reviewdog already placed comments on GitHub to indicate the places. See the tab "Files" in you PR.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

You can check review dog's comments at the tab "Files changed" of your pull request.

…ing: - refactored and renamed LangidEditorViewModel.java to LanguageEditorViewModel (and tests) - re-added gradle property - reverted edits to BibtexEntryTypeDefinitions.java - removed FieldProperty.LANGUAGEID so both language and langid standard fields have FieldProperty.LANGUAGE NB: Still yet to fix tests

…into 10868-support-for-langid-field # Conflicts: # gradle.properties

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
The tool reviewdog already placed comments on GitHub to indicate the places. See the tab "Files" in you PR.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

You can check review dog's comments at the tab "Files changed" of your pull request.

koppor

Minor comments.

Tests have to be rewritten to fit JabRef style.

No text for failing assertions.

gradle.properties

src/main/java/org/jabref/model/entry/Langid.java

src/test/java/org/jabref/gui/fieldeditors/optioneditors/LanguageEditorViewModelTest.java

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

github-actions

Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

obsolete now

* upstream/main: New Crowdin updates (#12264) New Crowdin updates (#12263) 11219 adapt UI font size (#12042) Added support for (biblatex) `langid` to be an optional field in entry editor (#12071) improve unlinked files dialog (#12195) Reword 0034-use-citation-key-for-grouping-chat-messages.md (#12183) Bump dev.langchain4j:langchain4j-open-ai from 0.36.0 to 0.36.2 (#12259) Bump io.zonky.test.postgres:embedded-postgres-binaries-bom (#12258) Bump tech.units:indriya from 2.2 to 2.2.1 (#12257) Bump org.jetbrains.kotlin:kotlin-stdlib-jdk8 from 2.0.21 to 2.1.0 (#12256) Bump io.github.classgraph:classgraph from 4.8.177 to 4.8.179 (#12255) Bump src/main/resources/csl-styles from `b90b81a` to `6b7b611` (#12254) Add hints on research (and BibTeX) to README.md (#12253) Disable non-working Openrewrite recipe always set maximized to false on exit for mac (#12248)

mag-sun added 5 commits October 15, 2024 00:10

Configured project and started integrating langid into classes

bf270cc

Successfully integrated a langid dropdown menu with all langid values…

3d21f10

… into gui and program logic

Fixed style in tests

08eaec7

Introduced display name to Langid enum and wrote more tests

203ad3b

Updated CHANGELOG.md to reflect that the langid optional field has be…

5aa170a

…en integrated.

koppor requested changes Oct 24, 2024

View reviewed changes

Updated files in accordance to feedback from maintainers, including:

5611bf7

- removed redundant description in CHANGELOG.md - removed unnecessary gradle properties - removed unnecessary tests - fixed formatting/commented out code

Siedlerchr reviewed Oct 25, 2024

View reviewed changes

gradle.properties Outdated Show resolved Hide resolved

Siedlerchr requested changes Oct 25, 2024

View reviewed changes

src/test/java/org/jabref/model/entry/LangidTest.java Outdated Show resolved Hide resolved

koppor added 2 commits October 27, 2024 02:00

Merge branch 'main' into 10868-support-for-langid-field

b459a05

Discard changes to gradle.properties

2b0f8a5

koppor requested changes Oct 27, 2024

View reviewed changes

Update langid field entry in CHANGELOG.md

7aa34d7

Co-authored-by: Oliver Kopp <[email protected]>

github-actions bot reviewed Oct 27, 2024

View reviewed changes

mag-sun added 3 commits October 27, 2024 18:02

Merge remote-tracking branch 'origin/10868-support-for-langid-field' …

1e7a04e

…into 10868-support-for-langid-field # Conflicts: # gradle.properties

re-added gradle parallel property

ac09f53

github-actions bot reviewed Oct 27, 2024

View reviewed changes

koppor previously requested changes Oct 27, 2024

View reviewed changes

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

Merge branch 'main' into 10868-support-for-langid-field

eaaa99e

github-actions bot reviewed Dec 1, 2024

View reviewed changes

cleanup

bed03f9

Siedlerchr marked this pull request as ready for review December 1, 2024 16:05

Siedlerchr added status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers and removed status: changes required Pull requests that are not yet complete labels Dec 1, 2024

use set

401f747

Siedlerchr previously approved these changes Dec 1, 2024

View reviewed changes

github-actions bot reviewed Dec 1, 2024

View reviewed changes

checkstyle

3768c7e

Siedlerchr dismissed their stale review via 3768c7e December 1, 2024 16:35

github-actions bot reviewed Dec 1, 2024

View reviewed changes

Siedlerchr added 2 commits December 1, 2024 17:57

disable test rule

ac4d473

apply rules

42e4577

Siedlerchr previously approved these changes Dec 1, 2024

View reviewed changes

Siedlerchr added 2 commits December 1, 2024 18:15

revert junit recipe

005ab1a

merge

86187ac

Siedlerchr dismissed their stale review via 86187ac December 1, 2024 17:16

Siedlerchr approved these changes Dec 1, 2024

View reviewed changes

Siedlerchr enabled auto-merge December 1, 2024 17:17

Siedlerchr added this pull request to the merge queue Dec 2, 2024

Merged via the queue into JabRef:main with commit d9b38ce Dec 2, 2024
23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for (biblatex) `langid` to be an optional field in entry editor #12071

Added support for (biblatex) `langid` to be an optional field in entry editor #12071

mag-sun commented Oct 24, 2024 •

edited

Loading

koppor left a comment

koppor left a comment

github-actions bot left a comment

github-actions bot left a comment

koppor left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

Added support for (biblatex) langid to be an optional field in entry editor #12071

Added support for (biblatex) langid to be an optional field in entry editor #12071

Conversation

mag-sun commented Oct 24, 2024 • edited Loading

Overview:

Changes implemented:

Mandatory checks

koppor left a comment

Choose a reason for hiding this comment

koppor left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

koppor left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

Added support for (biblatex) `langid` to be an optional field in entry editor #12071

Added support for (biblatex) `langid` to be an optional field in entry editor #12071

mag-sun commented Oct 24, 2024 •

edited

Loading