Skip to content

Add Examples section to Introduction and add some renderings#632

Merged
nigelmegitt merged 6 commits intomainfrom
issue-0553/intro-examples
Feb 10, 2026
Merged

Add Examples section to Introduction and add some renderings#632
nigelmegitt merged 6 commits intomainfrom
issue-0553/intro-examples

Conversation

@nigelmegitt
Copy link
Contributor

DRAFT pull request for early review comments, to see if I'm heading in an agreeable direction.

Closes #553

  • Add an Example Documents subsection to the Introduction
  • Point to existing samples in Appendix E and Appendix I.2
  • Add illustrative renderings of all the ISDs generated by each of those samples
  • Improve the EBU-TT-D example's formatting and rendered appearance, using some additional styling features - fontFamily, color, linePadding.

Also updates the examples' ttp:contentProfiles values to use the IMSC 1.3 designator instead of the 1.2 designator.

@nigelmegitt nigelmegitt requested a review from palemieux January 20, 2026 12:52
@css-meeting-bot
Copy link
Member

The Timed Text Working Group just discussed Add Examples section to Introduction and add some renderings w3c/imsc#632, and agreed to the following:

  • SUMMARY: @nigelmegitt to add example, remove pointers in 2.1 to other examples, leave renders in place.
The full IRC log of that discussion <nigel> Subtopic: Add Examples section to Introduction and add some renderings #632
<nigel> github: https://github.com//pull/632
<cpn> Nigel: It's a draft PR for now, to add examples to the Introduction, and add some renderings
<cpn> .. I want to check in before I do more on this
<cpn> .. It adds some orientation information for people unfamiliar with the spec. But want to pause to discuss
<cpn> Pierre: On the rendered examples, it's not a bad idea. But I'd rather we use actual examples. Those examples demonstrate the syntax but they're artificial
<cpn> ... Would it be possible to use a real example, and actual document or fragment?
<cpn> Nigel: I already have something like that in the BBC Subtitle Guidelines, so that's easy to do, but it takes up a lot of space
<nigel> -> https://www.bbc.co.uk/accessibility/forproducts/guides/subtitles/#Example-EBU-TT-D-document
<cpn> Pierre: Have a frame from a BBC show with the EBU-TT-D fragment, showing how it's used in practice?
<cpn> Nigel: Would that be useful?
<cpn> Pierre: I'm trying to think of something that's not been don elsewhere. MDN has examples. The IMSC test suite has exhaustive examples
<cpn> ... What's missing is how it shows up in practice
<cpn> Nigel: The BBC Subtitle Guidelines is a real world example
<cpn> ... [Shows the BBC example]
<cpn> Pierre: I think that's awesome. I'd just include this. The region stuff is helpful
<cpn> ... It could go in an Annex if it's too long
<cpn> ... Add an acknowledgement too
<cpn> Nigel: OK, yes
<cpn> Chris: Move it to an Annex?
<cpn> Nigel: For people reading from the top, and want orientation, I think it should go in the Introduction. Much easier than reading through the spec detail
<cpn> Pierre: I'm fine with putting it in the Introduction.
<cpn> Nigel: And leave the rendering examples in place in the PR?
<cpn> Pierre: That's fine, no strong opinion. Could link to them if in they're in the test suite
<nigel> SUMMARY: @nigelmegitt to add example, remove pointers in 2.1 to other examples, leave renders in place.

* Adds a Example Documents section in the Introduction, with pointers to two examples elsewhere in the document, and a stub sub-section for explaining the basic structure.
* Adds example renderings and explanations to the sample document in appendix E and the sample EBU-TT-D conformant document in appendix I.2.
* Fixes up the EBU-TT-D document in I.2 for formatting (replacing tabs with spaces) and to make the rendering demonstrate the styling features showBackground, fontFamily and linePadding, and to ensure there is adequate color contrast between the text and the background in the lime green region.
Refactor figcaption content to be shorter, moving the previous text into the main body content.
And remove the previous text in Example Document, as agreed in the TTWG call 2026-01-29 https://www.w3.org/2026/01/29-tt-minutes.html#9bb1
@nigelmegitt nigelmegitt force-pushed the issue-0553/intro-examples branch from ca2b26b to b50d7e7 Compare February 5, 2026 18:04
@nigelmegitt nigelmegitt marked this pull request as ready for review February 5, 2026 18:04
@nigelmegitt
Copy link
Contributor Author

Example added as discussed, I think this is ready for review now @palemieux .

@nigelmegitt nigelmegitt merged commit 980f3bf into main Feb 10, 2026
2 checks passed
@nigelmegitt nigelmegitt deleted the issue-0553/intro-examples branch February 10, 2026 18:59
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.

Update examples so they signal conformance with IMSC 1.3 Introduction: include an example annotated document and render

3 participants