Uploaded image for project: 'Picard'
  1. Picard
  2. PICARD-2677

Use of Tooltips for contextual help

XMLWordPrintable

    • Icon: Design Design
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • User Interface
    • None

      It occurred to me when writing a comment to another ticket that it should be possible to provide contextual tooltip help taken from the Picard Docs web site.

      As an example, suppose I were looking at the Metadata Options page and hovered my mouse for 1 second over the "Use standardised artist names" option.

      It would be great if this could then bring up the relevant part of the documentation page as a tooltip:

      This would require a few things to happen to make it work:

      1. In the Picard Docs web site, all the relevant text blocks would need to be marked with an HTML id to allow the text to be chosen from within a downloaded web page. In the above example the relevant HTML is:
        <blockquote>
            <div>
                <p>Check to only use standard Artist names, rather than Artist Credits which may differ slightly across tracks and releases.</p>
                <div class="admonition note">
                    <p class="admonition-title">Note</p>
                    <p>If the “Translate artist names” option above is also checked, it will override this option if a suitable alias is found.</p>
                </div>
            </div>
        </blockquote> 

        so we would need to add an `id=usestandardisedartists` to the `<blockquote>` tag.

      2. Download the web page in the background when the option page is selected so that the tooltip can be shown promptly, and select the relevant id and parse it to create the pop-up text.

      The biggest effort would be in adding ids to the documentation pages, though adding the Picard functionality is non-trivial. But I think the effort would be very worthwhile.

            Unassigned Unassigned
            sophist Sophist
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:

                Version Package