Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2298)

Unified Diff: chrome/common/extensions/docs/static/manifest.html

Issue 5398002: doc stuff (Closed) Base URL: svn://chrome-svn/chrome/trunk/src/
Patch Set: '' Created 10 years 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
Download patch
Index: chrome/common/extensions/docs/static/manifest.html
===================================================================
--- chrome/common/extensions/docs/static/manifest.html (revision 68334)
+++ chrome/common/extensions/docs/static/manifest.html (working copy)
@@ -2,10 +2,10 @@
<div id="pageData-showTOC" class="pageData">true</div>
<p>
-Every extension has a
+Every extension, installable web app, and theme has a
<a href="http://www.json.org">JSON</a>-formatted manifest file,
named <code>manifest.json</code>,
-that provides important information about the extension.
+that provides important information.
</p>
<h2 id="overview"> Field summary </h2>
@@ -13,7 +13,7 @@
<p>
The following code shows the supported manifest fields,
with links to the page that discusses each field.
-The only fields that are required for every extension
+The only fields that are always required
are <b>name</b> and <b>version</b>.
</p>
@@ -32,6 +32,7 @@
"<a href="browserAction.html">browser_action</a>": {...},
"<a href="pageAction.html">page_action</a>": {...},
"<a href="themes.html">theme</a>": {...},
+ "<a href="#app">app</a>": {...},
<em>// Add any of these that you need</em>
"<a href="background_pages.html">background_page</a>": "<em>aFile</em>.html",
@@ -59,6 +60,24 @@
see the <a href="#overview">Field summary</a>.
</p>
+
+<h3 id="app">app</h3>
+
+<p>
+Used by installable web apps,
+including packaged apps,
+to specify the URLs that the app uses.
+Most important is the <em>launch page</em> for the app&mdash;the
+page that the browser goes to when the user clicks the app's icon
+in the New Tab page.
+</p>
+
+<p>
+For details, see the documentation for
+<a href="http://code.google.com/chrome/apps/docs/developers_guide.html">hosted apps</a> and
+<a href="apps.html">packaged apps</a>.
+</p>
+
<h3 id="default_locale">default_locale</h3>
<p>
@@ -99,15 +118,15 @@
<h3 id="icons">icons</h3>
<p>
-One or more icons that represent the extension.
-You should provide icons in at least two sizes &mdash;
-48x48 and 128x128 pixels.
-The 48x48 icon is used in the extensions management page
+One or more icons that represent the extension, app, or theme.
+You should always provide a 128x128 icon;
+it's used during installation and by the Chrome Web Store.
+Extensions should also provide a 48x48 icon,
+which is used in the extensions management page
(chrome://extensions).
-The 128x128 icon is used when the user installs the extension.
You can also specify a 16x16 icon to be used as the favicon
-for the extension's pages.
-The 16x16 icon is also displayed in the experimental
+for an extension's pages.
+The 16x16 icon is also displayed in the experimental extension
<a href="experimental.infobars.html">infobar</a>
feature.
</p>
@@ -127,28 +146,28 @@
</pre>
<p class="note">
-<b>Note:</b>
+<b>Important:</b>
Use only the documented icon sizes.
<br><br>
-You may notice that Google Chrome sometimes resizes these icons down to smaller
-sizes. For example, as of this writing, the install dialog shrinks the 128-pixel
+You might notice that Chrome sometimes resizes these icons down to smaller
+sizes. For example, the install dialog might shrink the 128-pixel
icon down to 69 pixels.
<br><br>
-Nevertheless, you should use only the documented sizes. The details of Google
-Chrome's UI may change between versions. These changes are made assuming that
-extension developers are using the documented sizes. If you use other sizes,
+However, the details of
+Chrome's UI may change between versions, and these changes assume that
+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>,
+If you upload your extension, app, or theme using the
+<a href="https://chrome.google.com/extensions/developer/dashboard">Chrome Developer Dashboard</a>,
you'll need to upload additional images,
-including a 32x32-pixel logo
-and at least one screenshot of your extension.
-For more information on gallery requirements,
+including at least one screenshot of your extension.
+For more information,
see the
-<a href="http://www.google.com/support/chrome/bin/answer.py?answer=113909">gallery help</a>.
+<a href="http://code.google.com/chrome/webstore/">Chrome Web Store
+developer documentation</a>.
</p>
<h3 id="incognito">incognito</h3>
@@ -186,12 +205,12 @@
<p>
This value can be used to control
-the unique ID of an extension when
+the unique ID of an extension, app, or theme when
it is loaded during development.
</p>
<p class="note">
-<b>Note:</b> Most extensions should not need to
+<b>Note:</b> You don't usually need to
use this value. Instead, write your
code so that the key value doesn't matter
by using <a href="overview.html#relative-urls">relative paths</a>
@@ -202,7 +221,7 @@
To get a suitable key value, first
install your extension from a <code>.crx</code> file
(you may need to
-<a href="hosting.html#gallery">upload your extension to the gallery</a>,
+<a href="https://chrome.google.com/webstore/developer/dashboard">upload your extension</a>
or <a href="packaging.html">package it manually</a>).
Then, in your
<a href="http://www.chromium.org/user-experience/user-data-directory">user
@@ -214,7 +233,7 @@
<h3 id="minimum_chrome_version">minimum_chrome_version</h3>
<p>
-The version of Google Chrome that your extension requires, if any.
+The version of Chrome that your extension, app, or theme requires, if any.
The format for this string is the same as for the
<a href="#version">version</a> field.
@@ -234,18 +253,20 @@
<h3 id="permissions">permissions</h3>
<p>
-An array of permissions that the extension might use.
+An array of permissions that the extension or app might use.
Each permission can be either one of a list of known strings
-(such as "tabs")
+(such as "geolocation")
or a match pattern
that gives access to one or more hosts.
-These permissions are displayed to users before installation.
-Permissions might also help to limit damage
-if your extension is attacked.
+Permissions can help to limit damage
+if your extension or app is attacked.
+Some permissions are also displayed to users before installation,
+as detailed in
+<a href="permission_warnings.html">Permission Warnings</a>.
</p>
<p>
-If an API requires you to declare a permission in the manifest,
+If an extension API requires you to declare a permission in the manifest,
then its documentation tells you how to do so.
For example,
the <a href="tabs.html">Tabs</a> page
@@ -254,7 +275,8 @@
</p>
<p>
-Here's an example of the permissions part of a manifest file:
+Here's an example of the permissions part of a manifest file
+for an extension:
</p>
<pre>
@@ -268,9 +290,16 @@
</pre>
<p>
-The following table lists the permissions an extension can use.
+The following table lists the permissions an extension
+or packaged app can use.
</p>
+<p class="note">
+<strong>Note:</strong>
+Hosted apps can use only HTML5-related permissions
kurrik.chromium 2010/12/07 05:16:30 HTML5-related is a bit confusing. "Web-related"?
kathyw 2010/12/07 06:43:32 I've changed it. Take another look?
+such as "geolocation", "notifications", and "unlimitedStorage".
+</p>
+
<table>
<tr>
<th> Permission </th> <th> Description </th>

Powered by Google App Engine
This is Rietveld 408576698