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

APA WG comment: Add introduction #522

Closed
michael-n-cooper opened this issue Mar 9, 2020 · 7 comments
Closed

APA WG comment: Add introduction #522

michael-n-cooper opened this issue Mar 9, 2020 · 7 comments
Assignees
Labels
a11y-needs-resolution Issue the Accessibility Group has raised and looks for a response on. imsc1.2 pr open WR-commenter-agreed
Milestone

Comments

@michael-n-cooper
Copy link
Member

Suggested Introduction Section for First-Time Readers: The document would be easier to read and understand for first-time readers if it had an introduction that guided the reader to a better understanding of its content. Such an introduction could serve to introduce the reader to items such as the following:

  • Why are profiles needed for text-only and image-only captions/subtitles?
  • What are typical use cases for image-only captions/subtitles?
@michael-n-cooper michael-n-cooper added the a11y-needs-resolution Issue the Accessibility Group has raised and looks for a response on. label Mar 9, 2020
@css-meeting-bot
Copy link
Member

The Timed Text Working Group just discussed APA WG comment: Add introduction, and agreed to the following:

  • SUMMARY: Discussed today. Pierre to ask follow-up question on this issue.
The full IRC log of that discussion <cyril_> Topic: APA WG comment: Add introduction
<cyril_> github: https://github.com//issues/522
<cyril_> pal: before taking any action, I'd like to know if they've considered the text in 5.1
<cyril_> cyril_: maybe the fact that it's in 5.1 and not early
<cyril_> pal: exactly, happy to move some of it to an introduction if it suits them
<cyril_> SUMMARY: Discussed today. Pierre to ask follow-up question on this issue.

@palemieux palemieux self-assigned this Mar 12, 2020
@palemieux
Copy link
Contributor

@michael-n-cooper Section 5.1 describes scenarios and motivates the need for two profiles. Is this what you had in mind?

@gzimmermann
Copy link

I think, the first paragraph of Section 5.1 is a good basis for an introduction. But the introduction should be more elaborative in describing typical use cases for both profiles.

@css-meeting-bot
Copy link
Member

The Timed Text Working Group just discussed APA WG comment: Add introduction imsc#522, and agreed to the following:

  • SUMMARY: @palemieux to propose a pull request with an introduction after the other APA issues have been resolved.
The full IRC log of that discussion <nigel> Topic: APA WG comment: Add introduction imsc#522
<nigel> github: https://github.com//issues/522
<nigel> Nigel: @gzimmermann has answered your question Pierre that §5.1 is a good starting
<nigel> .. point for an introduction.
<nigel> Pierre: I'd like to close #542 knowing we've go that right, and then begin work on an
<nigel> .. introduction.
<nigel> .. I hate introductions and I'm worried it will take a long time, because everyone has a
<nigel> .. different idea of what is needed and what accessibility means but if it is needed then
<nigel> .. we should do it. My recommendation is we do this last.
<nigel> Nigel: We've discussed Explainers before, and I think it would be a good start to
<nigel> .. use the Explainer structure so that someone coming in from a cold start can read
<nigel> .. the introduction as an explainer and get a pretty good idea of what the spec is,
<nigel> .. how it might be used and how it fits with other work.
<nigel> Pierre: I'm reluctant to start listing use cases because there are so many different ideas
<nigel> .. for them globally. For example look at the WebVTT intro and it says "see MAUR".
<nigel> Nigel: That's fine, maybe that is all that's needed to set the context.
<nigel> Pierre: Alright, I'm happy to pull all the introductory text into a single introduction section.
<nigel> Gary: Yes Introductions are hard, it makes sense to do it last, definitely.
<nigel> Pierre: The positive way I am looking at it is that it might make sense to bring the informative
<nigel> .. text together in one introduction. It might improve the document. That part I'm excited by.
<nigel> Andreas: I agree with Pierre that it is really hard to cover all the use cases.
<nigel> .. Possibly something like MDN is a good place to look for more details about practical
<nigel> .. use cases.
<nigel> Nigel: Add an informative link to the MDN docs?
<nigel> Andreas: No not a proposal for a solution but just a point that some of the information
<nigel> .. should be somewhere else like MDN.
<nigel> .. Adding a link to it is a different question for us to consider.
<nigel> SUMMARY: @palemieux to propose a pull request with an introduction after the other APA issues have been resolved.

palemieux added a commit that referenced this issue May 16, 2020
@palemieux palemieux added this to the IMSC1.2-PR milestone May 16, 2020
@palemieux
Copy link
Contributor

@michael-n-cooper See #552 for a proposed introduction.

@gzimmermann
Copy link

@palemieux The new introduction is really good now and explains the purpose of the two profiles and their implications on SC 1.1.1 well. Thanks much.

@himorin
Copy link
Contributor

himorin commented Jul 30, 2020

(close this as all satisfied?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y-needs-resolution Issue the Accessibility Group has raised and looks for a response on. imsc1.2 pr open WR-commenter-agreed
Projects
None yet
Development

No branches or pull requests

6 participants