added default splash screen
authorMarcos Caceres <w3c@marcosc.com>
Wed, 07 Dec 2011 00:38:37 +0000
changeset 8 8d2ee8f7b842
parent 7 c010667089ac
child 9 f5396d91060a
added default splash screen
splashscreen/Overview.html
splashscreen/Overview.src.html
--- a/splashscreen/Overview.html	Tue Dec 06 20:30:38 2011 +0000
+++ b/splashscreen/Overview.html	Wed Dec 07 00:38:37 2011 +0000
@@ -54,7 +54,7 @@
   <p class=copyright><a href=http://creativecommons.org/publicdomain/zero/1.0/ rel=license><img alt=CC0 src=http://i.creativecommons.org/p/zero/1.0/80x15.png></a>
 To the extent possible under law, the editor has waived all copyright and
 related or neighboring rights to this work. In addition, as of
-6 December 2011, the editors have made this specification available
+7 December 2011, the editors have made this specification available
 under the
 <a href=http://www.openwebfoundation.org/legal/the-owf-1-0-agreements/owfa-1-0 rel=license>Open Web Foundation Agreement Version 1.0</a>,
 which is available at
@@ -72,25 +72,34 @@
 
 <!--begin-toc-->
 <ol class=toc>
- <li><a href=#status-of-this-document><span class=secno>1 </span>Status of this document</a></li>
- <li><a href=#introduction><span class=secno>2 </span>Introduction</a>
+ <li><a href=#open-questions><span class=secno>1 </span>Open Questions</a></li>
+ <li><a href=#status-of-this-document><span class=secno>2 </span>Status of this document</a></li>
+ <li><a href=#introduction><span class=secno>3 </span>Introduction</a>
   <ol>
-   <li><a href=#example><span class=secno>2.1 </span>Example</a></li></ol></li>
- <li><a href=#use-cases-and-requirements><span class=secno>3 </span>Use cases and requirements</a></li>
- <li><a href=#conformance><span class=secno>4 </span>Conformance</a></li>
- <li><a href=#user-agents><span class=secno>5 </span>User Agents</a></li>
- <li><a href=#splash-screen><span class=secno>6 </span>Splash screen</a></li>
- <li><a href=#the-splash-attribute><span class=secno>7 </span>The <code>splash</code> attribute</a></li>
- <li><a href=#processing-the-splash-attribute><span class=secno>8 </span>Processing the splash attribute</a>
+   <li><a href=#example><span class=secno>3.1 </span>Example</a></li></ol></li>
+ <li><a href=#use-cases-and-requirements><span class=secno>4 </span>Use cases and requirements</a></li>
+ <li><a href=#conformance><span class=secno>5 </span>Conformance</a></li>
+ <li><a href=#user-agents><span class=secno>6 </span>User Agents</a></li>
+ <li><a href=#splash-screen><span class=secno>7 </span>Splash screen</a></li>
+ <li><a href=#rendering-the-splash-screen><span class=secno>8 </span>Rendering the splash screen </a></li>
+ <li><a href=#the-splash-attribute><span class=secno>9 </span>The <code>splash</code> attribute</a></li>
+ <li><a href=#the-default-splash-screen><span class=secno>10 </span>The default splash screen</a></li>
+ <li><a href=#processing-the-splash-attribute><span class=secno>11 </span>Processing the splash attribute</a>
   <ol>
-   <li><a href=#locating-the-splash-screen><span class=secno>8.1 </span>Locating the splash screen</a></li></ol></li></ol>
+   <li><a href=#locating-the-splash-screen><span class=secno>11.1 </span>Locating the splash screen</a></li>
+   <li><a class="no-num done" href=#locate-the-default-splash-screen-file>Locate the default splash screen file</a></li></ol></li></ol>
 <!--end-toc-->
-<h2 id=status-of-this-document><span class=secno>1 </span>Status of this document</h2>
+<h2 id=open-questions><span class=secno>1 </span>Open Questions</h2>
+<ul>
+  <li>Do we want a magic file "splash.png" for instance? </li>
+  <li></li>
+</ul>
+<h2 id=status-of-this-document><span class=secno>2 </span>Status of this document</h2>
 <p>This document is undergoing rapid development and is changing frequently. It is inappropriate to cite this document as anything other than a work in progress. </p>
-<h2 id=introduction><span class=secno>2 </span>Introduction</h2>
+<h2 id=introduction><span class=secno>3 </span>Introduction</h2>
 <p><em>This section is non-normative.</em></p>
 <p>TBW</p>
-<h3 id=example><span class=secno>2.1 </span>Example</h3>
+<h3 id=example><span class=secno>3.1 </span>Example</h3>
 <p>The following example shows how to use the <code>splash</code> attribute. </p>
 <pre>&lt;widget xmlns="http://www.w3.org/ns/widgets"&gt; 
    &lt;content splash="splash.png"/&gt; 
@@ -98,21 +107,54 @@
 </pre>
 <p>Might appear as the following in a conforming user agent: </p>
 <p><img alt="Loading screen" height=228 src=images/device_portrait.png width=209></p>
-<h2 id=use-cases-and-requirements><span class=secno>3 </span>Use cases and requirements</h2>
+<h2 id=use-cases-and-requirements><span class=secno>4 </span>Use cases and requirements</h2>
 <p><em>This section is non-normative.</em></p>
 <p>TBW</p>
-<h2 id=conformance><span class=secno>4 </span>Conformance</h2>
+<h2 id=conformance><span class=secno>5 </span>Conformance</h2>
 <p>Everything is this specification is normative except sections marked as non-normative,  diagrams, examples, and notes.</p>
 <p>The key words <em class=rfc2119 title=must>must</em>, <em class=rfc2119 title="must not">must not</em>, <em class=rfc2119 title=required>required</em>, <em class=rfc2119 title=should>should</em>, <em class=rfc2119 title="should not">should not</em>, <em class=rfc2119 title=recommended>recommended</em>, <em class=rfc2119 title=may>may</em>, and <em class=rfc2119 title=optional>optional</em> in this specification are to be interpreted as described in <cite>RFC2119</cite>.</p>
 <p> This specification defines conformance criteria that apply to a single product: a <a href=#product-ua>user agent</a>. </p>
-<h2 id=user-agents><span class=secno>5 </span>User Agents</h2>
+<h2 id=user-agents><span class=secno>6 </span>User Agents</h2>
 <p>A <dfn id=product-ua title="user agent">user agent</dfn> a software application that implements this specification and 
   the <cite>Widget Packaging</cite> specification and its dependencies. </p>
-<h2 id=splash-screen><span class=secno>6 </span>Splash screen</h2>
+<h2 id=splash-screen><span class=secno>7 </span>Splash screen</h2>
 <p>TBW: define what splash screen is.</p>
-<h2 id=the-splash-attribute><span class=secno>7 </span>The <code>splash</code> attribute</h2>
+<h2 id=rendering-the-splash-screen><span class=secno>8 </span>Rendering the splash screen </h2>
+<p>TBW: We should provide some non-normative guidelines. </p>
+<h2 id=the-splash-attribute><span class=secno>9 </span>The <code>splash</code> attribute</h2>
 <p>The <dfn id=splash-attribute>splash attribute</dfn> is  <span>path attribute</span> of the <code>content</code> element that allows an author to point to a <span>file</span> within the <span>widget package</span>. This file is then used as the splash screen for an application. </p>
-<h2 id=processing-the-splash-attribute><span class=secno>8 </span>Processing the splash attribute</h2>
+<h2 id=the-default-splash-screen><span class=secno>10 </span>The default splash screen</h2>
+<p>A <dfn id=default-splash-screen>default splash-screen </dfn> is a <span>reserved</span> <span>image</span>, either at the <span>root of the widget package</span> or at the root of a <span>locale
+    folder</span>, whose file
+    name case-sensitively and exactly matches a file name given in the file name column of
+the <a href=#default-splash-screen-table>default splash-screen table</a>.</p>
+<table>
+  <caption>
+    <dfn id=default-splash-screen-table>Default Splash-Screen Table</dfn>
+  </caption>
+  <tbody><tr>
+    <th scope=col>file name</th>
+    <th scope=col>media type</th>
+  </tr>
+  <tr>
+    <td>splash.svg</td>
+    <td>image/svg+xml</td>
+  </tr>
+  <tr>
+    <td>splash.png</td>
+    <td>image/png</td>
+  </tr>
+  <tr>
+    <td>splash.gif</td>
+    <td>image/gif</td>
+  </tr>
+  <tr>
+    <td>splash.jpg</td>
+    <td>image/jpeg</td>
+  </tr>
+</tbody></table>
+<p>It is <em class=ct>optional</em> for a <a href=#product-ua>user agent</a> to <span title=supported>support</span> the <span title="media type">media types</span> listed in the <a href=#default-splash-screen-table>default splash-screen table</a>.</p>
+<h2 id=processing-the-splash-attribute><span class=secno>11 </span>Processing the splash attribute</h2>
 <p>Firstly, when processing the splash attribute in the configuration document, a user agent behaves as if the <a href=#splash-file-defaults-table>splash file defaults table</a> had been defined as part of the <a href=http://www.w3.org/TR/widgets/#table-of-configuration-defaults>Table of Configuration Defaults</a> in <a href=http://dev.w3.org/2006/waf/widgets/#step-3--set-the-configuration-defaults>Step 3</a> of the <cite>Widget Packaging</cite> specification.</p>
 <table class=simple style="border: 1px solid black" summary="The configuration defaults that a user agent must set prior to instantiation.">
   <caption>
@@ -138,7 +180,8 @@
 <p>Secondly, the user agent MUST run the <a href=#steps-to-locate-the-splash-screen-file>steps to locate the splash screen file</a> at 
   the appropriate point in the <a href=http://dev.w3.org/2006/waf/widgets/#algorithm-to-process-a-configuration-doc>algorithm to process a
 configuration document</a>: the appropriate point is after all other attributes of the <code>content</code> element have been processed. </p>
-<h3 id=locating-the-splash-screen><span class=secno>8.1 </span>Locating the splash screen</h3>
+<p>Thirdly, if no splash screen file was found by running  the <a href=#steps-to-locate-the-splash-screen-file>steps to locate the splash screen file</a>, the user agent MUST attempt to locate </p>
+<h3 id=locating-the-splash-screen><span class=secno>11.1 </span>Locating the splash screen</h3>
 <p>The <dfn id=steps-to-locate-the-splash-screen-file>steps to locate the splash screen file</dfn> is given by the following algorithm. </p>
 <ol>
   <li>
@@ -157,6 +200,29 @@
   </li>
   <li>Otherwise, if the file is a processable file, then let <a href=#dfn-access-request-list><var>splash file</var></a> be file.</li>
 </ol>
+<h3 class="no-num done" id=locate-the-default-splash-screen-file>Locate the default splash screen file</h3>
+<p>The <dfn id=algorithm-to-locate-the-default-splash-screen-file>algorithm to locate the default splash-screen file </dfn> is given by the following algorithm:</p>
+<ol>
+  <li>
+    <p>For each <var>file name</var> in the default splash screen table<span></span> (from top to
+      bottom) that has a <span>media type</span> that is <span>supported</span> by the user
+      agent:</p>
+    <ol>
+      <li>
+        <p>Let <var>potential-splash</var> be the result of applying the <span>rule for
+          finding a file within a widget package</span> to <var>file name</var>.</p>
+      </li>
+      <li>
+        <p>If the <var>potential-splash</var> is a <span>processable file</span>, determined
+          by the <span>media type</span> given in the media type column of thedefault splash screen table<span></span>, then let splash screen be <var>potential-splash</var><span></span> and terminate this algorithm. </p>
+      </li>
+      <li>
+        <p>Otherwise, move onto the next <var>file name</var> in thedefault splash screen table<span></span>. If no default splash screen file is found, then terminate this algorithm. </p>
+      </li>
+    </ol>
+  </li>
+</ol>
+<p> </p>
 
 
 </body></html>
\ No newline at end of file
--- a/splashscreen/Overview.src.html	Tue Dec 06 20:30:38 2011 +0000
+++ b/splashscreen/Overview.src.html	Wed Dec 07 00:38:37 2011 +0000
@@ -74,6 +74,11 @@
 <p>TBW... </p>
 <h2 class="no-num no-toc">Table of Contents</h2>
 <!--toc-->
+<h2>Open Questions</h2>
+<ul>
+  <li>Do we want a magic file &quot;splash.png&quot; for instance? </li>
+  <li></li>
+</ul>
 <h2>Status of this document</h2>
 <p>This document is undergoing rapid development and is changing frequently. It is inappropriate to cite this document as anything other than a work in progress. </p>
 <h2>Introduction</h2>
@@ -100,8 +105,41 @@
   the <cite>Widget Packaging</cite> specification and its dependencies. </p>
 <h2>Splash screen</h2>
 <p>TBW: define what splash screen is.</p>
+<h2>Rendering the splash screen </h2>
+<p>TBW: We should provide some non-normative guidelines. </p>
 <h2>The <code>splash</code> attribute</h2>
 <p>The <dfn>splash attribute</dfn> is  <span>path attribute</span> of the <code>content</code> element that allows an author to point to a <span>file</span> within the <span>widget package</span>. This file is then used as the splash screen for an application. </p>
+<h2>The default splash screen</h2>
+<p>A <dfn>default splash-screen </dfn> is a <span>reserved</span> <span>image</span>, either at the <span>root of the widget package</span> or at the root of a <span>locale
+    folder</span>, whose file
+    name case-sensitively and exactly matches a file name given in the file name column of
+the <span>default splash-screen table</span>.</p>
+<table>
+  <caption>
+    <dfn>Default Splash-Screen Table</dfn>
+  </caption>
+  <tr>
+    <th scope="col">file name</th>
+    <th scope="col">media type</th>
+  </tr>
+  <tr>
+    <td>splash.svg</td>
+    <td>image/svg+xml</td>
+  </tr>
+  <tr>
+    <td>splash.png</td>
+    <td>image/png</td>
+  </tr>
+  <tr>
+    <td>splash.gif</td>
+    <td>image/gif</td>
+  </tr>
+  <tr>
+    <td>splash.jpg</td>
+    <td>image/jpeg</td>
+  </tr>
+</table>
+<p>It is <em class="ct">optional</em> for a <span>user agent</span> to <span title="supported">support</span> the <span title="media type">media types</span> listed in the <span>default splash-screen table</span>.</p>
 <h2>Processing the splash attribute</h2>
 <p>Firstly, when processing the splash attribute in the configuration document, a user agent behaves as if the <span>splash file defaults table</span> had been defined as part of the <a href="http://www.w3.org/TR/widgets/#table-of-configuration-defaults">Table of Configuration Defaults</a> in <a href="http://dev.w3.org/2006/waf/widgets/#step-3--set-the-configuration-defaults">Step 3</a> of the <cite>Widget Packaging</cite> specification.</p>
 <table summary="The configuration defaults that a user agent must set prior to instantiation." class="simple" style="border: 1px solid black">
@@ -128,6 +166,7 @@
 <p>Secondly, the user agent MUST run the <span>steps to locate the splash screen file</span> at 
   the appropriate point in the <a href="http://dev.w3.org/2006/waf/widgets/#algorithm-to-process-a-configuration-doc">algorithm to process a
 configuration document</a>: the appropriate point is after all other attributes of the <code>content</code> element have been processed. </p>
+<p>Thirdly, if no splash screen file was found by running  the <span>steps to locate the splash screen file</span>, the user agent MUST attempt to locate </p>
 <h3>Locating the splash screen</h3>
 <p>The <dfn>steps to locate the splash screen file</dfn> is given by the following algorithm. </p>
 <ol>
@@ -147,5 +186,28 @@
   </li>
   <li>Otherwise, if the file is a processable file, then let <var>splash file</var> be file.</li>
 </ol>
+<h3 class="no-num done">Locate the default splash screen file</h3>
+<p>The <dfn>algorithm to locate the default splash-screen file </dfn> is given by the following algorithm:</p>
+<ol>
+  <li>
+    <p>For each <var>file name</var> in the default splash screen table<span></span> (from top to
+      bottom) that has a <span>media type</span> that is <span>supported</span> by the user
+      agent:</p>
+    <ol>
+      <li>
+        <p>Let <var>potential-splash</var> be the result of applying the <span>rule for
+          finding a file within a widget package</span> to <var>file name</var>.</p>
+      </li>
+      <li>
+        <p>If the <var>potential-splash</var> is a <span>processable file</span>, determined
+          by the <span>media type</span> given in the media type column of thedefault splash screen table<span></span>, then let splash screen be <var>potential-splash</var><span></span> and terminate this algorithm. </p>
+      </li>
+      <li>
+        <p>Otherwise, move onto the next <var>file name</var> in thedefault splash screen table<span></span>. If no default splash screen file is found, then terminate this algorithm. </p>
+      </li>
+    </ol>
+  </li>
+</ol>
+<p>&nbsp;</p>
 </body>
 </html>