moving captions from Events to User Context. See thread: http://lists.w3.org/Archives/Public/public-indie-ui/2012Dec/0019.html
authorJames Craig <jcraig@apple.com>
Wed, 05 Dec 2012 18:36:23 -0800
changeset 47 b6c8e8f1048d
parent 46 69268c37616f
child 48 553b89faaeef
moving captions from Events to User Context. See thread: http://lists.w3.org/Archives/Public/public-indie-ui/2012Dec/0019.html
src/include/terms.html
src/indie-ui-context.html
src/indie-ui-events.html
src/js/respec-transformers.js
--- a/src/include/terms.html	Mon Dec 03 17:55:01 2012 -0800
+++ b/src/include/terms.html	Wed Dec 05 18:36:23 2012 -0800
@@ -15,9 +15,6 @@
 		<p class="ednote">TBD: need to explain difference between the event.target, the element handler the event (addEventListener), and the "receiver" of the UIRequestEvent. The event "receiver" will be author-defined with an attribute (potentially @actions or @ui-actions) that describes the type of UI actions that can be performed on the element (the UIRequestEvent "receiver") as is a contract declaration of the types of UIRequestEvents that will be received and handled by the web application.</p>
 	</dd>
 	
-	<dt id="def_restricted_event">Restricted Event</dt>
-	<dd class="placeholder">TBD: This type of event will require user confirmation to share with the requesting site as it could be construed to determine private information about the user. This effort will need coordination with the privacy working groups.</dd>
-	
 	<dt id="def_user_agent">User Agent</dt>
 	<dd class="placeholder">TBD</dd>
 	
--- a/src/indie-ui-context.html	Mon Dec 03 17:55:01 2012 -0800
+++ b/src/indie-ui-context.html	Wed Dec 05 18:36:23 2012 -0800
@@ -139,12 +139,11 @@
 			
 			<section id="UserPreferenceKeys">
 				<h4>User Preference Keys</h4>
-				<p class="ednote">TBD whether this is the best way to define these in IDL, or if the IDL is even necessary here.</p>
+				<p class="ednote">TBD whether this is the best way to define these in IDL, or if the IDL is even necessary here. More keys are coming.</p>
 
 				<dl title="dictionary UserPreferenceKeys" class="idl">
 					<dt>DOMString? fontSize = null</dt><dd>User's current default font size of root element, prior to applying page styles, returned in a CSS pixel unit formatted string, e.g. '14px'</dd>
-					<dt>DOMString? foo = null</dt><dd>lorem ipsum</dd>
-					<dt>boolean? bar = false</dt><dd>lorem ipsum</dd>
+					<dt>boolean? showCaptions = null</dt><dd>Simple status of whether or not a user wants captions displayed. Note: keys will likely need to be added to indicate preferred languages and type of captions (CC, SDH, Subtitle, etc).</dd>
 				</dl>
 
 			</section>
--- a/src/indie-ui-events.html	Mon Dec 03 17:55:01 2012 -0800
+++ b/src/indie-ui-events.html	Wed Dec 05 18:36:23 2012 -0800
@@ -196,37 +196,6 @@
 								<li>Cancelable: Yes</li>
 							</ul>
 						</dd>
-						<dt id="captionsoffrequest" data-transform="markRestricted">Captions Off Request <code class="event">captionsoffrequest</code></dt>
-						<dd>
-							<p>Indicates the user desires to have video captions hidden.</p>
-							<p class="ednote">Possibly too much overlap on the 'caption' events with the User Context notifications when user preference changes.</p>
-							<p>Initiated when the user agent sends a 'captionsoffrequest' request to the web application.</p>
-							<ul>
-								<li>Bubbles: Yes</li>
-								<li>Cancelable: Yes</li>
-							</ul>
-						</dd>
-						<dt id="captionsonrequest" data-transform="markRestricted">Captions On Request <code class="event">captionsonrequest</code></dt>
-						<dd>
-							<p>Indicates the user desires to have video captions enabled where available.</p>
-							<p class="ednote">Possibly too much overlap on the 'caption' events with the User Context notifications when user preference changes.</p>
-							<p>Initiated when the user agent sends a 'captionsonrequest' request to the web application.</p>
-							<ul>
-								<li>Bubbles: Yes</li>
-								<li>Cancelable: Yes</li>
-							</ul>
-						</dd>
-						<dt id="captionstogglerequest" data-transform="markRestricted">Captions Toggle Request <code class="event">captionstogglerequest</code></dt>
-						<dd>
-							<p>Indicates the user desires to have video captions toggled between the 'on' and 'off' states.</p>
-							<p class="ednote">Possibly too much overlap on the 'caption' events with the User Context notifications when user preference changes.</p>
-							<p class="ednote">If it's determined that specific caption events are necessary, we should actively seeking comments on whether the caption 'toggle' event is necessary. It may be that the caption 'enable' and 'disable' events are enough.</p>
-							<p>Initiated when the user agent sends a 'captionstogglerequest' request to the web application.</p>
-							<ul>
-								<li>Bubbles: Yes</li>
-								<li>Cancelable: Yes</li>
-							</ul>
-						</dd>
 					</dl>
 				</section>
 			</section>
--- a/src/js/respec-transformers.js	Mon Dec 03 17:55:01 2012 -0800
+++ b/src/js/respec-transformers.js	Wed Dec 05 18:36:23 2012 -0800
@@ -16,8 +16,3 @@
 	s += '</ul>'
 	return content + s;
 }
-
-/* markRestricted: appends a link to the definition of restricted events */
-function markRestricted(r, content){
-	return content + ' (<a href="#def_restricted_event">' +loc('_restricted event')+ '</a>)';
-}