ecmarkup icon indicating copy to clipboard operation
ecmarkup copied to clipboard

Add new feature for generating MDN annotations in output

Open sideshowbarker opened this issue 6 years ago • 0 comments
trafficstars

This is a proposal for a new feature to automatically generate MDN annotations in output from ecmarkup.

For any specific feature in an spec/draft/proposal generated with ecmarkup, an annotation would automatically be generated with:

  • a link to any MDN articles which document that feature
  • the summary description of that feature from the MDN article (available as tooltip text on hovering over the annoation)
  • the (caniuse-like) browser-compatibility support matrix for that feature

A similar feature has been implemented for the https://html.spec.whatwg.org/multipage/ HTML spec:

mdnannos720

Also, the Respec tool that’s used for generating a number of W3C specs also has support; for an example, see https://w3c.github.io/payment-request/#paymentrequest-interface


Data that can be used to build the annotation content for the ECMAScript spec is available at https://github.com/w3c/mdn-spec-links/blob/master/ecmascript.json.

Data for the ECMA-402 spec is at https://github.com/w3c/mdn-spec-links/blob/master/ecma-402.json

Data for a number of other TC39 proposals is also available there, in files prefixed with proposal-; e.g., https://github.com/w3c/mdn-spec-links/blob/master/proposal-arraybuffer-transfer.json

sideshowbarker avatar Nov 21 '19 05:11 sideshowbarker