Skip to content
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.

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

Already on GitHub? Sign in to your account

LWTA abbreviation support #12107

Closed
wants to merge 6 commits into from
Closed

Conversation

Thomas-Bridgart
Copy link

See issue #12273 (https://github.com/koppor/jabref/issues/215)

Currently I've written the code to read the .csv file containing all lwta abbreviations, and to abbreviate a journal name. I note the following problems with what I've written:

-- it doesn't work properly on some edge cases of lwta abbreviations (occasionally, the standard requires context clues -- e.g. distinguishing between 'real' (english) and 'real' (spanish), or how '&' should be removed if it means 'and', but not in abbreviations)

-- lwta abbreviations require the elimination of articles and prepositions (in most cases), which here I've only implemented by writing a (currently very in-exhaustive) list of such.

-- I'm a little unsure of the class structure I've written for the implementation

Furthermore, it will not quite be possible to write a fully correct unabbreviate method, as the abbreviation is not quite injective.

If the above problems are deal-breakers, then I won't bother continuing to write the frontend / mvstore code (hence why this incomplete pr exists).

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 change is visible to the user)
  • 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.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

@Thomas-Bridgart Thomas-Bridgart marked this pull request as draft October 27, 2024 08:12
@Thomas-Bridgart
Copy link
Author

I'll remake this pr as one not from main, oops

@koppor
Copy link
Member

koppor commented Oct 27, 2024

@Thomas-Bridgart if you intend to work in this only, no need to recreate. Just be aware not to use the sync feature of the GitHub UI on your repo

@Thomas-Bridgart
Copy link
Author

That pr is #12109

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants