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.

Sign up for GitHub

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

Jump to bottom

Adds the ability to specify [camelN] as a title-related field marker for citation key generation #10772

Merged
merged 12 commits into from
Feb 19, 2024
Merged

Adds the ability to specify [camelN] as a title-related field marker for citation key generation #10772

merged 12 commits into from
Feb 19, 2024

Conversation

mkdjr
Copy link
Contributor

@mkdjr mkdjr commented Jan 12, 2024 •
edited
Loading

Adds the ability to specify [camelN] as a title-related field marker for citation key generation. This is identical to [camel] but with a maximum of N words.

Related documentation pull request: JabRef/user-documentation#481 (was JabRef/user-documentation#478 but I changed the fork's branch name).

This is my first time making a pull request that is not just a typo fix, so any feedback is welcomed. : )

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.

@mkdjr
add camelShort citation key marker
4f1d362 
Add the ability to set a citation key marker `camelShort` that is identical to the `camel` marker but with a maximum of 7 words.
@mkdjr
change name to shortcamel
45e22cb 
change name to `shortcamel` to match current naming scheme
@mkdjr mkdjr changed the title [WIP] [WIP] Adds the ability to specify [shortcamel] as a title-related field marker for citation key generation Jan 12, 2024
@mkdjr mkdjr mentioned this pull request Jan 12, 2024
Closed
@Siedlerchr
Copy link
Member

Siedlerchr commented Jan 12, 2024 •
edited
Loading

Thank you very much for your contribution, I like the idea, but however, I think instead of arbitrarily limiting it to 7 words, it may be useful to specify a parameter with the number of characters, e.g. how it's done by keywordN

PS: For general development check out https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/

@Siedlerchr Siedlerchr added FirstTimeCodeContribution Triggers GitHub Greeter Workflow and removed FirstTimeCodeContribution Triggers GitHub Greeter Workflow labels Jan 12, 2024
@Siedlerchr
Copy link
Member

@mkdjr It would be really nice if you could continue workin on this feature. Is there anything we can help you with?

@mkdjr
Copy link
Contributor Author

mkdjr commented Jan 25, 2024

I will let you know! Things have been busy this week -- I'd like to keep working on it this weekend.

@mkdjr mkdjr changed the title [WIP] Adds the ability to specify [shortcamel] as a title-related field marker for citation key generation [WIP] Adds the ability to specify [camelN] as a title-related field marker for citation key generation Feb 19, 2024
@mkdjr mkdjr mentioned this pull request Feb 19, 2024
Merged
@mkdjr
Copy link
Contributor Author

mkdjr commented Feb 19, 2024

Finally got around to finishing this request! I set up the dev environment with IntelliJ per the contributing docs. I liked your suggestion of having the pattern work like keywordN, shortCamel is now camelN. I updated the docs too (I submitted a new PR because I changed the forked repo's branch name, so that's linked above).

@Siedlerchr
Copy link
Member

Thanks, that already looks good so far. I will take a closer look later. +1 for adding a test!

@Siedlerchr Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Feb 19, 2024
@Siedlerchr Siedlerchr added this pull request to the merge queue Feb 19, 2024
Merged via the queue into JabRef:main with commit 35316f8 Feb 19, 2024
21 checks passed
@calixtus calixtus changed the title [WIP] Adds the ability to specify [camelN] as a title-related field marker for citation key generation Adds the ability to specify [camelN] as a title-related field marker for citation key generation Feb 19, 2024
Siedlerchr added a commit to shawn-jj/jabref that referenced this pull request Feb 26, 2024
@Siedlerchr
Merge remote-tracking branch 'upstream/main' into fix-for-issue-10509
cef4f9c 
* upstream/main: (22 commits)
  Bump com.github.andygoossens.modernizer from 1.9.0 to 1.9.2 (JabRef#10922)
  Bump com.dlsc.gemsfx:gemsfx from 1.97.0 to 2.0.3 (JabRef#10923)
  Bump org.apache.logging.log4j:log4j-to-slf4j from 2.22.1 to 2.23.0 (JabRef#10921)
  Added missing changelog entry for JabRef#10912
  Change the popup to enter types to the combo box for custom entry types (JabRef#10912)
  Add JDK EA build (JabRef#10904)
  Fix Broken Links (JabRef#10899)
  Add HTML2MD conversion to abstract and comment fields (JabRef#10896)
  docs: Fixed URLs and corrected typos (JabRef#10900)
  Add refresh button for LaTeX citations. (JabRef#10901)
  Farewell btut 👋 (JabRef#10905)
  Fix: About OOError, Alternatives section not visible (JabRef#10902)
  Update code-quality.md
  Fix documentation issues: Sourcegraph URL and method name (JabRef#10898)
  Removed mainapplication layer (JabRef#10895)
  Update check-links.yml (JabRef#10897)
  [WIP] Adds the ability to specify [camelN] as a title-related field marker for citation key generation (JabRef#10772)
  Bump com.dlsc.gemsfx:gemsfx from 1.92.0 to 1.97.0 (JabRef#10894)
  Bump org.openrewrite.recipe:rewrite-recipe-bom from 2.6.3 to 2.6.4 (JabRef#10892)
  Bump org.junit.platform:junit-platform-launcher from 1.10.1 to 1.10.2 (JabRef#10893)
  ...

# Conflicts:
#	src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Siedlerchr Siedlerchr Siedlerchr approved these changes

Assignees
No one assigned
Labels
FirstTimeCodeContribution Triggers GitHub Greeter Workflow status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mkdjr @Siedlerchr