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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps.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/appWindow.html ('k') | chrome/common/extensions/docs/apps/bookmarks.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>Packaged Apps - 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">Packaged Apps</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#overview">Overview</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#manifest"> The manifest </a>
200 <ol>
201 </ol>
202 </li><li>
203 <a href="#next">What next?</a>
204 <ol>
205 </ol>
206 </li>
207 </ol>
208 </div>
209 <!-- /TABLE OF CONTENTS -->
210 <!-- Standard content lead-in for experimental API pages -->
211 <!-- STATIC CONTENT PLACEHOLDER -->
212 <div id="static"><div id="pageData-name" class="pageData">Packaged Apps< /div>
213 <div id="pageData-showTOC" class="pageData">true</div>
214 <p>
215 This page talks about packaged apps—how
216 you implement them,
217 and how they're different from
218 extensions and ordinary web apps.
219 </p>
220 <h2 id="overview">Overview</h2>
221 <p>
222 A packaged app is a web app
223 that's bundled into a <code>.crx</code> file
224 and can use Chrome extension features.
225 You build a packaged app just like you build an extension,
226 except that a packaged app can't include a
227 <a href="browserAction.html">browser action</a> or
228 <a href="pageAction.html">page action</a>.
229 Instead, a packaged app includes at least one HTML file
230 within its <code>.crx</code> file
231 that provides the app's user interface.
232 </p>
233 <p>
234 Packaged apps are a type of
235 <a href="http://code.google.com/chrome/apps/">installable web app</a>—a
236 web app that can be installed in Chrome.
237 The other type of installable web app is a
238 <a href="http://code.google.com/chrome/apps/docs/developers_guide.html">hosted a pp</a>,
239 which is an ordinary web app with a bit of additional metadata.
240 </p>
241 <p>
242 If you're developing a web app for the Chrome Web Store,
243 you might want to use a packaged app
244 instead of a hosted app if any of the following are true:
245 </p>
246 <ul>
247 <li>
248 You don't want to run a service to host your app.
249 </li>
250 <li>
251 You want to build an app that works really well offline.
252 </li>
253 <li>
254 You want tighter integration with Chrome,
255 using the extension APIs.
256 </li>
257 </ul>
258 <p>
259 To learn more about
260 the differences between web apps and websites,
261 extensions and packaged apps, and packaged apps and hosted apps,
262 read these:
263 </p>
264 <ul>
265 <li> <a href="http://code.google.com/chrome/webstore/docs/choosing.html">Choos ing an App Type</a> </li>
266 <li> <a href="http://code.google.com/chrome/apps/articles/thinking_in_web_apps .html">Thinking in Web Apps</a> </li>
267 <li> <a href="http://code.google.com/chrome/webstore/articles/apps_vs_extensio ns.html">Extensions, Packaged Apps, and Hosted Apps in the Chrome Web Store</a> </li>
268 </ul>
269 <h2 id="manifest"> The manifest </h2>
270 <p>
271 A packaged app's manifest can have any field
272 that's available to extensions,
273 except for "browser_action" and "page_action".
274 In addition, a packaged app's manifest <b>must</b>
275 have an "app" field.
276 Here is a typical manifest for a packaged app:
277 </p>
278 <pre>{
279 "name": "My Awesome Racing Game",
280 "description": "Enter a world where a Vanagon can beat a Maserati",
281 "version": "1",
282 <b>"app": {
283 "launch": {
284 "local_path": "main.html"
285 }
286 },</b>
287 "icons": {
288 "16": "icon_16.png",
289 "128": "icon_128.png"
290 }
291 }
292 </pre>
293 <p>
294 The "app" field has one subfield, "launch",
295 which specifies the <em>launch page</em> for the app—the
296 page (HTML file bundled into the <code>.crx</code> file)
297 that the browser goes to when the user clicks the app's icon
298 in the New Tab page.
299 The "launch" field can contain the following:
300 </p>
301 <dl>
302 <dt>local_path:</dt>
303 <dd><em>Required.</em>
304 Specifies the launch page
305 as a relative path referring to a file
306 in the <code>.crx</code> package.
307 </dd>
308 <dt>container:</dt>
309 <dd> The value "panel" makes the app appear
310 in an app panel.
311 By default, or when you specify "tab",
312 the app appears in a tab.
313 <!-- PENDING: In the overview
314 (or somewhere else before here)
315 we should show and define both app panels and tabs.
316 We should link to that place from here. -->
317 </dd>
318 <dt>height:</dt>
319 <dd>
320 If the container is set to "panel",
321 this integer specifies the height
322 of the panel in pixels.
323 For example, you might specify
324 <code>"height":400</code>.
325 Note that you don't use quotation marks in the value.
326 This field specifies the height of the area
327 to display contents in;
328 window decorations add a few more pixels to the total height.
329 If the container isn't a panel, this field is ignored.
330 </dd>
331 <dt>width:</dt>
332 <dd>
333 Similar to "height",
334 but specifies the width of the panel.
335 </dd>
336 </dl>
337 <p>
338 Packaged apps usually provide a 16x16 icon
339 to be used as the favicon for
340 tabs that contain app's pages.
341 They also should provide a 128x128 icon,
342 but not a 48x48 icon.
343 See the manifest documentation for the
344 <a href="manifest.html#icons">"icons" field</a>
345 for more information.
346 </p>
347 <p>
348 For further details on what a packaged app's manifest can contain, see the
349 <a href="manifest.html">manifest documentation</a>.
350 </p>
351 <h2 id="next">What next?</h2>
352 <p>
353 Read the <a href="overview.html">Overview</a> to learn
354 basic concepts about extensions.
355 </p>
356 <p class="backtotop"><a href="#top">Back to top</a></p>
357 </div>
358 <!-- API PAGE -->
359 <!-- /apiPage -->
360 </div> <!-- /gc-pagecontent -->
361 </div> <!-- /g-section -->
362 </div> <!-- /codesiteContent -->
363 <div id="gc-footer" --="">
364 <div class="text">
365 <p>
366 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
367 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
368 Attribution 3.0 License</a>, and code samples are licensed under the
369 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
370 </p>
371 <p>
372 ©2011 Google
373 </p>
374 <!-- begin analytics -->
375 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
376 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
377 <script type="text/javascript">
378 // chrome doc tracking
379 try {
380 var engdocs = _gat._getTracker("YT-10763712-2");
381 engdocs._trackPageview();
382 } catch(err) {}
383 // code.google.com site-wide tracking
384 try {
385 _uacct="UA-18071-1";
386 _uanchor=1;
387 _uff=0;
388 urchinTracker();
389 }
390 catch(e) {/* urchinTracker not available. */}
391 </script>
392 <!-- end analytics -->
393 </div>
394 </div> <!-- /gc-footer -->
395 </div> <!-- /gc-container -->
396 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/appWindow.html ('k') | chrome/common/extensions/docs/apps/bookmarks.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698