chrome/common/extensions/docs/permission_warnings.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/permission_warnings.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: fix Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/pageCapture.html ('k') | chrome/common/extensions/docs/permissions.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/permission_warnings.html

diff --git a/chrome/common/extensions/docs/permission_warnings.html b/chrome/common/extensions/docs/permission_warnings.html

deleted file mode 100644

index 038c929bcd86f0c7e6d9be1c2ae5b0a2cd4eb1e2..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/permission_warnings.html

+++ /dev/null

@@ -1,651 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <title>Permission Warnings - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li class="leftNavSelected">Permission Warnings</li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">Permission Warnings</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#examples"> Examples of permission warnings </a>

- <ol>

- </ol>

- </li><li>

- <a href="#warnings"> Warnings and their triggers </a>

- <ol>

- </ol>

- </li><li>

- <a href="#nowarning"> Permissions that don't cause warnings </a>

- <ol>

- </ol>

- </li><li>

- <a href="#test"> Testing permission warnings </a>

- <ol>

- </ol>

- </li><li>

- <a href="#api">API</a>

- <ol>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Permission Warnings</div>

-<div id="pageData-showTOC" class="pageData">true</div>

-<!--

-NOTE: When this doc is updated, the online help should also be updated:

-http://www.google.com/support/chrome_webstore/bin/answer.py?hl=en&answer=186213

-We should periodically look at

-http://src.chromium.org/viewvc/chrome/trunk/src/chrome/app/generated_resources.grd?view=markup

-to make sure that we're covering all messages. Search for

-IDS_EXTENSION_PROMPT_WARNING

-(e.g. IDS_EXTENSION_PROMPT_WARNING_BROWSING_HISTORY).

--->

-<p>

-To use most chrome.* APIs and extension capabilities,

-your extension must declare its intent in the

-<a href="manifest.html">manifest</a>,

-often in the "permissions" field.

-Some of these declarations

-result in a warning when

-a user installs your extension.

-</p>

-<p>

-When you autoupdate your extension,

-the user might see another warning

-if the extension requests new permissions.

-These new permissions might be new APIs that your extension uses,

-or they might be new websites

-that your extension needs access to.

-</p>

-<h2 id="examples"> Examples of permission warnings </h2>

-<p>

-Here's a typical dialog

-that a user might see when installing an extension:

-</p>

-<img src="images/perms-hw1.png" width="410" height="193" alt="Permission warning: 'It can: Access your data on api.flickr.com'">

-<p>

-The warning about access to data on api.flickr.com

-is caused by the following lines

-in the extension's manifest:

-</p>

-<pre>"permissions": [

- <b>"http://api.flickr.com/"</b>

-],

-</pre>

-<p class="note">

-<b>Note:</b>

-You don't see permission warnings when

-you load an unpacked extension.

-You get permission warnings only when you install an extension

-from a <code>.crx</code> file.

-</p>

-<p>

-If you add a permission to the extension when you autoupdate it,

-the user might see a new permission warning.

-For example,

-assume you add a new site and the "tabs" permission

-to the previous example:

-</p>

-<pre>"permissions": [

- "http://api.flickr.com/",

- <b>"http://*.flickr.com/",

- "tabs"</b>

-],

-</pre>

-<p>

-When the extension autoupdates,

-the increased permissions

-cause the extension to be disabled

-until the user re-enables it.

-Here's the warning the user sees:

-</p>

-<img src="images/perms-hw2-disabled.png" width="814" height="30" alt="Warning text: 'The newest version of the extension Hello World requires more permissions, so it has been disabled. [Re-enable].'">

-<p>

-Clicking the Re-enable button

-brings up the following warning:

-</p>

-<img src="images/perms-hw2.png" width="412" height="220" alt="Permission warning: 'It can: Access your data on api.flickr.com and flickr.com; Read and modify your browsing history'">

-<h2 id="warnings"> Warnings and their triggers </h2>

-<p>

-It can be surprising when adding a permission such as "tabs"

-results in the seemingly unrelated warning

-that the extension can access your browsing activity.

-The reason for the warning is that

-although the <code>chrome.tabs</code> API

-might be used only to open new tabs,

-it can also be used to see the URL that's associated

-with every newly opened tab

-(using their <a href="tabs.html#type-Tab">Tab</a> objects).

-</p>

-<p class="note">

-<b>Note:</b>

-As of Google Chrome 7,

-you no longer need to specify the "tabs" permission

-just to call <code>chrome.tabs.create()</code>

-or <code>chrome.tabs.update()</code>.

-</p>

-<p>

-The following table lists the warning messages

-that users can see,

-along with the manifest entries

-that trigger them.

-</p>

-<p>

-</p><table>

-<tbody><tr>

- <th>Warning message</th> <th>Manifest entry that causes it</th> <th>Notes</th>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Access all data on your computer and the websites you visit

- </td>

- <td>

- "plugins"

- </td>

- <td>

- The "plugins" permission is required by

- <a href="npapi.html">NPAPI plugins</a>.

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Read and modify your bookmarks

- </td>

- <td>

- "bookmarks" permission

- </td>

- <td>

- The "bookmarks" permission is required by the

- <a href="bookmarks.html"><code>chrome.bookmarks</code></a> module.

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Read and modify your browsing history

- </td>

- <td>

-

- "history" permission

- </td>

- <td>

- <p>

- The "history" permission is required by

- <a href="history.html"><code>chrome.history</code></a>.

- </p>

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Access your tabs and browsing activity

- </td>

- <td>

-

- Any of the following:

- <ul>

- <li> "tabs" permission </li>

- <li> "webNavigation" permission </li>

- </ul>

- </td>

- <td>

- <p>

- The "tabs" permission is required by the

- <a href="tabs.html"><code>chrome.tabs</code></a> and

- <a href="windows.html"><code>chrome.windows</code></a> modules.

- </p>

- <p>

- The "webNavigation" permission is required by the

- <a href="webNavigation.html"><code>chrome.webNavigation</code></a> module.

- </p>

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Manipulate settings that specify whether websites can use features such as cookies, JavaScript, and plug-ins

- </td>

- <td>

-

- "contentSettings" permission

- </td>

- <td>

- <p>

- The "contentSettings" permission is required by

- <a href="contentSettings.html"><code>chrome.contentSettings</code></a>.

- </p>

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Access your data on all websites

- </td>

- <td>

-

- Any of the following:

- <ul>

- <li> "debugger" permission </li>

- <li> "proxy" permission </li>

- <li> A match pattern in the "permissions" field

- that matches all hosts </li>

- <li> A "content_scripts" field with a "matches" entry

- that matches all hosts </li>

- <li> "devtools_page" </li>

- </ul>

- </td>

- <td>

- <p>

- The "debugger" permission is required by the experimental

- <a href="experimental.debugger.html">debugger</a> module.

- </p>

- <p>

- The "proxy" permission is required by the

- <a href="proxy.html"><code>chrome.proxy</code></a> module.

- </p>

- <p>

- Any of the following URLs match all hosts:

- </p>

- <ul>

- <li> <code>http://*/*</code> </li>

- <li> <code>https://*/*</code> </li>

- <li> <code>*://*/*</code> </li>

- <li> <code><all_urls></code> </li>

- </ul>

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

-

- Access your data on <em>{list of websites}</em>

- </td>

- <td>

- A match pattern in the "permissions" field

- that specifies one or more hosts,

- but not all hosts

- </td>

- <td>

- <p>

- Up to 3 sites are listed by name.

- Subdomains aren't treated specially.

- For example, <code>a.com</code> and <code>b.a.com</code>

- are listed as different sites.

- </p>

- <p>

- On autoupdate,

- the user sees a permission warning

- if the extension adds or changes sites.

- For example, going from <code>a.com,b.com</code>

- to <code>a.com,b.com,c.com</code>

- triggers a warning.

- Going from <code>b.a.com</code>

- to <code>a.com</code>,

- or vice versa,

- also triggers a warning.

- </p>

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Access the content of pages you visit

- </td>

- <td>

- "pageCapture" permission

- </td>

- <td>

- The "pageCapture" permission is required by the

- <a href="pageCapture.html"><code>chrome.pageCapture</code></a> module.

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Manage your apps, extensions, and themes

- </td>

- <td>

- "management" permission

- </td>

- <td>

- The "management" permission is required by the

- <a href="management.html"><code>chrome.management</code></a> module.

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Detect your physical location

- </td>

- <td>

- "geolocation" permission

- </td>

- <td>

- Allows the extension to use the proposed HTML5

- <a href="http://dev.w3.org/geo/api/spec-source.html">geolocation API</a>

- without prompting the user for permission.

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Access data you copy and paste

- </td>

- <td>

- "clipboardRead" permission

- </td>

- <td>

- Allows the extension to use the following editing commands with

- <code>document.execCommand()</code>:

- <ul>

- <li> <code>"copy"</code> </li>

- <li> <code>"cut"</code> </li>

- </ul>

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Manipulate privacy-related settings

- </td>

- <td>

- "privacy" permission

- </td>

- <td>

- The "privacy" permission is required by the

- <a href="privacy.html"><code>chrome.privacy</code></a> module.

- </td>

-</tr>

-<tr>

- <td style="font-weight:bold">

-

- Access all text spoken using synthesized speech

- </td>

- <td>

- "ttsEngine" permission

- </td>

- <td>

- The "ttsEngine" permission is required by the

- <a href="ttsEngine.html"><code>chrome.ttsEngine</code></a> module.

- </td>

-</tr>

-</tbody></table>

-<p></p>

-<h2 id="nowarning"> Permissions that don't cause warnings </h2>

-<p>

-The following permissions don't result in a warning:

-</p>

-<ul>

- <li>"browsingData"</li>

- <li>"chrome://favicon/"</li>

- <li>"clipboardWrite"</li>

- <li>"contextMenus"</li>

- <li>"cookies"</li>

- <li>"experimental"</li>

- <li>"idle"</li>

- <li>"notifications"</li>

- <li>"storage"</li>

- <li>"unlimitedStorage"</li>

- <li>"webRequest"</li>

- <li>"webRequestBlocking"</li>

-</ul>

-<h2 id="test"> Testing permission warnings </h2>

-<p>

-If you'd like to see exactly which warnings your users will get,

-<a href="packaging.html">package your extension</a>

-into a <code>.crx</code> file,

-and install it.

-</p>

-<p>

-To see the warnings users will get when your extension is autoupdated,

-you can go to a little more trouble

-and set up an autoupdate server.

-To do this, first create an update manifest

-and point to it from your extension,

-using the "update_url" key

-(see <a href="autoupdate.html">Autoupdating</a>).

-Next, <a href="packaging.html">package the extension</a>

-into a new <code>.crx</code> file,

-and install the app from this <code>.crx</code> file.

-Now, change the extension's manifest to contain the new permissions,

-and <a href="packaging.html#update">repackage the extension</a>.

-Finally, update the extension

-(and all other extensions that have outstanding updates)

-by clicking the <b>chrome://extensions</b> page's

-<b>Update extensions now</b> button.

-</p>

-<h2 id="api">API</h2>

-<p>

-You can get a list of permission warnings for any manifest with

-<a href="management.html#method-getPermissionWarnings">chrome.management.getPermissionWarnings()</a>.

-</p>

-</div>

-

-

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>