chrome/common/extensions/docs/external_extensions.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/external_extensions.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 side-by-side diff with in-line comments

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

diff --git a/chrome/common/extensions/docs/external_extensions.html b/chrome/common/extensions/docs/external_extensions.html

deleted file mode 100644

index 632549fd2b92af1d17348c4c08d6d9512f025b64..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/external_extensions.html

+++ /dev/null

@@ -1,536 +0,0 @@

-<!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="../../../../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>Other Deployment Options - 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">

-

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

-

- <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="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>

- <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="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 class="leftNavSelected">Other Deployment Options</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">Other Deployment Options</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#prereqs">Before you begin</a>

- <ol>

- </ol>

- </li><li>

- <a href="#preferences">Using a preferences file</a>

- <ol>

- <li>

- <a href="#troubleshooting">Troubleshooting Mac OS permissions problems</a>

- </li>

- </ol>

- </li><li>

- <a href="#registry">Using the Windows registry</a>

- <ol>

- </ol>

- </li><li>

- <a href="#updating">Updating and uninstalling</a>

- <ol>

- </ol>

- </li><li>

- <a href="#faq">FAQ</a>

- <ol>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Other Deployment Options</div>

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

-<p>

-Usually, users install their own extensions.

-But sometimes you might want an extension

-to be installed automatically.

-Here are two typical cases:

-</p>

-<ul>

- <li>

- An extension is associated with some other software,

- and the extension should be installed

- whenever the user installs that other software.

- The extension could also be uninstalled

- when the user removes that other software.

- </li>

- <li>

- A network admin wants to install the same extensions

- throughout the company.

- </li>

-</ul>

-<p>

-An extension that's installed automatically is known as an

-<em>external extension</em>.

-Google Chrome supports two ways of

-installing external extensions:

-</p>

-<ul>

- <li> Using a preferences JSON file </li>

- <li> Using the Windows registry (Windows only) </li>

-</ul>

-<p>

-Both ways support installing an extension from a <code>.crx</code> extension

-file on the user's computer. The preferences JSON file also supports installing

-an extension hosted at an

-<a href="autoupdate.html#H2-1">update URL</a>.

-See <a href="hosting.html">hosting</a> for details on hosting an extension.

-</p>

-<h2 id="prereqs">Before you begin</h2>

-<p>

-First, package a

-<a href="packaging.html"><code>.crx</code> file</a>

-and make sure that it installs successfully.

-</p>

-<p>

-If you wish to install from an

- <a href="autoupdate.html#H2-1">update URL</a>, ensure that the extension

-is properly <a href="hosting.html">hosted</a>.

-</p>

-<p>

-Then, before you edit the preferences file or the registry,

-make a note of the following:

-</p>

-<ul>

- <li> The intended <b>location</b> of the extension's <code>.crx</code> file,

- or the update URL from which it is served </li>

- <li> The extension's <b>version</b>

- (from the manifest file or the <b>chrome://extensions</b> page) </li>

- <li> The extension's <b>ID</b>

- (from the <b>chrome://extensions</b> page

- when you've loaded the packed extension) </li>

-</ul>

-<p>

-The following examples assume the version is <code>1.0</code>

-and the ID is <code>aaaaaaaaaabbbbbbbbbbcccccccccc</code>.

-</p>

-<h2 id="preferences">Using a preferences file</h2>

-<p class="note">

-<b>Windows note:</b>

-Until <a href="http://crbug.com/41902">bug 41902</a> is fixed,

-you might want to use the <a href="#registry">Windows registry</a>

-instead of the preferences file.

-</p>

-<p class="note">

-<b>Note:</b>

-Previous versions of Google Chrome used an

-<code>external_extensions.json</code> file to specify which extensions to

-install. This file has been deprecated in favor of individual <code>.json</code>

-files, one per extension.

-</p>

-<ol>

-<li>If you are installing from a file, make the <code>.crx</code> extension

-file available to the machine you want to install the extension on.

-(Copy it to a local directory or to a network share for example,

-<code>\\server\share\extension.crx</code>

-or <code>/home/share/extension.crx</code>.)

-</li>

-<li>Create a file with the following name in one of the folders listed below:

- <code>aaaaaaaaaabbbbbbbbbbcccccccccc.json</code> where the file name (without the extension)

- corresponds to your extension's ID.

- The location depends on the operating system.

- <dl>

- <dt> Windows: </dt>

- <dd> <code><em>chrome_root</em>\Application\<em>chrome_version</em>\Extensions\</code>

- <br>

- Example: <code>c:\Users\Me\AppData\Local\Google\Chrome\Application\6.0.422.0\Extensions\</code>

- </dd>

- <dt> Mac OS X:</dt>

- <dd>For a specific user: <code>~USERNAME/Library/Application Support/Google/Chrome/External Extensions/</code><br>

- For all users: <code>/Library/Application Support/Google/Chrome/External Extensions/</code>

- <p>The external extension file for all users is read only if every directory in the path is owned by the user <code>root</code>, has the group <code>admin</code> or <code>wheel</code>, and is not world writable. The path must also be free of symbolic links. These restrictions prevent an unprivileged user from causing extensions to be installed for all users. See <a href="#troubleshooting">troubleshooting</a> for details.</p>

- <p class="note">

- <b>Note:</b> The above path for all users was added in Chrome 16. Prior versions used a different path:<br>

- <code>/Applications/Google Chrome.app/Contents/Extensions/</code>

- This path was deprecated in version 17. Support was removed in version 20. Use one of the paths above instead.</p>

- </dd>

- <dt> Linux: </dt>

- <dd> <code>/opt/google/chrome/extensions/</code> <br>

- </dd>

- <dd> <code>/usr/share/google-chrome/extensions/</code> <br>

- <b>Note:</b> Use <code>chmod</code> if necessary

- to make sure that the <code>aaaaaaaaaabbbbbbbbbbcccccccccc.json</code> files

- are world-readable.

- </dd>

- </dl>

-</li>

-<li>If you are installing from a file, specify the extension's location and version with fields

-named "external_crx" and "external_version" in the file created above.

-<p>

-Example:

-</p><pre> {

- "external_crx": "/home/share/extension.crx",

- "external_version": "1.0"

- }

-</pre>

-<p></p>

-<p class="note">

-<b>Note:</b>

-You need to escape

-each <code>\</code> character in the location.

-For example,

-<code>\\server\share\extension.crx</code> would be

-<code>"\\\\server\\share\\extension.crx"</code>.

-</p>

-<p>

-</p><p>

-If you are installing from an update URL, specify the extension's update URL

-with field name "external_update_url".

-</p>

-Example:

-<pre>{

- "external_update_url": "http://myhost.com/mytestextension/updates.xml"

-}</pre>

-<p>

-If you would like to install extension only for some browser locales,

-you can list supported locales in field name "supported_locale". Locale may

-specify parent locale like "en", in this case the extension will be

-installed for all English locales like "en-US", "en-GB", etc.

-If another browser locale is selected that is not supported by the extension,

-the external extensions will be uninstalled. If "supported_locales" list

-is missing, the extension will be installed for any locale.

-</p>

-Example:

-<pre>{

- "external_update_url": "http://myhost.com/mytestextension/updates.xml",

- "supported_locales": [ "en", "fr", "de" ]

-}</pre>

-</li>

-<li>Save the JSON file. </li>

-<li>Launch Google Chrome and go to <b>chrome://extensions</b>;

-you should see the extension listed. </li>

-</ol>

-<h3 id="troubleshooting">Troubleshooting Mac OS permissions problems</h3>

-<p>On Mac OS, the external extensions files for all users are only read if file system permissions prevent unprivileged users from changing it. If you do not see external extensions installed when Chrome is launched, there may be a permissions problem with the external extensions preferences files. To see if this is the problem, follow these steps:</p>

-<ol>

- <li> Launch the Console program. You can find it under /Applications/Utilities/Console. </li>

- <li> If the leftmost icon in the Console says "Show Log List", click that icon. A second column appears at the left. </li>

- <li> Click "Console Messages" in the left pane. </li>

- <li> Search for the string <b>Can not read external extensions</b>. If there is a problem reading the external extensions files, you will see an error message. Look for another error message directly above it, which should explain the issue. For example, if you see the following error:

- "Path /Library/Application Support/Google/Chrome is owned by the wrong group", you need to use <code>chgrp</code> or the Finder's Get Info dialog to change the directory's group owner to the Administrator group.</li>

- <li> After fixing the issue, relaunch Chrome. Test that the external extension is now installed. It is possible that one permissions error keeps Chrome from detecting a second error. If the external extension was not installed, repeat these steps until you do not see an error in the Console application.

-</li></ol>

-<h2 id="registry">Using the Windows registry</h2>

-<ol>

-<li>Make the <code>.crx</code> extension file available

-to the machine you want to install the extension on.

-(Copy it to a local directory or to a network share —

-for example, <code>\\server\share\extension.crx</code>.)

-</li>

-<li>Find or create the following key in the

-registry:

-<ul>

- <li> 32-bit Windows: <code>HKEY_LOCAL_MACHINE\Software\Google\Chrome\Extensions</code> </li>

- <li> 64-bit Windows: <code>HKEY_LOCAL_MACHINE\Software\Wow6432Node\Google\Chrome\Extensions</code> </li>

-</ul>

-</li>

-<li>Create a new key (folder)

-under the <b>Extensions</b> key with the

-same name as the ID of your extension

-(for example, <code>aaaaaaaaaabbbbbbbbbbcccccccccc</code>).

-</li>

-<li>Create two string values (<code>REG_SZ</code>) named "path" and "version",

- and set them to the extension's location and version.

- For example:

-<ul>

- <li>path: <code>\\server\share\extension.crx</code> </li>

- <li>version: <code>1.0</code> </li>

-</ul>

-</li>

-<li>Launch the browser and go to

-<b>chrome://extensions</b>; you should

-see the extension listed. </li>

-</ol>

-<h2 id="updating">Updating and uninstalling</h2>

-<p>Google Chrome scans the metadata entries

-in the preferences and registry

-each time the browser starts, and makes

-any necessary changes to the installed

-external extensions. </p>

-<p>To update your extension to a new version,

-update the file, and then update the version

-in the preferences or registry. </p>

-<p>To uninstall your extension

-(for example, if your software is uninstalled),

-remove your preference file (aaaaaaaaaabbbbbbbbbbcccccccccc.json)

-or the metadata from the registry. </p>

-<h2 id="faq">FAQ</h2>

-<p>

-This section answers common questions about external extensions.

-</p>

-<br>

-<p><b>Can I specify a URL as a path to the external extension?</b> </p>

-<p>Yes, if you use a <a href="#preferences">preferences JSON</a> file. The

-extension must be hosted as explained in <a href="hosting.html">hosting</a>.

-Use the "external_update_url" property to point to an

-<a href="autoupdate.html#H2-2">update manifest</a> that has the URL for your

-extension.</p>

-<br>

-<p><b>What are some common mistakes when installing with the preferences

-file?</b></p>

-<ul>

- <li>

- Not specifying the same id/version

- as the one listed in the <code>.crx</code> </li>

- <li>

- The .json file (<code>aaaaaaaaaabbbbbbbbbbcccccccccc.json</code>) is in

- the wrong location or the ID specified does not match the extension ID.

- </li><li>

- Syntax error in JSON file

- (forgetting to separate entries with comma or

- leaving a trailing comma somewhere) </li>

- <li>

- JSON file entry points to the wrong path

- to the <code>.crx</code> (or path specified but no filename) </li>

- <li>

- Backslashes in UNC path not escaped

- (for example, <code>"\\server\share\file"</code> is wrong;

- it should be <code>"\\\\server\\share\\extension"</code>) </li>

- <li>

- Permissions problems on a network share </li>

-</ul>

-<br>

-<p><b>What are some common mistakes when installing with the registry?</b> </p>

-<ul>

- <li>Not specifying the same id/version

- as the one listed in the <code>.crx</code> </li>

- <li>Key created in the wrong location in the registry </li>

- <li>Registry entry points to the wrong path to the <code>.crx</code> file

- (or path specified but no filename) </li>

- <li>Permissions problems on a network share </li>

-</ul>

-<br>

-<p><b>What if the user uninstalls the extension?</b> </p>

-<p>If the user uninstalls the extension through the UI, it will no

-longer be installed or updated on each startup. In other words, the

-external extension is blacklisted. </p>

-<br>

-<p><b>How do I get off the blacklist?</b> </p>

-<p>If the user uninstalls your extension, you should respect that

-decision. However, if you (the developer) accidentally uninstalled

-your extension through the UI,

-you can remove the blacklist tag

-by installing the extension normally

-through the UI, and then uninstalling it. </p>

-</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="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>

-

- </div>

- </div>

- </div>

-</body></html>

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