From 2a2f003b5bec6cd2351eef0a421e0e3e6a5f0e20 Mon Sep 17 00:00:00 2001 From: "kathyw@chromium.org" Date: Wed, 27 Oct 2010 22:13:06 +0000 Subject: Context Menu API doc improvements. Added info about '%s' suggested by PhistucK, plus did a bit of cleanup here and there. BUG=NONE TEST=NONE Review URL: http://codereview.chromium.org/4201003 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@64163 0039d316-1c4b-4281-b951-d872f2087c98 --- chrome/common/extensions/docs/contextMenus.html | 30 ++++++++++++------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'chrome/common/extensions/docs/contextMenus.html') diff --git a/chrome/common/extensions/docs/contextMenus.html b/chrome/common/extensions/docs/contextMenus.html index a7b2cdb..7e99928 100644 --- a/chrome/common/extensions/docs/contextMenus.html +++ b/chrome/common/extensions/docs/contextMenus.html @@ -537,7 +537,7 @@ You can find samples of this API on the -
This must be specified unless type is 'separator'.
+
The text to be displayed in the item; this is required unless type is 'separator'. When the context is 'selection', you can use '%s' within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word 'cool', the context menu item for the selection is "Translate cool to Pig Latin".
This parameter was added in version . @@ -595,7 +595,7 @@ You can find samples of this API on the
-
This only applies to the initial state of a checkbox or radio item. It indicates if the item should initially be checked/selected. Only one radio item can be selected at a time in a given group of radio items.
+
The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.
This parameter was added in version . @@ -901,7 +901,7 @@ You can find samples of this API on the
-
The id of a parent menu item - this makes the item a child of a previously added item.
+
The ID of a parent menu item; this makes the item a child of a previously added item.
This parameter was added in version . @@ -970,7 +970,7 @@ You can find samples of this API on the
-
Lets you restrict the item to only apply to documents whose URL matches one of the given patterns. (This applies to frames as well). For details on the format of a pattern, see Match Patterns.
+
Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see Match Patterns.
This parameter was added in version . @@ -1039,7 +1039,7 @@ You can find samples of this API on the
-
Similar to documentUrlPatterns, but this lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.
+
Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.
This parameter was added in version . @@ -1107,7 +1107,7 @@ You can find samples of this API on the
-
Called when the item has been created in the browser. If there were any problems creating the item, details will be avilable in chrome.extension.lastError.
+
Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.extension.lastError.
This parameter was added in version . @@ -1171,7 +1171,7 @@ You can find samples of this API on the
-
The id of the newly created item.
+
The ID of the newly created item.
This parameter was added in version . @@ -1282,7 +1282,7 @@ You can find samples of this API on the
-
The id of the context menu item to remove.
+
The ID of the context menu item to remove.
This parameter was added in version . @@ -1580,7 +1580,7 @@ You can find samples of this API on the
-
The id of the item to update.
+
The ID of the item to update.
This parameter was added in version . @@ -2401,7 +2401,7 @@ You can find samples of this API on the
-
The id of the menu item that was clicked.
+
The ID of the menu item that was clicked.
This parameter was added in version . @@ -2459,7 +2459,7 @@ You can find samples of this API on the
-
The parent id, if any, for the item clicked.
+
The parent ID, if any, for the item clicked.
This parameter was added in version . @@ -2575,7 +2575,7 @@ You can find samples of this API on the
-
If the element is a link, the url it points to.
+
If the element is a link, the URL it points to.
This parameter was added in version . @@ -2633,7 +2633,7 @@ You can find samples of this API on the
-
Will be present for elements with a 'src' url.
+
Will be present for elements with a 'src' URL.
This parameter was added in version . @@ -2691,7 +2691,7 @@ You can find samples of this API on the
-
The url of the page where the menu item was clicked.
+
The URL of the page where the menu item was clicked.
This parameter was added in version . @@ -2749,7 +2749,7 @@ You can find samples of this API on the
-
The url of the frame of the element where the context menu was clicked, if it was in a frame.
+
The URL of the frame of the element where the context menu was clicked, if it was in a frame.
This parameter was added in version . -- cgit v1.1