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

Limit group separator to one single character in Prefs->Entry Keyword Separator #10543

Merged
merged 9 commits into from
Oct 22, 2023

Conversation

colinldbd
Copy link
Contributor

@colinldbd colinldbd commented Oct 22, 2023

Fixes koppor#177 where Prefs dialog for groups should be adjusted that it is only possible to insert a single character as delimiter.

In EntryTab.java I used Text Formatter to limit the input to TextField Keyword Separator to only 1 character.

The original TextField for Keyword Separator in issue #177 Limit group separator:
image

However, the position of Keyword Separator has been moved to Preference->Entry, it's no longer in Preference->Group:
image

The current keyword separator is here:
image

Before, you can input string for whatever length into the keyword separator
image

But after the change, there's only one single character allowed:
image

I managed to create a TextFormatter for the TextField keywordSeparatr and limited the input string to one single character.

Mandatory checks

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

koppor and others added 5 commits October 22, 2023 21:29
Fixed issue JabRef#177  where Prefs dialog for groups should be adjusted that it is only possible to insert a single character as delimiter.

In EntryTab.java I used Text Formatter to limit the the input to Keyword Separator to only 1 character.
CHANGELOG.md Outdated
@@ -7,11 +7,11 @@ In case, there is no issue present, the pull request implementing the feature is

Note that this project **does not** adhere to [Semantic Versioning](https://semver.org/).

## [Unreleased]
## [Unreleased] – 2023-10-22
Copy link
Member

Choose a reason for hiding this comment

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

don't worry about this, there is another fix for this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

don't worry about this, there is another fix for this

Thanks for the reminder, I'm just worried why I can't pass the Markdown style check, but I guess for now it I don't need to do anything about it?

Copy link
Member

Choose a reason for hiding this comment

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

You need to worry a bit. The issue is quite clear:

 10:1  error  Unexpected additional part: ' – 2023-10-22'  entry-for-every-versions

An unreleased version has no release date - but you added one ^^. Just remove it again.

Please also merge latest main, which improved the CHANGELOG.md check - #10537

@colinldbd
Copy link
Contributor Author

colinldbd commented Oct 22, 2023

I'm so sorry about this but I just realized that my issue belongs to koppor/jabref
instead of
JabRef/jabref

Would that be a problem? I didn't realize there're 2 repo for this project.

You can close this pull-request if you want.

@Siedlerchr
Copy link
Member

No, this is correct. Fixes go here, just change the link

@colinldbd
Copy link
Contributor Author

No, this is correct. Fixes go here, just change the link

Thanks for the reply! Please feel free to review my PR and I'll make the revise if needed.

CHANGELOG.md Outdated
@@ -12,7 +12,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
### Added

### Changed

- WE changed the TextField for KeywordSeparator to only accepting 1 single character by using a TextFormatter in EntryTab.java so that Prefs dialog for groups should be adjusted that it is only possible to insert a single character as delimiter.[#177](https://github.com/koppor/jabref/issues/177)
Copy link
Member

Choose a reason for hiding this comment

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

I can tell you what the linter says: Missing empty lines.

See https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md for details.

@koppor
Copy link
Member

koppor commented Oct 22, 2023

There was a strange diff, therefore, 1e5af74 (#10543) and 6c06d90 (#10543) have been introduced.

@koppor
Copy link
Member

koppor commented Oct 22, 2023

I updated the CHANGELOG.md to be more end-user-oriented.

@koppor koppor enabled auto-merge October 22, 2023 22:46
@koppor
Copy link
Member

koppor commented Oct 22, 2023

@colinldbd We refined the overall commits a bit (there were strange updates in) and added the thing to the merge queue.

@koppor koppor added this pull request to the merge queue Oct 22, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 22, 2023
@koppor koppor merged commit 6c1b7a3 into JabRef:main Oct 22, 2023
17 checks passed
@ThiloteE
Copy link
Member

@colinldbd
To ease organizational workflows I have linked the pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request.

The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

Example:

  • Fix #xyz links pull-request to issue. Merging the PR will close the Issue.
  • Fix https://github.com/JabRef/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.
  • Fix https://github.com/Koppor/jabref/issues/xyz links pull-request to issue. Merging the PR will close the Issue.
  • Fix [#xyz](https://github.com/JabRef/jabref/issues/xyz) links pull-request to issue. Merging the PR will NOT close the Issue.

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.

Limit group separator to one single character in Prefs dialog
5 participants