Deprecate ittm:altText #290

palemieux · 2018-01-15T17:30:52Z

Closes #274

nigelmegitt

No problem with the basic content, but quite a few editorial comments/questions.

nigelmegitt · 2018-01-16T11:26:32Z

imsc1/spec/ttml-ww-profiles.html

@@ -67,6 +67,7 @@
  .equation {text-indent: 10%;}
  .example {font-size: small}
  .inline-note {font-size: small}
+  .deprecation {background-color: yellow; color:red; border: 2px solid darkred;}


I'm not sure if there's a W3C normal style for deprecation styling but TTML2 has used an orange background with black text. It'd be good to be consistent if possible.

Added to the editorial task list, i.e. I would rather not block this PR until we solve this.

I've just done a quick scan of HTML5.2, CSS Speech and XSD 1.1 and there does not appear to be a consistent standard for marking deprecations. I also reviewed this style in comparison with the TTML2 one, and this is certainly clearer, though in a sense it looks like it is not part of the spec!

It also has a specific problem that the text is too close to the border especially on the left edge.

I don't mind if you want to open a separate issue for getting the deprecation styling right.

nigelmegitt · 2018-01-16T11:28:31Z

imsc1/spec/ttml-ww-profiles.html

@@ -2474,6 +2492,9 @@ <h4>itts:forcedDisplay</h4>
      <section id='ittm-altText'>
        <h4>ittm:altText</h4>

+        <p class="deprecation">The <code>ittm:altText</code> element is intended to be removed from future revisions of this


Not enjoying the passive grammar of this - I'd prefer "The TTWG intends to remove the ittm:altText element from future revisions of this specification".

I think it might be best to have single definition of "deprecated" in the "document convention" section.

That'd work for me.

nigelmegitt · 2018-01-16T11:29:16Z

imsc1/spec/ttml-ww-profiles.html

@@ -2474,6 +2492,9 @@ <h4>itts:forcedDisplay</h4>
      <section id='ittm-altText'>
        <h4>ittm:altText</h4>

+        <p class="deprecation">The <code>ittm:altText</code> element is intended to be removed from future revisions of this
+        specification. The <code>altText</code> named metadata item provides equivalent semantics.</p>


Suggest changing "metadata item provides" to "metadata item (ttm:item) provides".

nigelmegitt · 2018-01-16T11:30:55Z

imsc1/spec/ttml-ww-profiles.html

+      <section id="altText">
+        <h4><code>altText</code> named metadata item element</h4>
+
+        <p>A <code>altText</code> named metadata item element SHALL NOT be present in a <a>Document Instance</a> if any


Can we be even more explicit that we are talking about ttm:item name="altText"?

altText named metadata item is the terminology used by TTML2

OK maybe I should raise an issue there too. Happy to hear other views before making this change.

It makes sense to keep it this way as long TTML2 does the same. If it changes in TTML2 it could also be changed in IMSC 1.1 on the basis of a new issue.

@TairT what's your view on which approach is better, assuming we take the same approach in both specs?

I do not have a strong view on this but here are some thoughts:

To use the term "named" with element may be confusing as the element has a local name ("item"). Therefore it may be better to just say "named metadata item". This terminology is used in TTML2. Only once it is called "named metadata item element". This should be corrected in TTML2.

"Named metadata item" is defined in TTML2, so it can/should be used in IMSC. It makes sense to establisch a convention and I think "[name of item] named metadata item is better than "ttm:item name="altText" (especially if you do not read it but speak about it).

As ittm:alt has an example, an example with ttm:item may help to ease transition. I won't mind if this would be added on the basis of a seperate github issue.

I think that's a request to change "named metadata item element" to "named metadata item".

OK I'm not sure it's really clear but I'm happy to go with my take on your points above @TairT , that we can use "altText named metadata item".

nigelmegitt · 2018-01-16T11:31:22Z

imsc1/spec/ttml-ww-profiles.html

+        desired.</p>
+
+        <p>A <code>ittm:altText</code> element SHALL NOT be present in a <a>Document Instance</a> if any <code>altText</code> named
+        metadata item element is also present.</p>


Again, I'd like to be explicit that we are talking about "ttm:item name="altText".

nigelmegitt · 2018-01-16T11:32:38Z

imsc1/spec/ttml-ww-profiles.html

@@ -4189,6 +4227,9 @@ <h3>#forcedDisplay</h3>
    <section class='appendix'>
      <h3>#altText</h3>

+      <p class="deprecation">This feature is intended to be removed from future revisions of this specification. The


Again, I'd prefer an active construction describing that TTWG intends this rather than the passive construction here.

nigelmegitt · 2018-01-16T12:29:31Z

imsc1/spec/ttml-ww-profiles.html


-              <td>Deprecated in <a>Image Profile</a> only. This feature was erroneously designated as permitted in the [[ttml-imsc1.0.1]] Image Profile.</td>
+              <td>This feature is replaced by the <code>altText</code> named metadata item element.</td>


Shouldn't the replacement of a feature be expressed in terms of a feature designator? If we are specifying the replacement syntax and semantics I would prefer to say "by the ttm:item metadata element with the name attribute set to "altText" ".

TTML2 does not specify a feature designator for individual items.

Right, I see, it's the combination of a feature scoped by a specific item name.

…e-ittm-altText

palemieux added the imsc1.1 label Jan 15, 2018

palemieux added this to the imsc1.1 WD2 milestone Jan 15, 2018

palemieux self-assigned this Jan 15, 2018

palemieux closed this Jan 15, 2018

Deprecate ittm:altText (#274)

206bfce

palemieux reopened this Jan 15, 2018

palemieux changed the base branch from master to IMSC1.1 January 15, 2018 17:32

Add deprecation to features table

eb29de7

palemieux added the pr open label Jan 15, 2018

Added support for #metadata-item and #metadata-version-2 features

3052aa9

nigelmegitt reviewed Jan 16, 2018

View reviewed changes

andreastai approved these changes Jan 16, 2018

View reviewed changes

palemieux added 2 commits January 16, 2018 15:43

Address #290 (comment)

d4433b6

Address #290 (comment)

264b8ca

andreastai approved these changes Jan 17, 2018

View reviewed changes

nigelmegitt approved these changes Jan 18, 2018

View reviewed changes

palemieux removed the pr open label Jan 25, 2018

Merge remote-tracking branch 'origin/IMSC1.1' into issue-274-deprecat…

fb705a8

…e-ittm-altText

palemieux merged commit 6202d3f into IMSC1.1 Jan 29, 2018

palemieux deleted the issue-274-deprecate-ittm-altText branch February 9, 2018 17:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate ittm:altText #290

Deprecate ittm:altText #290

palemieux commented Jan 15, 2018

nigelmegitt left a comment

nigelmegitt Jan 16, 2018

palemieux Jan 16, 2018

nigelmegitt Jan 16, 2018

nigelmegitt Jan 16, 2018

palemieux Jan 16, 2018 •

edited

Loading

nigelmegitt Jan 16, 2018

nigelmegitt Jan 16, 2018

nigelmegitt Jan 16, 2018

palemieux Jan 16, 2018

nigelmegitt Jan 16, 2018

andreastai Jan 16, 2018

nigelmegitt Jan 16, 2018

andreastai Jan 16, 2018

nigelmegitt Jan 16, 2018

nigelmegitt Jan 16, 2018

nigelmegitt Jan 16, 2018

nigelmegitt Jan 16, 2018

palemieux Jan 16, 2018

nigelmegitt Jan 16, 2018


		<td>Deprecated in <a>Image Profile</a> only. This feature was erroneously designated as permitted in the [[ttml-imsc1.0.1]] Image Profile.</td>
		<td>This feature is replaced by the <code>altText</code> named metadata item element.</td>

Deprecate ittm:altText #290

Deprecate ittm:altText #290

Conversation

palemieux commented Jan 15, 2018

nigelmegitt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

palemieux Jan 16, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

palemieux Jan 16, 2018 •

edited

Loading