Bug 60280

Summary: Web Inspector: add contextual links to documentation of DOM properties and APIs
Product: WebKit Reporter: Marc-Antoine Ruel <maruel>
Component: Web InspectorAssignee: Nobody <webkit-unassigned>
Status: NEW ---    
Severity: Normal CC: apavlov, bweinstein, graouts, inspector-bugzilla-changes, keishi, loislo, pfeldman, pmuellr, rik, webkit-bug-importer, yurys
Priority: P2 Keywords: InRadar
Version: 528+ (Nightly build)   
Hardware: All   
OS: All   

Description Marc-Antoine Ruel 2011-05-05 11:06:38 PDT
[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.
Comment 1 Radar WebKit Bug Importer 2014-12-17 11:23:59 PST