This repository has been archived by the owner on Mar 29, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
creating.html
761 lines (666 loc) · 26.9 KB
/
creating.html
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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.2.1/" >
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
<script type="text/javascript" src="static-files/syntaxhighlighter/scripts/shCore.js"></script>
<script type="text/javascript" src="static-files/syntaxhighlighter/scripts/shBrushCss.js"></script>
<script type="text/javascript" src="static-files/syntaxhighlighter/scripts/shBrushXml.js"></script>
<script type="text/javascript" src="static-files/syntaxhighlighter/scripts/shBrushJScript.js"></script>
<link rel="stylesheet" type="text/css" media="all" href="static-files/css/base.css">
<link rel="stylesheet" type="text/css" media="all" href="static-files/css/header.css">
<link rel="stylesheet" type="text/css" media="all" href="static-files/css/footer.css">
<link rel="stylesheet" type="text/css" media="all" href="static-files/css/sdk-docs.css">
<link rel="stylesheet" type="text/css" media="all" href="static-files/css/api-reference.css">
<link rel="stylesheet" type="text/css" href="static-files/syntaxhighlighter/styles/shCore.css">
<link rel="stylesheet" type="text/css" href="static-files/syntaxhighlighter/styles/shThemeDefault.css">
<!--[if IE]>
<style type="text/css">
.package-summary .module,
.package-entry .module,
.package-detail .module {
display: block;
}
</style>
<![endif]-->
<link rel="shortcut icon" type="image/x-icon" href="static-files/media/favicon.png">
<title>Creating Annotations - Add-on SDK Documentation</title>
</head>
<body>
<header id="global-header">
<div class="funnel">
<a id="mozilla-tab" href="http://www.mozilla.org/?ref=logo">Mozilla</a>
<div class="menu">
<p>
<a href="https://addons.mozilla.org/en-US/developers/">Back to Developer Hub</a>
</p>
</div>
</header>
<header id="site-header">
<div class="funnel">
<h1>
<a href="dev-guide/welcome.html">Add-on SDK<span></span></a>
</h1>
</div>
</header>
<div id="container">
<div id="columns">
<div id="main-content-column" class="column">
<div id="toc"></div>
<div id="main-content"><h1>Creating Annotations</h1>
<p>We'll use two objects to create annotations: a page-mod to find page elements
that the user can annotate, and a panel for the user to enter the annotation
text itself.</p>
<h2>Selector page-mod</h2>
<h3>Selector Content Scripts</h3>
<p>The content script for the selector page-mod uses <a href="http://jquery.com/">jQuery</a>
to examine and manipulate the DOM.</p>
<p>Its main job is to maintain a "matched element": this is the page element that
is the current candidate for an annotation. The matched element is highlighted
and has a click handler bound to it which sends a message to the main add-on
code.</p>
<p>The selector page mod can be switched on and off using a message from the
main add-on code. It is initially off:</p>
<pre><code>var matchedElement = null;
var originalBgColor = null;
var active = false;
function resetMatchedElement() {
if (matchedElement) {
$(matchedElement).css('background-color', originalBgColor);
$(matchedElement).unbind('click.annotator');
}
}
self.on('message', function onMessage(activation) {
active = activation;
if (!active) {
resetMatchedElement();
}
});
</code></pre>
<p>This selector listens for occurrences of the
<a href="http://api.jquery.com/mouseenter/">jQuery mouseenter</a> event.</p>
<p>When a mouseenter event is triggered the selector checks whether the element
is eligible for annotation. An element is eligible if it, or one of its
ancestors in the DOM tree, has an attribute named <code>"id"</code>. The idea here is to
make it more likely that the annotator will be able to identify annotated
elements correctly later on.</p>
<p>If the page element is eligible for annotation, then the selector highlights
that element and binds a click handler to it. The click handler sends a message
called <code>show</code> back to the main add-on code. The <code>show</code> message contains: the URL
for the page, the ID attribute value, and the text content of the page element.</p>
<pre><code>$('*').mouseenter(function() {
if (!active || $(this).hasClass('annotated')) {
return;
}
resetMatchedElement();
ancestor = $(this).closest("[id]");
matchedElement = $(this).first();
originalBgColor = $(matchedElement).css('background-color');
$(matchedElement).css('background-color', 'yellow');
$(matchedElement).bind('click.annotator', function(event) {
event.stopPropagation();
event.preventDefault();
self.port.emit('show',
[
document.location.toString(),
$(ancestor).attr("id"),
$(matchedElement).text()
]
);
});
});
</code></pre>
<p>Conversely, the add-on resets the matched element on
<a href="http://api.jquery.com/mouseout/">mouseout</a>:</p>
<pre><code>$('*').mouseout(function() {
resetMatchedElement();
});
</code></pre>
<p>Save this code in a new file called <code>selector.js</code> in your add-on's <code>data</code>
directory.</p>
<p>Because this code uses jQuery, you'll need to
<a href="http://docs.jquery.com/Downloading_jQuery">download</a> that as well, and save it in
<code>data</code>.</p>
<h3>Updating main.js</h3>
<p>Go back to <code>main.js</code> and add the code to create the selector into the <code>main</code>
function:</p>
<pre><code>var selector = pageMod.PageMod({
include: ['*'],
contentScriptWhen: 'ready',
contentScriptFile: [data.url('jquery-1.4.2.min.js'),
data.url('selector.js')],
onAttach: function(worker) {
worker.postMessage(annotatorIsOn);
selectors.push(worker);
worker.port.on('show', function(data) {
console.log(data);
});
worker.on('detach', function () {
detachWorker(this, selectors);
});
}
});
</code></pre>
<p>Make sure the name you use to load jQuery matches the name of the jQuery
version you downloaded.</p>
<p>The page-mod matches all pages, so each time the user loads a page the page-mod
emits the <code>attach</code> event, which will call the listener function we've assigned
to <code>onAttach</code>. The handler is passed a
<a href="packages/api-utils/docs/content/worker.html">worker</a> object. Each worker
represents a channel of communication between the add-on code and any content
scripts running in that particular page context. For a more detailed discussion
of the way <code>page-mod</code> uses workers, see the
<a href="packages/addon-kit/docs/page-mod.html">page-mod documentation</a>.</p>
<p>In the attach handler we do three things:</p>
<ul>
<li>send the content script a message with the current activation status</li>
<li>add the worker to an array called <code>selectors</code> so we can send it messages
later on</li>
<li>assign a message handler for messages from this worker. If the message is
<code>show</code> we will just log the content for the time being. If the message is
<code>detach</code> we remove the worker from the <code>selectors</code> array.</li>
</ul>
<p>At the top of the file import the <code>page-mod</code> module and declare an array for
the workers:</p>
<pre><code>const pageMod = require('page-mod');
var selectors = [];
</code></pre>
<p>Add <code>detachWorker</code>:</p>
<pre><code>function detachWorker(worker, workerArray) {
var index = workerArray.indexOf(worker);
if(index != -1) {
workerArray.splice(index, 1);
}
}
</code></pre>
<p>Edit <code>toggleActivation</code> to notify the workers of a change in activation state:</p>
<pre><code>function activateSelectors() {
selectors.forEach(
function (selector) {
selector.postMessage(annotatorIsOn);
});
}
function toggleActivation() {
annotatorIsOn = !annotatorIsOn;
activateSelectors();
return annotatorIsOn;
}
</code></pre>
<p><span class="aside">We'll be using this URL in all our screenshots. Because
<code>cfx run</code> doesn't preserve browsing history, if you want to play along it's
worth taking a note of the URL.</span></p>
<p>Save the file and execute <code>cfx run</code> again. Activate the annotator by clicking
the widget and load a page: the screenshot below uses
<a href="http://blog.mozilla.com/addons/2011/02/04/overview-amo-review-process/">http://blog.mozilla.com/addons/2011/02/04/
overview-amo-review-process/</a>.
You should see the highlight appearing when you move the mouse over certain elements:</p>
<img class="image-center"
src="static-files/media/annotator/highlight.png" alt="Annotator Highlighting">
<p>Click on the highlight and you should see something like this in the console
output:</p>
<pre>
info: show
info: http://blog.mozilla.com/addons/2011/02/04/overview-amo-review-process/,
post-2249,When you submit a new add-on, you will have to choose between 2
review tracks: Full Review and Preliminary Review.
</pre>
<h2>Annotation Editor Panel</h2>
<p>So far we have a page-mod that can highlight elements and send information
about them to the main add-on code. Next we will create the editor panel,
which enables the user to enter an annotation associated with the selected
element.</p>
<p>We will supply the panel's content as an HTML file, and will also supply a
content script to execute in the panel's context.</p>
<p>So create a subdirectory under <code>data</code> called <code>editor</code>. This will contain
two files: the HTML content, and the content script.</p>
<h3>Annotation Editor HTML</h3>
<p>The HTML is very simple:</p>
<script type="syntaxhighlighter" class="brush: html"><![CDATA[
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Annotation</title>
<style type="text/css" media="all">
body {
font: 100% arial, helvetica, sans-serif;
background-color: #F5F5F5;
}
textarea {
width: 180px;
height: 180px;
margin: 10px;
padding: 0px;
}
</style>
</head>
<body>
<textarea rows='10' cols='20' id='annotation-box'>
</textarea>
</body>
</html>
]]>
</script>
<p>Save this inside <code>data/editor</code> as <code>annotation-editor.html</code>.</p>
<h3>Annotation Editor Content Script</h3>
<p>In the corresponding content script we do two things:</p>
<ul>
<li>handle a message from the add-on code by giving the text area focus</li>
<li>listen for the return key and when it is pressed, send the contents of the
text area to the add-on.</li>
</ul>
<p>Here's the code:</p>
<pre><code>var textArea = document.getElementById('annotation-box');
textArea.onkeyup = function(event) {
if (event.keyCode == 13) {
self.postMessage(textArea.value);
textArea.value = '';
}
};
self.on('message', function() {
var textArea = document.getElementById('annotation-box');
textArea.value = '';
textArea.focus();
});
</code></pre>
<p>Save this inside <code>data/editor</code> as <code>annotation-editor.js</code>.</p>
<h3>Updating main.js Again</h3>
<p>Now we'll update <code>main.js</code> again to create the editor and use it.</p>
<p>First, import the <code>panel</code> module:</p>
<pre><code>const panels = require('panel');
</code></pre>
<p>Then add the following code to the <code>main</code> function:</p>
<pre><code>var annotationEditor = panels.Panel({
width: 220,
height: 220,
contentURL: data.url('editor/annotation-editor.html'),
contentScriptFile: data.url('editor/annotation-editor.js'),
onMessage: function(annotationText) {
if (annotationText) {
console.log(this.annotationAnchor);
console.log(annotationText);
}
annotationEditor.hide();
},
onShow: function() {
this.postMessage('focus');
}
});
</code></pre>
<p>We create the editor panel but don't show it.
We will send the editor panel the <code>focus</code> message when it is shown, so it will
give the text area focus. When the editor panel sends us its message we log the
message and hide the panel.</p>
<p>The only thing left is to link the editor to the selector. So edit the message
handler assigned to the selector so that on receiving the <code>show</code> message we
assign the content of the message to the panel using a new property
"annotationAnchor", and show the panel:</p>
<pre><code>var selector = pageMod.PageMod({
include: ['*'],
contentScriptWhen: 'ready',
contentScriptFile: [data.url('jquery-1.4.2.min.js'),
data.url('selector.js')],
onAttach: function(worker) {
worker.postMessage(annotatorIsOn);
selectors.push(worker);
worker.port.on('show', function(data) {
annotationEditor.annotationAnchor = data;
annotationEditor.show();
});
worker.on('detach', function () {
detachWorker(this, selectors);
});
}
});
</code></pre>
<p>Execute <code>cfx run</code> again, activate the annotator, move your mouse over an
element and click the element when it is highlighted. You should see a panel
with a text area for a note:</p>
<p><img class="image-center"
src="static-files/media/annotator/editor-panel.png" alt="Annotator Editor Panel">
<br></p>
<p>Enter the note and press the return key: you should see console output like
this:</p>
<pre>
info: http://blog.mozilla.com/addons/2011/02/04/overview-amo-review-process/,
post-2249,When you submit a new add-on, you will have to choose between 2
review tracks: Full Review and Preliminary Review.
info: We should ask for Full Review if possible.
</pre>
<p>That's a complete annotation, and in the next section we'll deal with
<a href="dev-guide/addon-development/annotator/storing.html">storing it</a>.</p></div>
</div>
<div id="sidebar" class="column">
<div class="sidebar-section" id="addon-development">
<h2 class="sidebar-section-header"><a href="dev-guide/addon-development/about.html">Developer Guide</a></h2>
<div class="sidebar-section-contents" id="default-section-contents">
<div class="sidebar-subsection">
<h3><a href="dev-guide/addon-development/installation.html">Installation</a></h3>
<div class="divider"></div>
<h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/tutorials.html">Tutorials</a></h3>
<div class="sidebar-subsection-contents">
<ul>
<li><h4><a href="dev-guide/addon-development/getting-started.html">Getting Started</a></h4>
<ul>
<li><a href="dev-guide/addon-development/implementing-simple-addon.html">A Simple Add-on</a></li>
<li><a href="dev-guide/addon-development/commonjs.html">CommonJS</a></li>
<li><a href="dev-guide/addon-development/implementing-reusable-module.html">Reusable Modules</a></li>
<li><a href="dev-guide/addon-development/troubleshooting.html">Troubleshooting</a></li>
</ul></li>
<li><h4><a href="dev-guide/addon-development/api-intro.html" >Introducing the APIs</a></h4>
<ul>
<li><a href="dev-guide/addon-development/api-idioms.html">Common Idioms</a></li>
<li><a href="dev-guide/addon-development/api-modules.html">API Overview</a></li>
</ul></li>
<li><h4><a href="dev-guide/addon-development/annotator/annotator.html">Annotator: a More Complex Add-on</a></h4>
<ul>
<li><a href="dev-guide/addon-development/annotator/overview.html">Design Overview</a></li>
<li><a href="dev-guide/addon-development/annotator/widget.html">Implementing the Widget</a></li>
<li><a href="dev-guide/addon-development/annotator/creating.html">Creating Annotations</a></li>
<li><a href="dev-guide/addon-development/annotator/storing.html">Storing Annotations</a></li>
<li><a href="dev-guide/addon-development/annotator/displaying.html">Displaying Annotations</a></li>
</ul></li>
</ul>
</div>
</div>
<div class="sidebar-subsection">
<div class="divider"></div>
<h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/guides.html">Programming Guides</a></h3>
<div class="sidebar-subsection-contents">
<ul>
<li><h4><a href="dev-guide/addon-development/two-types-of-scripts.html">Two Types of Scripts</a></h4></li>
<li><h4><a href="dev-guide/addon-development/events.html">Working with Events</a></h4></li>
<li><h4><a href="dev-guide/addon-development/web-content.html">Content Scripts</a></h4>
<ul>
<li><a href="dev-guide/addon-development/content-scripts/loading.html">Loading Content Scripts</a></li>
<li><a href="dev-guide/addon-development/content-scripts/access.html">Content Script Access</a></li>
<li><a href="dev-guide/addon-development/content-scripts/using-port.html">Using <code>port</code></a></li>
<li><a href="dev-guide/addon-development/content-scripts/using-postmessage.html">Using <code>postMessage</code></a></li>
<li><a href="dev-guide/addon-development/content-scripts/reddit-example.html">Example</a></li>
</ul></li>
<li><h4><a href="dev-guide/addon-development/program-id.html">The Program ID</a></h4></li>
<li><h4><a href="dev-guide/addon-development/module-search.html">Module Search</a></h4></li>
</ul>
</div>
</div>
<div class="sidebar-subsection">
<div class="divider"></div>
<h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/reference.html">Reference</a></h3>
<div class="sidebar-subsection-contents always-show">
<ul>
<li id="high-level-package-summaries">
<div style="display: block;" class="package-summary">
<h4>
<a href="packages/addon-kit/addon-kit.html">addon-kit</a>
</h4>
<ul class="modules">
<li class="module">
<a href="packages/addon-kit/docs/clipboard.html">clipboard</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/context-menu.html">context-menu</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/hotkeys.html">hotkeys</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/notifications.html">notifications</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/page-mod.html">page-mod</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/page-worker.html">page-worker</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/panel.html">panel</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/passwords.html">passwords</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/private-browsing.html">private-browsing</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/request.html">request</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/selection.html">selection</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/self.html">self</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/simple-storage.html">simple-storage</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/tabs.html">tabs</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/timers.html">timers</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/widget.html">widget</a>
</li>
<li class="module">
<a href="packages/addon-kit/docs/windows.html">windows</a>
</li>
</ul>
</div>
</li>
<li><h4><a href="dev-guide/addon-development/console.html">console</a></h4></li>
<li><h4><a href="dev-guide/addon-development/cfx-tool.html">cfx</a></h4></li>
<li><h4><a href="dev-guide/addon-development/package-spec.html">Package Specification</a></h4></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sidebar-section" id="module-development">
<h2 class="sidebar-section-header"><a href="dev-guide/module-development/about.html">Internals Guide</a></h2>
<div class="sidebar-section-contents">
<div class="sidebar-subsection">
<h3 class="sidebar-subsection-header"><a href="dev-guide/module-development/guides.html">Programming Guides</a></h3>
<div class="sidebar-subsection-contents">
<ul>
<li><h4><a href="dev-guide/module-development/best-practices.html">Low-Level Module Best Practices</a></h4>
<li><h4><a href="dev-guide/module-development/chrome.html">Chrome Authority</a></h4>
<li><h4><a href="dev-guide/module-development/xpi.html">XPI Generation</a></h4>
<li><h4><a href="dev-guide/module-development/e10s.html">Out-of-Process Add-ons</a></h4>
</ul>
</div>
</div>
<div class="sidebar-subsection">
<div class="divider"></div>
<h3 class="sidebar-subsection-header"><a href="dev-guide/module-development/reference.html">Reference</a></h3>
<div class="sidebar-subsection-contents">
<ul>
<li id="low-level-package-summaries">
<div style="display: block;" class="package-summary">
<h4>
<a href="packages/api-utils/api-utils.html">api-utils</a>
</h4>
<ul class="modules">
<li class="module">
<a href="packages/api-utils/docs/api-utils.html">api-utils</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/app-strings.html">app-strings</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/byte-streams.html">byte-streams</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/collection.html">collection</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/content.html">content</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/content/loader.html">content/loader</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/content/symbiont.html">content/symbiont</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/content/worker.html">content/worker</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/cortex.html">cortex</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/cuddlefish.html">cuddlefish</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/e10s.html">e10s</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/errors.html">errors</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/events.html">events</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/file.html">file</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/hidden-frame.html">hidden-frame</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/light-traits.html">light-traits</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/list.html">list</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/match-pattern.html">match-pattern</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/memory.html">memory</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/observer-service.html">observer-service</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/plain-text-console.html">plain-text-console</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/preferences-service.html">preferences-service</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/securable-module.html">securable-module</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/tab-browser.html">tab-browser</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/text-streams.html">text-streams</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/traceback.html">traceback</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/traits.html">traits</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/unit-test.html">unit-test</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/unload.html">unload</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/url.html">url</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/window-utils.html">window-utils</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/xhr.html">xhr</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/xpcom.html">xpcom</a>
</li>
<li class="module">
<a href="packages/api-utils/docs/xul-app.html">xul-app</a>
</li>
</ul>
</div>
<div style="display: block;" class="package-summary">
<h4>
<a href="packages/test-harness/test-harness.html">test-harness</a>
</h4>
<ul class="modules">
<li class="module">
<a href="packages/test-harness/docs/harness.html">harness</a>
</li>
<li class="module">
<a href="packages/test-harness/docs/run-tests.html">run-tests</a>
</li>
</ul>
</div>
<div style="display: block;" class="package-summary">
<h4>
<a href="packages/development-mode/development-mode.html">development-mode</a>
</h4>
<ul class="modules">
<li class="module">
<a href="packages/development-mode/docs/bootstrap.html">bootstrap</a>
</li>
<li class="module">
<a href="packages/development-mode/docs/main.html">main</a>
</li>
</ul>
</div>
</li>
<li><h4><a href="dev-guide/module-development/globals.html">Globals</a></h4></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sidebar-section" id="appendices">
<h3><a href="https://wiki.mozilla.org/Labs/Jetpack/Release_Notes">Release Notes</a></h3>
<div class="divider"></div>
<h3><a href="https://wiki.mozilla.org/Labs/Jetpack">Jetpack Wiki</a></h3>
<div class="divider"></div>
<h3><a href="dev-guide/appendices/glossary.html">Glossary</a></h3>
<div class="divider"></div>
<h3><a href="dev-guide/appendices/credits.html">Credits</a></h3>
</div>
<!--end of sidebar column-->
</div>
<!--end of 'columns'-->
<div class="clearfooter"></div>
</div>
</div>
<div role="contentinfo" id="footer">
<div class="section">
<img alt="" src="static-files/media/footer-logo-med.png" class="footerlogo">
<div id="social-footer">
<ul>
<li>get to know <b>add-ons</b></li>
<li><a href="https://addons.mozilla.org/en-US/firefox/about">About</a></li>
<li><a href="http://blog.mozilla.com/addons">Blog</a></li>
<li class="footer-devhub-link"><a href="https://addons.mozilla.org/en-US/developers/">Developer Hub</a></li>
<li><a href="https://addons.mozilla.org/en-US/firefox/faq">FAQ</a></li>
<li><a href="https://forums.addons.mozilla.org">Forum</a></li>
</ul>
</div>
<div id="copyright">
<p id="footer-links">
<a href="http://mozilla.com/privacy-policy.html">Privacy Policy</a> |
<a href="http://mozilla.com/about/legal.html">Legal Notices</a> |
<a href="http://mozilla.com/legal/fraud-report/index.html">Report Trademark Abuse</a>
| <a href="https://addons.mozilla.org/z/en-US/developers/" class="mobile-link">View Mobile Site</a>
</p>
<p>
Except where otherwise <a href="http://mozilla.com/about/legal.html#site">noted</a>, content on this site is licensed under the <br> <a href="http://creativecommons.org/licenses/by-sa/3.0/"> Creative Commons Attribution Share-Alike License v3.0 </a> or any later version.
</p>
</div>
</div>
</div>
<script type="text/javascript" src="static-files/js/jquery.js"></script>
<script type="text/javascript" src="static-files/js/main.js"></script>
</body>
</html>