Add tooltips for all entry types

[systemoperator]

When creating a new entry or when editing the entry type of an existing entry in a library, it would be useful, if tooltips describe each possible entry type.

The required content of the tooltips could be simply used from the following files:

• entry types in biblatex: http://mirror.easyname.at/ctan/macros/latex/contrib/biblatex/doc/biblatex.pdf (p. 8ff, 2.1 Entry Types)
• entry types in bibtex: http://mirror.kumi.systems/ctan/biblio/bibtex/base/btxdoc.pdf (p. 7ff, 3.1 Entry Types)

Requirements:

• A tooltip should contain detailed information for what this entry type is used.
• 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 types.

The tooltips could be added in the following areas:

• When the "Select entry type" dialog is opened (e.g. Library > New entry)
  • Hovering a button of an entry type should show the tooltip
• When changing the entry type in the entry editor. (left side of the entry editor)
  • Hovering an entry type in the list should show the tooltip
• When right clicking a reference in the main table and clicking Change entry type
  • Hovering an entry type in the list should show the tooltip

[dimitra-karadima]

I'd like to work on that.

[systemoperator]

@dimitra-karadima That would be really great! :)

[systemoperator]

@dimitra-karadima To probably boost your productivity a bit, you could maybe find it useful to grab some ideas from the code of the PR #6046. Simple textual (non-html) tooltips will be sufficient for this PR, thus the lengthy discussion of the linked PR is not that relevant for you. But feel free to implement it as you think it is best for you. :)

[dimitra-karadima]

@systemoperator Thank you for the additional tips. I will take everything into notice and see how it is going to work out in the end.

[dimitra-karadima]

Hey @systemoperator ,
I have been trying to implement the tooltip enhancement in the first option you described, when the "Select entry type" dialog is opened. All I have found is that the dialog box opens from the org.jabref.gui.importer.NewEntryAction.java and I tryied implementing a getDescription method as PR #6046 has. But my attempt failed, because the method setTooltip does not work for the NewEntryAction. So, if you have any suggestion on how to fix that or if you know onther class I should put the Tooltip with the getDescription method, it would be really much appreciated!

[systemoperator]

@dimitra-karadima An interesting class is org.jabref.gui.EntryTypeView.java. Here you will find

jabref/src/main/java/org/jabref/gui/EntryTypeView.java

Line 99 in 093a6fb

public void initialize() {

In this method

jabref/src/main/java/org/jabref/gui/EntryTypeView.java

Line 122 in 093a6fb

if (basePanel.getBibDatabaseContext().isBiblatexMode()) {

decides on whether bibtex or biblatex mode is active.

If e.g. biblatex is active, the following line gets executed, which adds the available entries to the pane:

jabref/src/main/java/org/jabref/gui/EntryTypeView.java

Line 123 in 093a6fb

addEntriesToPane(biblatexPane, BiblatexEntryTypeDefinitions.ALL);

And the full method is:

jabref/src/main/java/org/jabref/gui/EntryTypeView.java

Lines 89 to 96 in 093a6fb

	private void addEntriesToPane(FlowPane pane, Collection<? extends BibEntryType> entries) {
	for (BibEntryType entryType : entries) {
	Button entryButton = new Button(entryType.getType().getDisplayName());
	entryButton.setUserData(entryType);
	entryButton.setOnAction(event -> setEntryTypeForReturnAndClose(Optional.of(entryType)));
	pane.getChildren().add(entryButton);
	}
	}

You can associate a tooltip to a button like that:

Tooltip tooltip = new Tooltip();
tooltip.setText(description);
entryButton.setTooltip(tooltip);

[dimitra-karadima]

@systemoperator Thank you so much for your suggestion, I will try that and let you know!

[Siedlerchr]

Thanks to @dimitra-karadima this issue should now be fixed