-
Notifications
You must be signed in to change notification settings - Fork 46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Align terminology with W3C API #25
Comments
For a couple properties, we probably actually want to depart from W3C terminology, typically to convey the notions of TR and ED URLs, that only really make sense in a W3C context. One idea would be to reuse software terminology and talk about:
Both properties would be always set (and would thus be set to the same value for living specs and specs that have not been released yet). |
There has to be some subtlety to what counts as a Also, there needs to be some way to distinguish specs which have no |
See w3c#25. Following exchanges with W3C API folks, this update aligns terms used in browser-specs with existing or upcoming terms in the W3C API, where it makes sense. In practice, this update brings the following changes: - `shortname` becomes `series.shortname` - `name` becomes `shortname` - `level` becomes `seriesVersion` and is now a string - `levelComposition` becomes `seriesComposition` - `currentLevel` becomes `series.currentSpecification` - `previousLevel` becomes `previousInSeries` - `nextLevel` becomes `nextInSeries` - `trUrl` becomes `release.url` and is set for all specs - `edUrl` becomes `nightly.url` and is set for all specs
See w3c#25. Following exchanges with W3C API folks, this update aligns terms used in browser-specs with existing or upcoming terms in the W3C API, where it makes sense. In practice, this update brings the following changes: - `shortname` becomes `series.shortname` - `name` becomes `shortname` - `level` becomes `seriesVersion` and is now a string - `levelComposition` becomes `seriesComposition` - `currentLevel` becomes `series.currentSpecification` - `previousLevel` becomes `previousInSeries` - `nextLevel` becomes `nextInSeries` - `trUrl` becomes `release.url` and is set for all specs - `edUrl` becomes `nightly.url` and is set for all specs
See w3c#25. Following exchanges with W3C API folks, this update aligns terms used in browser-specs with existing or upcoming terms in the W3C API, where it makes sense. In practice, this update brings the following changes: - `shortname` becomes `series.shortname` - `name` becomes `shortname` - `level` becomes `seriesVersion` and is now a string - `levelComposition` becomes `seriesComposition` - `currentLevel` becomes `series.currentSpecification` - `previousLevel` becomes `previousInSeries` - `nextLevel` becomes `nextInSeries` - `trUrl` becomes `release.url` and is set for all specs - `edUrl` becomes `nightly.url` and is set for all specs
Right, I wasn't planning to make I don't mind using terms other than
Do we need to know? And if we do, what do we need to know? |
See w3c#25. Following exchanges with W3C API folks, this update aligns terms used in browser-specs with existing or upcoming terms in the W3C API, where it makes sense. In practice, this update brings the following changes: - `shortname` becomes `series.shortname` - `name` becomes `shortname` - `level` becomes `seriesVersion` and is now a string - `levelComposition` becomes `seriesComposition` - `currentLevel` becomes `series.currentSpecification` - `previousLevel` becomes `previousInSeries` - `nextLevel` becomes `nextInSeries` - `edUrl` becomes `nightly.url` and is set for all specs - `trUrl` becomes `release.url` and is only set for TR specs
See w3c#25. Following exchanges with W3C API folks, this update aligns terms used in browser-specs with existing or upcoming terms in the W3C API, where it makes sense. In practice, this update brings the following changes: - `shortname` becomes `series.shortname` - `name` becomes `shortname` - `level` becomes `seriesVersion` and is now a string - `levelComposition` becomes `seriesComposition` - `currentLevel` becomes `series.currentSpecification` - `previousLevel` becomes `previousInSeries` - `nextLevel` becomes `nextInSeries` - `edUrl` becomes `nightly.url` and is set for all specs - `trUrl` becomes `release.url` and is only set for TR specs
See #25. Following exchanges with W3C API folks, this update aligns terms used in browser-specs with existing or upcoming terms in the W3C API, where it makes sense. In practice, this update brings the following changes: - `shortname` becomes `series.shortname` - `name` becomes `shortname` - `level` becomes `seriesVersion` and is now a string - `levelComposition` becomes `seriesComposition` - `currentLevel` becomes `series.currentSpecification` - `previousLevel` becomes `previousInSeries` - `nextLevel` becomes `nextInSeries` - `edUrl` becomes `nightly.url` and is set for all specs - `trUrl` becomes `release.url` and is only set for TR specs
Last commit introduced the terms If it seems useful to have more details about the actual lifecycle process that a spec is following, I believe the right approach would be to expose the group and organization that develops the spec. I'll create a separate issue to track this. |
After further discussions, idea is to align terminology used here with that used in the W3C API.
In particular, goal is to use:
series
to link levels/versions of the same spec together.shortname
to mean both the "name with version" and the "name without version". In other words, theseries
property should typically be an object with ashortname
property.seriesVersion
, with ax
,x.y
orx.y.z
string value, to identify the level/version of a spec in a seriescurrentSpecification
to reference the current specification from aseries
objectThe text was updated successfully, but these errors were encountered: