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

Entry editor: Add more tooltips and wrap tooltips if necessary #6239

Merged
merged 8 commits into from
Apr 10, 2020
Merged

Entry editor: Add more tooltips and wrap tooltips if necessary #6239

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c1ac5d0
wrap tooltips if necessary
systemoperator Apr 3, 2020
eac2ac3
adding additional entry field tooltips (including SpecialFields)
systemoperator Apr 3, 2020
0d3af6b
small changes
systemoperator Apr 3, 2020
f49c633
ISRN added
systemoperator Apr 3, 2020
acf4374
small changes
systemoperator Apr 4, 2020
c96530e
descriptions adapted
systemoperator Apr 4, 2020
71667b3
English localization extended
systemoperator Apr 5, 2020
7b18ce1
Merge remote-tracking branch 'upstream/master' into entry-field-tooltips
systemoperator Apr 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 93 additions & 2 deletions src/main/java/org/jabref/gui/fieldeditors/FieldNameLabel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
import javafx.geometry.Pos;
import javafx.scene.control.Label;
import javafx.scene.control.Tooltip;
import javafx.stage.Screen;

import org.jabref.logic.l10n.Localization;
import org.jabref.model.entry.field.Field;
import org.jabref.model.entry.field.InternalField;
import org.jabref.model.entry.field.SpecialField;
import org.jabref.model.entry.field.StandardField;
import org.jabref.model.strings.StringUtil;

Expand All @@ -22,8 +24,11 @@ public FieldNameLabel(Field field) {

String description = getDescription(field);
if (StringUtil.isNotBlank(description)) {
Tooltip tooltip = new Tooltip();
tooltip.setText(description);
Screen currentScreen = Screen.getPrimary();
double maxWidth = currentScreen.getBounds().getWidth();
Tooltip tooltip = new Tooltip(description);
tooltip.setMaxWidth(maxWidth * 2 / 3);
tooltip.setWrapText(true);
this.setTooltip(tooltip);
}
}
Expand All @@ -32,18 +37,29 @@ public String getDescription(Field field) {
if (field.isStandardField()) {
StandardField standardField = (StandardField) field;
switch (standardField) {
case ABSTRACT:
return Localization.lang("This field is intended for recording abstracts in a bib file, to be printed by a special bibliography style.");
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
case ADDENDUM:
return Localization.lang("Miscellaneous bibliographic data usually printed at the end of the entry.");
case AFTERWORD:
return Localization.lang("Author(s) of an afterword to the work.");
case ANNOTATION:
case ANNOTE:
return Localization.lang("This field may be useful when implementing a style for annotated bibliographies.");
case ANNOTATOR:
return Localization.lang("Author(s) of annotations to the work.");
case AUTHOR:
return Localization.lang("Author(s) of the work.");
case BOOKSUBTITLE:
return Localization.lang("The subtitle related to the \"Booktitle\".");
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
case BOOKTITLE:
return Localization.lang("Title of the main publication this work is part of.");
case BOOKTITLEADDON:
return Localization.lang("An annex to the \"Booktitle\", to be printed in a different font.");
case CHAPTER:
return Localization.lang("Chapter or section or any other unit of a work.");
case COMMENT:
return Localization.lang("A comment to this entry.");
case COMMENTATOR:
return Localization.lang("Author(s) of a commentary to the work.") + "\n" +
Localization.lang("Note that this field is intended for commented editions which have a commentator in addition to the author. If the work is a stand-alone commentary, the commentator should be given in the author field.");
Expand All @@ -55,6 +71,20 @@ public String getDescription(Field field) {
return Localization.lang("Edition of a printed publication.");
case EDITOR:
return Localization.lang("Editor(s) of the work or the main publication, depending on the type of the entry.");
case EDITORA:
return Localization.lang("A secondary editor performing a different editorial role, such as compiling, redacting, etc.");
case EDITORB:
return Localization.lang("Another secondary editor performing a different role.");
case EDITORC:
return Localization.lang("Another secondary editor performing a different role.");
case EDITORTYPE:
return Localization.lang("The type of editorial role performed by the editor. Roles supported by default are \"editor\", \"compiler\", \"founder\", \"continuator\", \"redactor\", \"reviser\", \"collaborator\", \"organizer\". The role \"editor\" is the default. In this case, the field is omissible.");
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
case EDITORATYPE:
return Localization.lang("Similar to \"Editortype\" but referring to the editora field.");
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
case EDITORBTYPE:
return Localization.lang("Similar to \"Editortype\" but referring to the editorb field.");
case EDITORCTYPE:
return Localization.lang("Similar to \"Editortype\" but referring to the editorc field.");
case EID:
return Localization.lang("Electronic identifier of a work.") + "\n" +
Localization.lang("This field may replace the pages field for journals deviating from the classic pagination scheme of printed journals by only enumerating articles or papers and not pages.");
Expand All @@ -79,6 +109,8 @@ public String getDescription(Field field) {
case FILE:
case PDF:
return Localization.lang("Link(s) to a local PDF or other document of the work.");
case FOREWORD:
return Localization.lang("The author(s) of a foreword to the work.");
case HOWPUBLISHED:
return Localization.lang("Publication notice for unusual publications which do not fit into any of the common categories.");
case INSTITUTION:
Expand All @@ -88,48 +120,78 @@ public String getDescription(Field field) {
return Localization.lang("Author(s) of an introduction to the work.");
case ISBN:
return Localization.lang("International Standard Book Number of a book.");
case ISRN:
return Localization.lang("The International Standard Technical Report Number of a technical report.");
case ISSN:
return Localization.lang("The International Standard Serial Number of a periodical.");
case ISSUE:
return Localization.lang("Issue of a journal.") + "\n" +
Localization.lang("This field is intended for journals whose individual issues are identified by a designation such as \"Spring\" or \"Summer\" rather than the month or a number. Integer ranges and short designators are better written to the number field.");
case ISSUESUBTITLE:
return Localization.lang("Subtitle of a specific issue of a journal or other periodical.");
case ISSUETITLE:
return Localization.lang("Title of a specific issue of a journal or other periodical.");
case JOURNALSUBTITLE:
return Localization.lang("The subtitle of a journal, a newspaper, or some other periodical.");
case JOURNALTITLE:
case JOURNAL:
return Localization.lang("Name of a journal, a newspaper, or some other periodical.");
case LABEL:
return Localization.lang("Designation to be used by the citation style as a substitute for the regular label if any data required to generate the regular label is missing.");
case LANGUAGE:
return Localization.lang("The language(s) of the work. Languages may be specified literally or as localisation keys.");
case LIBRARY:
return Localization.lang("Information such as a library name and a call number.");
case LOCATION:
case ADDRESS:
return Localization.lang("The place(s) of publication, i. e., the location of the publisher or institution, depending on the entry type.");
case MAINSUBTITLE:
return Localization.lang("The subtitle related to the \"Maintitle\".");
case MAINTITLE:
return Localization.lang("Main title of a multi-volume book, such as \"Collected Works\".");
case MAINTITLEADDON:
return Localization.lang("An annex to the \"Maintitle\", to be printed in a different font.");
case MONTH:
return Localization.lang("Publication month.");
case NAMEADDON:
return Localization.lang("An addon to be printed immediately after the author name in the bibliography.");
case NOTE:
return Localization.lang("Miscellaneous bibliographic data which does not fit into any other field.");
case NUMBER:
return Localization.lang("Number of a journal or the volume/number of a book in a series.");
case ORGANIZATION:
return Localization.lang("Organization(s) that published a manual or an online resource, or sponsored a conference.");
case ORIGDATE:
return Localization.lang("If the work is a translation, a reprint, or something similar, the publication date of the original edition.");
case ORIGLANGUAGE:
return Localization.lang("If the work is a translation, the language(s) of the original work.");
case PAGES:
return Localization.lang("One or more page numbers or page ranges.") + "\n" +
Localization.lang("If the work is published as part of another one, such as an article in a journal or a collection, this field holds the relevant page range in that other work. It may also be used to limit the reference to a specific part of a work (a chapter in a book, for example). For papers in electronic journals with anon-classical pagination setup the eid field may be more suitable.");
case PAGETOTAL:
return Localization.lang("Total number of pages of the work.");
case PAGINATION:
return Localization.lang("The pagination of the work. The key should be given in the singular form. Possible keys are \"page\", \"column\", \"line\", \"verse\", \"section\", and \"paragraph\".");
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
case PART:
return Localization.lang("The number of a partial volume. This field applies to books only, not to journals. It may be used when a logical volume consists of two or more physical ones.");
case PUBLISHER:
return Localization.lang("Name(s) of the publisher(s).");
case PUBSTATE:
return Localization.lang("Publication state of the work, e. g., \"in press\".");
case SERIES:
return Localization.lang("Name of a publication series, such as \"Studies in...\", or the number of a journal series.");
case SHORTTITLE:
return Localization.lang("The title in an abridged form.");
case SUBTITLE:
return Localization.lang("Subtitle of the work.");
case TITLE:
return Localization.lang("Title of the work.");
case TITLEADDON:
return Localization.lang("An annex to the \"Title\", to be printed in a different font.");
case TRANSLATOR:
return Localization.lang("The translator(s) of the \"Title\" or \"Booktitle\", depending on the entry type. If the translator is identical to the \"Editor\", the standard styles will automatically concatenate these fields in the bibliography.");
case TYPE:
return Localization.lang("The type of a \"Manual\", \"Patent\", \"Report\", or \"Thesis\".");
case URL:
return Localization.lang("URL of an online publication.");
case URLDATE:
Expand All @@ -144,17 +206,46 @@ public String getDescription(Field field) {
return Localization.lang("Total number of volumes of a multi-volume work.");
case YEAR:
return Localization.lang("Year of publication.");
case CROSSREF:
return Localization.lang("This field holds an entry key for the cross-referencing feature. Child entries with a \"Crossref\" field inherit data from the parent entry specified in the \"Crossref\" field.");
case GENDER:
return Localization.lang("The gender of the author or the gender of the editor, if there is no author." + "\n" +
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
"The following identifiers are supported: \"sf\" (feminine singular, a single female name), \"sm\" (masculine singular, a single male name), \"sn\" (neuter singular, a single neuter name), \"pf\" (feminine plural, a list of female names), \"pm\" (masculine plural, a list of male names), \"pn\" (neuter plural, a list of neuter names), \"pp\" (plural, a mixed gender list of names).");
case KEYWORDS:
return Localization.lang("Separated list of keywords.");
case RELATED:
return Localization.lang("Citation keys of other entries which have a relationship to this entry.");
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to add "separated by ," here?

case XREF:
return Localization.lang("This field is an alternative cross-referencing mechanism. It differs from \"Crossref\" in that the child entry will not inherit any data from the parent entry specified in the \"Xref\" field.");
}
} else if (field instanceof InternalField) {
InternalField internalField = (InternalField) field;
switch (internalField) {
case OWNER:
return Localization.lang("The owner/creator of this entry.");
case TIMESTAMP:
return Localization.lang("The timestamp of this entry, when it has been created or last modified.");
case KEY_FIELD:
return Localization.lang("Key by which the work may be cited.");
case GROUPS:
return Localization.lang("Name(s) of the (manual) groups the entry belongs to.");
}
} else if (field instanceof SpecialField) {
SpecialField specialField = (SpecialField) field;
switch (specialField) {
case PRINTED:
return Localization.lang("A user-specific printed flag for this entry, in case the entry has been printed.");
systemoperator marked this conversation as resolved.
Show resolved Hide resolved
case PRIORITY:
return Localization.lang("A user-specific priority for this entry.");
case QUALITY:
return Localization.lang("A user-specific quality flag for this entry, in case its quality is assured.");
case RANKING:
return Localization.lang("A user-specific ranking for this entry.");
case READ_STATUS:
return Localization.lang("A user-specific read status for this entry.");
case RELEVANCE:
return Localization.lang("A user-specific relevance flag for this entry, in case the entry is relevant.");
}
}
return "";
}
Expand Down