Handling editions of W3C recommendations
See original GitHub issueAs it stands, it looks like like entries like TTML1
refers to the most recent version of TTML1, which is fine since references to specific versions, e.g. ttml1-20041101
are also available.
It looks like there is however an issue with the TTML1
entry as it is current generated:
Glenn Adams; Pierre-Anthony Lemieux. Timed Text Markup Language 1 (TTML1) (Third Edition). 24 April 2018. W3C Candidate Recommendation. URL: https://www.w3.org/TR/ttml1/ ED: https://w3c.github.io/ttml1/index.html
The URL points to the Latest Version
link https://www.w3.org/TR/ttml1/
and not the This Version
link https://www.w3.org/TR/2018/CR-ttml1-20180424/
.
This is an issue across editions. As an example, IMSC 1.0.1 refers to TTML1. When IMSC 1.0.1 was published, only TTML1 2ED has been published, and so the reference reads:
Timed Text Markup Language 1 (TTML1) (Second Edition). Glenn Adams. W3C. 24 September 2013. W3C Recommendation. URL: https://www.w3.org/TR/ttml1/
The URL https://www.w3.org/TR/ttml1/
however now points to TTML1 3ED. This is pretty confusing to readers, and may yield issues if IMSC 1.0.1 had in fact relied specifically on TTML1 2ED.
Would it make sense for the URL of entries such as TTML1
to point to the This Version
link?
Issue Analytics
- State:
- Created 5 years ago
- Comments:27 (14 by maintainers)
Top GitHub Comments
From my perspective, the problem is that IMSC doesn’t employ the correct URL. The intent of the generic URL is to be fluid, and be updated as new editions are created. By using that URL in IMSC, you get a non-fixed resource to dereference (and must live with it). On the other hand, if IMSC wants to refer to a specific edition, then it should do so, and thus have a fixed resource to dereference.
Note that respec handles subtitles., eg https://w3c.github.io/pointerevents/
Now, compare the data from https://www.specref.org/?q=pointerevents2
and the actual WD at https://www.w3.org/TR/pointerevents2/ (the subtitle got dropped in specref)
This is because we don’t expose through our API those subtitles. So, if you actually want to drop edition and version numbers, the solution is to put them as a subtitle (in html, this means use an h2 instead of h1).