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

Add tooltips for all fields in the entry editor #5847

Closed
systemoperator opened this issue Jan 19, 2020 · 9 comments
Closed

Add tooltips for all fields in the entry editor #5847

systemoperator opened this issue Jan 19, 2020 · 9 comments
Labels
entry-editor good first issue An issue intended for project-newcomers. Varies in difficulty. type: feature ui

Comments

@systemoperator
Copy link
Contributor

systemoperator commented Jan 19, 2020

Since there are many different entry fields in the entry editor, it would be useful, if every field provided some tooltip when hovering a field or some tooltip which can be clicked next to the entry field.

Requirements:

  • A tooltip should contain detailed information for what this field is used.
  • A tooltip should describe which type of information should be entered into a field.
  • A tooltip should describe the required input format for the input field. In some cases different input formats are possible.
    • example: pages: One or more page numbers or range of numbers, such as 42-111 or 7,41,73-97 or 43+ (the ‘+’ in this last example indicates pages following that don’t form a simple range). BibTEX requires double dashes for page ranges (--).
  • Some dedicated input examples should also be listed, since examples are very intuitive and very easy to understand.
  • It should be mentioned whether the field is optional or not. Sometimes also only one out of several input fields is required (example: author or editor in biblatex entry type @Misc).
  • The information within a tooltip should be self-contained, without the need to look up other external documents and without being linked to other entry fields.
  • It should be implemented for all provided entry fields in the entry editor, also considering other tabs like Optional fields.
  • Depending on, whether bibtex or biblatex is enabled, different input fields are visible and the tooltip should depend on whether bibtex or biblatex is active.

If more information gets added to the tooltips, maybe the information could be structured in sections, split with new lines. Maybe extended tooltips are possible, which allow formatting texts using e.g. bold, underline, italic, etc.

Some (incomplete) inspiration:

@systemoperator systemoperator changed the title Add tooltip for all fields in the entry editor Add tooltips for all fields in the entry editor Jan 19, 2020
@tobiasdiez tobiasdiez added entry-editor type: feature good first issue An issue intended for project-newcomers. Varies in difficulty. ui labels Feb 1, 2020
@lglopezh
Copy link

Hello! I think I can do this, can I contribute? I´m totally new to open source projects.

@systemoperator
Copy link
Contributor Author

Hello! Yes, that would be great! :)

@lglopezh
Copy link

Thanks! I'm reading the Guidelines, I want to start ASAP

@systemoperator
Copy link
Contributor Author

systemoperator commented Feb 14, 2020

A library can be configured with either bibtex or biblatex.

You might find the following documents useful:

@lglopezh
Copy link

Thanks!

@lglopezh
Copy link

lglopezh commented Mar 2, 2020

Sorry guys! I can't find where all fields are created, my progress is practically zero.

@lglopezh
Copy link

lglopezh commented Mar 2, 2020

Oh! Someone did it already.

@tobiasdiez
Copy link
Member

Thanks to @ShikunXiong this is now implemented in the latest development version. Could you please check the build from http://builds.jabref.org/master/. Thanks! Please remember to make a backup of your library before trying-out this version.

@lglopezh Don't be too upset! We have a bunch of nice issues that are just waiting to be attacked: good first issue An issue intended for project-newcomers. Varies in difficulty.

@lglopezh
Copy link

I'm not upset, hehe.

Let me see other issues, thanks.

koppor pushed a commit that referenced this issue Jan 17, 2022
0237ae7 Update journal-fur-kulturpflanzen-journal-of-cultivated-plants.csl (#5848)
ca87cf0 Use container-title for newspaper/magazine articles w/o author (#5847)
1455165 add medium to IEEE (#5846)

git-subtree-dir: buildres/csl/csl-styles
git-subtree-split: 0237ae7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
entry-editor good first issue An issue intended for project-newcomers. Varies in difficulty. type: feature ui
Projects
None yet
Development

No branches or pull requests

3 participants