Skip to content
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

Editorial: let ReSpec handle id assignment #337

Merged
merged 3 commits into from
Dec 6, 2023
Merged

Conversation

marcoscaceres
Copy link
Member

@marcoscaceres marcoscaceres commented Nov 10, 2023

Copy link
Member

@tidoust tidoust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This update changes the effective ID of exported definitions. For instance, it will change init-segment to dfn-initialization-segment.

The problem is that byte stream format specs reference these exported terms, e.g., see links in the Initialization Segments section in MPEG-2 TS Byte Stream Format.

These specs have the same issue as MSE: they still use custom JavaScript to manage cross-references. They would certainly benefit from being updated as well, but since we don't really have plans to update the published byte stream formats specs any time soon, I would suggest to keep the explicit ID for terms that are exported.

No problem for non-exported terms.

@marcoscaceres
Copy link
Member Author

MPEG-2 TS Byte Stream Format is a tiny note though. Couldn't we (by which I mean I) update it and just put that on auto publish too? These are just spec heath changes so shouldn't impact anything... we could even keep the same date for the Note if we wanted to and no one would notice the difference.

@tidoust
Copy link
Member

tidoust commented Dec 4, 2023

MPEG-2 TS Byte Stream Format is a tiny note though. Couldn't we (by which I mean I) update it and just put that on auto publish too? These are just spec heath changes so shouldn't impact anything... we could even keep the same date for the Note if we wanted to and no one would notice the difference.

We sure can and I'm happy to help. Note that we need to update the 5 byte stream format specifications, which all expect the init-segment term, I think. They're all very small too though, so totally manageable.

tidoust added a commit to w3c/mse-byte-stream-format-isobmff that referenced this pull request Dec 4, 2023
This refreshes the spec to leverage ReSpec cross-referencing capabilities.
See discussion in w3c/media-source#337 (comment)

ReSpec currently (rightfully) issues warnings because some of the MSE terms
are defined informatively in MSE, whereas they should rather be defined in a
normative section, as noted in:
w3c/media-source#325 (comment)
@tidoust
Copy link
Member

tidoust commented Dec 4, 2023

@marcoscaceres I prepared a refresh of the ISO BMFF Byte Stream Format spec to see what that would involve, see w3c/mse-byte-stream-format-isobmff#12. If that looks fine, happy to do the same for the other specs (and then we can setup auto publish).

@marcoscaceres
Copy link
Member Author

That would be amazing! Thanks for handling the other doc!

@marcoscaceres
Copy link
Member Author

@tidoust, please merge this when you are ready in coordination with the other PR when ready. Thanks again!

tidoust added a commit to w3c/mse-byte-stream-format-mp2t that referenced this pull request Dec 5, 2023
This refreshes the spec to leverage ReSpec cross-referencing capabilities.
See discussion in:
w3c/media-source#337 (comment)

Section 3 contained a reference to "ISO/IEC 13818-1:2012 Amd. 2". As far as I
can tell, there have been no revision of 13818-1 dated 2012, so that reference
is incorrect. The closest might be "ISO/IEC 13818-1:2013/Amd 2:2014" but this
version has been replaced by newer versions in any case. This update simply
uses `[[MPEG2TS]]`.
tidoust added a commit to w3c/mse-byte-stream-format-mpeg-audio that referenced this pull request Dec 5, 2023
See discussion in w3c/media-source#337 (comment)

The references to ID3v1 and ID3v2 remain in the local biblio for now because
the id3.org server, which hosts the specifications, returns a 500 Internal
Server Error (and has been returning that error in the past few months). Not
quite sure what to do with that.

Also, Specref has ID3 v2.4.0, but the spec probably means it when it references
v2.3.0 as that is the "main" one in practice.
tidoust added a commit to w3c/mse-byte-stream-format-webm that referenced this pull request Dec 5, 2023
See discussion in w3c/media-source#337 (comment)

Fragment references to WebM Container Guidelines spec need to be done through
`data-cite` because the spec is not in the cross-references database (and does
not follow usual conventions for definitions).
tidoust added a commit to w3c/mse-byte-stream-format-registry that referenced this pull request Dec 5, 2023
tidoust added a commit to w3c/mse-byte-stream-format-isobmff that referenced this pull request Dec 6, 2023
This refreshes the spec to leverage ReSpec cross-referencing capabilities.
See discussion in w3c/media-source#337 (comment)

ReSpec currently (rightfully) issues warnings because some of the MSE terms
are defined informatively in MSE, whereas they should rather be defined in a
normative section, as noted in:
w3c/media-source#325 (comment)
tidoust added a commit to w3c/mse-byte-stream-format-mp2t that referenced this pull request Dec 6, 2023
This refreshes the spec to leverage ReSpec cross-referencing capabilities.
See discussion in:
w3c/media-source#337 (comment)

Section 3 contained a reference to "ISO/IEC 13818-1:2012 Amd. 2". As far as I
can tell, there have been no revision of 13818-1 dated 2012, so that reference
is incorrect. The closest might be "ISO/IEC 13818-1:2013/Amd 2:2014" but this
version has been replaced by newer versions in any case. This update simply
uses `[[MPEG2TS]]`.
tidoust added a commit to w3c/mse-byte-stream-format-webm that referenced this pull request Dec 6, 2023
See discussion in w3c/media-source#337 (comment)

Fragment references to WebM Container Guidelines spec need to be done through
`data-cite` because the spec is not in the cross-references database (and does
not follow usual conventions for definitions).
tidoust added a commit to w3c/mse-byte-stream-format-registry that referenced this pull request Dec 6, 2023
tidoust added a commit to w3c/mse-byte-stream-format-mpeg-audio that referenced this pull request Dec 6, 2023
See discussion in w3c/media-source#337 (comment)

The references to ID3v1 and ID3v2 remain in the local biblio for now because
the id3.org server, which hosts the specifications, returns a 500 Internal
Server Error (and has been returning that error in the past few months). Not
quite sure what to do with that.

Also, Specref has ID3 v2.4.0, but the spec probably means it when it references
v2.3.0 as that is the "main" one in practice.
@tidoust
Copy link
Member

tidoust commented Dec 6, 2023

@tidoust, please merge this when you are ready in coordination with the other PR when ready. Thanks again!

Byte stream format specs and registry have now been updated not to rely on the custom media-source.js logic anymore. Merging accordingly.

@tidoust tidoust merged commit be0d251 into main Dec 6, 2023
2 checks passed
github-actions bot added a commit that referenced this pull request Dec 6, 2023
SHA: be0d251
Reason: push, by tidoust

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@marcoscaceres marcoscaceres deleted the SourceBuffer_headings branch June 14, 2024 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants