Added 1.1 docset from release candidate 1

mozilla · Sep 12, 2011 · 595a8b9 · 595a8b9
1 parent ad7d8a3
commit 595a8b9
Show file tree

Hide file tree

Showing 216 changed files with 2,605 additions and 531 deletions.
diff --git a/base.html b/base.html
diff --git a/css/api-reference.css b/css/api-reference.css
diff --git a/css/base.css b/css/base.css
diff --git a/css/footer.css b/css/footer.css
diff --git a/css/header.css b/css/header.css
diff --git a/css/sdk-docs.css b/css/sdk-docs.css
diff --git a/dev-guide/addon-development/about.html b/dev-guide/addon-development/about.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/annotator/annotator.html b/dev-guide/addon-development/annotator/annotator.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/annotator/creating.html b/dev-guide/addon-development/annotator/creating.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/annotator/displaying.html b/dev-guide/addon-development/annotator/displaying.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/annotator/overview.html b/dev-guide/addon-development/annotator/overview.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/annotator/storing.html b/dev-guide/addon-development/annotator/storing.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/annotator/widget.html b/dev-guide/addon-development/annotator/widget.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/api-idioms.html b/dev-guide/addon-development/api-idioms.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/api-intro.html b/dev-guide/addon-development/api-intro.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/api-modules.html b/dev-guide/addon-development/api-modules.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>
@@ -191,7 +191,10 @@ <h3><a href="packages/addon-kit/docs/self.html">self</a></h3>
 <a href="packages/addon-kit/docs/panel.html"><code>panel</code></a> you can store the files in your
 <code>data</code> directory and retrieve them using <code>self</code>.</p>
 <p>This module also gives your add-on access to its <a href="dev-guide/addon-development/program-id.html">Program
-ID</a>.</p></div>
+ID</a>.</p>
+<p>Note that the <code>self</code> module is completely different from the global <code>self</code>
+object accessible to content scripts, which is used by a content script to
+<a href="dev-guide/addon-development/web-content#content_script_events">communicate with the add-on code</a>.</p></div>
   </div>
 
   <div id="sidebar" class="column">

diff --git a/dev-guide/addon-development/cfx-tool.html b/dev-guide/addon-development/cfx-tool.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/commonjs.html b/dev-guide/addon-development/commonjs.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>
@@ -76,6 +76,18 @@ <h2>CommonJS Modules</h2>
 </li>
 </ul>
 <p><img alt="CommonJS modules" src="media/commonjs-modules.jpg" /></p>
+<p>The SDK
+<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/freeze">freezes</a>
+the <code>exports</code> object returned by <code>require</code>. So a if you import a module using
+<code>require</code>, you can't change the properties of the object returned:</p>
+<pre><code>self = require("self");
+// Attempting to define a new property
+// will fail, or throw an exception in strict mode
+self.foo = 1;
+// Attempting to modify an existing property
+// will fail, or throw an exception in strict mode
+self.data = "foo";
+</code></pre>
 <h2>CommonJS Packages</h2>
 <p>A CommonJS <strong>package</strong> is a structure which can wrap a collection of related
 modules: this makes it easier to distribute, install and manage modules.</p>
@@ -98,8 +110,7 @@ <h2>CommonJS and the Add-on SDK</h2>
 <p>According to the CommonJS specification, if a module called <code>main</code> exists in a
 CommonJS package, that module will be evaluated as soon as your program is
 loaded. For an add-on, that means that the <code>main</code> module will be evaluated as
-soon as the host application (such as Firefox) has enabled your program as an
-extension.</p>
+soon as Firefox has enabled the add-on.</p>
 <p>So in terms of CommonJS objects the translator consists of a package that
 contains a single module called <code>main</code>, and which imports three SDK modules:</p>
 <p><img alt="CommonJS translator" src="media/commonjs-translator.jpg" /></p>

diff --git a/dev-guide/addon-development/console.html b/dev-guide/addon-development/console.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/events.html b/dev-guide/addon-development/events.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/getting-started.html b/dev-guide/addon-development/getting-started.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/guides.html b/dev-guide/addon-development/guides.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/implementing-reusable-module.html b/dev-guide/addon-development/implementing-reusable-module.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>

diff --git a/dev-guide/addon-development/implementing-simple-addon.html b/dev-guide/addon-development/implementing-simple-addon.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>
@@ -244,7 +244,7 @@ <h3>Logging</h3>
 <p>Note the calls to <code>console.log()</code> here. <code>console</code> is a global object accessible
 by any module, which you can use to write error, warning, or informational
 messages.</p>
-<p>For an extension which has been packaged as an XPI file and installed into
+<p>For an add-on which has been packaged as an XPI file and installed into
 Firefox, the messages are sent to Firefox's
 <a href="https://developer.mozilla.org/en/Error_Console">Error Console</a>. If you are
 launching Firefox from the command line using <code>cfx</code>, as you will be for

diff --git a/dev-guide/addon-development/installation.html b/dev-guide/addon-development/installation.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>
@@ -56,58 +56,88 @@ <h1>
   <div id="main-content-column" class="column">
     <div id="toc"></div>
     <div id="main-content"><h1>Installation</h1>
+<h2>Prerequisites</h2>
 <p>To develop with the Add-on SDK, you'll need:</p>
 <ul>
 <li>
 <p><a href="http://www.python.org/">Python</a> 2.5 or 2.6. Note that versions 3.0 and 3.1
   of Python are not supported. Make sure that Python is in your path.</p>
 </li>
 <li>
-<p>A version of Firefox that uses Gecko 2.0.0.7 or later
-  (for example, Firefox 4.0).</p>
+<p>Firefox version 4.0 or later.</p>
 </li>
 </ul>
-<p>At the moment, the latest stable version of the Add-on SDK is 1.0.
+<p>At the moment, the latest stable version of the Add-on SDK is 1.1.
 You can obtain it as a
 <a href="https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz">tarball</a>
 or a <a href="https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.zip">zip file</a>.
 Alternatively, you can get the latest development version of the
 Add-on SDK from its <a href="https://github.com/mozilla/addon-sdk">GitHub repository</a>.</p>
+<h2>Installation on Mac OS X / Linux</h2>
 <p>Extract the file contents wherever you choose, and navigate to the root
 directory of the SDK with a shell/command prompt. For example:</p>
 <pre>
-  ~/mozilla > tar -xf addon-sdk-1.0.tar.gz
-  ~/mozilla > cd addon-sdk-1.0
-  ~/mozilla/addon-sdk-1.0 >
+  ~/mozilla > tar -xf addon-sdk-1.1.tar.gz
+  ~/mozilla > cd addon-sdk-1.1
+  ~/mozilla/addon-sdk-1.1 >
 </pre>
 
-<p>Then, if you're on Linux, OS X, or another Unix-based system, run:</p>
+<p>Then run:</p>
 <pre>
-  ~/mozilla/addon-sdk-1.0 > source bin/activate
+  ~/mozilla/addon-sdk-1.1 > source bin/activate
 </pre>
 
-<p>Otherwise, if you're on Windows, run:</p>
+<p>Your command prompt should now have a new prefix containing the name of the
+SDK's root directory:</p>
 <pre>
-  C:\Users\Mozilla\addon-sdk-1.0> bin\activate
+  (addon-sdk-1.1)~/mozilla/addon-sdk-1.1 >
 </pre>
 
-<p>Now the beginning of your command prompt should contain the text
-<code>(addon-sdk)</code>, which means that your shell has entered a special
-virtual environment that gives you access to the Add-on SDK's
-command-line tools.</p>
-<p>At any time, you can leave a virtual environment by running
-<code>deactivate</code>.</p>
+<h2>Installation on Windows</h2>
+<p>Extract the file contents wherever you choose, and navigate to the root
+directory of the SDK with a shell/command prompt. For example:</p>
+<pre>
+  C:\Users\mozilla\sdk>7z.exe x addon-sdk-1.1.zip
+  C:\Users\mozilla\sdk>cd addon-sdk-1.1
+  C:\Users\mozilla\sdk\addon-sdk-1.1>
+</pre>
+
+<p>Then run:</p>
+<pre>
+  C:\Users\mozilla\sdk\addon-sdk-1.1>bin\activate
+</pre>
+
+<p>You might see an error like this:</p>
+<pre>
+  ERROR: The system was unable to find the specified registry key or value.
+</pre>
+
+<p>This is a known issue, being tracked as
+<a href="https://bugzilla.mozilla.org/show_bug.cgi?id=574563">bug 574563</a>, and should
+not affect the proper functioning of the SDK at all.</p>
+<p>Your command prompt should now have a new prefix containing the full path to
+the SDK's root directory:</p>
+<pre>
+  (C:\Users\mozilla\sdk\addon-sdk-1.1) C:\Users\Work\sdk\addon-sdk-1.1>
+</pre>
+
+<h2>SDK Virtual Environment</h2>
+<p>The new prefix to your command prompt indicates that your shell has entered
+a virtual environment that gives you access to the Add-on SDK's command-line
+tools.</p>
+<p>At any time, you can leave a virtual environment by running <code>deactivate</code>.</p>
 <p>The virtual environment is specific to this particular command prompt. If you
 close this command prompt, it is deactivated and you need to type
-<code>source bin/activate</code> in a new command prompt to reactivate it. If
-you open a new command prompt, the SDK will not be active in the new prompt.</p>
+<code>source bin/activate</code> or <code>bin\activate</code> in a new command prompt to reactivate
+it. If you open a new command prompt, the SDK will not be active in the new
+prompt.</p>
 <p>You can have multiple copies of the SDK in different locations on disk and
 switch between them, or even have them both activated in different command
 prompts at the same time.</p>
 <h2>Sanity Check</h2>
 <p>Run this at your shell prompt:</p>
 <pre>
-  ~/mozilla/addon-sdk-1.0 > cfx
+  ~/mozilla/addon-sdk-1.1 > cfx
 </pre>
 
 <p>It should produce output whose first line looks something like this, followed by

diff --git a/dev-guide/addon-development/module-search.html b/dev-guide/addon-development/module-search.html
@@ -2,7 +2,7 @@
 "http://www.w3.org/TR/html4/strict.dtd">
 <html lang="en">
 <head>
-  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
+  <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >
   <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
   <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>