Status: Closed (View Workflow)
Affects Version/s: None
Fix Version/s: None
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
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.