Details
-
Type:
Task
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:2
-
Epic Link:
-
Sprint:Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr, Spring 8 : 24 Apr to 8 May, Spring 8 : 11 May to 25 May
Description
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel.
For this task:
- First, make a google spreadsheet listing each user input component in the Primer Options panel: https://docs.google.com/spreadsheets/d/1JeMZFTyN0a99hTBKVYbOE1XNGXyw9dnRxt8NG3kD0aI/edit?usp=sharing
- Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times.
- Copy the text into the code. (Usability testing will be in a separate ticket)
You can find "starter text" for the tooltips in the NCBI Primer Design Web page: https://www.ncbi.nlm.nih.gov/tools/primer-blast/
While we are working on the wording of the text, meanwhile design a mechanism that will allow a developer to modify a simple JSON, XML, or plain text document that will capture the text of the tooltips. Our idea is that the App itself will read this file and display tooltips found in the file. However, note that this might not be feasible due to our dependence on the GUI builder. That is, the wording of things like tooltips and button labels may have to be hard-coded into the Java code due to the form-based nature of the GUI Builder. So as part of this ticket, investigate whether GUI Builder allows UI components to be configured via a file external to the Java code itself.
In addition to the above task, also investigate conventions for internationalization. Many users of IGB live in places where English is not normally spoken, and many software applications are written in such a way that allows the developers to easily display button text and other text-based UI components using the preferred language of the computer user. As you are investigating how to implement the tooltips, also investigate tooling for internationalizing applications like IGB to enable different languages to be shown on the UI.
Attachments
Issue Links
- is blocked by
-
IGBF-2348 Add new parameter to NCBI Primer App
-
- Closed
-
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link |
|
| Rank | Ranked higher |
| Description |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each component in the Primer Options panel. Add a link to it here. * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each component in the Primer Options panel: * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
| Description |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each component in the Primer Options panel: * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
| Description |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: https://docs.google.com/spreadsheets/d/1JeMZFTyN0a99hTBKVYbOE1XNGXyw9dnRxt8NG3kD0aI/edit?usp=sharing * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
| Description |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: https://docs.google.com/spreadsheets/d/1JeMZFTyN0a99hTBKVYbOE1XNGXyw9dnRxt8NG3kD0aI/edit?usp=sharing * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: https://docs.google.com/spreadsheets/d/1JeMZFTyN0a99hTBKVYbOE1XNGXyw9dnRxt8NG3kD0aI/edit?usp=sharing * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) You can find "starter text" for the tooltips in the NCBI Primer Design Web page: https://www.ncbi.nlm.nih.gov/tools/primer-blast/ |
| Assignee | Prutha Kulkarni [ prutha ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Assignee | Prutha Kulkarni [ prutha ] | Ann Loraine [ aloraine ] |
| Status | In Progress [ 3 ] | To-Do [ 10305 ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Sprint | Spring 6 : 30 Mar to Apr 10 [ 91 ] | Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr [ 91, 92 ] |
| Rank | Ranked higher |
| Status | In Progress [ 3 ] | To-Do [ 10305 ] |
| Sprint | Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr [ 91, 92 ] | Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr, Spring 8 : 24 Apr to 8 May [ 91, 92, 93 ] |
| Rank | Ranked higher |
| Story Points | 1.5 | 2 |
| Description |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: https://docs.google.com/spreadsheets/d/1JeMZFTyN0a99hTBKVYbOE1XNGXyw9dnRxt8NG3kD0aI/edit?usp=sharing * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) You can find "starter text" for the tooltips in the NCBI Primer Design Web page: https://www.ncbi.nlm.nih.gov/tools/primer-blast/ |
Most IGB components are configured with tooltips so that if a user has any question about what something does, they can hover the mouse over it and read some short text about it.
Let us add tooltips to each component in the Primer App Options panel. For this task: * First, make a google spreadsheet listing each user input component in the Primer Options panel: https://docs.google.com/spreadsheets/d/1JeMZFTyN0a99hTBKVYbOE1XNGXyw9dnRxt8NG3kD0aI/edit?usp=sharing * Then, one by one, compose some text for the tooltip that will appear when the user hovers the mouse over the component. We will iterate this a few times. * Copy the text into the code. (Usability testing will be in a separate ticket) You can find "starter text" for the tooltips in the NCBI Primer Design Web page: https://www.ncbi.nlm.nih.gov/tools/primer-blast/ While we are working on the wording of the text, meanwhile design a mechanism that will allow a developer to modify a simple JSON, XML, or plain text document that will capture the text of the tooltips. Our idea is that the App itself will read this file and display tooltips found in the file. However, note that this might not be feasible due to our dependence on the GUI builder. That is, the wording of things like tooltips and button labels may have to be hard-coded into the Java code due to the form-based nature of the GUI Builder. So as part of this ticket, investigate whether GUI Builder allows UI components to be configured via a file external to the Java code itself. In addition to the above task, also investigate conventions for internationalization. Many users of IGB live in places where English is not normally spoken, and many software applications are written in such a way that allows the developers to easily display button text and other text-based UI components using the preferred language of the computer user. As you are investigating how to implement the tooltips, also investigate tooling for internationalizing applications like IGB to enable different languages to be shown on the UI. |
| Assignee | Ann Loraine [ aloraine ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Assignee | Noor Zahara [ noor91zahara ] |
Suggestion
One way to add tool-tip text via external file instead of hard-coding is using Resource bundle.
I created a .properties file and tried it out and it worked.
Let me know if this works.
I think it is better to continue working with branch IGBF-2348.
[~aloraine] - Is this fine?
Sure, that is fine.
I found a way to internalize a gui form - https://www.youtube.com/watch?v=gdpc4qe9H48
| Sprint | Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr, Spring 8 : 24 Apr to 8 May [ 91, 92, 93 ] | Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr, Spring 8 : 24 Apr to 8 May, Spring 8 : 11 May to 25 May [ 91, 92, 93, 94 ] |
| Rank | Ranked higher |
Code Diff for tooltips - https://bitbucket.org/noorzahara/ncbi-primer-local/branch/IGBF-2320#diff
Investigation about internationalization of projects on netbeans -
Below links explain the above-
https://netbeans.org/kb/docs/java/gui-automatic-i18n.html#newlocale
https://www.youtube.com/watch?v=gdpc4qe9H48
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | Ready for Pull Request [ 10304 ] |
| Status | Ready for Pull Request [ 10304 ] | Pull Request Submitted [ 10101 ] |
| Assignee | Noor Zahara [ noor91zahara ] |
| Status | Pull Request Submitted [ 10101 ] | Reviewing Pull Request [ 10303 ] |
| Status | Reviewing Pull Request [ 10303 ] | Merged Needs Testing [ 10002 ] |
Merged and moved to Ready for testing.
cc: Noor Zahara and Pooja Nikhare
| Assignee | Prutha Kulkarni [ prutha ] |
| Status | Merged Needs Testing [ 10002 ] | Post-merge Testing In Progress [ 10003 ] |
Used latest repository.xml which was generated in the app repos download section to test the tooltips in IGB.
Inputs in the primer options tab now have an info icon hovering on which shows the tooltip related to that particular input option.
Moving the ticket to DONE.
| Assignee | Prutha Kulkarni [ prutha ] | Noor Zahara [ noor91zahara ] |
| Resolution | Done [ 10000 ] | |
| Status | Post-merge Testing In Progress [ 10003 ] | Closed [ 6 ] |
I have added the tooltip text for the fields I found on the NCBI Primer webpage.
Prof. [~aloraine], could you please have a look at it?
Also, could you please let me know what text should be added for the tooltips which I did not find on the webpage?
Updated google sheet can be found on the same location which is mentioned in the description box.