- From: Ian Hickson via cvs-syncmail <cvsmail@w3.org>
- Date: Thu, 01 Nov 2012 23:27:15 +0000
- To: public-html-commits@w3.org
Update of /sources/public/html5/webvtt In directory hutz:/tmp/cvs-serv10723 Modified Files: Overview.html Log Message: Define a syntax for comments in WebVTT (doesn't affect parsers) (whatwg r7500) Index: Overview.html =================================================================== RCS file: /sources/public/html5/webvtt/Overview.html,v retrieving revision 1.47 retrieving revision 1.48 diff -u -d -r1.47 -r1.48 --- Overview.html 30 Oct 2012 22:15:55 -0000 1.47 +++ Overview.html 1 Nov 2012 23:27:13 -0000 1.48 @@ -122,7 +122,7 @@ <header class=head id=head><!-- the following line added by request of Ian Jacobs --><p class=logo><a href=http://www.w3.org/><img alt=W3C height=48 src=http://www.w3.org/Icons/w3c_home width=72></a></p> <hgroup><h1 class="no-num no-toc">WebVTT</h1> - <h2 class="no-num no-toc">Living Standard — Last Updated 30 October 2012</h2> + <h2 class="no-num no-toc">Living Standard — Last Updated 1 November 2012</h2> </hgroup><dl><dt>Latest version:</dt> <dd><a href=http://dev.w3.org/html5/webvtt/>http://dev.w3.org/html5/webvtt/</a></dd> <dt>Participate:</dt> @@ -151,7 +151,8 @@ <ol class=toc> <li><a href=#introduction><span class=secno>1 </span>Introduction</a> <ol> - <li><a href=#cues-with-multiple-lines><span class=secno>1.1 </span>Cues with multiple lines</a></ol></li> + <li><a href=#cues-with-multiple-lines><span class=secno>1.1 </span>Cues with multiple lines</a></li> + <li><a href=#comments><span class=secno>1.2 </span>Comments</a></ol></li> <li><a href=#conformance><span class=secno>2 </span>Conformance</a> <ol> <li><a href=#dependencies><span class=secno>2.1 </span>Dependencies</a></ol></li> @@ -189,8 +190,6 @@ DEFAULTS line:-1 align:middle size:50% - Comments. See http://www.w3.org/Bugs/Public/show_bug.cgi?id=14552 - --><h2 id=introduction><span class=secno>1 </span>Introduction</h2> <p><i>This section is non-normative.</i></p> @@ -311,6 +310,60 @@ </div> + + <h3 id=comments><span class=secno>1.2 </span>Comments</h3> + + <p><i>This section is non-normative.</i></p> + + <p>Comments can be included in WebVTT files.</p> + + <p>Comments are just blocks that start with the word "<code title="">NOTE</code>" or "<code title="">NOTES</code>" (followed by a space or newline). A comment ends at the first blank + line.</p> + + <div class=example> + + <p>Here, a one-line comment is used to note a possible problem with a cue.</p> + + <pre>WEBVTT + +00:01.000 --> 00:04.000 +Never drink liquid nitrogen. + +NOTE I'm not sure the timing is write on the following cue. + +00:05.000 --> 00:09.000 +— It will perforate your stomach. +— You could die.</pre> + + </div> + + <div class=example> + + <p>In this example, the author has written many comments.</p> + + <pre>WEBVTT + +NOTES +This file was written by Jill. I hope +you enjoy reading it. Some things to +bear in mind: +- I was lip-reading, so the cues may +not be 100% accurate +- I didn't pay too close attention to +when the cues should start or end. + +00:01.000 --> 00:04.000 +Never drink liquid nitrogen. + +NOTES check next cue + +00:05.000 --> 00:09.000 +— It will perforate your stomach. +— You could die. + +NOTES end of file</pre> + + </div> @@ -394,9 +447,9 @@ line, the second one to terminate the header block: in the future, we can add a metadata block before the first blank line --> - <li>Zero or more <a href=#webvtt-cue title="WebVTT cue">WebVTT cues</a> - separated from each other by two or more <a href=#webvtt-line-terminator title="WebVTT line - terminator">WebVTT line terminators</a>.</li> + <li>Zero or more <a href=#webvtt-cue title="WebVTT cue">WebVTT cues</a> and/or <span title="WebVTT + comments">WebVTT comments</span> separated from each other by two or more <a href=#webvtt-line-terminator title="WebVTT + line terminator">WebVTT line terminators</a>.</li> <li>Zero or more <a href=#webvtt-line-terminator title="WebVTT line terminator">WebVTT line terminators</a>.</li> @@ -408,7 +461,7 @@ <li><a href=#webvtt-cue-timings>WebVTT cue timings</a>.</li> <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>, <a href=#webvtt-chapter-title-text>WebVTT chapter title text</a>, or <a href=#webvtt-metadata-text>WebVTT metadata text</a>, but it must not contain the substring "-->" (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN).</li> + <li>The <dfn id=cue-payload>cue payload</dfn>: either <a href=#webvtt-cue-text>WebVTT cue text</a>, <a href=#webvtt-chapter-title-text>WebVTT chapter title text</a>, or <a href=#webvtt-metadata-text>WebVTT metadata text</a>, but it must not contain the substring "<code title="">--></code>" (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN).</li> </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 @@ -434,6 +487,24 @@ is a <a href=#webvtt-file-using-chapter-title-text>WebVTT file using chapter title text</a> is also a <a href=#webvtt-file-using-cue-text>WebVTT file using cue text</a>.</p> + + <p>A <dfn id=webvtt-comment>WebVTT comment</dfn> consists of the following components, in + the given order:</p> + + <ol><li>The string "<code title="">NOTE</code>".</li> + <li>Optionally, a U+0053 LATIN CAPITAL LETTER S character.</li> + <li>Optionally, the following components, in the given order: + <ol><li>Either: + <ul><li>A U+0020 SPACE character or U+0009 CHARACTER TABULATION (tab) character.</li> + <li>A <a href=#webvtt-line-terminator>WebVTT line terminator</a>.</li> + </ul><li>Any sequence of zero 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>, except that the entire resulting string must not contain + the substring "<code title="">--></code>" (U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN). + </ol></li> + </ol><p class=note>A <a href=#webvtt-comment>WebVTT comment</a> is ignored by the parser.</p> + + <p>A <dfn id=webvtt-line-terminator>WebVTT line terminator</dfn> consists of one of the following:</p>
Received on Thursday, 1 November 2012 23:27:17 UTC