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

Add @ttm:alt as shorthand for ttm:item name="altText" (#490). #506

Closed
wants to merge 3 commits into from

Conversation

skynavga
Copy link
Collaborator

Closes #490.

@skynavga skynavga self-assigned this Dec 23, 2017
@skynavga skynavga added this to the Editor's CR Work List milestone Dec 23, 2017
@nigelmegitt
Copy link
Contributor

Built version can be found at https://rawgit.com/w3c/ttml2/issue-0490-add-ttm-alt-build/index.html

Copy link
Contributor

@palemieux palemieux left a comment

Choose a reason for hiding this comment

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

The prose at /altText must match the prose at 7.7.4 ittm:altText at IMSC1.0.1, including the NOTE. Also, shouldn't the be a feature that includes the ttm:alt attribute?

Copy link
Contributor

@nigelmegitt nigelmegitt left a comment

Choose a reason for hiding this comment

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

Request addition of a note about applicable values of attributes on a ttm:item name="altText" that cannot be set on the attribute shorthand.

Also the schemas need to be updated to include the new attribute form.

spec/ttml2.xml Outdated

<div3 id="metadata-attribute-alt">
<head>ttm:alt</head>
<p>The <att>ttm:alt</att> attribute serves as a shorthand expression for an equivalent
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to state that the applicable xml:lang on the element applies, and that xml:space is considered to be "preserve" on attribute values?

Also probably worth noting that if these values need to be set explicitly, or indeed any other attribute on an ttm:item name="altText" then the element form needs to be used.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

sounds reasonable, will add

@nigelmegitt
Copy link
Contributor

@palemieux I don't agree that the altText attribute prose must match IMSC 1.0.1 ittm:altText, because a) it can't - see #490 (comment) and b) it is reasonable for TTML2 to be more general and for profiles to be more specific.

Any modifications that are worth making to align the TTML2 structure with the IMSC one, such as usage notes, would need to be made on the ttm:item section that defines the altText name rather than the short form attribute version since the latter simply refers to the former. Would you consider raising any such issue against 14.3.2 <named item> rather than requiring it on this pull request?

@skynavga
Copy link
Collaborator Author

skynavga commented Dec 24, 2017

@palemieux regarding

shouldn't the[re] be a feature that includes the ttm:alt attribute?

I presume you are asking for a distinct feature for ttm:alt, and not just one group feature, as just defined in #508. I should normally say no, since TTML1 doesn't define a feature for each metadata vocabulary item, but instead, coalesces them into one feature (#metadata). However, I anticipate that you might want to include support only for @ttm:alt in a profile, but exclude support for ttm:item, so I will define individual features in #508 as well.

@skynavga
Copy link
Collaborator Author

@palemieux see 69867ff

@skynavga
Copy link
Collaborator Author

@nigelmegitt added schema update and note/prose on lang/space

Copy link
Contributor

@nigelmegitt nigelmegitt left a comment

Choose a reason for hiding this comment

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

Thanks, all my comments addressed here.

@skynavga
Copy link
Collaborator Author

@palemieux are your comments addressed?

@cconcolato
Copy link
Contributor

To address @palemieux, maybe we could add some text to "14.3.2 " in the "altText" part, not in the new attribute section. What seems to be missing are:

  • this sentence:

This text equivalent may be used to support indexing of the content and also facilitate quality checking of the document during authoring.

  • and the NOTE

@skynavga
Copy link
Collaborator Author

skynavga commented Jan 1, 2018

@cconcolato in general, I am opposed to enumerating or describing applications of a feature, particularly when it is a feature that has a long history of various applications.

also, what do you mean by "and the NOTE"?

@cconcolato
Copy link
Contributor

I was talking about the NOTE in IMSC which talks about how it is different from HTML5.

@skynavga
Copy link
Collaborator Author

skynavga commented Jan 2, 2018

That note is irrelevant to TTML (and IMSC for that matter), and adds nothing that clarifies or explains TTML metadata semantics. If we went down this path, we would need notes explaining that TTML {head,body,div,p,span,br} are distinct from HTML vocabulary of the same name.

@palemieux
Copy link
Contributor

In preparation for the F2F meeting, below is a summary of my objection.

  • IMSC1 introduced ittm:altText. The prose around ittm:altText was subject of much discussion, including the note at the end of 7.7.4 and the MAY in the introductory paragraph.

  • TTML2 eventually introduced <ttm:item name="altText"/> to serve a similar purpose. [ed.: it is still not clear to me what motivated using a generic ttm:item element plus @name, instead of simply introducing individual elements, i.e. using native XML extension mechanisms.]

  • the discussion at the TTWG F2F pointed towards using an @ttm:alt attribute instead of <ttm:item name="altText"/>.

This PR, which (i) proposes to introduce @ttm:alt in addition to <ttm:item name="altText"/> and (ii) does not match IMSC1 prose, has the following pitfalls:

  • supporting both @ttm:alt and <ttm:item name="altText"/> complicates implementations, especially since the mapping is not one-to-one
  • both @ttm:alt and <ttm:item name="altText"/> diverge syntactically from ittm:altText
  • additional prose will be required in IMSC1.1 to backfill any prose absent from TTML2, and constrain out <ttm:item name="altText"/>, thereby somewhat defeating the purpose of IMSC1.1 referencing TTML2
  • the new prose in both TTML2 and IMSC1.1 may yield new comments whereas the prose in IMSC1 is presumably acceptable

Assuming there is a desire to preserve the altText element, I think the simplest path forward is to:

  • move ittm:altText to the TTML2 namespace (as ttm:altText)
  • deprecate ittm:altText in IMSC 1.1
  • use ttm:altText in IMSC 1.1

Alternatively, IMSC 1.1 could continue supporting ittm:altText, regardless of what TTML2 does.

@skynavga
Copy link
Collaborator Author

skynavga commented Jan 2, 2018 via email

@nigelmegitt
Copy link
Contributor

WG resolves not to merge this and not to add the ttm:altText attribute. See the issue.

@skynavga
Copy link
Collaborator Author

Per #490 (comment), have resolved not to add @ttm:alt; therefore, closing this PR.

@skynavga skynavga closed this Jan 10, 2018
@skynavga skynavga deleted the issue-0490-add-ttm-alt branch March 9, 2018 21:09
@skynavga skynavga removed their assignment Mar 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants