1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
|
<!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="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> Browser UI
<ul>
<li><a href="browserAction.html">Browser Actions</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>
<li><a href="themes.html">Themes</a></li>
</ul>
</li>
<li> Browser Interaction
<ul>
<li><a href="bookmarks.html">Bookmarks</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>
</ul>
</li>
<li> Implementation
<ul>
<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="messaging.html">Message Passing</a></li>
<li><a href="npapi.html">NPAPI Plugins</a></li>
</ul>
</li>
<li> Finishing
<ul>
<li><a href="autoupdate.html">Autoupdating</a></li>
<li><a href="packaging.html">Packaging</a></li>
</ul>
</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="samples.html">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>
|
