diff options
Diffstat (limited to 'chrome/common/extensions/docs/manifest.html')
| -rw-r--r-- | chrome/common/extensions/docs/manifest.html | 123 |
1 files changed, 76 insertions, 47 deletions
diff --git a/chrome/common/extensions/docs/manifest.html b/chrome/common/extensions/docs/manifest.html index d8bd4f4..b593f31 100644 --- a/chrome/common/extensions/docs/manifest.html +++ b/chrome/common/extensions/docs/manifest.html @@ -15,6 +15,7 @@ </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>Formats: Manifest Files - Google Chrome Extensions - Google Code</title></head> <body> <div id="gc-container" class="labs"> <div id="devModeWarning"> @@ -94,7 +95,7 @@ <div> </div> </div> - </dl> + </dl> </div> </div> <!-- /SUBTEMPLATES --> @@ -225,6 +226,9 @@ <li><h2><a href="samples.html">Samples</a></h2></li> </ul> </div> + <script> + initToggles(); + </script> <div class="g-unit" id="gc-pagecontent"> <div id="pageTitle"> @@ -245,11 +249,15 @@ <a href="#H2-1">Field details</a> <ol> <li> + <a href="#default_locale">default_locale</a> + </li><li> <a href="#description">description</a> </li><li> + <a href="#homepage_url">homepage_url</a> + </li><li> <a href="#icons">icons</a> </li><li> - <a href="#default_locale">default_locale</a> + <a href="#incognito">incognito</a> </li><li> <a href="#key">key</a> </li><li> @@ -260,8 +268,6 @@ <a href="#permissions">permissions</a> </li><li> <a href="#version">version</a> - </li><li> - <a href="#incognito">incognito</a> </li> </ol> </li> @@ -350,13 +356,14 @@ are <b>name</b> and <b>version</b>. "<a href="background_pages.html">background_page</a>": "<em>aFile</em>.html", "<a href="override.html">chrome_url_overrides</a>": {...}, "<a href="content_scripts.html">content_scripts</a>": [...], + "<a href="#homepage_url">homepage_url</a>": "http://<em>path/to/homepage</em>", + "<a href="#incognito">incognito</a>": "spanning" <em>or</em> "split", "<a href="#key">key</a>": "<em>publicKey</em>", "<a href="#minimum_chrome_version">minimum_chrome_version</a>": "<em>versionString</em>", "<a href="options.html">options_page</a>": "<em>aFile</em>.html", "<a href="#permissions">permissions</a>": [...], "<a href="npapi.html">plugins</a>": [...], "<a href="autoupdate.html">update_url</a>": "http://<em>path/to/updateInfo</em>.xml" - "<a href="#incognito">incognito</a>": "<em>split</em> or <em>spanning</em>", } </pre> @@ -370,6 +377,19 @@ with links to where they're described in detail, see the <a href="#overview">Field summary</a>. </p> +<h3 id="default_locale">default_locale</h3> + +<p> +Specifies the subdirectory of <code>_locales</code> +that contains the default strings for this extension. +This field is <b>required</b> in extensions +that have a <code>_locales</code> directory; +it <b>must be absent</b> in extensions +that have no <code>_locales</code> directory. +For details, see +<a href="i18n.html">Internationalization</a>. +</p> + <h3 id="description">description</h3> <p> @@ -384,6 +404,15 @@ You can specify locale-specific strings for this field; see <a href="i18n.html">Internationalization</a> for details. </p> +<h3 id="homepage_url">homepage_url</h3> + +<p> +The URL of the homepage for this extension. The extensions management page (chrome://extensions) +will contain a link to this URL. This field is particularly useful if you +<a href="hosting.html">host the extension on your own site</a>. If you distribute your +extension using the <a href="http://chrome.google.com/extensions">gallery</a>, +the homepage URL defaults to the extension's own gallery page. +</p> <h3 id="icons">icons</h3> @@ -428,8 +457,6 @@ extension developers are using the documented sizes. If you use other sizes, your icon may look bad in future versions of the browser. </p> - - <p> If you submit your extension to the <a href="https://chrome.google.com/extensions">gallery</a>, @@ -441,17 +468,35 @@ see the <a href="http://www.google.com/support/chrome/bin/answer.py?answer=113909">gallery help</a>. </p> -<h3 id="default_locale">default_locale</h3> +<h3 id="incognito">incognito</h3> <p> -Specifies the subdirectory of <code>_locales</code> -that contains the default strings for this extension. -This field is <b>required</b> in extensions -that have a <code>_locales</code> directory; -it <b>must be absent</b> in extensions -that have no <code>_locales</code> directory. -For details, see -<a href="i18n.html">Internationalization</a>. +Either "spanning" or "split", to specify how this extension will +behave if allowed to run in incognito mode. +</p> + +<p> +The default for extensions is "spanning", which means that the extension +will run in a single shared process. Any events or messages from an incognito +tab will be sent to the shared process, with an <em>incognito</em> flag +indicating where it came from. +</p> + +<p> +The default for installable web apps is "split", +which means that all app pages in +an incognito window will run in their own incognito process. If the app or extension contains a background page, that will also run in the incognito process. +This incognito process runs along side the regular process, but has a separate +memory-only cookie store. Each process sees events and messages only from its +own context (for example, the incognito process will see only incognito tab updates). +The processes are unable to communicate with each other. +</p> + +<p> +As a rule of thumb, if your extension or app needs to load a tab in an incognito browser, use +<em>split</em> incognito behavior. If your extension or app needs to be logged +into a remote server or persist settings locally, use <em>spanning</em> +incognito behavior. </p> <h3 id="key">key</h3> @@ -607,6 +652,11 @@ The following table lists the permissions an extension can use. <a href="idle.html">chrome.idle</a> module. </td> </tr> <tr> + <td> "management" </td> + <td> Required if the extension uses the + <a href="management.html">chrome.management</a> module. </td> +</tr> +<tr> <td> "notifications" </td> <td> Allows the extension to use the proposed HTML5 <a href="http://www.chromium.org/developers/design-documents/desktop-notifications/api-specification">notification API</a> @@ -626,7 +676,16 @@ The following table lists the permissions an extension can use. <td> Provides an unlimited quota for storing HTML5 client-side data, such as databases and local storage files. Without this permission, the extension is limited to - 5 MB of local storage. </td> + 5 MB of local storage. + + <p class="note"> + <b>Note:</b> + This permission applies only to Web SQL Database and application cache + (see issue <a href="http://crbug.com/58985">58985</a>). + Also, it doesn't currently work with wildcard subdomains such as + <code>http://*.example.com</code>. + </p> + </td> </tr> </tbody></table> @@ -680,36 +739,6 @@ For more information, see <a href="autoupdate.html">Autoupdating</a>. </p> -<h3 id="incognito">incognito</h3> - -<p> -Either <em>split</em> or <em>spanning</em>, to specify how this extension will -behave if allowed to run in incognito. -</p> - -<p> -<em>spanning</em> is the default for extensions, and means that the extension -will run in a single shared process. Any events or messages from an incognito -tab will be sent to the shared process, with an <em>incognito</em> flag -indicating where it came from. -</p> - -<p> -<em>split</em> is the default for apps, and it means that all app pages in -an incognito window will run in their own incognito process. If the app or extension contains a background page, that will also run in the incognito process. -This incognito process runs along side the regular process, but has a separate -memory-only cookie store. Each process sees events and messages only from its -own context (e.g. the incognito process will only see incognito tab updates). -The processes are unable to communicate with each other. -</p> - -<p> -As a rule of thumb, if your extension or app needs to load a tab in an incognito browser, use -<em>split</em> incognito behavior. If your extension or app needs to be logged -into a remote server or persist settings locally, use <em>spanning</em> -incognito behavior. -</p> - <!-- [PENDING: Possibly: point to the gallery and make a big deal of the fact that autoupdating is free if you use the gallery.] --> </div> |