MDN/Development/Offsites/Toronto 2012/Features/jsFiddle meeting

From MozillaWiki
Jump to: navigation, search

We are considering using jsFiddle to provide code example features on the MDN.

Below are notes from a meeting we had with Piotr to discuss whether jsFiddle can provide the features we need. This page captures most of what we discussed, but some of the things we talked about are not publicly listed here due to jsFiddle being (at least at the moment) a closed source third party partner. For more sensitive information, please request access to our additional meeting notes.

Requirements

Priority Category Feature Supported
(Yes / No / Sort of)
Notes
P1 Security Needs to live on a domain that is not *.mozilla.org Yes developer.mozillademos.org. coordinate with IT.
P1 Security Ideally, should live in an iframe. Yes Sandbox and security
P1 Display Shows code snippets of HTML, CSS, and JS in one place Yes
P1 Display Inline Yes
P1 Display Uploadable reference image to be displayed with code example Yes Our end. Via upload at first, then automatically.
P1 Display Display size must be customizable Sort of Embedded jsFiddles need to be pretty wide, but the height is customizable.
P1 Language support HTML Yes
P1 Language support JavaScript Yes
P1 Language support CSS Yes
P1 Language support MathML No Piotr adding more languages. Coordinate with him. Should be pretty easy for him to add.
P1 Language support SVG No Piotr adding more languages. Coordinate with him. Should be pretty easy for him to add.
P1 Highlighting Line number
P1 Highlighting Line range
P1 Highlighting HTML block ID
P1 Highlighting CSS class
P1 Highlighting JavaScript function
P1 Revisions Managed along with page revisions Sort of A Fiddle cannot be changed without creating a fork. Every fork has a unique URL. Therefore, if someone wants to change a jsFiddle being used in an MDN article, he would need to change the URL of that Fiddle and update the MDN to point to that new URL. So any jsFiddle edit would be reflected in the MDN revision history.
P1 Revisions Need to be able to revert revisions Sort of A Fiddle cannot be changed without creating a fork. Every fork has a unique URL. Therefore, if someone wants to change a jsFiddle being used in an MDN article, he would need to change the URL of that Fiddle and update the MDN to point to that new URL. So any jsFiddle edit would be reflected in the MDN revision history.
P1 Editing In browser Yes
P1 Security Permission management
P2 Display Syntax highlighting Yes
P2 Display Separate window Yes
P2 Display Automatically generated video to show with code example
P2 Display User can click functions/properties/elements/etc. for more documentation
P2 Editing Fiddling with / experimenting with the code example Sort of I think a user could do this, but only by first creating a fork of the Fiddle.
P2 Editing Show console.log'ing in page while fiddling
P3 Display Automatically generated images to show with code example
P3 Display Tooltips for more documentation on functions/properties/elements/etc.
Other Hosted on our server
Other Open source
P3 Editing Validation tools

Other meeting notes