[html5] r6366 - [e] (0) More information for cue syntax. Fixing http://www.w3.org/Bugs/Public/sh [...]

whatwg at whatwg.org whatwg at whatwg.org
Thu Aug 4 13:13:12 PDT 2011


Author: ianh
Date: 2011-08-04 13:13:10 -0700 (Thu, 04 Aug 2011)
New Revision: 6366

Modified:
   complete.html
   index
   source
Log:
[e] (0) More information for cue syntax.
Fixing http://www.w3.org/Bugs/Public/show_bug.cgi?id=12813

Modified: complete.html
===================================================================
--- complete.html	2011-08-04 16:24:35 UTC (rev 6365)
+++ complete.html	2011-08-04 20:13:10 UTC (rev 6366)
@@ -32038,7 +32038,12 @@
    <li>Optionally, one or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters followed by <a href=#webvtt-cue-settings>WebVTT cue settings</a>.</li>
    <li>A <a href=#webvtt-line-terminator>WebVTT line terminator</a>.</li>
    <li>The <dfn id=cue-payload>cue payload</dfn>: either <a href=#webvtt-cue-text>WebVTT cue text</a> or <a href=#webvtt-metadata-text>WebVTT metadata text</a>.</li>
-  </ol><p><a href=#webvtt-cue-text>WebVTT cue text</a> is syntactically a subset of
+  </ol><p class=note>A <a href=#webvtt-cue>WebVTT cue</a> corresponds to one piece
+  of time-aligned text or data in the <a href=#webvtt-file>WebVTT file</a>, for
+  example one subtitle. The <a href=#cue-payload>cue payload</a> is the text or
+  data associated with the cue.</p>
+
+  <p><a href=#webvtt-cue-text>WebVTT cue text</a> is syntactically a subset of
   <a href=#webvtt-metadata-text>WebVTT metadata text</a>. Conformance checkers, when
   validating <a href=#webvtt>WebVTT</a> files, may offer to restrict all cues
   to only having <a href=#webvtt-cue-text>WebVTT cue text</a> as their <a href=#cue-payload>cue
@@ -32062,6 +32067,9 @@
   SIGN), nor containing any U+000A LINE FEED (LF) characters or U+000D
   CARRIAGE RETURN (CR) characters.</p>
 
+  <p class=note>A <a href=#webvtt-cue-identifier>WebVTT cue identifier</a> can be used to
+  reference a specific cue, for example from script or CSS.</p>
+
   <p>The <dfn id=webvtt-cue-timings>WebVTT cue timings</dfn> part of a <a href=#webvtt-cue>WebVTT
   cue</a> consists of the following components, in the given
   order:</p>
@@ -32085,7 +32093,11 @@
    timestamp</a> must be greater than the start time offset of the
    cue.</li>
 
-  </ol><p>A <dfn id=webvtt-timestamp>WebVTT timestamp</dfn> representing a time in seconds and
+  </ol><p class=note>The <a href=#webvtt-cue-timings>WebVTT cue timings</a> give the start
+  and end offsets of the <a href=#webvtt-cue>WebVTT cue</a>. Different cues can
+  overlap. Cues are always listed ordered by their start time.</p>
+
+  <p>A <dfn id=webvtt-timestamp>WebVTT timestamp</dfn> representing a time in seconds and
   fractions of a second is a <a href=#webvtt-timestamp>WebVTT timestamp</a>
   representing hours <var title="">hours</var>, minutes <var title="">minutes</var>, seconds
   <var title="">seconds</var>, and thousandths of a second <var title="">seconds-frac</var>, calculated as follows:</p>
@@ -32144,13 +32156,23 @@
    <li>A <a href=#webvtt-text-position-cue-setting>WebVTT text position cue setting</a>.</li> <!-- T:100% -->
    <li>A <a href=#webvtt-size-cue-setting>WebVTT size cue setting</a>.</li>          <!-- S:100% -->
    <li>A <a href=#webvtt-alignment-cue-setting>WebVTT alignment cue setting</a>.</li>     <!-- A:start/middle/end -->
-  </ul><p>A <dfn id=webvtt-vertical-text-cue-setting>WebVTT vertical text cue setting</dfn> consists of the
+  </ul><p class=note><a href=#webvtt-cue-settings>WebVTT cue settings</a> give configuration
+  options regarding the position and alignment of the cue. For
+  example, it allows a cue to be aligned to the left or positioned at
+  the top right.</p>
+
+  <p>A <dfn id=webvtt-vertical-text-cue-setting>WebVTT vertical text cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0044 LATIN CAPITAL LETTER D character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One of the following strings: "<code title="">vertical</code>", "<code title="">vertical-lr</code>".</li>
-  </ol><p>A <dfn id=webvtt-line-position-cue-setting>WebVTT line position cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-vertical-text-cue-setting>WebVTT vertical text cue setting</a>
+  configures the cue to use vertical text layout rather than
+  horizontal text layout. Vertical text layout is sometimes used in
+  Japanese, for example. The default is horiontal layout.</p>
+
+  <p>A <dfn id=webvtt-line-position-cue-setting>WebVTT line position cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li><p>A U+004C LATIN CAPITAL LETTER L character.</li>
@@ -32167,27 +32189,55 @@
        <li>One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).</li>
       </ol></dd>
     </dl></li>
-  </ol><p>A <dfn id=webvtt-text-position-cue-setting>WebVTT text position cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-line-position-cue-setting>WebVTT line position cue setting</a>
+  configures the position of the cue. For horizontal cues, this is the
+  vertical position. The position can be given either as a percentage,
+  which gives the distance from the top of the frame, or as a line
+  number. Line numbers are based on the size of the first line of the
+  cue. Positive line numbers count from the top of the frame (the top
+  line is numbered 0), negative line numbers from the bottom of the
+  frame (the bottom line is numbered −1).</p>
+
+  <p>A <dfn id=webvtt-text-position-cue-setting>WebVTT text position cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0054 LATIN CAPITAL LETTER T character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).</li>
    <li>A U+0025 PERCENT SIGN character (%).</li>
-  </ol><p>A <dfn id=webvtt-size-cue-setting>WebVTT size cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-text-position-cue-setting>WebVTT text position cue setting</a>
+  configures the position of the text in the direction orthogonal to
+  the <a href=#webvtt-line-position-cue-setting>WebVTT line position cue setting</a>. For horizontal
+  cues, this is the horizontal position. The <a href=#webvtt-text-position-cue-setting>WebVTT text
+  position cue setting</a> is given as a percentage, calculated
+  from the edge of the frame that the text begins (so for
+  left-to-right English text, the left edge).</p>
+
+  <p>A <dfn id=webvtt-size-cue-setting>WebVTT size cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0053 LATIN CAPITAL LETTER S character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).</li>
    <li>A U+0025 PERCENT SIGN character (%).</li>
-  </ol><p>A <dfn id=webvtt-alignment-cue-setting>WebVTT alignment cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-size-cue-setting>WebVTT size cue setting</a> configures
+  the size of the cue in the same direction as the <a href=#webvtt-text-position-cue-setting>WebVTT text
+  position cue setting</a>. For horizontal cues, this is the width
+  of the cue. It is given as a percentage of the width of the
+  frame.</p>
+
+  <p>A <dfn id=webvtt-alignment-cue-setting>WebVTT alignment cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0041 LATIN CAPITAL LETTER A character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One of the following strings: "<code title="">start</code>", "<code title="">middle</code>", "<code title="">end</code>"</li>
-  </ol><p><dfn id=webvtt-metadata-text>WebVTT metadata text</dfn> consists of any sequence of one
+  </ol><p class=note>A <a href=#webvtt-alignment-cue-setting>WebVTT alignment cue setting</a>
+  configures the alignment of the text within the cue. The keywords
+  are relative to the text direction; for left-to-right English text,
+  "<code title="">start</code>" means left-aligned.</p>
+
+  <p><dfn id=webvtt-metadata-text>WebVTT metadata text</dfn> consists of any sequence of one
   or more characters other than U+000A LINE FEED (LF) characters and
   U+000D CARRIAGE RETURN (CR) characters, each optionally separated
   from the next by a <a href=#webvtt-line-terminator>WebVTT line terminator</a>. (In other

Modified: index
===================================================================
--- index	2011-08-04 16:24:35 UTC (rev 6365)
+++ index	2011-08-04 20:13:10 UTC (rev 6366)
@@ -31910,7 +31910,12 @@
    <li>Optionally, one or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters followed by <a href=#webvtt-cue-settings>WebVTT cue settings</a>.</li>
    <li>A <a href=#webvtt-line-terminator>WebVTT line terminator</a>.</li>
    <li>The <dfn id=cue-payload>cue payload</dfn>: either <a href=#webvtt-cue-text>WebVTT cue text</a> or <a href=#webvtt-metadata-text>WebVTT metadata text</a>.</li>
-  </ol><p><a href=#webvtt-cue-text>WebVTT cue text</a> is syntactically a subset of
+  </ol><p class=note>A <a href=#webvtt-cue>WebVTT cue</a> corresponds to one piece
+  of time-aligned text or data in the <a href=#webvtt-file>WebVTT file</a>, for
+  example one subtitle. The <a href=#cue-payload>cue payload</a> is the text or
+  data associated with the cue.</p>
+
+  <p><a href=#webvtt-cue-text>WebVTT cue text</a> is syntactically a subset of
   <a href=#webvtt-metadata-text>WebVTT metadata text</a>. Conformance checkers, when
   validating <a href=#webvtt>WebVTT</a> files, may offer to restrict all cues
   to only having <a href=#webvtt-cue-text>WebVTT cue text</a> as their <a href=#cue-payload>cue
@@ -31934,6 +31939,9 @@
   SIGN), nor containing any U+000A LINE FEED (LF) characters or U+000D
   CARRIAGE RETURN (CR) characters.</p>
 
+  <p class=note>A <a href=#webvtt-cue-identifier>WebVTT cue identifier</a> can be used to
+  reference a specific cue, for example from script or CSS.</p>
+
   <p>The <dfn id=webvtt-cue-timings>WebVTT cue timings</dfn> part of a <a href=#webvtt-cue>WebVTT
   cue</a> consists of the following components, in the given
   order:</p>
@@ -31957,7 +31965,11 @@
    timestamp</a> must be greater than the start time offset of the
    cue.</li>
 
-  </ol><p>A <dfn id=webvtt-timestamp>WebVTT timestamp</dfn> representing a time in seconds and
+  </ol><p class=note>The <a href=#webvtt-cue-timings>WebVTT cue timings</a> give the start
+  and end offsets of the <a href=#webvtt-cue>WebVTT cue</a>. Different cues can
+  overlap. Cues are always listed ordered by their start time.</p>
+
+  <p>A <dfn id=webvtt-timestamp>WebVTT timestamp</dfn> representing a time in seconds and
   fractions of a second is a <a href=#webvtt-timestamp>WebVTT timestamp</a>
   representing hours <var title="">hours</var>, minutes <var title="">minutes</var>, seconds
   <var title="">seconds</var>, and thousandths of a second <var title="">seconds-frac</var>, calculated as follows:</p>
@@ -32016,13 +32028,23 @@
    <li>A <a href=#webvtt-text-position-cue-setting>WebVTT text position cue setting</a>.</li> <!-- T:100% -->
    <li>A <a href=#webvtt-size-cue-setting>WebVTT size cue setting</a>.</li>          <!-- S:100% -->
    <li>A <a href=#webvtt-alignment-cue-setting>WebVTT alignment cue setting</a>.</li>     <!-- A:start/middle/end -->
-  </ul><p>A <dfn id=webvtt-vertical-text-cue-setting>WebVTT vertical text cue setting</dfn> consists of the
+  </ul><p class=note><a href=#webvtt-cue-settings>WebVTT cue settings</a> give configuration
+  options regarding the position and alignment of the cue. For
+  example, it allows a cue to be aligned to the left or positioned at
+  the top right.</p>
+
+  <p>A <dfn id=webvtt-vertical-text-cue-setting>WebVTT vertical text cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0044 LATIN CAPITAL LETTER D character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One of the following strings: "<code title="">vertical</code>", "<code title="">vertical-lr</code>".</li>
-  </ol><p>A <dfn id=webvtt-line-position-cue-setting>WebVTT line position cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-vertical-text-cue-setting>WebVTT vertical text cue setting</a>
+  configures the cue to use vertical text layout rather than
+  horizontal text layout. Vertical text layout is sometimes used in
+  Japanese, for example. The default is horiontal layout.</p>
+
+  <p>A <dfn id=webvtt-line-position-cue-setting>WebVTT line position cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li><p>A U+004C LATIN CAPITAL LETTER L character.</li>
@@ -32039,27 +32061,55 @@
        <li>One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).</li>
       </ol></dd>
     </dl></li>
-  </ol><p>A <dfn id=webvtt-text-position-cue-setting>WebVTT text position cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-line-position-cue-setting>WebVTT line position cue setting</a>
+  configures the position of the cue. For horizontal cues, this is the
+  vertical position. The position can be given either as a percentage,
+  which gives the distance from the top of the frame, or as a line
+  number. Line numbers are based on the size of the first line of the
+  cue. Positive line numbers count from the top of the frame (the top
+  line is numbered 0), negative line numbers from the bottom of the
+  frame (the bottom line is numbered −1).</p>
+
+  <p>A <dfn id=webvtt-text-position-cue-setting>WebVTT text position cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0054 LATIN CAPITAL LETTER T character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).</li>
    <li>A U+0025 PERCENT SIGN character (%).</li>
-  </ol><p>A <dfn id=webvtt-size-cue-setting>WebVTT size cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-text-position-cue-setting>WebVTT text position cue setting</a>
+  configures the position of the text in the direction orthogonal to
+  the <a href=#webvtt-line-position-cue-setting>WebVTT line position cue setting</a>. For horizontal
+  cues, this is the horizontal position. The <a href=#webvtt-text-position-cue-setting>WebVTT text
+  position cue setting</a> is given as a percentage, calculated
+  from the edge of the frame that the text begins (so for
+  left-to-right English text, the left edge).</p>
+
+  <p>A <dfn id=webvtt-size-cue-setting>WebVTT size cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0053 LATIN CAPITAL LETTER S character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One or more characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).</li>
    <li>A U+0025 PERCENT SIGN character (%).</li>
-  </ol><p>A <dfn id=webvtt-alignment-cue-setting>WebVTT alignment cue setting</dfn> consists of the
+  </ol><p class=note>A <a href=#webvtt-size-cue-setting>WebVTT size cue setting</a> configures
+  the size of the cue in the same direction as the <a href=#webvtt-text-position-cue-setting>WebVTT text
+  position cue setting</a>. For horizontal cues, this is the width
+  of the cue. It is given as a percentage of the width of the
+  frame.</p>
+
+  <p>A <dfn id=webvtt-alignment-cue-setting>WebVTT alignment cue setting</dfn> consists of the
   following components, in the order given:</p>
 
   <ol><li>A U+0041 LATIN CAPITAL LETTER A character.</li>
    <li>A U+003A COLON character (:).</li>
    <li>One of the following strings: "<code title="">start</code>", "<code title="">middle</code>", "<code title="">end</code>"</li>
-  </ol><p><dfn id=webvtt-metadata-text>WebVTT metadata text</dfn> consists of any sequence of one
+  </ol><p class=note>A <a href=#webvtt-alignment-cue-setting>WebVTT alignment cue setting</a>
+  configures the alignment of the text within the cue. The keywords
+  are relative to the text direction; for left-to-right English text,
+  "<code title="">start</code>" means left-aligned.</p>
+
+  <p><dfn id=webvtt-metadata-text>WebVTT metadata text</dfn> consists of any sequence of one
   or more characters other than U+000A LINE FEED (LF) characters and
   U+000D CARRIAGE RETURN (CR) characters, each optionally separated
   from the next by a <a href=#webvtt-line-terminator>WebVTT line terminator</a>. (In other

Modified: source
===================================================================
--- source	2011-08-04 16:24:35 UTC (rev 6365)
+++ source	2011-08-04 20:13:10 UTC (rev 6366)
@@ -34966,6 +34966,11 @@
    <li>The <dfn>cue payload</dfn>: either <span>WebVTT cue text</span> or <span>WebVTT metadata text</span>.</li>
   </ol>
 
+  <p class="note">A <span>WebVTT cue</span> corresponds to one piece
+  of time-aligned text or data in the <span>WebVTT file</span>, for
+  example one subtitle. The <span>cue payload</span> is the text or
+  data associated with the cue.</p>
+
   <p><span>WebVTT cue text</span> is syntactically a subset of
   <span>WebVTT metadata text</span>. Conformance checkers, when
   validating <span>WebVTT</span> files, may offer to restrict all cues
@@ -34994,6 +34999,9 @@
   SIGN), nor containing any U+000A LINE FEED (LF) characters or U+000D
   CARRIAGE RETURN (CR) characters.</p>
 
+  <p class="note">A <span>WebVTT cue identifier</span> can be used to
+  reference a specific cue, for example from script or CSS.</p>
+
   <p>The <dfn>WebVTT cue timings</dfn> part of a <span>WebVTT
   cue</span> consists of the following components, in the given
   order:</p>
@@ -35023,6 +35031,10 @@
 
   </ol>
 
+  <p class="note">The <span>WebVTT cue timings</span> give the start
+  and end offsets of the <span>WebVTT cue</span>. Different cues can
+  overlap. Cues are always listed ordered by their start time.</p>
+
   <p>A <dfn>WebVTT timestamp</dfn> representing a time in seconds and
   fractions of a second is a <span>WebVTT timestamp</span>
   representing hours <var
@@ -35112,6 +35124,11 @@
    <li>A <span>WebVTT alignment cue setting</span>.</li>     <!-- A:start/middle/end -->
   </ul>
 
+  <p class="note"><span>WebVTT cue settings</span> give configuration
+  options regarding the position and alignment of the cue. For
+  example, it allows a cue to be aligned to the left or positioned at
+  the top right.</p>
+
   <p>A <dfn>WebVTT vertical text cue setting</dfn> consists of the
   following components, in the order given:</p>
 
@@ -35121,6 +35138,11 @@
    <li>One of the following strings: "<code title="">vertical</code>", "<code title="">vertical-lr</code>".</li>
   </ol>
 
+  <p class="note">A <span>WebVTT vertical text cue setting</span>
+  configures the cue to use vertical text layout rather than
+  horizontal text layout. Vertical text layout is sometimes used in
+  Japanese, for example. The default is horiontal layout.</p>
+
   <p>A <dfn>WebVTT line position cue setting</dfn> consists of the
   following components, in the order given:</p>
 
@@ -35147,6 +35169,15 @@
    </li>
   </ol>
 
+  <p class="note">A <span>WebVTT line position cue setting</span>
+  configures the position of the cue. For horizontal cues, this is the
+  vertical position. The position can be given either as a percentage,
+  which gives the distance from the top of the frame, or as a line
+  number. Line numbers are based on the size of the first line of the
+  cue. Positive line numbers count from the top of the frame (the top
+  line is numbered 0), negative line numbers from the bottom of the
+  frame (the bottom line is numbered &#x2212;1).</p>
+
   <p>A <dfn>WebVTT text position cue setting</dfn> consists of the
   following components, in the order given:</p>
 
@@ -35157,6 +35188,14 @@
    <li>A U+0025 PERCENT SIGN character (%).</li>
   </ol>
 
+  <p class="note">A <span>WebVTT text position cue setting</span>
+  configures the position of the text in the direction orthogonal to
+  the <span>WebVTT line position cue setting</span>. For horizontal
+  cues, this is the horizontal position. The <span>WebVTT text
+  position cue setting</span> is given as a percentage, calculated
+  from the edge of the frame that the text begins (so for
+  left-to-right English text, the left edge).</p>
+
   <p>A <dfn>WebVTT size cue setting</dfn> consists of the
   following components, in the order given:</p>
 
@@ -35167,6 +35206,12 @@
    <li>A U+0025 PERCENT SIGN character (%).</li>
   </ol>
 
+  <p class="note">A <span>WebVTT size cue setting</span> configures
+  the size of the cue in the same direction as the <span>WebVTT text
+  position cue setting</span>. For horizontal cues, this is the width
+  of the cue. It is given as a percentage of the width of the
+  frame.</p>
+
   <p>A <dfn>WebVTT alignment cue setting</dfn> consists of the
   following components, in the order given:</p>
 
@@ -35176,6 +35221,11 @@
    <li>One of the following strings: "<code title="">start</code>", "<code title="">middle</code>", "<code title="">end</code>"</li>
   </ol>
 
+  <p class="note">A <span>WebVTT alignment cue setting</span>
+  configures the alignment of the text within the cue. The keywords
+  are relative to the text direction; for left-to-right English text,
+  "<code title="">start</code>" means left-aligned.</p>
+
   <p><dfn>WebVTT metadata text</dfn> consists of any sequence of one
   or more characters other than U+000A LINE FEED (LF) characters and
   U+000D CARRIAGE RETURN (CR) characters, each optionally separated




More information about the Commit-Watchers mailing list