Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-2320

Add tooltips to NCBI Primer Design options panel

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      2
    • 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:

      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

            Activity

            Hide
            noor91zahara Noor Zahara (Inactive) added a comment -

            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

            Show
            noor91zahara Noor Zahara (Inactive) added a comment - 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
            Hide
            noor91zahara Noor Zahara (Inactive) added a comment - - edited

            Packaged jsoup jar file within NCBI primer app.

            Show
            noor91zahara Noor Zahara (Inactive) added a comment - - edited Packaged jsoup jar file within NCBI primer app.
            Show
            noor91zahara Noor Zahara (Inactive) added a comment - PR submitted .- https://bitbucket.org/lorainelab/ncbi-primer/pull-requests/1/igbf-2320/diff
            Hide
            ann.loraine Ann Loraine added a comment -

            Merged and moved to Ready for testing.

            cc: Noor Zahara and Pooja Nikhare

            Show
            ann.loraine Ann Loraine added a comment - Merged and moved to Ready for testing. cc: Noor Zahara and Pooja Nikhare
            Hide
            prutha Prutha Kulkarni (Inactive) added a comment -

            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.

            Show
            prutha Prutha Kulkarni (Inactive) added a comment - 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.

              People

              • Assignee:
                noor91zahara Noor Zahara (Inactive)
                Reporter:
                ann.loraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: