<!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">
<script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
</script>
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<title>Tutorial: Debugging</title></head><body> <div id="container">
<!-- 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" -->
<div style="display:none">
<!-- VALUE -->
<div id="valueTemplate">
<dt>
<var>paramName</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<a> Type</a>
</span>
<span>
<span>
array of <span><span></span></span>
</span>
<span>paramType</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
</div>
</div>
</dl>
</dd>
</div> <!-- /VALUE -->
</div> <!-- /SUBTEMPLATES -->
<a name="top"> </a>
<!-- API HEADER -->
<div id="pageHeader">
<div id="searchbox">
<form action="http://www.google.com/cse" id="cse-search-box">
<div>
<input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" size="31">
<input type="submit" name="sa" value="Search">
</div>
</form>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
<script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script>
<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script>
</div>
<div id="pageTitle">
<h1>Tutorial: Debugging</h1>
</div>
</div> <!-- /pageHeader -->
<div id="pageContent">
<!-- SIDENAV -->
<div id="leftNav">
<ul>
<li> <a href="index.html">Home</a></li>
<li> <a href="getstarted.html">Getting Started</a></li>
<li> <a href="overview.html">Overview</a></li>
<li> <a href="devguide.html"><div>Developer's Guide</div></a>
<ul>
<li><a href="toolstrip.html">Toolstrips</a></li>
<li><a href="browserAction.html">Browser Actions</a></li>
<li><a href="pageAction.html">Page Actions</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="events.html">Events</a></li>
<li><a href="tabs.html">Tabs</a></li>
<li><a href="windows.html">Windows</a></li>
<li><a href="bookmarks.html">Bookmarks</a></li>
<li><a href="themes.html">Themes</a></li>
<li><a href="npapi.html">NPAPI Plugins</a></li>
<li><a href="xhr.html">Cross-Origin XHR</a></li>
<li><a href="packaging.html">Packaging</a></li>
<li><a href="autoupdate.html">Autoupdate</a></li>
</ul>
</li>
<li><a href="tutorials.html"><div>Tutorials</div></a>
<ul>
<li class="leftNavSelected">Debugging</li>
</ul>
</li>
<li>Reference
<ul>
<li> Formats
<ul>
<li><a href="manifest.html">Manifest Files</a></li>
<li><a href="match_patterns.html">Match Patterns</a></li>
<!-- <li>Packages (.crx)</li> -->
</ul>
</li>
<li> <a href="api_index.html">chrome.* APIs</a> </li>
<li> <a href="api_other.html">Other APIs</a> </li>
</ul>
</li>
<li><a href="http://dev.chromium.org/developers/design-documents/extensions/samples">Samples</a></li>
</ul>
</div>
<div id="mainColumn">
<!-- TABLE OF CONTENTS -->
<div id="toc">
<p>Contents</p>
<ol>
<li jsinstance="0">
<a href="#files"> Get the source code </a>
<ol>
<li jsinstance="*0" style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li jsinstance="1">
<a href="#load"> Load and inspect the extension </a>
<ol>
<li jsinstance="*0" style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li jsinstance="2">
<a href="#debug"> Debug the extension </a>
<ol>
<li jsinstance="*0" style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li jsinstance="*3">
<a href="#summary">Now what?</a>
<ol>
<li jsinstance="*0" style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li>
<div style="display: none; ">
<li>
<a href="#apiReference">API reference</a>
<ol>
<li>
<a href="#properties">Properties</a>
<ol>
<li>
<a href="#property-anchor">propertyName</a>
</li>
</ol>
</li>
<li>
<a href="#methods">Methods</a>
<ol>
<li>
<a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
<li>
<a href="#events">Events</a>
<ol>
<li>
<a href="#event-anchor">eventName</a>
</li>
</ol>
</li>
<li>
<a href="#types">Types</a>
<ol>
<li>
<a href="#id-anchor">id</a>
</li>
</ol>
</li>
</ol>
</li>
</div>
</ol>
</div>
<!-- /TABLE OF CONTENTS -->
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"><div id="pageData-title" class="pageData">Tutorial: Debugging</div>
<div id="pageData-showTOC" class="pageData">true</div>
<p>
This tutorial shows you how to use
Google Chrome's built-in developer tools
to view your extension's code,
display debugging output,
and interactively debug your extension.
</p>
<p class="comment">
[PENDING: Rewrite this when we update the example.]
</p>
<h2 id="files"> Get the source code </h2>
<p>
To follow this tutorial,
you use a modified version of
the Hello World extension that was featured in
<a href="getstarted.html">Getting Started</a>.
</p>
<ol>
<li>
<p>
Find your copy of the Hello World extension's files.
If you don't have a handy copy,
extract them from this
<a href="samples/tut_debugging.zip">ZIP file</a>.
</p>
</li>
<li>
<p> Edit <code>my_toolstrip.html</code> so that it has the following code: </p>
<pre><b><script>
function helloWorld() {
var hwFile = 'hello_world.html';
console.log("in helloWorld()");
window.open(hwFile);
}
</script></b>
<div class="toolstrip-button" onclick="<b>helloWorld();</b>">
<span>Hello, World!</span>
</div></pre>
<p> The revised code has the same effect
but now has some debugging output,
thanks to the call to <code>console.log()</code>.</p>
</li>
</ol>
<h2 id="load"> Load and inspect the extension </h2>
<ol>
<li>
<em>Optional:</em>
Close all your Google Chrome windows, except for one.
<br>
The fewer windows you have open,
the easier it'll be to debug the extension.
<span class="comment">
[PENDING: OK to say?
Is there a better way
to match extensions to windows?]
</span>
</li>
<li>
Go to <b>chrome://extensions</b>.
If the extension is already running, click <b>Reload</b>.
Otherwise, load the extension by clicking
<b>Load unpacked extension</b>
and choosing the folder that contains
the modified extension files.
</li>
<li>
In <b>chrome://extensions</b>,
click the <b>Inspect</b> link
next to <b>my_toolstrip.html</b>.
<span class="comment">[PENDING: show this?]</span>
<br>
A Developer Tools window like this should appear:
<p>
<img src="images/devtools-1.gif" alt=""> </p>
<p>
<b>Note:</b>
If you have multiple browser windows open,
you'll see multiple copies of <b>my_toolstrip.html</b>
in <b>chrome://extensions</b>.
Each copy corresponds to a window —
or, more precisely, to an instance of the toolstrip.
</p>
</li>
<li>
If the <strong>Scripts</strong> button isn't already selected,
click it.
</li>
<li>
If <strong>my_toolstrip.html</strong> isn't already selected,
choose it from the list of scripts.
The result should be something like this:
<p>
<img src="images/devtools-2.gif" alt=""> </p>
</li>
</ol>
<h2 id="debug"> Debug the extension </h2>
<ol>
<li>
Set a debugging breakpoint at the <code>window.open()</code> statement
by clicking <strong>5</strong> in the left column:
<p>
<img src="images/devtools-3.gif" alt=""> </p>
</li>
<li>
Click the Console button
(second from left, at the bottom of the Developer Tools window)
so that you can see both the code and the console.
<p>
<img src="images/devtools-4.gif" alt=""></p>
</li>
<li>
Back in the main browser window,
click the <strong>Hello, World!</strong> button,
so that the extension begins executing.
You should see the output of <code>console.log()</code>
along with the line number,
and execution should stop just before
the call to <code>window.open()</code>.
<p>
<img src="images/devtools-5.gif" alt="">
</p>
<p>
The Call Stack area at the right of the tools window shows that
the <code>helloWorld()</code> method was called by an anonymous function
that was called by <code>onclick</code>.
Anywhere in the Call Stack or console that you see a file and line number
(for example, "my_toolstrip.html:4"),
you can click that text to see the relevant line of code. </p>
</li>
<li>
In the upper right part of the tools window,
scroll down (if necessary) until you can see the local scope variables.
This section shows the current values of all variables in the current scope.
For example, you can see that <code>hwFile</code> is a local variable
that has the value "hello_world.html".
<p>
<img src="images/devtools-6.gif" alt=""> </p>
</li>
<li>
Click the buttons at the upper right of the window
to resume execution or to step through the code.
Once the call to <code>window.open()</code> returns,
the main browser window should open a new tab
that displays the contents of <code>hello_world.html</code>.</li>
</ol>
<div class="comment">
[PENDING: more stuff we might want to cover:]
<ul>
<li>
You can't currently use the debugger with content scripts;
you need to use console.*.
</li>
<li>
location.reload()
</li>
</ul>
</div>
<h2 id="summary">Now what?</h2>
<p>
Now that you've been introduced to debugging,
here are suggestions for what to do next:
</p>
<ul>
<li>
Explore the developer tools to find more features
<span class="comment">
[PENDING: should point to dev tools doc]
</span>
</li>
<li>
Try installing and debugging other extensions,
such as the
<a href="http://dev.chromium.org/developers/design-documents/extensions/samples">samples</a>
</li>
</ul>
<p>
For more ideas,
see the <a href="getstarted.html#summary">Now what?</a> section
of Getting Started.
</p>
</div>
<!-- API PAGE -->
<div class="apiPage" style="display: none; ">
<a name="apiReference"></a>
<h2>API reference: chrome.apiname </h2>
<!-- PROPERTIES -->
<div class="apiGroup">
<a name="properties"></a>
<h3 id="properties">Properties</h3>
<div>
<a></a>
<h4>getLastError</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension</span><span>lastError</span>
</div>
<div>
</div>
</div>
</div> <!-- /apiGroup -->
<!-- METHODS -->
<div class="apiGroup" id="methods">
<a name="methods"></a>
<h3>Methods</h3>
<!-- iterates over all functions -->
<div class="apiItem">
<a></a> <!-- method-anchor -->
<h4>method name</h4>
<div class="summary"><span>void</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.module.methodName</span>(<span><span>, </span><span></span>
<var><span></span></var></span>)</div>
<div class="description">
<p class="todo">Undocumented.</p>
<p>
A description from the json schema def of the function goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
<!-- RETURNS -->
<h4>Returns</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
<!-- CALLBACK -->
<div>
<div>
<h4>Callback function</h4>
<p>
If you specify the <em>callback</em> parameter,
it should specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
</div>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<div class="apiGroup">
<a name="events"></a>
<h3 id="events">Events</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a></a>
<h4>event name</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);
</div>
<div class="description">
<p class="todo">Undocumented.</p>
<p>
A description from the json schema def of the event goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div> <!-- /decription -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
<div class="apiGroup">
<a name="types.sort(sortByName)"></a>
<h3 id="types">Types</h3>
<!-- iterates over all types -->
<div class="apiItem">
<a></a>
<h4>type name</h4>
<div>
</div>
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
</div> <!-- /apiPage -->
</div> <!-- /mainColumn -->
</div> <!-- /pageContent -->
<div id="pageFooter" --="">
<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>
©2009 Google
</p>
<!-- begin analytics -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
<script type="text/javascript">
// chrome doc tracking
try {
var engdocs = _gat._getTracker("YT-10763712-2");
engdocs._trackPageview();
} catch(err) {}
// code.google.com site-wide tracking
try {
_uacct="UA-18071-1";
_uanchor=1;
_uff=0;
urchinTracker();
}
catch(e) {/* urchinTracker not available. */}
</script>
<!-- end analytics -->
</div> <!-- /pageFooter -->
</div> <!-- /container -->
</body></html>