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

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

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

deleted file mode 100644

index cfbced90ad639bb85acbf92108958ff57473ae68..0000000000000000000000000000000000000000

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

+++ /dev/null

@@ -1,414 +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>Packaging - 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><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">Packaging</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#H2-0">Creating a package</a>

- <ol>

- </ol>

- </li><li>

- <a href="#update">Updating a package</a>

- <ol>

- </ol>

- </li><li>

- <a href="#upload"> Uploading a previously packaged extension to the Chrome Web Store</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-3">Packaging at the command line</a>

- <ol>

- </ol>

- </li><li>

- <a href="#H2-4">Package format and scripts</a>

- <ol>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Packaging</div>

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

-<p>

-This page describes how to package your extension.

-As the <a href="overview.html">Overview</a> explains,

-extensions are packaged as signed ZIP files

-with the file extension "crx"—for example,

-<code>myextension.crx</code>.

-</p>

-<p>

-<b>Note:</b>

-You might not need to package your extension.

-If you publish your extension using the

-<a href="https://chrome.google.com/webstore/developer/dashboard">Chrome Developer Dashboard</a>,

-then the only reason to create your own <code>.crx</code> file

-would be to distribute a non-public version—for example,

-to alpha testers.

-You can find information on publishing extensions and apps in the

-Chrome Web Store getting started tutorial, starting at

-<a href="http://code.google.com/chrome/webstore/docs/get_started_simple.html#step5">Step 5: Zip up your app</a>.

-</p>

-<p>

-When you package an extension,

-the extension is assigned a unique key pair.

-The extension's ID is based on a hash of the public key.

-The private key is kept private

-and used to sign each version of the extension.

-</p>

-<a name="H2-0"></a><h2>Creating a package</h2>

-<p>To package an extension:</p>

-<ol>

- <li>

- Bring up the Extensions management page

- by going to this URL:

- <blockquote>

- <b>chrome://extensions</b>

- </blockquote>

- </li>

- <li>

- If <b>Developer mode</b> has a + by it,

- click the +.

- </li>

- <li>

- Click the <b>Pack extension</b> button.

- A dialog appears.

- </li>

- <li>

- In the <b>Extension root directory</b> field,

- specify the path to the extension's folder—for example,

- <code>c:\myext</code>.

- (Ignore the other field;

- you don't specify a private key file

- the first time you package a particular extension.)

- </li>

- <li>

- Click <b>OK</b>.

- The packager creates two files:

- a <code>.crx</code> file,

- which is the actual extension that can be installed,

- and a <code>.pem</code> file,

- which contains the private key.

- </li>

-</ol>

-<p>

-<b>Do not lose the private key!</b>

-Keep the <code>.pem</code> file secret and in a safe place.

-You'll need it later if you want to do any of the following:

-</p>

-<ul>

-<li><a href="#update">Update</a> the extension</li>

-<li><a href="#upload">Upload</a> the extension to the Chrome Web Store</li>

-</ul>

-<p>

-If the extension is successfully packaged, you'll see a dialog like this

-that tells you where to find

-the <code>.crx</code> and <code>.pem</code> files:</p>

-<p></p>

-<img src="images/package-success.gif" width="554" height="208">

-<h2 id="update">Updating a package</h2>

-<p>To create an updated version of your extension:</p>

-<ol>

- <li>

- Increase the version number in <code>manifest.json</code>.

- </li>

- <li>

- Bring up the Extensions management page

- by going to this URL: <b>chrome://extensions</b>

- </li>

- <li>

- Click the <b>Pack extension</b> button.

- A dialog appears.

- </li>

- <li>

- In the <b>Extension root directory</b> field,

- specify the path to the extension's folder—for example,

- <code>c:\myext</code>.

- </li>

- <li>

- In the <b>Private key file</b> field,

- specify the location of the

- already generated <code>.pem</code> file for this extension—for

- example, <code>c:\myext.pem</code>.

- </li>

- <li>

- Click <b>OK</b>.

- </li>

-</ol>

-<p>If the updated extension is successfully packaged, you'll see a dialog like this:</p>

-<img src="images/update-success.gif" width="298" height="160">

-<h2 id="upload"> Uploading a previously packaged extension to the Chrome Web Store</h2>

-<p>

-You can use the Chrome Developer Dashboard

-to upload an extension that you've previously packaged yourself.

-However, unless you take special steps,

-the extension's ID in the Chrome Web Store

-will be different from its ID in the package you created.

-This different ID might be a problem if you've

-distributed your extension package,

-because it allows users to install multiple versions of your extension,

-each with its own local data.

-</p>

-<p>

-If you want to keep the extension ID the same,

-follow these steps:

-</p>

-<ol>

- <li> Rename the private key that was generated

- when you created the <code>.crx</code> file to <code>key.pem</code>. </li>

- <li> Put <code>key.pem</code> in the top directory

- of your extension. </li>

- <li> Compress that directory into a ZIP file. </li>

- <li> Upload the ZIP file using the

- <a href="https://chrome.google.com/webstore/developer/dashboard">Chrome Developer Dashboard</a>. </li>

-</ol>

-<a name="H2-3"></a><h2>Packaging at the command line</h2>

-<p>

-Another way to package extensions

-is by invoking <code>chrome.exe</code> at the command line.

-Use the <code>--pack-extension</code> flag

-to specify the location of the extension's folder.

-Use <code>--pack-extension-key</code>

-to specify the location of the extension's private key file.

-For example:

-</p>

-<pre>chrome.exe --pack-extension=c:\myext --pack-extension-key=c:\myext.pem

-</pre>

-<p>

-To suppress the dialog,

-add <code>--no-message-box</code> to the command.

-</p>

-<a name="H2-4"></a><h2>Package format and scripts</h2>

-<p>

-For more information on the format, as well as pointers to scripts you can use

-to create <code>.crx</code> files, see <a href="crx.html">CRX Package Format</a>.

-</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/overview.html ('k') | chrome/common/extensions/docs/pageAction.html » ('j') | no next file with comments »