chrome/common/extensions/docs/apps.html - Issue 5398002: doc stuff

Unified Diff: chrome/common/extensions/docs/apps.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

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

===================================================================

--- chrome/common/extensions/docs/apps.html (revision 0)

+++ chrome/common/extensions/docs/apps.html (revision 0)

@@ -0,0 +1,683 @@

+<!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="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>Packaged Apps - Google Chrome Extensions - Google Code</title></head>

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

+ <div id="devModeWarning">

+ 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>

+

+ <!-- 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" -->

+ <div style="display:none">

+

+ <div id="valueTemplate">

+ <dt>

+ <var>paramName</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional">optional</span>

+ <span class="enum">enumerated</span>

+ <span id="typeTemplate">

+ <span>

+ <a> Type</a>

+ </span>

+ <span>

+ array of <span><span></span></span>

+ </span>

+ <span>paramType</span>

+ <span></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+ <dd>

+ Description of this parameter from the json schema.

+ </dd>

+ <dd>

+ This parameter was added in version

+ <b><span></span></b>.

+ You must omit this parameter in earlier versions,

+ and you may omit it in any version. If you require this

+ parameter, the manifest key

+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

+ can ensure that your extension won't be run in an earlier browser version.

+ </dd>

+

+ <dd>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </dd>

+

+ <dd>

+ <div></div>

+ </dd>

+ </div>

+ <div id="functionParametersTemplate">

+ <h5>Parameters</h5>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div>

+ <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="http://www.google.com/jsapi"></script>

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

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

+ <script type="text/javascript" src="http://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>

+ </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="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="idle.html">Idle</a></li>

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

+ <li><a href="messaging.html">Message Passing</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><a href="permission_warnings.html">Permission Warnings</a></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">Packaged Apps</h1>

+ </div>

+

+ <div id="toc">

+ <h2>Contents</h2>

+ <ol>

+ <li>

+ <a href="#overview">Overview</a>

+ <ol>

+ <li style="display: none; ">

+ <a>h3Name</a>

+ </li>

+ </ol>

+ </li><li>

+ <a href="#manifest"> The manifest </a>

+ <ol>

+ <li style="display: none; ">

+ <a>h3Name</a>

+ </li>

+ </ol>

+ </li><li>

+ <a href="#next">What next?</a>

+ <ol>

+ <li style="display: none; ">

+ <a>h3Name</a>

+ </li>

+ </ol>

+ </li>

+ <li style="display: none; ">

+ <a href="#apiReference">API reference</a>

+ <ol>

+ <li>

+ <a href="#properties">Properties</a>

+ <ol>

+ <li>

+ <a href="#property-anchor">propertyName</a>

+ </li>

+ </ol>

+ </li>

+ <li>

+ <a href="#methods">Methods</a>

+ <ol>

+ <li>

+ <a href="#method-anchor">methodName</a>

+ </li>

+ </ol>

+ </li>

+ <li>

+ <a href="#events">Events</a>

+ <ol>

+ <li>

+ <a href="#event-anchor">eventName</a>

+ </li>

+ </ol>

+ </li>

+ <li>

+ <a href="#types">Types</a>

+ <ol>

+ <li>

+ <a href="#id-anchor">id</a>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </div>

+

+

+ <p id="classSummary" style="display: none; ">

+ For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

+ </p>

+

+ <div id="static"><div id="pageData-name" class="pageData">Packaged Apps</div>

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

+<p>

+This page talks about packaged apps—how

+you implement them,

+and how they're different from

+extensions and ordinary web apps.

+</p>

+<h2 id="overview">Overview</h2>

+<p>

+A packaged app is a web app

+that's bundled into a <code>.crx</code> file

+and can use Chrome extension features.

+You build a packaged app just like you build an extension,

+except that a packaged app can't include a

+<a href="browserAction.html">browser action</a> or

+<a href="pageAction.html">page action</a>.

+Instead, a packaged app includes at least one HTML file

+within its <code>.crx</code> file

+that provides the app's user interface.

+</p>

+<p>

+Packaged apps are a type of

+<a href="http://code.google.com/chrome/apps/">installable web app</a>—a

+web app that can be installed in Chrome.

+The other type of installable web app is a

+<a href="http://code.google.com/chrome/apps/docs/developers_guide.html">hosted app</a>,

+which is an ordinary web app with a bit of additional metadata.

+</p>

+<p>

+If you're developing a web app for the Chrome Web Store,

+you might want to use a packaged app

+instead of a hosted app if any of the following are true:

+</p>

+<ul>

+ <li>

+ You don't want to run a service to host your app.

+ </li>

+ <li>

+ You want to build an app that works really well offline.

+ </li>

+ <li>

+ You want tighter integration with Chrome,

+ using the extension APIs.

+ </li>

+</ul>

+<p>

+The following articles can help you understand

+the differences between web apps and websites,

+extensions and packaged apps, and packaged apps and hosted apps:

+</p>

+<ul>

+ <li> <a href="http://code.google.com/chrome/apps/articles/thinking_in_web_apps.html">Thinking in Web Apps</a> </li>

+ <li> <a href="http://codesite-staging:29006/chrome/webstore/articles/apps_vs_extensions.html">Extensions, Packaged Apps, and Hosted Apps in the Chrome Web Store</a> </li>

+</ul>

+<h2 id="manifest"> The manifest </h2>

+<p>

+A packaged app's manifest can have any field

+that's available to extensions,

+except for "browser_action" and "page_action".

+In addition, a packaged app's manifest <b>must</b>

+have an "app" field.

+Here is a typical manifest for a packaged app:

+</p>

+<pre>{

+ "name": "My Awesome Racing Game",

+ "description": "Enter a world where a Vanagon can beat a Maserati",

+ "version": "1",

+ <b>"app": {

+ "launch": {

+ "local_path": "main.html"

+ }

+ },</b>

+ "icons": {

+ "16": "icon_16.png",

+ "128": "icon_128.png"

+ },

+ "permissions": [

+ "unlimitedStorage",

+ "notifications"

+ ]

+</pre>

+<p>

+The "app" field has one subfield, "launch",

+which specifies the <em>launch page</em> for the app—the

+page (HTML file bundled into the <code>.crx</code> file)

+that the browser goes to when the user clicks the app's icon

+in the New Tab page.

+The "launch" field can contain the following:

+</p>

+<dl>

+ <dt>local_path:</dt>

+ <dd><em>Required.</em>

+ Specifies the launch page

+ as a relative path referring to a file

+ in the <code>.crx</code> package.

+ </dd>

+ <dt>container:</dt>

+ <dd> The value "panel" makes the app appear

+ in an app panel.

+ By default, or when you specify "tab",

+ the app appears in a tab.

+ <!-- PENDING: In the overview

+ (or somewhere else before here)

+ we should show and define both app panels and tabs.

+ We should link to that place from here. -->

+ </dd>

+ <dt>height:</dt>

+ <dd>

+ If the container is set to "panel",

+ this integer specifies the height

+ of the panel in pixels.

+ For example, you might specify

+ <code>"height":400</code>.

+ Note that you don't use quotation marks in the value.

+ This field specifies the height of the area

+ to display contents in;

+ window decorations add a few more pixels to the total height.

+ If the container isn't a panel, this field is ignored.

+ </dd>

+ <dt>width:</dt>

+ <dd>

+ Similar to "height",

+ but specifies the width of the panel.

+ </dd>

+</dl>

+<p>

+Packaged apps usually provide a 16x16 icon

+to be used as the favicon for

+tabs that contain app's pages.

+They also should provide a 128x128 icon,

+but not a 48x48 icon.

+See the manifest documentation for the

+<a href="manifest.html#icons">"icons" field</a>

+for more information.

+</p>

+<p>

+For further details on what a packaged app's manifest can contain, see the

+<a href="manifest.html">manifest documentation</a>.

+</p>

+<h2 id="next">What next?</h2>

+<p>

+Read the <a href="overview.html">Overview</a> to learn

+basic concepts about extensions.

+</p>

+<p class="backtotop"><a href="#top">Back to top</a></p>

+</div>

+

+ <div class="apiPage" style="display: none; ">

+ <a name="apiReference"></a>

+ <h2>API reference: chrome.apiname </h2>

+

+ <div class="apiGroup">

+ <a name="properties"></a>

+ <h3 id="properties">Properties</h3>

+ <div>

+ <a></a>

+ <h4>getLastError</h4>

+ <div class="summary">

+

+ <span>chrome.extension</span><span>lastError</span>

+ </div>

+ <div>

+ </div>

+ </div>

+

+ <div class="apiGroup" id="methods">

+ <a name="methods"></a>

+ <h3>Methods</h3>

+

+ <div class="apiItem">

+ <a></a>

+ <h4>method name</h4>

+ <div class="summary"><span>void</span>

+

+ <span>chrome.module.methodName</span>(<span><span>, </span><span></span>

+ <var><span></span></var></span>)</div>

+ <div class="description">

+ <p class="todo">Undocumented.</p>

+ <p>

+ A description from the json schema def of the function goes here.

+ </p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+

+ <h4>Returns</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+

+ <div>

+ <h4>Callback function</h4>

+ <p>

+ The callback <em>parameter</em> should specify a function

+ that looks like this:

+ </p>

+ <p>

+ If you specify the <em>callback</em> parameter, it should

+ specify a function that looks like this:

+ </p>

+

+ <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <p>

+ This function was added in version <b><span></span></b>.

+ If you require this function, the manifest key

+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

+ can ensure that your extension won't be run in an earlier browser version.

+ </p>

+ </div>

+ </div>

+ </div>

+

+ <div class="apiGroup">

+ <a name="events"></a>

+ <h3 id="events">Events</h3>

+

+ <div class="apiItem">

+ <a></a>

+ <h4>event name</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);

+ </div>

+ <div class="description">

+ <p class="todo">Undocumented.</p>

+ <p>

+ A description from the json schema def of the event goes here.

+ </p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div>

+ </div>

+

+ <div class="apiGroup">

+ <a name="types"></a>

+ <h3 id="types">Types</h3>

+

+ <div class="apiItem">

+ <a></a>

+ <h4>type name</h4>

+ <div>

+ </div>

+ </div>

+ </div>

+ </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="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>

+<script src="http://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>

Property changes on: chrome/common/extensions/docs/apps.html

___________________________________________________________________

Added: svn:mime-type

+ text/html

Added: svn:eol-style

+ LF

« no previous file with comments | « chrome/common/extensions/docs/api_other.html ('k') | chrome/common/extensions/docs/autoupdate.html » ('j') | no next file with comments »