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

Re-introduce CitationKey column as default in the entry (main) table #10510

Closed
Siedlerchr opened this issue Oct 16, 2023 · 17 comments · Fixed by #12080
Closed

Re-introduce CitationKey column as default in the entry (main) table #10510

Siedlerchr opened this issue Oct 16, 2023 · 17 comments · Fixed by #12080
Assignees
Labels
FirstTimeCodeContribution Triggers GitHub Greeter Workflow good first issue An issue intended for project-newcomers. Varies in difficulty. maintable type: enhancement

Comments

@Siedlerchr
Copy link
Member

Siedlerchr commented Oct 16, 2023

The main/entry table should show the column citation key by default.

internal issue for refefence:
https://github.com/JabRef/jabref-issue-melting-pot/issues/305

Currently, this has to be manually activated using the preferences by adding the field "citationkey" (internal)

grafik

It should be added as default value in the preferences. It should be coming before entrytype and it should have a decent width.

defaults.put(COLUMN_NAMES, "groups;files;linked_id;field:entrytype;field:author/editor;field:title;field:year;field:journal/booktitle;special:ranking;special:readstatus;special:priority");
defaults.put(COLUMN_WIDTHS, "28;28;28;75;300;470;60;130;50;50;50");

To test, you can reset your preferences and restart JabRef. Then the column should be visible

@Siedlerchr Siedlerchr added type: enhancement good first issue An issue intended for project-newcomers. Varies in difficulty. labels Oct 16, 2023
@u7288020
Copy link

Hi there,

I am new to open source contribution and would love to contribute to this issue. Could you please assign it to me? I'll try my best to resolve the problem - If you have any specific information or steps you'd like me to follow, please feel free to share them.

Thank you!

@tobiasdiez
Copy link
Member

I think we removed it since normally it doesn't contain any new information (by default it's authors + year) and users almost never need it (you don't want to copy the key manually but use right click, copy key).

@Siedlerchr
Copy link
Member Author

@tobiasdiez please see the linked issue. @koppor made clear why it should be there

@ThiloteE
Copy link
Member

I don't have a strong opinion on this. Our user-base is still largely bibtex/biblatex based, so whatever. It is now easier to remove unwanted columns from the entry table by right-clicking on the column, so this should be no biggy.
image
Once we have more CSL styles, and hence a growth in users and contributors from OpenOffice/LibreOffice, this issue might become slightly more controversal, but for now, whatever.

@ThiloteE
Copy link
Member

By the way, one should not have to refer to a non-open issue from "issue-melting-pot" to justify ones proposal. IMHO, all relevant info should be public.

For context, this was the original issue:

Default configuration:

grafik

I get following warnings in bibtex:

Warning--empty journal in Hejda2023
Warning--empty journal in Veytsman2020

I could find the entry for searching the key. However, I could also sort the column. I can also use my eyes to follow the entry table. - In general, the entry table provides an overview of entries. My claim: i) Users are interested in a subset of the entries displayed in the entry table and ii) are using the citation keys in LaTeX and check these keys in the entry table. This makes the keys an integal part, which should be shown.

I agree that for "modern" interfaces (such as JabRefOnline or CiteDrive), other approaches might be taken. Our focus is still BibTeX and a unique key is a key part of BibTeX

After the change:

grafik


Manual config:

grafik

@koppor
Copy link
Member

koppor commented Oct 17, 2023

I wrote more than 100 papers, my library is more than 1000 entries large. I lead research groups. I worked with dozens of LaTeX newcomers. I discussed with LaTeX experts at the TUG user group. This needs to be implemented. No work arounds

Research groups do not change their citation keys to something JabRef wants; they have their own way. - The sort order of the table is sometimes hard.

@Siedlerchr
Copy link
Member Author

@ThiloteE Copying images fromt he private repo does not work, you need to reupload them

@tobiasdiez
Copy link
Member

tobiasdiez commented Oct 17, 2023

This is how jabref looks like on a normal-sized laptop screen in fullscreen with the default config:
image

Already pretty full. Which column do you want to remove to make space for the citation key?

@tobiasdiez
Copy link
Member

For context, the same arguments were brought forward in the PR that removed the citation key column: #7286. And as far as I can see no user complained in the past 2.5 years.

@Siedlerchr
Copy link
Member Author

What about adding this to the right click menu? as a simple option

@koppor
Copy link
Member

koppor commented Oct 22, 2023

Thank you for the link! #7286

Hiding a column is possible via right-click menu, thus shrinking is easy. Enlarging is currently an issue. The default configuration should be good. - I am talking to persons not using JabRef anymore or at all - and the confusion with BibTeX keys not shown in the UI is one reason.

@JabRef JabRef deleted a comment from github-actions bot Apr 8, 2024
@koppor koppor removed the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Apr 8, 2024
@jiaxin0103
Copy link

Hello, I am a student at the Australian National University. For our team project, we need to contribute to an open-source project. May I be assigned to this task?

@koppor koppor added the FirstTimeCodeContribution Triggers GitHub Greeter Workflow label Oct 14, 2024
Copy link
Contributor

Welcome to the vibrant world of open-source development with JabRef!

Newcomers, we're excited to have you on board. Start by exploring our Contributing guidelines, and don't forget to check out our workspace setup guidelines to get started smoothly.

In case you encounter failing tests during development, please check our developer FAQs!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on JabRef's Gitter chat. And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.

Happy coding! 🚀

@koppor
Copy link
Member

koppor commented Oct 14, 2024

@jiaxin0103 Thank you for your interest. The code should be easy. You also need to add an ADR document to the folder https://github.com/JabRef/jabref/tree/main/docs/decisions outlining the pros and cons of showing/not showing the citation key column as default. With discusisons linked.

@koppor
Copy link
Member

koppor commented Oct 14, 2024

It is good to have this in the alpha/beta release to be enabled to gather user feedback.

@suftware
Copy link
Contributor

Hi @koppor , I am part of the same group as @jiaxin0103 and am working on this issue - would I be able to be added as an assignee as well? Thank you!

@koppor
Copy link
Member

koppor commented Oct 19, 2024

@suftware @jiaxin0103 I assume, this is a one-line fix - and a line to the CHANGELOG.md. This issue guides you through the process to contribute to an open source project. Please complete this fast - and try to take another issue afterwards to really level-up your coding skills!

suftware added a commit to suftware/jabref that referenced this issue Oct 25, 2024
suftware added a commit to suftware/jabref that referenced this issue Oct 25, 2024
github-merge-queue bot pushed a commit that referenced this issue Oct 25, 2024
* Add CitationKey to entry table default columns

Part of #10510

* Add note regarding #10510, default addition of CitationKey column

Part of #10510
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FirstTimeCodeContribution Triggers GitHub Greeter Workflow good first issue An issue intended for project-newcomers. Varies in difficulty. maintable type: enhancement
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

7 participants