Updated docs to explain "intents" section in extension manifest.

Updated docs to explain "intents" section in extension manifest.


BUG=116171
TEST=none

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=126725

[groby-ooo-7-16, 2012-03-06 23:58:16]

Please review updated docs.

Note: git cl upload complains, even though I _did_ run build.py and added
output. Am I missing something, or is that an issue in the PRESUBMIT check?

[mkearney, 2012-03-09 00:28:50]

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
File chrome/common/extensions/docs/static/manifest.html (right):

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:58: "<a
href="#intents">intents</a>": {...}
These links are in alphabetical order, so you probably want to move this to the
top.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:756: <h3
id="intents">intents</h3>
These sections are in alphabetical order, so you will want to move this up in
the list accordingly.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
What about adding a sentence that briefly defines web intents and links to the
main doc up here rather than later on ? Something like:
Use <a href="http://www.webintents.org">webintents</a>to allow users to control
the services that your extension interacts with.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
'extent' should be 'extension'?

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
Should this also mention hosted apps?

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:786: The value of "type" is
an array of mime types that is supported by this handler. "path" indicates the
URL of the page that handles the intent. For hosted apps, these URLs must be
within the allowed set of URLs. For extensions, all URLs are inside the
extension and considered relative to the extension root URL.
Small - add 'The' before "path".

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:791: </p>
Slight rewording:

The "title" is displayed in the intent picker UI when the user initiates the
action specific to the handler.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:794: "disposition" is either
"inline" or "window". Intents with "window" disposition will open a new tab when
invoked. Intents with "inline" disposition will be displayed inside the intent
picker when invoked.
Small - add 'The' before "disposition".

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:798: For more information on
intents, refer to the <a
href="dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html">Web Intents
specification</a> and <a href="http://www.webintents.org">webintents.org</a>.
If you put the sentence above with the cross-reference to web intents docs, I
think it would be OK to remove this paragraph (making the content a bit
shorter). Also, I don't think you need the specification here, as it is linked
to in the .org doc.

[groby-ooo-7-16, 2012-03-09 20:44:25]

Addressed review issues, looping in pkinlan for additional input

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
File chrome/common/extensions/docs/static/manifest.html (right):

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:58: "<a
href="#intents">intents</a>": {...}
On 2012/03/09 00:28:50, mkearney wrote:
> These links are in alphabetical order, so you probably want to move this to
the
> top.

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:756: <h3
id="intents">intents</h3>
On 2012/03/09 00:28:50, mkearney wrote:
> These sections are in alphabetical order, so you will want to move this up in
> the list accordingly.

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
On 2012/03/09 00:28:50, mkearney wrote:
> 'extent' should be 'extension'?

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
On 2012/03/09 00:28:50, mkearney wrote:
> Should this also mention hosted apps?

webintents are available in packaged apps, hosted apps, and extensions. I use
extension in the generic sense - "This thing described by the manifest". (See
e.g. the way "description" uses the term, too)

I've clarified to "extension or app" in the first usage.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
I wish I _had_ a sentence like that. Even webintents.org can't describe them in
a single sentence. Since it's a complex subject, the document assumes basic
knowledge of them. 

Vaguely based this approach on nacl_handlers - that section assumes familiarity
with nacl, but has additional link for an overview at the end.
I changed "web intents" to "intent handlers", to at least clarify what this
section refers to.

On 2012/03/09 00:28:50, mkearney wrote:
> What about adding a sentence that briefly defines web intents and links to the
> main doc up here rather than later on ? Something like:
> Use <a href="http://www.webintents.org">webintents</a>to allow users to
control
> the services that your extension interacts with.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:786: The value of "type" is
an array of mime types that is supported by this handler. "path" indicates the
URL of the page that handles the intent. For hosted apps, these URLs must be
within the allowed set of URLs. For extensions, all URLs are inside the
extension and considered relative to the extension root URL.
On 2012/03/09 00:28:50, mkearney wrote:
> Small - add 'The' before "path".
> 

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:791: </p>
On 2012/03/09 00:28:50, mkearney wrote:
> Slight rewording:
> 
> The "title" is displayed in the intent picker UI when the user initiates the
> action specific to the handler.

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:794: "disposition" is either
"inline" or "window". Intents with "window" disposition will open a new tab when
invoked. Intents with "inline" disposition will be displayed inside the intent
picker when invoked.
On 2012/03/09 00:28:50, mkearney wrote:
> Small - add 'The' before "disposition".

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:798: For more information on
intents, refer to the <a
href="dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html">Web Intents
specification</a> and <a href="http://www.webintents.org">webintents.org</a>.
I consider the .org doc to be somewhat in flux (it currently _doesn't_ refer to
the spec :)

Since intents are a brand-new subject, I'd prefer to err on the side of caution
in terms of additional info

We do the same for HTML5 notifications and CSS3D in the "requirements" section.

On 2012/03/09 00:28:50, mkearney wrote:
> If you put the sentence above with the cross-reference to web intents docs, I
> think it would be OK to remove this paragraph (making the content a bit
> shorter). Also, I don't think you need the specification here, as it is linked
> to in the .org doc.

[mkearney, 2012-03-09 21:41:15]

Almost...

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
File chrome/common/extensions/docs/static/manifest.html (right):

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
Looks good, and yes, I totally know what you mean. I tried all sorts of ways to
narrow the definition down to a sentence or two. Not very doable.

On 2012/03/09 20:44:26, groby wrote:
> I wish I _had_ a sentence like that. Even http://webintents.org can't describe
them in
> a single sentence. Since it's a complex subject, the document assumes basic
> knowledge of them. 
> 
> Vaguely based this approach on nacl_handlers - that section assumes
familiarity
> with nacl, but has additional link for an overview at the end.
> I changed "web intents" to "intent handlers", to at least clarify what this
> section refers to.
> 
> On 2012/03/09 00:28:50, mkearney wrote:
> > What about adding a sentence that briefly defines web intents and links to
the
> > main doc up here rather than later on ? Something like:
> > Use <a href="http://www.webintents.org">webintents</a>to allow users to
> control
> > the services that your extension interacts with. 
>

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
Can we make "http://webintents.org/share" a link to the share description?

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:798: For more information on
intents, refer to the <a
href="dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html">Web Intents
specification</a> and <a href="http://www.webintents.org">webintents.org</a>.
Sonds good. 

I just tested the link though to the spec, and it appears to be broken.

On 2012/03/09 20:44:26, groby wrote:
> I consider the .org doc to be somewhat in flux (it currently _doesn't_ refer
to
> the spec :)
> 
> Since intents are a brand-new subject, I'd prefer to err on the side of
caution
> in terms of additional info
> 
> We do the same for HTML5 notifications and CSS3D in the "requirements"
section.
> 
> On 2012/03/09 00:28:50, mkearney wrote:
> > If you put the sentence above with the cross-reference to web intents docs,
I
> > think it would be OK to remove this paragraph (making the content a bit
> > shorter). Also, I don't think you need the specification here, as it is
linked
> > to in the .org doc.
>

[groby-ooo-7-16, 2012-03-09 22:06:04]

Round 3 of the docs up for review. (Also on staging)

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
File chrome/common/extensions/docs/static/manifest.html (right):

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:759: A dictionary that
specifies all web intents provided by this extension. Each key in the dictionary
specifies the action name that is handled by this extent. The following example
specifies two handlers for the action "http://webintents.org/share".
On 2012/03/09 21:41:15, mkearney wrote:
> Can we make "http://webintents.org/share" a link to the share description?

Done.

http://codereview.chromium.org/9618033/diff/1/chrome/common/extensions/docs/s...
chrome/common/extensions/docs/static/manifest.html:798: For more information on
intents, refer to the <a
href="dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html">Web Intents
specification</a> and <a href="http://www.webintents.org">webintents.org</a>.
That's because it _is_ broken - I forgot the http in front of it :)

On 2012/03/09 21:41:15, mkearney wrote:
> Sonds good. 
> 
> I just tested the link though to the spec, and it appears to be broken.
> 
> On 2012/03/09 20:44:26, groby wrote:
> > I consider the .org doc to be somewhat in flux (it currently _doesn't_ refer
> to
> > the spec :)
> > 
> > Since intents are a brand-new subject, I'd prefer to err on the side of
> caution
> > in terms of additional info
> > 
> > We do the same for HTML5 notifications and CSS3D in the "requirements"
> section.
> > 
> > On 2012/03/09 00:28:50, mkearney wrote:
> > > If you put the sentence above with the cross-reference to web intents
docs,
> I
> > > think it would be OK to remove this paragraph (making the content a bit
> > > shorter). Also, I don't think you need the specification here, as it is
> linked
> > > to in the .org doc.
> > 
>

[mkearney, 2012-03-09 22:09:13]

lgtm

[commit-bot: I haz the power, 2012-03-09 22:09:17]

No LGTM from a valid reviewer yet. Only full committers are accepted.
Even if an LGTM may have been provided, it was from a non-committer or
a lowly provisional committer, _not_ a full super star committer.
See http://www.chromium.org/getting-involved/become-a-committer
Note that this has nothing to do with OWNERS files.

[groby-ooo-7-16, 2012-03-09 22:10:10]

aa: Please review README.txt - slight clarifications in there, plus mention of
staging process.

[Aaron Boodman, 2012-03-12 20:11:00]

readme lgtm

[PaulKinlan, 2012-03-12 20:16:55]

lgtm

lgtm

[commit-bot: I haz the power, 2012-03-12 20:19:46]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/groby@chromium.org/9618033/8001

[commit-bot: I haz the power, 2012-03-12 20:19:49]

Presubmit check for 9618033-8001 failed and returned exit status 1.

Running presubmit commit checks ...

** Presubmit Warnings **
This change modifies the extension docs but the generated docs have not been
updated properly. See chrome/common/extensions/docs/README.txt for more info.
 - Changes to chrome/common/extensions/docs/static/manifest.html not reflected
in generated doc.
First build DumpRenderTree, then update the docs by running:
  chrome/common/extensions/docs/build/build.py

[commit-bot: I haz the power, 2012-03-14 15:01:25]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/groby@chromium.org/9618033/8001

[commit-bot: I haz the power, 2012-03-14 16:12:09]

Try job failure for 9618033-8001 (retry) (retry) (retry) on linux_rel for step
"update".
It's a second try, previously, step "remoting_unittests" failed.
http://build.chromium.org/p/tryserver.chromium/buildstatus?builder=linux_rel&...

Step "update" is always a major failure.
Look at the try server FAQ for more details.

[commit-bot: I haz the power, 2012-03-14 17:24:13]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/groby@chromium.org/9618033/8001

[commit-bot: I haz the power, 2012-03-14 20:24:10]

Try job failure for 9618033-8001 (retry) on win_rel for step "browser_tests".
It's a second try, previously, step "browser_tests" failed.
http://build.chromium.org/p/tryserver.chromium/buildstatus?builder=win_rel&nu...