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.

Sign up for GitHub

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

Jump to bottom

Deprecate ittm:altText #290

Merged
merged 6 commits into from
Jan 29, 2018
Merged

Deprecate ittm:altText #290

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
206bfce
Deprecate ittm:altText (#274)
palemieux Jan 15, 2018
eb29de7
Add deprecation to features table
palemieux Jan 15, 2018
3052aa9
Added support for #metadata-item and #metadata-version-2 features
palemieux Jan 15, 2018
d4433b6
Address https://github.com/w3c/imsc/pull/290#discussion_r161860149
palemieux Jan 16, 2018
264b8ca
Address https://github.com/w3c/imsc/pull/290#discussion_r161799609
palemieux Jan 16, 2018
fb705a8
Merge remote-tracking branch 'origin/IMSC1.1' into issue-274-deprecat…
palemieux Jan 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 60 additions & 5 deletions imsc1/spec/ttml-ww-profiles.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;}
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

</style>
</head>

Expand Down Expand Up @@ -304,9 +305,8 @@ <h3>General</h3>
assistive technologies have access to its corresponding text form. The method by which this association is made is left to
each application.</p>

<p class='note'>The <code>ittm:altText</code> element specified <a href='#ittm-altText'></a> also allows text equivalent
string to be associated with an image, e.g. to support indexation of the content and also facilitate quality checking of the
document during authoring.</p>
<p class='note'>The <code>altText</code> named metadata item also allows text equivalent string to be associated with an
image, e.g. to support indexation of the content and also facilitate quality checking of the document during authoring.</p>

<p>Annex <a href='#wcag-applications'></a> specifically discusses this specification in the context of the [[WCAG20]]
guidelines.</p>
Expand Down Expand Up @@ -1163,6 +1163,18 @@ <h2>Supported Features and Extensions</h2>
<td colspan="2">permitted</td>
</tr>

<tr>
<td><code>#metadata-item</code></td>

<td colspan="2">permitted</td>
</tr>

<tr>
<td><code>#metadata-version-2</code></td>

<td colspan="2">permitted</td>
</tr>

<tr>
<td><code>#nested-div</code></td>

Expand Down Expand Up @@ -1875,6 +1887,12 @@ <h2>Supported Features and Extensions</h2>
<td colspan="3" style="text-align:center"><em>Relative to the <a>IMSC 1.0 Extension</a> namespace</em></td>
</tr>

<tr>
<td><code>#altText</code></td>

<td colspan="2">permitted-deprecated</td>
</tr>

<tr>
<td><code>#aspectRatio</code></td>

Expand Down Expand Up @@ -2473,6 +2491,9 @@ <h4>itts:forcedDisplay</h4>
<section id='ittm-altText'>
<h4>ittm:altText</h4>

<p class="deprecation">The <code>#altText</code> feature is designated as <em>permitted-deprecated</em> in the profiles
defined by this specification. The <code>altText</code> named metadata item provides equivalent semantics.</p>

<p><code>ittm:altText</code> allows an author to provide a text string equivalent for an element, typically an image. This
text equivalent MAY be used to support indexing of the content and also facilitate quality checking of the document during
authoring.</p>
Expand Down Expand Up @@ -2799,6 +2820,23 @@ <h5>Maximum number</h5>
</section>
</section>

<section id="altText">
<h4><code>altText</code> named metadata item</h4>

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

<section id="itm-altText">
<h4><code>#altText</code></h4>

<p>The <code>ittm:altText</code> element SHOULD NOT be present unless compatibility with [[ttml-imsc1.0.1]] processors is
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>
Copy link
Contributor

Choose a reason for hiding this comment

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

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

</section>

<section>
<h4><code>#cellResolution</code></h4>

Expand Down Expand Up @@ -3139,8 +3177,8 @@ <h4><code>TTML #image Feature</code></h4>
<p>A <code>div</code> element SHALL have zero or one child <code>image</code> element.</p>

<p>A <code>div</code> element that contains a child <code>image</code> element SHOULD contain a <code>metadata</code>
element containing an <code>ittm:altText</code> element that is a <a>Text Alternative</a> of the image resource referenced
by the <code>image</code> element.</p>
element containing an <code>altText</code> named metadata item that is a <a>Text Alternative</a> of the image resource
referenced by the <code>image</code> element.</p>

<p>An <code>image</code> element SHALL specify a <code>src</code> attribute, which references an image resource that
conforms to <a href='#image-resource'></a>.</p>
Expand Down Expand Up @@ -4188,6 +4226,9 @@ <h3>#forcedDisplay</h3>
<section class='appendix'>
<h3>#altText</h3>

<p class="deprecation">The <code>#altText</code> feature is designated as <em>permitted-deprecated</em> in the profiles
defined by this specification. The <code>altText</code> named metadata item provides equivalent semantics.</p>

<p>A <a>transformation processor</a> supports the <code>#altText</code> feature if it recognizes and is capable of
transforming values of the <a href="#ittm-altText"><code>ittm:altText</code></a> element.</p>

Expand Down Expand Up @@ -4540,6 +4581,14 @@ <h4>Added Features</h4>
<td><code>#luminanceGain</code></td>
</tr>

<tr>
<td><code>#metadata-item</code></td>
</tr>

<tr>
<td><code>#metadata-version-2</code></td>
</tr>

<tr>
<td><code>#position</code></td>
</tr>
Expand Down Expand Up @@ -4649,6 +4698,12 @@ <h4>Deprecated selected Features</h4>
<td colspan="2" style="text-align:center"><em>Relative to the <a>IMSC 1.0 Extension</a> namespace</em></td>
</tr>

<tr>
<td><code>#altText</code><br></td>

<td>This feature is replaced by the <code>altText</code> named metadata item.</td>
</tr>

<tr>
<td><code>#linePadding</code></td>

Expand Down