W3C home > Mailing lists > Public > public-html-commits@w3.org > January 2009

html5/spec Overview.html,1.1843,1.1844

From: Ian Hickson via cvs-syncmail <cvsmail@w3.org>
Date: Fri, 16 Jan 2009 01:45:43 +0000
To: public-html-commits@w3.org
Message-Id: <E1LNdmJ-0007Le-7L@lionel-hutz.w3.org>

Update of /sources/public/html5/spec
In directory hutz:/tmp/cvs-serv28232

Modified Files:
Log Message:
Allow authors to include documentation inside <script> blocks that have src='' attributes. (credit: sp) (whatwg r2674)

Index: Overview.html
RCS file: /sources/public/html5/spec/Overview.html,v
retrieving revision 1.1843
retrieving revision 1.1844
diff -u -d -r1.1843 -r1.1844
--- Overview.html	16 Jan 2009 01:09:13 -0000	1.1843
+++ Overview.html	16 Jan 2009 01:45:40 -0000	1.1844
@@ -279,7 +279,8 @@
      <li><a href=#script><span class=secno>4.3.1 </span>The <code>script</code> element</a>
-       <li><a href=#scriptingLanguages><span class=secno> </span>Scripting languages</a></ol></li>
+       <li><a href=#scriptingLanguages><span class=secno> </span>Scripting languages</a></li>
+       <li><a href=#inline-documentation-for-external-scripts><span class=secno> </span>Inline documentation for external scripts</a></ol></li>
      <li><a href=#the-noscript-element><span class=secno>4.3.2 </span>The <code>noscript</code> element</a></li>
      <li><a href=#the-eventsource-element><span class=secno>4.3.3 </span>The <code>eventsource</code> element</a></ol></li>
    <li><a href=#sections><span class=secno>4.4 </span>Sections</a>
@@ -7890,7 +7891,8 @@
    <dd>If there is no <code title=attr-script-src><a href=#attr-script-src>src</a></code>
    attribute, depends on the value of the <code title=attr-script-type><a href=#attr-script-type>type</a></code> attribute.</dd>
    <dd>If there <em>is</em> a <code title=attr-script-src><a href=#attr-script-src>src</a></code>
-   attribute, the element must be empty.</dd>
+   attribute, the element must be either empty or contain only
+   <a href=#inline-documentation-for-external-scripts>script documentation</a>.</dd>
    <dt>Element-specific attributes:</dt>
    <dd><code title=attr-script-src><a href=#attr-script-src>src</a></code></dd>
    <dd><code title=attr-script-async><a href=#attr-script-async>async</a></code></dd>
@@ -8364,7 +8366,38 @@
   user agents must not ignore unknown MIME parameters &mdash; types
   with unknown parameters must be assumed to be unsupported.</p><!--
    XXX we should reference #references http://www.ietf.org/rfc/rfc4329
-  --><h4 id=the-noscript-element><span class=secno>4.3.2 </span>The <dfn><code>noscript</code></dfn> element</h4><dl class=element><dt>Categories</dt>
+  --><h5 id=inline-documentation-for-external-scripts><span class=secno> </span><dfn title="script documentation">Inline documentation for external scripts</dfn></h5><p>If a <code><a href=#script>script</a></code> element's <code title=attr-script-src><a href=#attr-script-src>src</a></code> attribute is specified, then the
+  contents of the <code><a href=#script>script</a></code> element, if any, must be such
+  that the value of the DOM <code title=dom-script-text><a href=#dom-script-text>text</a></code>
+  attribute, which is derived from the element's contents, matches the
+  <code>documentation</code> production in the following ABNF. <a href=#references>[ABNF]</a></p><!-- XXX
+  ftp://ftp.rfc-editor.org/in-notes/std/std68.txt --><pre>documentation ::= *( *( space / tab / comment ) [ line-comment ] newline )
+comment       ::= slash star *( not-star / star not-slash ) 1*star slash
+line-comment  ::= slash slash *not-newline
+space         ::= &lt; a U+0020 SPACE character &gt;
+tab           ::= &lt; a U+0009 TAB character &gt;
+newline       ::= &lt; a U+000A LINE FEED character &gt;
+star          ::= &lt; a U+002A ASTERISK character &gt;
+slash         ::= &lt; a U+002F SOLIDUS character &gt;
+not-star      ::= &lt; a single Unicode character other than a U+002A ASTERISK character &gt;
+not-slash     ::= &lt; a single Unicode character other than a U+002F SOLIDUS character &gt;
+not-newline   ::= &lt; a single Unicode character other than a U+000A LINE FEED character &gt;</pre><div class=example>
+   <p>This allows authors to include documentation, such as license
+   information or API information, inside their documents while still
+   referring to external script files. The syntax is constrained so
+   that authors don't accidentally include what looks like valid
+   script while also providing a <code title=attr-script-src><a href=#attr-script-src>src</a></code> attribute.</p>
+   <pre>&lt;script src="cool-effects.js"&gt;
+ // create new instances using:
+ //    var e = new Effect();
+ // start the effect using .play, stop using .stop:
+ //    e.play();
+ //    e.stop();
+  </div><h4 id=the-noscript-element><span class=secno>4.3.2 </span>The <dfn><code>noscript</code></dfn> element</h4><dl class=element><dt>Categories</dt>
    <dd><a href=#metadata-content-0>Metadata content</a>.</dd>
    <dd><a href=#flow-content-0>Flow content</a>.</dd>
    <dd><a href=#phrasing-content-0>Phrasing content</a>.</dd>
@@ -46057,4 +46090,6 @@
        form data set the way that is done today.
  XXX * placeholder="" for <textarea>, e.g. as seen on:
+ XXX * become more consistent about what markup we use to mark up
+       productions (nothing? <i>? <code>?)
Received on Friday, 16 January 2009 01:45:52 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 7 January 2015 15:09:20 UTC