How to add ISO/IEC specs #1191
Comments
|
I prefer the major bump approach ("the future is longer than the past", he said optimistically) |
tidoust
added a commit
that referenced
this issue
Feb 5, 2024
To add ISO/IEC standards related to JPEG XL (see #1089), there needs to be a way to add an entry in browser-specs that has a canonical URL but no actual nightly URL, because ISO standards are not public (see also #1191). This update amends the code to allow and create entries without a `nightly` property when needed (only for ISO standards for now). The code also retrieves the name of the group that develops an ISO standard. This is a BREAKING CHANGE because the `nightly` property used to be mandatory. Projects that expect to find a `nightly.url` property need to be updated to only look at the root `url` property or to skip the entry altogether. First ISO spec added to the list is JPEG XL, which will appear as: ```json { "url": "https://www.iso.org/standard/85253.html", "seriesComposition": "full", "shortname": "iso18181-2", "series": { "shortname": "iso18181-2", "currentSpecification": "iso18181-2", "title": "Information technology — JPEG XL image coding system — Part 2: File format", "shortTitle": "JPEG XL: File Format" }, "shortTitle": "JPEG XL: File Format", "organization": "ISO/IEC", "groups": [ { "name": "ISO/IEC JTC 1/SC 29", "url": "https://www.iso.org/committee/45316.html" } ], "title": "Information technology — JPEG XL image coding system — Part 2: File format", "source": "specref", "categories": [ "browser" ], "standing": "good" } ``` Worth noting: the absence of a `nightly` property means that there is no place to store the status of the spec, which could in theory be "Under development" or "Published" for ISO specs (there are additional stages in the ISO process but they are probably not worth capturing in any case). An alternative would be to have a `nightly.status` property, but that seems clumsy.
tidoust
added a commit
that referenced
this issue
Feb 6, 2024
…1192) To add ISO/IEC standards related to JPEG XL (see #1089), there needs to be a way to add an entry in browser-specs that has a canonical URL but no actual nightly URL, because ISO standards are not public (see also #1191). This update amends the code to allow and create entries without a `nightly` property when needed (only for ISO standards for now). The code also retrieves the name of the group that develops an ISO standard. This is a BREAKING CHANGE because the `nightly` property used to be mandatory. Projects that expect to find a `nightly.url` property need to be updated to only look at the root `url` property or to skip the entry altogether. First ISO spec added to the list is JPEG XL, which will appear as: ```json { "url": "https://www.iso.org/standard/85253.html", "seriesComposition": "full", "shortname": "iso18181-2", "series": { "shortname": "iso18181-2", "currentSpecification": "iso18181-2", "title": "Information technology — JPEG XL image coding system — Part 2: File format", "shortTitle": "JPEG XL: File Format" }, "shortTitle": "JPEG XL: File Format", "organization": "ISO/IEC", "groups": [ { "name": "ISO/IEC JTC 1/SC 29", "url": "https://www.iso.org/committee/45316.html" } ], "title": "Information technology — JPEG XL image coding system — Part 2: File format", "source": "specref", "categories": [ "browser" ], "standing": "good" } ``` Worth noting: the absence of a `nightly` property means that there is no place to store the status of the spec, which could in theory be "Under development" or "Published" for ISO specs (there are additional stages in the ISO process but they are probably not worth capturing in any case). An alternative would be to have a `nightly.status` property, but that seems clumsy.
|
Corresponding updates to code and list made, and new major versions released (already deployed in web-features and browser-compat-data, pending PR for Yari). I'll update Reffy accordingly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Via #1089. ISO/IEC standards such as JPEG XL do not have a public specification. They all have a "canonical" page on the ISO web site though, which seems a good entry point for the spec. That URL is also the one used in Specref.
Now, all entries in browser-specs so far target actual specs. Question is: how should we add ISO/IEC entries to browser-specs?
A clean solution would probably be to use the ISO page URL as the canonical URL and not to set the
nightlyproperty, because there are no public spec to point at. That would break the schema though asnightlyis mandatory, and would likely require updates to the code of projects that currently consume browser-specs data as these projects may expectnightly.urlto be always set.A non-breaking solution would be to use the ISO page URL as the canonical URL and as the
nightly.urlURL. That's less clean but most code that uses browser-specs data today should continue to run. Well, Reffy may still need to learn to skipiso.orgURLs.Overall, choice seems to be between a major bump and a minor bump. The major bump approach is more painful but has the advantage of making things explicit. The minor bump is easier but has the drawback of hiding the fact that we may not have a published version of the spec.
The text was updated successfully, but these errors were encountered: