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

Fix WebVTT description indicating that text payload lines need to start with a hyphen #19997

Closed
TimJentzsch opened this issue Aug 26, 2022 · 0 comments · Fixed by #34034
Closed
Labels
Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help!

Comments

@TimJentzsch
Copy link

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API

What specific section or headline is this issue about?

https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API#inner_structure_of_a_webvtt_file

What information was incorrect, unhelpful, or incomplete?

The text indicates that the text payload lines of the cues need to start with a hyphen:

  • We can then have one or more lines that start with a hyphen (-), each containing part of the text track to be shown.

The examples at the start of the article also all start with hyphens, further indicating that this would be necessary.

To my understanding of the specification, the text payload can contain any text in the lines, except < and & (they need to be escaped) and empty lines.
The hyphens (-) would simply show up as a hyphen in the subtitle.

What did you expect to see?

Any text indicating that hyphens at the start of the payload lines are necessary should be removed.
The examples should be adapted to show that this is not necessary, e.g. showing some lines that do not have hyphens at the start.
This is already the case for examples later in the article.

Do you have any supporting links, references, or citations?

Do you have anything more you want to share?

No response

MDN metadata

Page report details
@github-actions github-actions bot added Content:WebAPI Web API docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Aug 26, 2022
@sideshowbarker sideshowbarker added help wanted If you know something about this topic, we would love your help! and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Aug 26, 2022
hamishwillee added a commit to hamishwillee/content that referenced this issue Jun 10, 2024
hamishwillee added a commit to hamishwillee/content that referenced this issue Jul 2, 2024
hamishwillee added a commit to hamishwillee/content that referenced this issue Jul 8, 2024
hamishwillee added a commit to hamishwillee/content that referenced this issue Jul 9, 2024
hamishwillee added a commit to hamishwillee/content that referenced this issue Jul 12, 2024
hamishwillee added a commit that referenced this issue Jul 12, 2024
* Any character references supported + del old relnotes

* Fix payload lines don't have to start with a hyphen #19997

* API ref for interfaces - update to current standard

* WebVTT file format split out

* Delete ::cue-region CSS pseudo class (no implementations)

* Web API - Styling example

* Start updating WebVTT text format doc

* Prettier the video element

* Add STYLE block. Add Style examples

* Tidy up after removing description kind

* Apply suggestions from code review

Co-authored-by: Chris Mills <chrisdavidmills@gmail.com>

* add note about :cue-region support (or lack of

* TextTrack - explain how created
<track> element creation info
Track/Video element cross linking

* Apply suggestions from code review

Co-authored-by: Chris Mills <chrisdavidmills@gmail.com>

---------

Co-authored-by: Chris Mills <chrisdavidmills@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help!
2 participants