| 1 <!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 mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated 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>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta is significant and loads the needed libraries and styles --><head jstcache="0
"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="
0"> <title jscontent="getPageTitle()" jstcache="1">Packaging</title> <link href=
"css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script ty
pe="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js
" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_genera
tor.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.
js" jstcache="0"></script> </head><!-- <body> content is completely generated. D
o not edit, as it will be and rewritten. --><body jstcache="0"> <div id="contain
er" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="
pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="http:/
/www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input
type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0">
<input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" n
ame="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" js
tcache="0"> </div> </form> <script type="text/javascript" src="http://www.google
.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">g
oogle.load("elements", "1", {packages: "transliteration"});</script> <script typ
e="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box
&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="h
ttp://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0
"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPageTitle
()" jstcache="1">Packaging</h1> </div> </div> <!-- /pageHeader --> <div id="page
Content" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstc
ache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li
jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li> <l
i jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstca
che="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guid
e</div></a> <ul jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstcache
="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jstcache="0
">Page Actions</a></li> <li jstcache="0"><a href="background_pages.html" jstcach
e="0">Background Pages</a></li> <li jstcache="0"><a href="content_scripts.html"
jstcache="0">Content Scripts</a></li> <li jstcache="0">Events</li> <li jstcache=
"0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="win
dows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="bookmarks.htm
l" jstcache="0">Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstcache="0"
><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0" class
="leftNavSelected">Packaging</li> <li jstcache="0">Autoupdate</li> </ul> </li> <
li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorial
s</div></a> <ul jstcache="0"> <li jstcache="0"><a href="tut_debugging.html" jstc
ache="0">Debugging</a></li> </ul> </li> <li jstcache="0">Reference <ul jstcache=
"0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcache="0"><a href="manif
est.html" jstcache="0">Manifest Files</a></li> <li jstcache="0">Match Patterns</
li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0"> <a href=
"api_index.html" jstcache="0">chrome.* APIs</a> </li> <li jstcache="0">Other API
s</li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[
sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id
="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="
showPageTOC()" jstcache="2"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li
jsselect="getStaticTOC()" jstcache="9" jsinstance="0"> <a jscontent="name" jsval
ues=".href:'#' + href" jstcache="14" href="#H2-0">Creating a package</a> <ol jst
cache="0"> <li jsselect="$this.children" jstcache="22" jsinstance="*0"> <a jscon
tent="name" jsvalues=".href:'#' + href" jstcache="14" href="#H3-1">Finding the p
ath to Chrome</a> </li> </ol> </li><li jsselect="getStaticTOC()" jstcache="9" js
instance="1"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14" href
="#H2-2">Updating a package</a> <ol jstcache="0"> <li jsselect="$this.children"
jstcache="22" jsinstance="*0" style="display: none; "> <a jscontent="name" jsval
ues=".href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li><li jsselect="g
etStaticTOC()" jstcache="9" jsinstance="*2"> <a jscontent="name" jsvalues=".href
:'#' + href" jstcache="14" href="#H2-3">Tips and Tricks</a> <ol jstcache="0"> <l
i jsselect="$this.children" jstcache="22" jsinstance="*0" style="display: none;
"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3Name</a> </li
> </ol> </li> <div jsselect="apiDefinition" jstcache="3" style="display: none; "
> <li jstcache="0"> <a href="#apiReference" jscontent="'API Reference: ' + getMo
duleName()" jstcache="23">API Reference</a> <ol jstcache="0"> <li jsdisplay="$th
is.properties" jstcache="5"> <a href="#properties" jstcache="0">Properties</a> <
ol jstcache="0"> <li jsselect="getPropertyListFromObject($this)" jstcache="10">
<a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor"
jstcache="42">propertyName</a> </li> </ol> </li> <li jsdisplay="functions &
& functions.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Met
hods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="11"> <a jscontent=
"name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="43">me
thodName</a> </li> </ol> </li> <li jsdisplay="events && events.length &g
t; 0" jstcache="7"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0">
<li jsselect="events" jstcache="12"> <a jscontent="name" jsvalues=".href:'#event
-' + name" href="#event-anchor" jstcache="44">eventName</a> </li> </ol> </li> <l
i jsdisplay="types && types.length > 0" jstcache="8"> <a href="#types
" jstcache="0">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <
a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="45">
id</a> </li> </ol> </li> </ol> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS
--> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="
pageData-title" class="pageData" jstcache="0">Packaging</div> <div id="pageData-
showTOC" class="pageData" jstcache="0">true</div> <p jstcache="0"> Extensions ar
e packaged as signed zip files with the file extension "crx" (for example, <code
jstcache="0">myextension.crx</code>). Each extension has its own unique key pai
r. The public key is used as the unique identifier for the extension. The privat
e key is kept private and used to sign each version of the extension. </p> <!--
[PENDING: Perhaps mention that once the gallery is up, creating and updating a p
ackage will be much easier. Also refer to instructions on submitting an extensio
n for inclusion in the gallery.] --> <a name="H2-0" jstcache="0"></a><h2 jstcach
e="0">Creating a package</h2> <p jstcache="0">To package an extension:</p> <ol j
stcache="0"> <li jstcache="0">Close all your Chrome windows</li> <li jstcache="0
">Execute Chrome, using the <code jstcache="0">--pack-extension</code> option to
specify the path to the extension's folder: <pre jstcache="0">chrome.exe --pack
-extension=<em jstcache="0">ext-folder-path</em></pre> </li> </ol> <p jstcache="
0">The packager creates two files: a <code jstcache="0">.crx</code> file, which
is the actual extension that can be installed, and a <code jstcache="0">.pem</co
de> file, which contains the private key. </p> <p jstcache="0"> <b jstcache="0">
Do not lose the private key!</b> Keep the <code jstcache="0">.pem</code> file se
cret and in a safe place. You'll need it later if you want to do any of the foll
owing: </p> <ul jstcache="0"> <li jstcache="0"><a href="#update" jstcache="0">Up
date</a> the extension</li> <li jstcache="0">Import the extension into the exten
sions gallery, once the gallery becomes available</li> </ul> <p jstcache="0"> If
the extension is successfully packaged, you'll see a dialog like this that tell
s you where to find the <code jstcache="0">.crx</code> and <code jstcache="0">.p
em</code> files:</p> <p jstcache="0"></p> <img src="images/create-package.png" j
stcache="0"> <a name="H3-1" jstcache="0"></a><h3 jstcache="0">Finding the path t
o Chrome</h3> <p jstcache="0"> If <code jstcache="0">chrome.exe</code> isn't alr
eady in your path, you need to specify the complete path to it. Here's how: </p>
<ul jstcache="0"> <li jstcache="0"> In Windows XP, right-click your Google Chro
me shortcut, choose <b jstcache="0">Properties > Shortcut</b>, and then choos
e <b jstcache="0">Find Target</b>. </li> <li jstcache="0"> In Vista, right-click
your Google Chrome shortcut and select <b jstcache="0">Open File Location</b>.
</li> </ul> <a name="H2-2" jstcache="0"></a><h2 id="update" jstcache="0">Updatin
g a package</h2> <p jstcache="0">To create an updated version of your extension:
</p> <ol jstcache="0"> <li jstcache="0">Increase the version number in <code jst
cache="0">manifest.json</code>.</li> <li jstcache="0">Close all your Chrome wind
ows.</li> <li jstcache="0">Execute Chrome, using the <code jstcache="0">--pack-e
xtension</code> and <code jstcache="0">--pack-extension-key</code> options. The
value of the key option should be the path to the already generated <code jstcac
he="0">.pem</code> file for this extension. <pre jstcache="0">chrome.exe --pack-
extension=<em jstcache="0">ext-folder-path</em> --pack-extension-key=<em jstcach
e="0">ext-key-path</em></pre> </li> </ol> <p jstcache="0">If the updated extensi
on is successfully packaged, you'll see a dialog like this:</p> <img src="images
/package-success.png" jstcache="0"> <a name="H2-3" jstcache="0"></a><h2 jstcache
="0">Tips and Tricks</h2> <ul jstcache="0"> <li jstcache="0">In build 3.0.195 an
d later, you can use the <code jstcache="0">--no-message-box</code> command line
flag to suppress the dialog. This is useful if you're packing extensions in non
-interactive scripts.</li> </ul> </div> <!-- API PAGE --> <div class="apiPage" j
sselect="apiDefinition" jstcache="3" style="display: none; "> <a name="apiRefere
nce" jstcache="0"></a> <h2 jscontent="getModuleName() + ' API reference'" jstcac
he="4">chrome.apiname API reference</h2> <!-- PROPERTIES --> <div jsdisplay="$th
is.properties" class="apiGroup" jstcache="5"> <a name="properties" jstcache="0">
</a> <h3 id="properties" jstcache="0">Properties</h3> <div jsselect="getProperty
ListFromObject($this)" jstcache="10"> <a jsvalues=".name:'property-' + name" jst
cache="15"></a> <h4 jscontent="name" jstcache="16">getLastError</h4> <div class=
"summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jsc
ontent="getModuleName() + '.'" jstcache="24">chrome.extension</span><span jscont
ent="$this.name" jstcache="25">lastError</span> </div> <div transclude="valueTem
plate" jstcache="17"> </div> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <
div jsdisplay="functions && functions.length > 0" class="apiGroup" id
="methods" jstcache="6"> <a name="methods" jstcache="0"></a> <h3 jstcache="0">Me
thods</h3> <!-- iterates over all functions --> <div class="apiItem" jsselect="f
unctions" jstcache="11"> <a jsvalues=".name:'method-' + name" jstcache="18"></a>
<!-- method-anchor --> <h4 jscontent="name" jstcache="16">method name</h4> <div
class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(r
eturns)" jstcache="26">void</span> <!-- Note: intentionally longer 80 columns --
> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="27">chrome.mo
dule.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'o
ptional' : ''" jstcache="28"><span jsdisplay="$index" jstcache="34">, </span><sp
an jscontent="getTypeName($this)" jstcache="35"></span> <var jstcache="0"><span
jscontent="name" jstcache="16"></span></var></span>)</div> <div class="descripti
on" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="29">Undocum
ented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache
="30"> A description from the json schema def of the function goes here. </p> <!
-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jssele
ct="parameters" jstcache="36"> <!-- VALUE: This is a subtemplate that is used el
sewhere via jsTemplate *transclude* --> <div id="valueTemplate" jstcache="0"> <d
t jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46"
>paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="display:inline" jst
cache="0"> ( <span class="optional" jsdisplay="optional" jstcache="47">optional<
/span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTypeRef($this)"
jstcache="48"> <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRe
f($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a> </span> <span js
display="!getTypeRef($this)" jstcache="49"> <span jsdisplay="isArray($this)" jst
cache="51"> array of <span jsselect="items" jstcache="53"><span transclude="type
Template" jstcache="54"></span></span> </span> <span jsdisplay="!isArray($this)"
jscontent="getTypeName($this)" jstcache="52">paramType</span> </span> </span> )
</div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="39
"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$t
his.description" jstcache="40"> Description of this parameter from the json sche
ma. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" j
stcache="41"> <dl jstcache="0"> <div jsselect="getPropertyListFromObject($this)"
jstcache="10"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </d
l> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="ret
urns" jstcache="31">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstca
che="37"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> <!-
- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcache="32"> <div js
select="getCallbackParameters(parameters)" jstcache="38"> <h4 jstcache="0">Callb
ack function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback<
/em> parameter, it should specify a function that looks like this: </p> <!-- Not
e: intentionally longer 80 columns --> <pre jstcache="0">function(<span jsconten
t="getSignatureString(parameters)" jstcache="33">Type param1, Type param2</span>
) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div
jsselect="parameters" jstcache="36"> <div transclude="valueTemplate" jstcache="
17"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!--
/apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events &a
mp;& events.length > 0" class="apiGroup" jstcache="7"> <a name="events" j
stcache="0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- iterates over all
events --> <div jsselect="events" class="apiItem" jstcache="12"> <a jsvalues=".
name:'event-' + name" jstcache="19"></a> <h4 jscontent="name" jstcache="16">even
t name</h4> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 8
0 columns --> <span jscontent="getModuleName() + '.'" class="subdued" jstcache="
24">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span><s
pan class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="g
etSignatureString(parameters)" jstcache="33">Type param1, Type param2</span>) <s
pan class="subdued" jstcache="0">{...}</span>); </div> <div class="description"
jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="29">Undocumente
d.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="30
"> A description from the json schema def of the event goes here. </p> <!-- PARA
METERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="par
ameters" jstcache="36"> <div transclude="valueTemplate" jstcache="17"> </div> </
div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /api
Group --> <!-- TYPES --> <div jsdisplay="types && types.length > 0" c
lass="apiGroup" jstcache="8"> <a name="types" jstcache="0"></a> <h3 id="types" j
stcache="0">Types</h3> <!-- iterates over all types --> <div jsselect="types" cl
ass="apiItem" jstcache="13"> <a jsvalues=".name:'type-' + id" jstcache="20"></a>
<h4 jscontent="id" jstcache="21">type name</h4> <div transclude="valueTemplate"
jstcache="17"> </div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div>
<!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div
id="pageFooter" --="" jstcache="0"> Copyright 2009. For terms of use, see the C
hromium <a href="http://src.chromium.org/viewvc/chrome/trunk/src/LICENSE" jstcac
he="0">license</a>. </div> <!-- /pageFooter --> </div> <!-- /container --> </bod
y></html> | 1 <!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 mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated 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>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta is significant and loads the needed libraries and styles --><head jstcache="0
"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="
0"> <title jscontent="getPageTitle()" jstcache="1">Packaging</title> <link href=
"css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script ty
pe="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js
" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_genera
tor.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.
js" jstcache="0"></script> </head><!-- <body> content is completely generated. D
o not edit, as it will be and rewritten. --><body jstcache="0"> <div id="contain
er" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="
pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="http:/
/www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input
type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0">
<input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" n
ame="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" js
tcache="0"> </div> </form> <script type="text/javascript" src="http://www.google
.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">g
oogle.load("elements", "1", {packages: "transliteration"});</script> <script typ
e="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box
&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="h
ttp://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0
"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPageTitle
()" jstcache="1">Packaging</h1> </div> </div> <!-- /pageHeader --> <div id="page
Content" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstc
ache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li
jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li> <l
i jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstca
che="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guid
e</div></a> <ul jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstcache
="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jstcache="0
">Page Actions</a></li> <li jstcache="0"><a href="background_pages.html" jstcach
e="0">Background Pages</a></li> <li jstcache="0"><a href="content_scripts.html"
jstcache="0">Content Scripts</a></li> <li jstcache="0">Events</li> <li jstcache=
"0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="win
dows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="bookmarks.htm
l" jstcache="0">Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstcache="0"
><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0" class
="leftNavSelected">Packaging</li> <li jstcache="0">Autoupdate</li> </ul> </li> <
li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorial
s</div></a> <ul jstcache="0"> <li jstcache="0"><a href="tut_debugging.html" jstc
ache="0">Debugging</a></li> </ul> </li> <li jstcache="0">Reference <ul jstcache=
"0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcache="0"><a href="manif
est.html" jstcache="0">Manifest Files</a></li> <li jstcache="0">Match Patterns</
li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0"> <a href=
"api_index.html" jstcache="0">chrome.* APIs</a> </li> <li jstcache="0"> <a href=
"api_other.html" jstcache="0">Other APIs</a> </li> </ul> </li> <li jstcache="0">
<a href="http://dev.chromium.org/developers/design-documents/extensions/samples"
jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache="0"> <
!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPageTOC()" jstcache="2">
<p jstcache="0">Contents</p> <ol jstcache="0"> <li jsselect="getStaticTOC()" jst
cache="9" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#' + href" jstcac
he="14" href="#H2-0">Creating a package</a> <ol jstcache="0"> <li jsselect="$thi
s.children" jstcache="22" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'
#' + href" jstcache="14" href="#H3-1">Finding the path to Chrome</a> </li> </ol>
</li><li jsselect="getStaticTOC()" jstcache="9" jsinstance="1"> <a jscontent="n
ame" jsvalues=".href:'#' + href" jstcache="14" href="#H2-2">Updating a package</
a> <ol jstcache="0"> <li jsselect="$this.children" jstcache="22" jsinstance="*0"
style="display: none; "> <a jscontent="name" jsvalues=".href:'#' + href" jstcac
he="14">h3Name</a> </li> </ol> </li><li jsselect="getStaticTOC()" jstcache="9" j
sinstance="*2"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14" hr
ef="#H2-3">Tips and tricks</a> <ol jstcache="0"> <li jsselect="$this.children" j
stcache="22" jsinstance="*0" style="display: none; "> <a jscontent="name" jsvalu
es=".href:'#' + href" jstcache="14">h3Name</a> </li> </ol> </li> <div jsselect="
apiDefinition" jstcache="3" style="display: none; "> <li jstcache="0"> <a href="
#apiReference" jscontent="'API reference: ' + getModuleName()" jstcache="4">API
reference</a> <ol jstcache="0"> <li jsdisplay="$this.properties" jstcache="5"> <
a href="#properties" jstcache="0">Properties</a> <ol jstcache="0"> <li jsselect=
"getPropertyListFromObject($this)" jstcache="10"> <a jscontent="name" jsvalues="
.href:'#property-' + name" href="#property-anchor" jstcache="41">propertyName</a
> </li> </ol> </li> <li jsdisplay="functions && functions.length > 0"
jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li
jsselect="functions" jstcache="11"> <a jscontent="name" jsvalues=".href:'#metho
d-' + name" href="#method-anchor" jstcache="42">methodName</a> </li> </ol> </li>
<li jsdisplay="events && events.length > 0" jstcache="7"> <a href="#
events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache
="12"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor
" jstcache="43">eventName</a> </li> </ol> </li> <li jsdisplay="types &&
types.length > 0" jstcache="8"> <a href="#types" jstcache="0">Types</a> <ol j
stcache="0"> <li jsselect="types" jstcache="13"> <a jscontent="id" jsvalues=".hr
ef:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </li> </ol> </li> </ol>
</li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACE
HOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageDat
a" jstcache="0">Packaging</div> <div id="pageData-showTOC" class="pageData" jstc
ache="0">true</div> <p jstcache="0"> Extensions are packaged as signed zip files
with the file extension "crx" (for example, <code jstcache="0">myextension.crx<
/code>). Each extension has its own unique key pair. The public key is used as t
he unique identifier for the extension. The private key is kept private and used
to sign each version of the extension. </p> <!-- [PENDING: Perhaps mention that
once the gallery is up, creating and updating a package will be much easier. Al
so refer to instructions on submitting an extension for inclusion in the gallery
.] --> <a name="H2-0" jstcache="0"></a><h2 jstcache="0">Creating a package</h2>
<p jstcache="0">To package an extension:</p> <ol jstcache="0"> <li jstcache="0">
Close all your Chrome windows</li> <li jstcache="0">Execute Chrome, using the <c
ode jstcache="0">--pack-extension</code> option to specify the path to the exten
sion's folder: <pre jstcache="0">chrome.exe --pack-extension=<em jstcache="0">ex
t-folder-path</em></pre> </li> </ol> <p jstcache="0">The packager creates two fi
les: a <code jstcache="0">.crx</code> file, which is the actual extension that c
an be installed, and a <code jstcache="0">.pem</code> file, which contains the p
rivate key. </p> <p jstcache="0"> <b jstcache="0">Do not lose the private key!</
b> Keep the <code jstcache="0">.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 jstcache="0">
<li jstcache="0"><a href="#update" jstcache="0">Update</a> the extension</li> <l
i jstcache="0">Import the extension into the extensions gallery, once the galler
y becomes available</li> </ul> <p jstcache="0"> If the extension is successfully
packaged, you'll see a dialog like this that tells you where to find the <code
jstcache="0">.crx</code> and <code jstcache="0">.pem</code> files:</p> <p jstcac
he="0"></p> <img src="images/create-package.png" jstcache="0"> <a name="H3-1" js
tcache="0"></a><h3 jstcache="0">Finding the path to Chrome</h3> <p jstcache="0">
If <code jstcache="0">chrome.exe</code> isn't already in your path, you need to
specify the complete path to it. Here's how: </p> <ul jstcache="0"> <li jstcach
e="0"> In Windows XP, right-click your Google Chrome shortcut, choose <b jstcach
e="0">Properties > Shortcut</b>, and then choose <b jstcache="0">Find Target<
/b>. </li> <li jstcache="0"> In Vista, right-click your Google Chrome shortcut a
nd select <b jstcache="0">Open File Location</b>. </li> </ul> <a name="H2-2" jst
cache="0"></a><h2 id="update" jstcache="0">Updating a package</h2> <p jstcache="
0">To create an updated version of your extension:</p> <ol jstcache="0"> <li jst
cache="0">Increase the version number in <code jstcache="0">manifest.json</code>
.</li> <li jstcache="0">Close all your Chrome windows.</li> <li jstcache="0">Exe
cute Chrome, using the <code jstcache="0">--pack-extension</code> and <code jstc
ache="0">--pack-extension-key</code> options. The value of the key option should
be the path to the already generated <code jstcache="0">.pem</code> file for th
is extension. <pre jstcache="0">chrome.exe --pack-extension=<em jstcache="0">ext
-folder-path</em> --pack-extension-key=<em jstcache="0">ext-key-path</em></pre>
</li> </ol> <p jstcache="0">If the updated extension is successfully packaged, y
ou'll see a dialog like this:</p> <img src="images/package-success.png" jstcache
="0"> <a name="H2-3" jstcache="0"></a><h2 jstcache="0">Tips and tricks</h2> <ul
jstcache="0"> <li jstcache="0">In build 3.0.195 and later, you can use the <code
jstcache="0">--no-message-box</code> command line flag to suppress the dialog.
This is useful if you're packing extensions in non-interactive scripts.</li> </u
l> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcac
he="3" style="display: none; "> <a name="apiReference" jstcache="0"></a> <h2 jsc
ontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.
apiname </h2> <!-- PROPERTIES --> <div jsdisplay="$this.properties" class="apiGr
oup" jstcache="5"> <a name="properties" jstcache="0"></a> <h3 id="properties" js
tcache="0">Properties</h3> <div jsselect="getPropertyListFromObject($this)" jstc
ache="10"> <a jsvalues=".name:'property-' + name" jstcache="15"></a> <h4 jsconte
nt="name" jstcache="16">getLastError</h4> <div class="summary" jstcache="0"> <!-
- Note: intentionally longer 80 columns --> <span jscontent="getModuleName() + '
.'" jstcache="23">chrome.extension</span><span jscontent="$this.name" jstcache="
24">lastError</span> </div> <div transclude="valueTemplate" jstcache="17"> </div
> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functions &a
mp;& functions.length > 0" class="apiGroup" id="methods" jstcache="6"> <a
name="methods" jstcache="0"></a> <h3 jstcache="0">Methods</h3> <!-- iterates ov
er all functions --> <div class="apiItem" jsselect="functions" jstcache="11"> <a
jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- method-anchor --> <h4
jscontent="name" jstcache="16">method name</h4> <div class="summary" jstcache="
0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">void
</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFully
QualifiedFunctionName($this)" jstcache="26">chrome.module.methodName</span>(<spa
n jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27
"><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($
this)" jstcache="34"></span> <var jstcache="0"><span jscontent="name" jstcache="
16"></span></var></span>)</div> <div class="description" jstcache="0"> <p class=
"todo" jsdisplay="!description" jstcache="28">Undocumented.</p> <p jsdisplay="de
scription" jsvalues=".innerHTML:description" jstcache="29"> A description from t
he json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstca
che="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="3
5"> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTemplate *tra
nsclude* --> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <var jsdisp
lay="$this.name" jscontent="$this.name" jstcache="45">paramName</var> <em jstcac
he="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span class="o
ptional" jsdisplay="optional" jstcache="46">optional</span> <span id="typeTempla
te" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47"> <a jsvalues
=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTyp
eRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($this)
" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50"> array of <span
jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53"></s
pan></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeName($th
is)" jstcache="51">paramType</span> </span> </span> ) </div> </em> </dt> <dd cla
ss="todo" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <dd
jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="
39"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPE
RTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40"> <dl jstcache=
"0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div transc
lude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /VALUE
--> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30">Returns
</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36"> <div transclude="
valueTemplate" jstcache="17"> </div> </div> </dl> <!-- CALLBACK --> <div js
display="hasCallback(parameters)" jstcache="31"> <div jsselect="getCallbackParam
eters(parameters)" jstcache="37"> <h4 jstcache="0">Callback function</h4> <p jst
cache="0"> If you specify the <em jstcache="0">callback</em> parameter, it shoul
d specify a function that looks like this: </p> <!-- Note: intentionally longer
80 columns --> <pre jstcache="0">function(<span jscontent="getSignatureString(pa
rameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued"
jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="parameters" j
stcache="35"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl>
</div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!--
/apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length &
gt; 0" class="apiGroup" jstcache="7"> <a name="events" jstcache="0"></a> <h3 id=
"events" jstcache="0">Events</h3> <!-- iterates over all events --> <div jsselec
t="events" class="apiItem" jstcache="12"> <a jsvalues=".name:'event-' + name" js
tcache="19"></a> <h4 jscontent="name" jstcache="16">event name</h4> <div class="
summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jsco
ntent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.bookmarks</sp
an><span jscontent="name" jstcache="16">onEvent</span><span class="subdued" jstc
ache="0">.addListener</span>(function(<span jscontent="getSignatureString(parame
ters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstc
ache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="
todo" jsdisplay="!description" jstcache="28">Undocumented.</p> <p jsdisplay="des
cription" jsvalues=".innerHTML:description" jstcache="29"> A description from th
e json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache=
"0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="35">
<div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div> <!-- /
decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES -->
<div jsdisplay="types && types.length > 0" class="apiGroup" jstcache
="8"> <a name="types" jstcache="0"></a> <h3 id="types" jstcache="0">Types</h3> <
!-- iterates over all types --> <div jsselect="types" class="apiItem" jstcache="
13"> <a jsvalues=".name:'type-' + id" jstcache="20"></a> <h4 jscontent="id" jstc
ache="21">type name</h4> <div transclude="valueTemplate" jstcache="17"> </div> <
/div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div
> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" j
stcache="0"> Copyright 2009. For terms of use, see the Chromium <a href="http://
src.chromium.org/viewvc/chrome/trunk/src/LICENSE" jstcache="0">license</a>. </di
v> <!-- /pageFooter --> </div> <!-- /container --> </body></html> |
Chromium Code Reviews
Issue 180016:
Extension API Renaming/Consistency changes (Closed)
