| Index: chrome/common/extensions/docs/autoupdate.html
|
| diff --git a/chrome/common/extensions/docs/autoupdate.html b/chrome/common/extensions/docs/autoupdate.html
|
| index 2279c2daee836cc5d6019f79977c758359993da5..2aaf387962a7cd601e2036542c8d8c5f6fb4d531 100644
|
| --- a/chrome/common/extensions/docs/autoupdate.html
|
| +++ b/chrome/common/extensions/docs/autoupdate.html
|
| @@ -1,4 +1,5 @@
|
| -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
|
| +<!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.
|
| @@ -7,371 +8,22 @@
|
| 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">
|
| +-->
|
| +<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 type="text/javascript"
|
| + src="../../../third_party/jstemplate/jstemplate_compiled.js">
|
| </script>
|
| - <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">
|
| + <script type="text/javascript"
|
| + src="../../../../third_party/json_minify/minify-sans-regexp.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>Autoupdating - Google Chrome Extensions - Google Code</title></head>
|
| - <body> <div id="devModeWarning" class="displayModeWarning">
|
| - 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>
|
| - <div id="branchWarning" class="displayModeWarning">
|
| - <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
|
| - It may not work with the stable release of Chrome.</span>
|
| - <select id="branchChooser">
|
| - <option>Choose a different version...
|
| - </option><option value="">Stable
|
| - </option><option value="beta">Beta
|
| - </option><option value="dev">Dev
|
| - </option><option value="trunk">Trunk
|
| - </option></select>
|
| - </div>
|
| - <div id="unofficialWarning" class="displayModeWarning">
|
| - <span>WARNING: This is unofficial documentation. It may not work with the
|
| - current release of Chrome.</span>
|
| - <button id="goToOfficialDocs">Go to the official docs</button>
|
| - </div>
|
| - <div id="gc-container" class="labs">
|
| - <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
|
| - <!-- 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" -->
|
| - <!-- /SUBTEMPLATES -->
|
| - <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>
|
| - <!-- API HEADER -->
|
| - <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="https://www.google.com/jsapi"></script>
|
| - <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
|
| - <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>
|
| - <script type="text/javascript" src="https://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>
|
| - <li id="so_link">
|
| - <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
|
| - </li>
|
| - </ul>
|
| - </div> <!-- end gc-topnav -->
|
| - <div class="g-section g-tpl-170">
|
| - <!-- SIDENAV -->
|
| - <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="devtools.html">Developer Tools</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="i18n.html">Internationalization</a></li>
|
| - <li><a href="messaging.html">Message Passing</a></li>
|
| - <li><a href="permissions.html">Optional Permissions</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">Autoupdating</h1>
|
| - </div>
|
| - <!-- TABLE OF CONTENTS -->
|
| - <div id="toc">
|
| - <h2>Contents</h2>
|
| - <ol>
|
| - <li>
|
| - <a href="#H2-0">Overview</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#H2-1">Update URL</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#H2-2">Update manifest</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#H2-3">Testing</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#H2-4">Advanced usage: request parameters</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#H2-5">Advanced usage: minimum browser version</a>
|
| - <ol>
|
| - </ol>
|
| - </li>
|
| - </ol>
|
| - </div>
|
| - <!-- /TABLE OF CONTENTS -->
|
| - <!-- Standard content lead-in for experimental API pages -->
|
| - <!-- STATIC CONTENT PLACEHOLDER -->
|
| - <div id="static"><div id="pageData-name" class="pageData">Autoupdating</div>
|
| -<div id="pageData-showTOC" class="pageData">true</div>
|
| -<p>We want extensions to be autoupdated for some of the same reasons as Google Chrome itself: to incorporate bug and security fixes, add new features or performance enhancements, and improve user interfaces.</p>
|
| -<p>If you publish your extension using the <a href="https://chrome.google.com/webstore/developer/dashboard">Chrome Developer Dashboard</a>, you can <em>ignore this page</em>. You can use the dashboard to release updated versions of your extension to users, as well as to the Chrome Web Store.</p>
|
| -<p>If you want to host your extension somewhere other than the store, keep reading.
|
| -You should also read <a href="hosting.html">Hosting</a> and
|
| -<a href="packaging.html">Packaging</a>.</p>
|
| -<a name="H2-0"></a><h2>Overview</h2>
|
| -<ul><li>An extension manifest may contain an "update_url" field, pointing to a location for doing update checks.</li>
|
| -<li>The content returned by an update check is an <em>update manifest</em> XML document listing the latest version of an extension.</li></ul>
|
| -<p>Every few hours, the browser checks whether any installed extensions have an update URL. For each one, it makes a request to that URL looking for an update manifest XML file. If the update manifest mentions a version of an extension that is more recent than what's installed, the browser downloads and installs the new version. As with manual updates, the new <code>.crx</code> file must be signed with the same private key as the currently installed version.</p>
|
| -<a name="H2-1"></a><h2>Update URL</h2>
|
| -<p>If you're hosting your own extension, you need to add the "update_url" field to your <a href="manifest.html"><code>manifest.json</code></a> file,
|
| -like this:</p>
|
| -<pre>{
|
| - "name": "My extension",
|
| - ...
|
| - <b>"update_url": "http://myhost.com/mytestextension/updates.xml"</b>,
|
| - ...
|
| -}
|
| -</pre>
|
| -<a name="H2-2"></a><h2>Update manifest</h2>
|
| -<p>The update manifest returned by the server should be an XML document that looks like this (highlights indicate parts you should modify):</p>
|
| -<pre><?xml version='1.0' encoding='UTF-8'?>
|
| -<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
|
| - <app appid='<b>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</b>'>
|
| - <updatecheck codebase='<b>http://myhost.com/mytestextension/mte_v2.crx</b>' version='<b>2.0</b>' />
|
| - </app>
|
| -</gupdate>
|
| -</pre>
|
| -<p>This XML format is borrowed from that used by Omaha, Google's update infrastructure. See <a href="http://code.google.com/p/omaha/">http://code.google.com/p/omaha/</a> for more details.
|
| -The extensions system uses the following attributes
|
| -for the <strong><app></strong>
|
| -and <strong><updatecheck></strong> elements of the update manifest:
|
| -</p>
|
| -<p><b>appid</b><br>
|
| -The extension ID, generated based on a hash of the extension's public key,
|
| -as described in <a href="packaging.html">Packaging</a>. You can find the
|
| -ID of an extension or packaged app by going to the Extensions page (<b>chrome://extensions</b>).
|
| -Hosted apps, however, are not listed on the Extensions page. You can find the ID of any
|
| -app using the following steps:
|
| -</p>
|
| -<ul>
|
| - <li> Open the app. You can do this by clicking its icon on the New Tab page.</li>
|
| - <li> Open the JavaScript console. You can do this by clicking the wrench icon
|
| - and choosing <b>Tools > JavaScript Console</b>.</li>
|
| - <li> Enter the following expression into the JavaScript console: <code>chrome.app.getDetails().id</code>
|
| - <p>The console shows the app's ID as a quoted string.</p>
|
| - </li>
|
| -</ul>
|
| -<p><b>codebase</b><br>
|
| -A URL to the extension's <code>.crx</code> file.</p>
|
| -<p><b>version</b><br>
|
| -Used by the client to determine whether it should download the <code>.crx</code> file specified by <code>codebase</code>. It should match the value of "version" in the <code>.crx</code> file's <code>manifest.json</code> file.</p>
|
| -<p>The update manifest XML file may contain information about multiple extensions by including multiple <app> elements.</p>
|
| -<a name="H2-3"></a><h2>Testing</h2>
|
| -<p>The default update check frequency is several hours,
|
| -but you can force an update using the Extensions page's
|
| -<b>Update extensions now</b> button.
|
| -</p>
|
| -<p>
|
| -Another option is to use the --extensions-update-frequency command-line flag to set a more frequent interval in seconds. For example, to make checks run every 45 seconds, run Google Chrome like this:</p>
|
| -<pre>chrome.exe <b>--extensions-update-frequency=45</b></pre>
|
| -<p>Note that this affects checks for all installed extensions, so consider the bandwidth and server load implications of this. You may want to temporarily uninstall all but the one extension you are testing with, and should not run with this option turned on during normal browser usage.</p>
|
| -<a name="H2-4"></a><h2>Advanced usage: request parameters</h2>
|
| -<p>The basic autoupdate mechanism is designed to make the server-side work as easy as just dropping a static XML file onto any plain web server such as Apache, and updating that XML file as you release new versions of your extensions.</p>
|
| -<p>More advanced developers may wish to take advantage of the fact that we add on parameters to the request for the update manifest to indicate the extension ID and version. Then they can use the same update URL for all of their extensions, pointing to a URL running dynamic server-side code instead of a static XML file.</p>
|
| -<p>The format of the request parameters is:</p>
|
| -<p><code> ?x=<em><extension_data></em></code></p>
|
| -<p>Where <code><em><extension_data></em></code> is a URL-encoded string of the format:</p>
|
| -<p><code> <em>id=<id></em>&v=<em><version></em></code></p>
|
| -<p>For example, say you have two extensions,
|
| -both of which point to the same update URL
|
| -(<code>http://test.com/extension_updates.php</code>):
|
| -</p>
|
| -<ul>
|
| -<li> Extension 1
|
| - <ul>
|
| - <li> ID: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" </li>
|
| - <li> Version: "1.1"</li>
|
| - </ul>
|
| -</li><li> Extension 2
|
| - <ul>
|
| - <li> ID: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" </li>
|
| - <li> Version: "0.4"</li>
|
| - </ul>
|
| -</li></ul>
|
| -<p>The request to update each individual extension would be:</p>
|
| -<ul>
|
| - <li> <code>http://test.com/extension_updates.php?x=id%3Daaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa%26v%3D1.1</code> </li>
|
| - <li> <code>http://test.com/extension_updates.php?x=id%3Dbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb%26v%3D0.4</code> </li>
|
| -</ul>
|
| -<p>
|
| -Multiple extensions can be listed in a single request for each unique update URL.
|
| -For the above example, if a user has both of the extensions installed,
|
| -then the two requests are merged into a single request:</p>
|
| -<p><code>http://test.com/extension_updates.php?x=id%3Daaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa%26v%3D1.1&x=id%3Dbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb%26v%3D0.4</code></p>
|
| -<p>If the number of installed extensions using the same update URL is large enough that a GET request URL is too long (over 2000 characters or so), the update check issues additional GET requests as necessary.</p>
|
| -<p class="note">
|
| -<b>Note:</b>
|
| -In the future, instead of issuing multiple GET requests,
|
| -a single POST request might be issued
|
| -with the request parameters in the POST body.
|
| -</p>
|
| -<a name="H2-5"></a><h2>Advanced usage: minimum browser version</h2>
|
| -<p>As we add more APIs to the extensions system, it's possible you will want to release an updated version of an extension that will work only with newer versions of the browser. While Google Chrome itself is autoupdated, it can take a few days before the majority of the user base has updated to any given new release. To ensure that a given extension update will apply only to Google Chrome versions at or higher than a specific version, you add the "prodversionmin" attribute to the <app> element in your update manifest. For example:</p>
|
| -<pre><?xml version='1.0' encoding='UTF-8'?>
|
| -<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
|
| - <app appid='aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'>
|
| - <updatecheck codebase='http://myhost.com/mytestextension/mte_v2.crx' version='2.0' <b>prodversionmin='3.0.193.0'</b>/>
|
| - </app>
|
| -</gupdate>
|
| -</pre>
|
| -<p>This would ensure that users of this extension would autoupdate to version 2 only if they are running Google Chrome 3.0.193.0 or greater.</p>
|
| -</div>
|
| - <!-- API PAGE -->
|
| - <!-- /apiPage -->
|
| - </div> <!-- /gc-pagecontent -->
|
| - </div> <!-- /g-section -->
|
| - </div> <!-- /codesiteContent -->
|
| - <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>
|
| - ©2011 Google
|
| - </p>
|
| -<!-- begin analytics -->
|
| -<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
|
| -<script src="https://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>
|
| -<!-- end analytics -->
|
| - </div>
|
| - </div> <!-- /gc-footer -->
|
| - </div> <!-- /gc-container -->
|
| -</body></html>
|
| + </head>
|
| + <body>
|
| + </body>
|
| +</html>
|
|
|
Chromium Code Reviews
Issue 10162023:
An extension docs experiment. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src