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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/manifestVersion.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: 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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/manifest.html ('k') | chrome/common/extensions/docs/match_patterns.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <title>Manifest Version - Google Chrome Extensions - Google Code</title></head >
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">Manifest Version</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <!-- /TABLE OF CONTENTS -->
192 <!-- Standard content lead-in for experimental API pages -->
193 <!-- STATIC CONTENT PLACEHOLDER -->
194 <div id="static"><div id="pageData-name" class="pageData">Manifest Versi on</div>
195 <style type="text/css">
196 #schedule h3 {
197 margin-bottom:0;
198 }
199 #schedule p {
200 margin-top:0;
201 margin-bottom:1em;
202 }
203 </style>
204 <p>
205 Extensions, themes, and applications are simply bundles of resources, wrapped
206 up with a <a href="manifest.html"><code>manifest.json</code></a> file that
207 describes the package's contents. The format of this file is generally stable,
208 but occasionally breaking changes must be made to address important issues.
209 Developers should specify which version of the manifest specification their
210 package targets by setting a <code>manifest_version</code> key in their
211 manifests.
212 </p>
213 <h2>Current Version</h2>
214 <p>
215 Developers should currently specify
216 <strong><code>'manifest_version': 2</code></strong>:
217 </p>
218 <pre>{
219 ...,
220 "manifest_version": 2,
221 ...
222 }</pre>
223 <p>
224 Manifest version 1 was <em>deprecated</em> in Chrome 18, and support will
225 be phased out according to the following schedule.
226 </p>
227 <h2>Manifest version 1 support schedule</h2>
228 <div id="schedule">
229 <h3>Chrome 21</h3>
230 <p><em>Beta: Early July 2012;
231 Stable: Mid-August 2012</em></p>
232 <ul>
233 <li>The Web Store will block updating items to manifest version 1.
234 </li><li>The Web Store will allow updates to existing manifest version 1 items .
235 </li></ul>
236 <h3>Chrome 23</h3>
237 <p><em>Beta: Late September 2012;
238 Stable: Early November 2012</em></p>
239 <ul>
240 <li>The Web Store will block updates to manifest version 1 items.
241 </li><li>Chrome will stop packaging manifest version 1 items (or loading
242 them for development).
243 </li></ul>
244 <h3>First Quarter 2013</h3>
245 <ul>
246 <li>The Web Store will remove manifest version 1 items from the wall,
247 search results, and category pages.
248 </li><li>Notice emails will be sent to all developers with manifest
249 version 1 items still in the store reminding them that these
250 items will be unpublished and providing update instructions.
251 </li></ul>
252 <h3>Second Quarter 2013</h3>
253 <ul>
254 <li>The Web Store will unpublish all manifest version 1 items.
255 </li><li>Final notice emails will be sent to developers with manifest
256 version 1 items still in the Web Store.
257 </li><li>Chrome will continue to load and run installed manifest
258 version 1 items.
259 </li></ul>
260 <h3>Third Quarter 2013</h3>
261 <ul>
262 <li>Chrome will stop loading or running manifest
263 version 1 items.
264 </li></ul>
265 </div>
266 <h2>Changes between version 1 and 2</h2>
267 <ul>
268 <li>
269 <p>
270 A content security policy is set to <code>`script-src 'self'; object-src
271 'self'</code> by default. This has a variety of impacts on developers,
272 described at length in the <a href="contentSecurityPolicy.html">
273 <code>content_security_policy</code></a> documentation.
274 </p>
275 </li>
276 <li>
277 <p>
278 A package's resources are no longer available by default to external
279 websites (as the <code>src</code> of an image, or a <code>script</code>
280 tag). If you want a website to be able to load a resource contained in
281 your package, you'll need to explicitly whitelist it via the
282 <a href="manifest.html#web_accessible_resources">
283 <code>web_accessible_resources</code>
284 </a> manifest attribute. This is particularly relevant for extensions that
285 build up an interface on a website via injected content scripts.
286 </p>
287 </li>
288 <li>
289 <p>
290 The <code>background_page</code> property has been replaced with a
291 <code>background</code> property that contains <em>either</em> a
292 <code>scripts</code> or <code>page</code> property. Details are available
293 in the <a href="background_pages.html">Background Pages</a> documentation.
294 </p>
295 </li>
296 <li>
297 <p>Browser action changes:</p>
298 <ul>
299 <li>
300 <p>
301 The <code>browser_actions</code> key in the manifest, and the
302 <code>chrome.browserActions</code> API are gone. Use the singular
303 <a href="browserAction.html">
304 <code>browser_action</code> and <code>chrome.browserAction</code>
305 </a> instead.
306 </p>
307 </li>
308 <li>
309 <p>
310 The <code>icons</code> property of <code>browser_action</code> has
311 been removed. Use <a href="browserAction.html#manifest">
312 the <code>default_icon</code> property
313 </a> or <a href="browserAction.html#method-setIcon">
314 <code>chrome.browserAction.setIcon</code>
315 </a> instead.
316 </p>
317 </li>
318 <li>
319 <p>
320 The <code>name</code> property of <code>browser_action</code> has been
321 removed. Use <a href="browserAction.html#manifest">
322 the <code>default_title</code> property
323 </a> or <a href="browserAction.html#method-setTitle">
324 <code>chrome.browserAction.setTitle</code>
325 </a> instead.
326 </p>
327 </li>
328 <li>
329 <p>
330 The <code>popup</code> property of <code>browser_action</code> has
331 been removed. Use <a href="browserAction.html#manifest">
332 the <code>default_popup</code> property
333 </a> or <a href="browserAction.html#method-setPopup">
334 <code>chrome.browserAction.setPopup</code>
335 </a> instead.
336 </p>
337 </li>
338 <li>
339 <p>
340 The <code>default_popup</code> property of <code>browser_action</code>
341 can no longer be specified as an object. It must be a string.
342 </p>
343 </li>
344 </ul>
345 </li>
346 <li>
347 <p>Page action changes:</p>
348 <ul>
349 <li>
350 <p>
351 The <code>page_actions</code> key in the manifest, and the
352 <code>chrome.pageActions</code> API are gone. Use the singular
353 <a href="pageAction.html">
354 <code>page_action</code> and <code>chrome.pageAction</code>
355 </a> instead.
356 </p>
357 </li>
358 <li>
359 <p>
360 The <code>icons</code> property of <code>page_action</code> has been
361 removed. Use <a href="pageAction.html#manifest">
362 the <code>default_icon</code> property
363 </a> or <a href="pageAction.html#method-setIcon">
364 <code>chrome.pageAction.setIcon</code>
365 </a> instead.
366 </p>
367 </li>
368 <li>
369 <p>
370 The <code>name</code> property of <code>page_action</code> has been
371 removed. Use <a href="pageAction.html#manifest">
372 the <code>default_title</code> property
373 </a> or <a href="pageAction.html#method-setTitle">
374 <code>chrome.pageAction.setTitle</code>
375 </a> instead.
376 </p>
377 </li>
378 <li>
379 <p>
380 The <code>popup</code> property of <code>page_action</code> has been
381 removed. Use <a href="pageAction.html#manifest">
382 the <code>default_popup</code> property
383 </a> or <a href="pageAction.html#method-setPopup">
384 <code>chrome.pageAction.setPopup</code>
385 </a> instead.
386 </p>
387 </li>
388 <li>
389 <p>
390 The <code>default_popup</code> property of <code>page_action</code>
391 can no longer be specified as an object. It must be a string.
392 </p>
393 </li>
394 <li>
395 <p>
396 The <code>chrome.self</code> API has been removed. Use
397 <a href="extension.html"><code>chrome.extension</code></a> instead.
398 </p>
399 </li>
400 </ul>
401 </li>
402 <li>
403 <p>
404 <code>chrome.extension.getTabContentses</code> (!!!) and
405 <code>chrome.extension.getExtensionTabs</code> are gone. Use
406 <a href="extension.html#method-getViews">
407 <code>chrome.extension.getViews({ "type": "tab" })</code>
408 </a> instead.
409 </p>
410 </li>
411 <li>
412 <p>
413 <code>Port.tab</code> is gone. Use
414 <a href="extension.html#type-Port"><code>Port.sender</code></a>
415 instead.
416 </p>
417 </li>
418 </ul>
419 </div>
420 <!-- API PAGE -->
421 <!-- /apiPage -->
422 </div> <!-- /gc-pagecontent -->
423 </div> <!-- /g-section -->
424 </div> <!-- /codesiteContent -->
425 <div id="gc-footer" --="">
426 <div class="text">
427 <p>
428 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
429 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
430 Attribution 3.0 License</a>, and code samples are licensed under the
431 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
432 </p>
433 <p>
434 ©2011 Google
435 </p>
436 <!-- begin analytics -->
437 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
438 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
439 <script type="text/javascript">
440 // chrome doc tracking
441 try {
442 var engdocs = _gat._getTracker("YT-10763712-2");
443 engdocs._trackPageview();
444 } catch(err) {}
445 // code.google.com site-wide tracking
446 try {
447 _uacct="UA-18071-1";
448 _uanchor=1;
449 _uff=0;
450 urchinTracker();
451 }
452 catch(e) {/* urchinTracker not available. */}
453 </script>
454 <!-- end analytics -->
455 </div>
456 </div> <!-- /gc-footer -->
457 </div> <!-- /gc-container -->
458 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/manifest.html ('k') | chrome/common/extensions/docs/match_patterns.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698