| | 1 | |
| | 2 | == Format == |
| | 3 | |
| | 4 | === Global object === |
| | 5 | |
| | 6 | Each JSON file is a dictionary with two items: |
| | 7 | * specifications: (optional): a list of specifications. |
| | 8 | * features: a list of features. |
| | 9 | |
| | 10 | Example: |
| | 11 | {{{ |
| | 12 | { |
| | 13 | "specification": [...] |
| | 14 | "features": [...] |
| | 15 | } |
| | 16 | }}} |
| | 17 | |
| | 18 | === Specification object === |
| | 19 | |
| | 20 | The list of specification contains specification objects with the following keys: |
| | 21 | * name: The official name of the spec |
| | 22 | * url: The url of the spec being implemented, can be the working draft. |
| | 23 | * status: A status dictionary, more about that below. |
| | 24 | * documentation-url: (optional) Link to good documentation, like MDM. |
| | 25 | * webkit-url: (optional) Link to the bug in bugzilla or trac. |
| | 26 | * description: (optional) A description of the specification. |
| | 27 | * comments: (optional) Free comments from implementors. |
| | 28 | * contact: (optional) A contact dictionary, more about that below. |
| | 29 | |
| | 30 | === Feature object === |
| | 31 | |
| | 32 | Features are small features that do not necessarily fit in a complete specification. For example, ES6 template string is a popular feature that can have its own feature object. |
| | 33 | |
| | 34 | Each feature object can have the following fields: |
| | 35 | * name: Name of the feature. |
| | 36 | * status: A status dictionary, more about that below. |
| | 37 | * url: (optional) Link to the feature in the spec. |
| | 38 | * documentation-url: (optional) Link to good documentation, like MDM. |
| | 39 | * webkit-url: (optional) Link to the bug in bugzilla or trac. |
| | 40 | * specification: (optional) The name of the specification the feature belongs to. The name must match the name of a specification object. |
| | 41 | * description: (optional) A description of the specification. |
| | 42 | * comments: (optional) Free comments from implementors. |
| | 43 | * contact: (optional) A contact dictionary, more about that below. |
| | 44 | |
| | 45 | === Status object === |
| | 46 | The dictionary has the following fields: |
| | 47 | * status: Any description of the status of the feature: "In development", "Waiting for feedback", "Done", "Removed" |
| | 48 | * enabled-by-default: true/false. |
| | 49 | * comment: (optional) Free comment about the status. |
| | 50 | * shipped (optional): a list of the first release when something was shipped. E.g. ["safari-7-prefix", "osx-safari-8", "webkitgtk-2.7.3"] |
| | 51 | |
| | 52 | === Contact object === |
| | 53 | * name: Name of a contact person. |
| | 54 | * twitter: name on twitter. |
| | 55 | * email: email address. |
