W3C home > Mailing lists > Public > public-web-intents@w3.org > June 2012

Editorial pass on the spec

From: Robin Berjon <robin@berjon.com>
Date: Wed, 20 Jun 2012 12:40:14 +0200
Message-Id: <604A920A-90B8-4546-8A46-70E496A4652D@berjon.com>
To: WebIntents <public-web-intents@w3.org>
Hi all!

Since a draft is to be published soon, as I promised Greg (too long ago), I made a pass through the current document looking for editorial/spec-markup issues. I detail them here for those who are interested in such matters.

Given that I can't push to the hg repository, I've played it old school style and attached a patch to the bottom of this email.

Here are the changes:
     switched to ReSpec v3, with async loading. This should be both faster and better.
     pointed to the actual editor's draft in the configuration
     made it a joint deliverable between DAP and WebApps
     enabled syntax highlighting for examples
     in IntentParameters, unless I'm mistaken I don't believe you can use "dictionary" as a type name. I replaced it with |any| which I believe is the closest (even if not as clear)
     removed "raises DOMException" from the Intent constructor (raises was dropped from WebIDL)
     replaced type |string| with |DOMString| in a number of places
     fixed a reference to POSTMSG that was using the URI instead
     put in the proper references to callbacks in startActivity
     made IntentSuccessCallback and IntentFailureCallback actually use the WebIDL callback feature
     I wonder if rather than "[NoInterfaceObject] interface Foo {...};" followed by "Window implements Foo" (or Navigator) it wouldn't be better to just use "partial interface Window {...};". It seems more straightforward, but I didn't make that change.
     replaced <i> with <var> for variables in algorithms
     when referring to WebIDL items that you are defining in the draft, it is better to use <a>Foo</a> rather than <code>Foo</Foo> because they get automatically linked (I changed them all)





-- 
Robin Berjon - http://berjon.com/ - @robinberjon



Received on Wednesday, 20 June 2012 10:40:40 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Wednesday, 20 June 2012 10:40:41 GMT