[Webkit-unassigned] [Bug 60280] New: Web Inspector: Add docstrings to properties, shown as a tooltip on mouse hover

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=60280

           Summary: Web Inspector: Add docstrings to properties, shown as
                    a tooltip on mouse hover
           Product: WebKit
           Version: 528+ (Nightly build)
          Platform: All
        OS/Version: All
            Status: UNCONFIRMED
          Severity: Normal
          Priority: P2
         Component: Web Inspector
        AssignedTo: webkit-unassigned at lists.webkit.org
        ReportedBy: maruel at chromium.org
                CC: timothy at apple.com, rik at webkit.org, keishi at webkit.org,
                    pmuellr at yahoo.com, joepeck at webkit.org,
                    pfeldman at chromium.org, yurys at chromium.org,
                    bweinstein at apple.com, apavlov at chromium.org,
                    loislo at chromium.org


[The idea is a bit far fetched]

Add docstrings to DOM objects and their properties including styles and events.

This help text is shown on mouse hovering in the inspector window as a tooltip. An item is added to the contextual menu "Help about <item type>" which navigates to the help content. The idea is to help beginners to improve their comprehension of the current inspected web page construct and behavior.


Use cases:

The user hovers the property "onhashchange" of a HTMLElement and the tooltip displays the description of the hashchange event type at http://www.w3.org/TR/html5/history.html#event-hashchange.

The user hovers a SVGGElement and the text from http://www.w3.org/TR/SVG/struct.html#InterfaceSVGGElement is shown: "Corresponds to the ‘g’ element." and links to http://www.w3.org/TR/SVG/struct.html#GElement.

(or an improvement of the above use case)


Data source:

The data could be harvested from http://w3.org/TR/* or written manually. Each way, that represents a significant amount of work.

Another issue is the total data size increase in webkit. [Even more far fetched] A workaround that could make sense to do web requests to get the help data instead of storing it locally, with proper caching. The content of the tooltip could be itself html content.

-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.