Updating the doc to reflect the new experimental.keybinding API.

Updating the doc to reflect the new experimental.keybinding API.

Adding missing elements from previous API updates (someone forgot to run build.py).

Tiny code-change in extension.cc which was suggested during review, but I forgot to do.

BUG=27702
TEST=None (doc change)
Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=123724

[Mike West, 2012-02-24 14:24:24]

Took a quick pass. Meggin will do a better job when you move from experimental
to stable, but I think this has the makings of a good first cut.

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
File chrome/common/extensions/api/experimental.keybinding.json (right):

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/api/experimental.keybinding.json:4: "nodoc": false,
Nit: I'm pretty sure you can drop this entirely.

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
File chrome/common/extensions/docs/i18n.html (right):

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/docs/i18n.html:812:
<var><span>messageName</span></var></span><span class="optional"><span>,
</span><span>string or array of string</span>
Nit: Worth noting that this is an unintentional drive-by. :)

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
File chrome/common/extensions/docs/static/experimental.keybinding.html (right):

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/docs/static/experimental.keybinding.html:5: or sending
a command to the extension.
Can you add a link here to the experimental docs? It's a pretty standard piece
of boilerplate, just copy paste out of any other experimental API's docs.

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/docs/static/experimental.keybinding.html:12: to use
this API. Also note that "pageAction" and "browserAction" are reserved
I'd recommend separating this into two parts: `permission` and `commands`.

The first is (again) boilerplate that you can copy from any other experimental
permission. You'll also need to make it clear that authors currently require the
`experimental` permission.

The second is part of the API's usage, and probably deserves it's own section.

So something like:

---

# Permissions 

Blah blah blah.

  {  sample code blah }

# Usage

The keybinding API allows you to define specific commands, and bind them to to a
default key combination. Each command your extension accepts must be listed in
the manifest as an attribute of the `commands` manifest key. Blah blah blah.

{ sample code }

In your background page, you can bind a handler to each of these commands via
[`chrome.experimental.keybinding.onCommand.addListener`](link). For example:

{ sample code }

The `browserAction` and `pageAction` commands are reserved for the action of
opening/closing your extension's popups. They won't generate events that you can
handle. If you need to take action based on your popup opening, consider
listening for an `onDomReady` event inside your popup's code.

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/docs/static/experimental.keybinding.html:27: "key":
"Ctrl+Shift+B"
Probably also worth mentioning that `Ctrl+Alt` isn't supported.

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
File chrome/common/extensions/docs/tabs.html (right):

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/docs/tabs.html:2715: <span>string</span>
Nit: Worth noting that this is an unintentional drive-by. :)

[Finnur, 2012-02-24 15:09:16]

Ran gclient sync (which I forgot to do before uploading initially) and addressed
all comments but one (see below).

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
File chrome/common/extensions/docs/static/experimental.keybinding.html (right):

https://chromiumcodereview.appspot.com/9465005/diff/1004/chrome/common/extens...
chrome/common/extensions/docs/static/experimental.keybinding.html:5: or sending
a command to the extension.
This is generated automatically when you build the docs.

[Mike West, 2012-02-24 15:14:28]

LGTM, as soon as the trybots are happy. :)

https://chromiumcodereview.appspot.com/9465005/diff/1009/chrome/common/extens...
File chrome/common/extensions/docs/static/experimental.keybinding.html (right):

https://chromiumcodereview.appspot.com/9465005/diff/1009/chrome/common/extens...
chrome/common/extensions/docs/static/experimental.keybinding.html:18:
"experimental", "keybinding",
Nit: Separate lines for clarity.