[e] (0) Captions - Stage 18.1: rearrange the domintro blocks for time…

…d track APIs around their IDLs. git-svn-id: http://svn.whatwg.org/webapps@5134 340c8d12-0b0e-0410-8428-c7bf67bfef74
whatwg · Jul 7, 2010 · 0597f42 · 0597f42
1 parent 1ceed00
commit 0597f42
Show file tree

Hide file tree

Showing 3 changed files with 316 additions and 242 deletions.
diff --git a/complete.html b/complete.html
@@ -26701,7 +26701,32 @@ <h6 id=guidelines-for-exposing-cues-in-various-formats-as-timed-track-cues><span
 
   <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
 
-  <pre class=idl>interface <dfn id=timedtrack>TimedTrack</dfn> {
+  <dl class=domintro><dt><var title="">media</var> . <code title=dom-media-tracks>tracks</code> . <code title="">length</code></dt>
+   <dd>
+    <p>Returns the number of timed tracks associated with the element (e.g. from <code><a href=#the-track-element>track</a></code> elements).</p>
+   </dd>
+
+   <dt><var title="">media</var> . <code title=dom-media-tracks>tracks[</code> <var title="">n</var> <code title="">]</code></dt>
+   <dd>
+    <p>Returns the <code><a href=#timedtrack>TimedTrack</a></code> object representing the <var title="">n</var>th timed track.</p>
+   </dd>
+
+   <dt><var title="">track</var> . <code title=dom-track-track><a href=#dom-track-track>track</a></code></dt>
+   <dd>
+    <p>Returns the <code><a href=#timedtrack>TimedTrack</a></code> object representing the <code><a href=#the-track-element>track</a></code> element's timed track.</p>
+   </dd>
+
+  </dl><div class=impl>
+
+<!-- XXX
+ - readonly attribute <span>TimedTrack</span>[] <span title="dom-media-tracks">tracks</span>
+-->
+
+  <p class=XXX>...</p>
+
+  </div>
+
+  <hr><pre class=idl>interface <dfn id=timedtrack>TimedTrack</dfn> {
   readonly attribute DOMString <span title=dom-TimedTrack-kind>kind</span>;
   readonly attribute DOMString <span title=dom-TimedTrack-label>label</span>;
   readonly attribute DOMString <span title=dom-TimedTrack-language>language</span>;
@@ -26723,59 +26748,9 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
   readonly attribute <a href=#timedtrackcuelist>TimedTrackCueList</a> <span title=dom-TimedTrack-activeCues>activeCues</span>;
 
   readonly attribute <a href=#function>Function</a> <span title=dom-TimedTrack-oncuechange>oncuechange</span>;
-};
-
-interface <dfn id=mutabletimedtrack>MutableTimedTrack</dfn> : <a href=#timedtrack>TimedTrack</a> {
- void <span title=dom-MutableTimedTrack-addCue>addCue</span>(in <a href=#timedtrackcue>TimedTrackCue</a> cue);
- void <span title=dom-MutableTimedTrack-removeCue>removeCue</span>(in <a href=#timedtrackcue>TimedTrackCue</a> cue);
-};
-
-interface <dfn id=timedtrackcuelist>TimedTrackCueList</dfn> {
-  readonly attribute unsigned long <span title=dom-TimedTrackCueList-length>length</span>;
-  getter <a href=#timedtrackcue>TimedTrackCue</a> (in unsigned long index);
-  <a href=#timedtrackcue>TimedTrackCue</a> <span title=dom-TimedTrackCueList-getCueById>getCueById</span>(in DOMString id);
-};
-
-[<span title=dom-TimedTrackCue>Constructor</span>(in DOMString id, in float startTime, in float endTime, in DOMString text, in optional DOMString settings, in optional DOMString voice, in optional boolean pauseOnExit)]
-interface <dfn id=timedtrackcue>TimedTrackCue</dfn> {
-  readonly attribute <a href=#timedtrack>TimedTrack</a> <span title=dom-TimedTrackCue-track>track</span>;
-  readonly attribute DOMString <span title=dom-TimedTrackCue-id>id</span>;
-
-  readonly attribute float <span title=dom-TimedTrackCue-startTime>startTime</span>;
-  readonly attribute float <span title=dom-TimedTrackCue-endTime>endTime</span>;
-  readonly attribute boolean <span title=dom-TimedTrackCue-pauseOnExit>pauseOnExit</span>;
-
-  readonly attribute DOMString <span title=dom-TimedTrackCue-direction>direction</span>;
-  readonly attribute boolean <span title=dom-TimedTrackCue-snapToLines>snapToLines</span>;
-  readonly attribute long <span title=dom-TimedTrackCue-linePosition>linePosition</span>;
-  readonly attribute long <span title=dom-TimedTrackCue-textPosition>textPosition</span>;
-  readonly attribute long <span title=dom-TimedTrackCue-size>size</span>;
-  readonly attribute DOMString <span title=dom-TimedTrackCue-alignment>alignment</span>;
-
-  readonly attribute DOMString <span title=dom-TimedTrackCue-voice>voice</span>;
-  DOMString <span title=dom-TimedTrackCue-getCueAsSource()>getCueAsSource</span>();
-  <a href=#documentfragment>DocumentFragment</a> <span title=dom-TimedTrackCue-getCueAsHTML()>getCueAsHTML</span>();
-
-  readonly attribute <a href=#function>Function</a> <span title=dom-TimedTrackCue-onenter>onenter</span>;
-  readonly attribute <a href=#function>Function</a> <span title=dom-TimedTrackCue-onexit>onexit</span>;
 };</pre>
 
-  <dl class=domintro><dt><var title="">media</var> . <code title=dom-media-tracks>tracks</code> . <code title="">length</code></dt>
-   <dd>
-    <p>Returns the number of timed tracks associated with the element (e.g. from <code><a href=#the-track-element>track</a></code> elements).</p>
-   </dd>
-
-   <dt><var title="">media</var> . <code title=dom-media-tracks>tracks[</code> <var title="">n</var> <code title="">]</code></dt>
-   <dd>
-    <p>Returns the <code><a href=#timedtrack>TimedTrack</a></code> object representing the <var title="">n</var>th timed track.</p>
-   </dd>
-
-   <dt><var title="">track</var> . <code title=dom-track-track><a href=#dom-track-track>track</a></code></dt>
-   <dd>
-    <p>Returns the <code><a href=#timedtrack>TimedTrack</a></code> object representing the <code><a href=#the-track-element>track</a></code> element's timed track.</p>
-   </dd>
-
-  </dl><dl class=domintro><dt><var title="">timedTrack</var> . <code title=dom-TimedTrack-kind>kind</code></dt>
+  <dl class=domintro><dt><var title="">timedTrack</var> . <code title=dom-TimedTrack-kind>kind</code></dt>
    <dd>
     <p>Returns the <a href=#timed-track-kind>timed track kind</a> string.</p>
    </dd>
@@ -26841,7 +26816,35 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
     <p>Returns the <a href=#timed-track-cue title="timed track cue">timed track cues</a> from the <a href=#timed-track-list-of-cues>timed track list of cues</a> that are currently active (i.e. that start before the <a href=#current-playback-position>current playback position</a> and end after it), as a <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object.</p>
    </dd>
 
-  </dl><dl class=domintro><dt><var title="">mutableTimedTrack</var> = <var title="">media</var> . <code title=dom-media-addTrack>addTrack</code>( <var title="">label</var>, <var title="">kind</var>, <var title="">language</var> )</dt>
+  </dl><div class=impl>
+
+  <p class=XXX>...</p>
+
+<!-- XXX
+   Make sure that .cues and .activeCues doesn't change while script is
+   running, except for addCue/removeCue and the removal of all cues in
+   the face of a dynamic track.src change.
+
+  <p>User agents must not expose cues whose start and end times are
+  entirely prior to the <span>media resource</span>'s <span>earliest
+  possible position</span>.</p>
+
+  changing dom-TimedTrack-mode to disabled/hidden should hide all the
+  titles, changing it to showing should show them. (Only 'showing'
+  tracks get updated automatically.)
+
+ - <span>MutableTimedTrack</span> <span title="dom-media-addTrack">addTrack</span>(in DOMString label, in DOMString kind, in DOMString language);
+   - addTrack should add it as Loaded, Disabled, and with the rules for WebSRT.
+-->
+
+  </div>
+
+  <hr><pre class=idl>interface <dfn id=mutabletimedtrack>MutableTimedTrack</dfn> : <a href=#timedtrack>TimedTrack</a> {
+ void <span title=dom-MutableTimedTrack-addCue>addCue</span>(in <a href=#timedtrackcue>TimedTrackCue</a> cue);
+ void <span title=dom-MutableTimedTrack-removeCue>removeCue</span>(in <a href=#timedtrackcue>TimedTrackCue</a> cue);
+};</pre>
+
+  <dl class=domintro><dt><var title="">mutableTimedTrack</var> = <var title="">media</var> . <code title=dom-media-addTrack>addTrack</code>( <var title="">label</var>, <var title="">kind</var>, <var title="">language</var> )</dt>
    <dd>
     <p>Creates and returns a new <code><a href=#mutabletimedtrack>MutableTimedTrack</a></code> object, which is also added to the <a href=#media-element>media element</a>'s <a href=#list-of-timed-tracks>list of timed tracks</a>.</p>
    </dd>
@@ -26858,7 +26861,19 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
     <!-- XXX exception thrown if it's not there -->
    </dd>
 
-  </dl><dl class=domintro><dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-length>length</code></dt>
+  </dl><div class=impl>
+
+  <p class=XXX>...</p>
+
+  </div>
+
+  <hr><pre class=idl>interface <dfn id=timedtrackcuelist>TimedTrackCueList</dfn> {
+  readonly attribute unsigned long <span title=dom-TimedTrackCueList-length>length</span>;
+  getter <a href=#timedtrackcue>TimedTrackCue</a> (in unsigned long index);
+  <a href=#timedtrackcue>TimedTrackCue</a> <span title=dom-TimedTrackCueList-getCueById>getCueById</span>(in DOMString id);
+};</pre>
+
+  <dl class=domintro><dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-length>length</code></dt>
    <dd>
     <p>Returns the number of <a href=#timed-track-cue title="timed track cue">cues</a> in the list.</p>
    </dd>
@@ -26875,7 +26890,37 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
     <p>Returns null if none of the cues have the given identifier.</p>
    </dd>
 
-  </dl><dl class=domintro><dt><var title="">cue</var> = new <code title=dom-TimedTrackCue>TimedTrackCue</code>( <var title="">id</var>, <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> [, <var title="">settings</var> [, <var title="">voice</var> [, <var title="">pauseOnExit</var> ] ] ] )</dt>
+  </dl><div class=impl>
+
+  <p class=XXX>...</p>
+
+  </div>
+
+  <hr><pre class=idl>[<span title=dom-TimedTrackCue>Constructor</span>(in DOMString id, in float startTime, in float endTime, in DOMString text, in optional DOMString settings, in optional DOMString voice, in optional boolean pauseOnExit)]
+interface <dfn id=timedtrackcue>TimedTrackCue</dfn> {
+  readonly attribute <a href=#timedtrack>TimedTrack</a> <span title=dom-TimedTrackCue-track>track</span>;
+  readonly attribute DOMString <span title=dom-TimedTrackCue-id>id</span>;
+
+  readonly attribute float <span title=dom-TimedTrackCue-startTime>startTime</span>;
+  readonly attribute float <span title=dom-TimedTrackCue-endTime>endTime</span>;
+  readonly attribute boolean <span title=dom-TimedTrackCue-pauseOnExit>pauseOnExit</span>;
+
+  readonly attribute DOMString <span title=dom-TimedTrackCue-direction>direction</span>;
+  readonly attribute boolean <span title=dom-TimedTrackCue-snapToLines>snapToLines</span>;
+  readonly attribute long <span title=dom-TimedTrackCue-linePosition>linePosition</span>;
+  readonly attribute long <span title=dom-TimedTrackCue-textPosition>textPosition</span>;
+  readonly attribute long <span title=dom-TimedTrackCue-size>size</span>;
+  readonly attribute DOMString <span title=dom-TimedTrackCue-alignment>alignment</span>;
+
+  readonly attribute DOMString <span title=dom-TimedTrackCue-voice>voice</span>;
+  DOMString <span title=dom-TimedTrackCue-getCueAsSource()>getCueAsSource</span>();
+  <a href=#documentfragment>DocumentFragment</a> <span title=dom-TimedTrackCue-getCueAsHTML()>getCueAsHTML</span>();
+
+  readonly attribute <a href=#function>Function</a> <span title=dom-TimedTrackCue-onenter>onenter</span>;
+  readonly attribute <a href=#function>Function</a> <span title=dom-TimedTrackCue-onexit>onexit</span>;
+};</pre>
+
+  <dl class=domintro><dt><var title="">cue</var> = new <code title=dom-TimedTrackCue>TimedTrackCue</code>( <var title="">id</var>, <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> [, <var title="">settings</var> [, <var title="">voice</var> [, <var title="">pauseOnExit</var> ] ] ] )</dt>
    <dd>
     <p>Returns a new <code><a href=#timedtrackcue>TimedTrackCue</a></code> object, for use with the <code title=dom-MutableTimedTrack-addCue>addCue()</code> method.</p>
     <p>The <var title="">id</var> argument sets the <a href=#timed-track-cue-identifier>timed track cue identifier</a>.</p>
@@ -26975,46 +27020,23 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
 
   </dl><div class=impl>
 
-  <p class=XXX>...
-
-<!-- XXX
- - readonly attribute <span>TimedTrack</span>[] <span title="dom-media-tracks">tracks</span>;
- - <span>MutableTimedTrack</span> <span title="dom-media-addTrack">addTrack</span>(in DOMString label, in DOMString kind, in DOMString language);
-   - addTrack should add it as Loaded, Disabled, and with the rules for WebSRT.
--->
-
-  <!-- XXX
-   Make sure that .cues and .activeCues doesn't change while script is
-   running, except for addCue/removeCue and the removal of all cues in
-   the face of a dynamic track.src change.
-
-  <p>User agents must not expose cues whose start and end times are
-  entirely prior to the <span>media resource</span>'s <span>earliest
-  possible position</span>.</p>
-
-  changing dom-TimedTrack-mode to disabled/hidden should hide all the
-  titles, changing it to showing should show them. (Only 'showing'
-  tracks get updated automatically.)
-
-  -->
+  <p class=XXX>...</p>
 
   </div>
 
 
+
   <h6 id=cue-events><span class=secno>4.8.10.10.6 </span>Event definitions</h6>
 
 <!-- XXX
   readonly attribute <span>Function</span> <span title="dom-TimedTrack-onload">onload</span>;
   readonly attribute <span>Function</span> <span title="dom-TimedTrack-onerror">onerror</span>;
   readonly attribute <span>Function</span> <span title="dom-TimedTrack-oncuechange">oncuechange</span>;
--->
-
-<!-- XXX
   readonly attribute <span>Function</span> <span title="dom-TimedTrackCue-onenter">onenter</span>;
   readonly attribute <span>Function</span> <span title="dom-TimedTrackCue-onexit">onexit</span>;
 -->
 
-  <p class=XXX>...
+  <p class=XXX>...</p>
 
 
   <h5 id=websrt-0><span class=secno>4.8.10.11 </span>WebSRT</h5>