Permalink
Browse files

add 1.4rc3 docset

  • Loading branch information...
1 parent b621331 commit 0c79c8251b0292dbe13a6bfc2e9720e5abf6df80 @wbamberg wbamberg committed Jan 5, 2012
Showing with 3,213 additions and 1,609 deletions.
  1. +6 −8 dev-guide-source/addon-development/cfx-tool.md
  2. +1 −1 dev-guide-source/addon-development/content-scripts/access.md
  3. +1 −1 dev-guide-source/addon-development/implementing-simple-addon.md
  4. +9 −10 dev-guide-source/addon-development/installation.md
  5. +5 −0 dev-guide-source/addon-development/package-spec.md
  6. +1 −1 dev-guide-source/addon-development/tutorials.md
  7. +3 −0 dev-guide-source/appendices/credits.md
  8. +0 −105 dev-guide-source/module-development/e10s.md
  9. +0 −1 dev-guide-source/module-development/guides.md
  10. +0 −1 dev-guide-source/module-development/tutorials.md
  11. +15 −7 dev-guide/addon-development/about.html
  12. +15 −7 dev-guide/addon-development/annotator/annotator.html
  13. +15 −7 dev-guide/addon-development/annotator/creating.html
  14. +15 −7 dev-guide/addon-development/annotator/displaying.html
  15. +15 −7 dev-guide/addon-development/annotator/overview.html
  16. +15 −7 dev-guide/addon-development/annotator/storing.html
  17. +15 −7 dev-guide/addon-development/annotator/widget.html
  18. +15 −7 dev-guide/addon-development/api-idioms.html
  19. +15 −7 dev-guide/addon-development/api-intro.html
  20. +15 −7 dev-guide/addon-development/api-modules.html
  21. +21 −15 dev-guide/addon-development/cfx-tool.html
  22. +15 −7 dev-guide/addon-development/commonjs.html
  23. +15 −7 dev-guide/addon-development/console.html
  24. +15 −7 dev-guide/addon-development/content-scripts/access.html
  25. +15 −7 dev-guide/addon-development/content-scripts/loading.html
  26. +15 −7 dev-guide/addon-development/content-scripts/reddit-example.html
  27. +15 −7 dev-guide/addon-development/content-scripts/using-port.html
  28. +15 −7 dev-guide/addon-development/content-scripts/using-postmessage.html
  29. +15 −7 dev-guide/addon-development/events.html
  30. +15 −7 dev-guide/addon-development/getting-started.html
  31. +15 −7 dev-guide/addon-development/guides.html
  32. +15 −7 dev-guide/addon-development/implementing-reusable-module.html
  33. +16 −8 dev-guide/addon-development/implementing-simple-addon.html
  34. +24 −17 dev-guide/addon-development/installation.html
  35. +15 −7 dev-guide/addon-development/library-detector.html
  36. +15 −7 dev-guide/addon-development/module-search.html
  37. +22 −7 dev-guide/addon-development/package-spec.html
  38. +15 −7 dev-guide/addon-development/program-id.html
  39. +15 −7 dev-guide/addon-development/reference.html
  40. +15 −7 dev-guide/addon-development/sdk-vs-xul.html
  41. +15 −7 dev-guide/addon-development/third-party-packages.html
  42. +15 −7 dev-guide/addon-development/troubleshooting.html
  43. +16 −8 dev-guide/addon-development/tutorials.html
  44. +15 −7 dev-guide/addon-development/two-types-of-scripts.html
  45. +15 −7 dev-guide/addon-development/web-content.html
  46. +15 −7 dev-guide/addon-development/xul-migration.html
  47. +18 −7 dev-guide/appendices/credits.html
  48. +15 −7 dev-guide/appendices/glossary.html
  49. +15 −7 dev-guide/module-development/about.html
  50. +15 −7 dev-guide/module-development/best-practices.html
  51. +15 −7 dev-guide/module-development/chrome.html
  52. +15 −7 dev-guide/module-development/globals.html
  53. +16 −9 dev-guide/module-development/guides.html
  54. +15 −7 dev-guide/module-development/reference.html
  55. +16 −9 dev-guide/module-development/tutorials.html
  56. +15 −7 dev-guide/module-development/xpi.html
  57. +15 −7 dev-guide/welcome.html
  58. +15 −7 index.html
  59. +20 −18 packages/addon-kit/addon-kit.html
  60. +15 −7 packages/addon-kit/docs/clipboard.html
  61. +15 −7 packages/addon-kit/docs/context-menu.html
  62. +15 −7 packages/addon-kit/docs/hotkeys.html
  63. +15 −7 packages/addon-kit/docs/notifications.html
  64. +1 −0 packages/addon-kit/docs/page-mod.div
  65. +16 −7 packages/addon-kit/docs/page-mod.html
  66. +1 −1 packages/addon-kit/docs/page-mod.json
  67. +15 −7 packages/addon-kit/docs/page-worker.html
  68. +15 −7 packages/addon-kit/docs/panel.html
  69. +15 −7 packages/addon-kit/docs/passwords.html
  70. +15 −7 packages/addon-kit/docs/private-browsing.html
  71. +15 −7 packages/addon-kit/docs/request.html
  72. +15 −7 packages/addon-kit/docs/selection.html
  73. +15 −7 packages/addon-kit/docs/self.html
  74. +94 −0 packages/addon-kit/docs/simple-prefs.div
  75. +65 −248 packages/{api-utils/docs/e10s.html → addon-kit/docs/simple-prefs.html}
  76. +1 −0 packages/addon-kit/docs/simple-prefs.json
  77. +15 −7 packages/addon-kit/docs/simple-storage.html
  78. +15 −7 packages/addon-kit/docs/tabs.html
  79. +15 −7 packages/addon-kit/docs/timers.html
  80. +8 −8 packages/addon-kit/docs/widget.div
  81. +23 −15 packages/addon-kit/docs/widget.html
  82. +1 −1 packages/addon-kit/docs/widget.json
  83. +15 −7 packages/addon-kit/docs/windows.html
  84. +25 −23 packages/api-utils/api-utils.html
  85. +15 −7 packages/api-utils/docs/api-utils.html
  86. +15 −7 packages/api-utils/docs/app-strings.html
  87. +15 −7 packages/api-utils/docs/byte-streams.html
  88. +15 −7 packages/api-utils/docs/collection.html
  89. +15 −7 packages/api-utils/docs/content.html
  90. +15 −7 packages/api-utils/docs/content/loader.html
  91. +15 −7 packages/api-utils/docs/content/proxy.html
  92. +15 −7 packages/api-utils/docs/content/symbiont.html
  93. +15 −7 packages/api-utils/docs/content/worker.html
  94. +15 −7 packages/api-utils/docs/cortex.html
  95. +15 −7 packages/api-utils/docs/cuddlefish.html
  96. +0 −285 packages/api-utils/docs/e10s.div
  97. +0 −1 packages/api-utils/docs/e10s.json
  98. +38 −0 packages/api-utils/docs/environment.div
  99. +54 −81 dev-guide/module-development/e10s.html → packages/api-utils/docs/environment.html
  100. +1 −0 packages/api-utils/docs/environment.json
  101. +15 −7 packages/api-utils/docs/errors.html
  102. +15 −7 packages/api-utils/docs/es5.html
  103. +15 −7 packages/api-utils/docs/events.html
  104. +15 −7 packages/api-utils/docs/file.html
  105. +15 −7 packages/api-utils/docs/hidden-frame.html
  106. +29 −0 packages/api-utils/docs/httpd.div
  107. +515 −0 packages/api-utils/docs/httpd.html
  108. +1 −0 packages/api-utils/docs/httpd.json
  109. +15 −7 packages/api-utils/docs/light-traits.html
  110. +15 −7 packages/api-utils/docs/list.html
  111. +15 −7 packages/api-utils/docs/match-pattern.html
  112. +15 −7 packages/api-utils/docs/memory.html
  113. +69 −0 packages/api-utils/docs/namespace.div
  114. +555 −0 packages/api-utils/docs/namespace.html
  115. +1 −0 packages/api-utils/docs/namespace.json
  116. +15 −7 packages/api-utils/docs/observer-service.html
  117. +15 −7 packages/api-utils/docs/plain-text-console.html
  118. +24 −0 packages/api-utils/docs/preferences-service.div
  119. +39 −7 packages/api-utils/docs/preferences-service.html
  120. +1 −1 packages/api-utils/docs/preferences-service.json
  121. +15 −7 packages/api-utils/docs/runtime.html
  122. +15 −7 packages/api-utils/docs/securable-module.html
  123. +15 −7 packages/api-utils/docs/tab-browser.html
  124. +15 −7 packages/api-utils/docs/text-streams.html
  125. +15 −7 packages/api-utils/docs/traceback.html
  126. +15 −7 packages/api-utils/docs/traits.html
  127. +15 −7 packages/api-utils/docs/unit-test.html
  128. +15 −7 packages/api-utils/docs/unload.html
  129. +15 −7 packages/api-utils/docs/url.html
  130. +15 −7 packages/api-utils/docs/window-utils.html
  131. +15 −7 packages/api-utils/docs/xhr.html
  132. +15 −7 packages/api-utils/docs/xpcom.html
  133. +15 −7 packages/api-utils/docs/xul-app.html
  134. +15 −17 packages/development-mode/development-mode.html
  135. +15 −7 packages/development-mode/docs/bootstrap.html
  136. +15 −7 packages/development-mode/docs/main.html
  137. +1 −1 packages/index.json
  138. +1 −1 packages/test-harness/README.md
  139. +15 −7 packages/test-harness/docs/harness.html
  140. +1 −1 packages/test-harness/docs/run-tests.div
  141. +16 −8 packages/test-harness/docs/run-tests.html
  142. +1 −1 packages/test-harness/docs/run-tests.json
  143. +16 −18 packages/test-harness/test-harness.html
  144. +1 −1 static-files/base.html
  145. +6 −3 static-files/css/header.css
  146. +2 −2 static-files/css/sdk-docs.css
  147. BIN static-files/media/screenshots/widget-panel-clock.png
  148. +1 −1 status.md5
@@ -111,7 +111,7 @@ your add-on alongside debuggers like [Firebug](http://getfirebug.com/).
<p>For example, to pass the
<code>-jsconsole</code> argument to Firefox, which will launch the
<a href="https://developer.mozilla.org/en/Error_Console">JavaScript
- Error Console</a>, try the following:</p<>
+ Error Console</a>, try the following:</p>
<pre>cfx run --binary-args -jsconsole</pre>
<p>To pass multiple arguments, or arguments containing spaces, quote them:</p>
<pre>cfx run --binary-args '-url "www.mozilla.org" -jsconsole'</pre>
@@ -263,9 +263,8 @@ To launch the application, enter the following command:
<code>--e10s</code>
</td>
<td>
- If this option is set then the add-on runs in a separate process. See
- <a href="dev-guide/module-development/e10s.html">out-of-process add-ons</a>
- for details.
+ If this option is set then the add-on runs in a separate process.
+ This option is currently not implemented.
</td>
</tr>
@@ -333,7 +332,7 @@ times.
<p>For example, to pass the
<code>-jsconsole</code> argument to Firefox, which will launch the
<a href="https://developer.mozilla.org/en/Error_Console">JavaScript
- Error Console</a>, try the following:</p<>
+ Error Console</a>, try the following:</p>
<pre>cfx run --binary-args -jsconsole</pre>
<p>To pass multiple arguments, or arguments containing spaces, quote them:</p>
<pre>cfx run --binary-args '-url "www.mozilla.org" -jsconsole'</pre>
@@ -488,9 +487,8 @@ To launch the application, enter the following command:
<code>--e10s</code>
</td>
<td>
- If this option is set then the add-on runs in a separate process. See
- <a href="dev-guide/module-development/e10s.html">out-of-process add-ons</a>
- for details.
+ If this option is set then the add-on runs in a separate process.
+ This option is currently not implemented.
</td>
</tr>
@@ -21,7 +21,7 @@ Any changes they make are made to the proxy, and so are not visible to
page content.
The proxy is based on `XRayWrapper`, (also known as
-[`XPCNativeWrapper`](https://developer.mozilla.oreg/en/XPCNativeWrapper)).
+[`XPCNativeWrapper`](https://developer.mozilla.org/en/XPCNativeWrapper)).
These wrappers give the user access to the native values of DOM functions
and properties, even if they have been redefined by a script.
@@ -258,7 +258,7 @@ add-on in Firefox's Add-ons Manager and on
To specify an icon, save it as "icon.png" in your add-on's root directory. To
give the icon a different name or to store it in a different location
under the root, use the "icon" key in your `package.json` file. See the
-[Package Specification](file:///Users/Work/mozilla/jetpack-sdk/doc/dev-guide/addon-development/package-spec.html)
+[Package Specification](dev-guide/addon-development/package-spec.html)
for more details.
### cfx xpi ###
@@ -9,8 +9,7 @@ To develop with the Add-on SDK, you'll need:
* Firefox version 4.0 or later.
-At the moment, the latest stable version of the Add-on SDK is 1.3.
-You can obtain it as a
+You can obtain the latest stable version of the SDK as a
[tarball](https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz)
or a [zip file](https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.zip).
Alternatively, you can get the latest development version of the
@@ -22,21 +21,21 @@ Extract the file contents wherever you choose, and navigate to the root
directory of the SDK with a shell/command prompt. For example:
<pre>
- tar -xf addon-sdk-1.3.tar.gz
- cd addon-sdk-1.3
+tar -xf addon-sdk.tar.gz
+cd addon-sdk
</pre>
Then run:
<pre>
- source bin/activate
+source bin/activate
</pre>
Your command prompt should now have a new prefix containing the name of the
SDK's root directory:
<pre>
- (addon-sdk-1.3)~/mozilla/addon-sdk-1.3 >
+(addon-sdk)~/mozilla/addon-sdk >
</pre>
## Installation on Windows ##
@@ -45,8 +44,8 @@ Extract the file contents wherever you choose, and navigate to the root
directory of the SDK with a shell/command prompt. For example:
<pre>
- 7z.exe x addon-sdk-1.3.zip
- cd addon-sdk-1.3
+7z.exe x addon-sdk.zip
+cd addon-sdk
</pre>
Then run:
@@ -69,7 +68,7 @@ Your command prompt should now have a new prefix containing the full path to
the SDK's root directory:
<pre>
- (C:\Users\mozilla\sdk\addon-sdk-1.3) C:\Users\Work\sdk\addon-sdk-1.3>
+(C:\Users\mozilla\sdk\addon-sdk) C:\Users\Work\sdk\addon-sdk>
</pre>
## SDK Virtual Environment ##
@@ -126,7 +125,7 @@ program in your `~/bin` directory:
Run this at your shell prompt:
<pre>
- ~/mozilla/addon-sdk-1.3 > cfx
+~/mozilla/addon-sdk > cfx
</pre>
It should produce output whose first line looks something like this, followed by
@@ -48,6 +48,11 @@ called `package.json`. This file is also referred to as the
[`icon64URL` entry in the Install Manifest](https://developer.mozilla.org/en/install_manifests#icon64URL),
so the icon should be 64x64 pixels in size.
+* `preferences` - *experimental*
+ An array of JSON objects that use the following keys `name`, `type`, `value`,
+ `title`, and `description`. These JSON objects will be used to automatically
+ create a preferences interface for the addon in the Add-ons Manager.
+ For more information see the documentation of [simple-prefs](packages/addon-kit/docs/simple-prefs.html).
* `license` - the name of the license as a String, with an optional
URL in parentheses.
@@ -9,4 +9,4 @@ An introduction to the SDK APIs.
### [Annotator: a More Complex Add-on](dev-guide/addon-development/annotator/annotator.html) ###
This tutorial takes you through the implementation of a more complex add-on,
-and introduces most of the APIs in the [addon-kit package](#package/addon-kit).
+and introduces most of the APIs in the [addon-kit package](packages/addon-kit/addon-kit.html).
@@ -15,9 +15,11 @@ We'd like to thank our many Jetpack project contributors! They include:
* [Shane Caraveo](https://github.com/mixedpuppy)
* [Matěj Cepl](https://github.com/mcepl)
* Hernán Rodriguez Colmeiro
+* dexter
* [Matteo Ferretti (ZER0)](https://github.com/ZER0)
* fuzzykiller
* [Marcio Galli](https://github.com/taboca)
+* [Ben Gillbanks](http://www.iconfinder.com/browse/iconset/circular_icons/)
* Felipe Gomes
* Irakli Gozalishvili
* Luca Greco
@@ -41,6 +43,7 @@ We'd like to thank our many Jetpack project contributors! They include:
* Aza Raskin
* Justin Scott
* Ayan Shah
+* [skratchdot](https://github.com/skratchdot)
* [Mihai Sucan](https://github.com/mihaisucan)
* Clint Talbert
* Thomas
@@ -1,105 +0,0 @@
-# Out-of-Process Add-ons #
-
-Early infrastructure for allowing add-ons to execute in a separate process from
-Firefox itself is now available in the Add-on SDK.
-
-## Motivation ##
-
-Add-ons are awesome, but like any software, they have the ability to behave in
-unexpected ways. An add-on that's gone rogue should have as little ability to
-negatively affect the rest of the user's browsing experience as possible; one
-way to achieve this is by running the add-on's code in a separate process.
-
-These separate processes are relatively lightweight, don't have access to XPCOM,
-and are provided messaging facilities that allow them to communicate with their
-parent chrome process.
-
-## The Big Picture ##
-
-![Multi-Process Architecture](static-files/media/twitter-widget.png)
-
-The above diagram is a simplified depiction of what happens when a hypothetical
-add-on using the `widget` module is loaded.
-
-First, the add-on loader initializes the add-on and loads `main.js` in a
-separate process. We call this the *add-on process*.
-
-When `main.js` calls `require("widget")`, the add-on process sends a message to
-the chrome process and awaits a reply.
-
-The chrome process then notices that the `widget` module requires chrome
-privileges and therefore won't work properly if sent to the add-on process for
-evaluation. So it looks for an *e10s adapter* for the module by appending
-`-e10s-adapter` to the module's name and searching for it.
-
-This causes `widget-e10s-adapter.js` to be found and imported as the
-`widget-e10s-adapter` module in the chrome process. The *exact same code* is
-also returned to the add-on process for evaluation as the `widget` module in its
-world, and its exports are returned by `require()`. In other words, different
-sides of the message-passing boundary between the two processes are contained in
-the same adapter file, which is typically of the following form:
-
- if (this.chrome) {
- /* We're being evaluated in the add-on process. Export the
- * module's API, proxying all calls to the chrome process
- * as necessary. */
- } else exports.register = function register(addon) {
- /* We're being evaluated in the chrome process.
- * Set up chrome process listeners to communicate with
- * the given add-on process. */
- };
-
-More details on the above code can be found in the documentation for the
-<code>[e10s][]</code> module.
-
-Note that this only describes what happens when a module requiring chrome
-privileges *and* having an e10s adapter is requested by code in the add-on
-process.
-
-### Other Cases ###
-
-If the add-on process code attempts to import a chrome-privileged module that
-does *not* have an e10s adapter, an access denied exception is thrown.
-
-If the add-on process code attempts to import a module that does *not*
-explicitly require chrome privileges, the code for the module is sent to the
-add-on process and evaluated there, just like the `main` module.
-
-### Double Loading ###
-
-If both a module in the chrome process *and* a module in the add-on process
-request the same module that doesn't require chrome privileges, it is actually
-loaded *twice*: once in each process. This means that modules which intend to
-provide singleton-like functionality may need an e10s adapter to proxy calls
-into a single process.
-
-## Usage ##
-
-To enable out-of-process add-on functionality, simply pass the `--e10s` option
-to `cfx`. At present, this is only intended for SDK platform developers who are
-porting core SDK modules to work in out-of-process add-ons.
-
-Once these modules have been ported and the infrastructure is production-ready,
-we will be removing the `--e10s` option, as it will become the new default
-environment for add-ons to run in. We may decide to introduce a `--no-e10s`
-option at that time, to allow add-on authors to use the in-process architecture
-if absolutely necessary.
-
-For more detailed information on the usage of the e10s APIs, see the
-<code>[e10s][]</code> module.
-
-## Internals ##
-
-Code for the creation and bootstrapping of the add-on process is contained in
-the <code>[e10s][]</code> module, which uses the
-<code>[nsIJetpackService][]</code> and <code>[nsIJetpack][]</code> XPCOM
-interfaces to create a [Jetpack process][] and send
-<code>[bootstrap-remote-process.js][]</code> to it for evaluation. The `e10s`
-module also contains most of the `require()` logic for the add-on process.
-
-[e10s]: packages/api-utils/docs/e10s.html
-
-[bootstrap-remote-process.js]: packages/api-utils/data/bootstrap-remote-process.js
-[nsIJetpackService]: https://developer.mozilla.org/en/nsIJetpackService
-[nsIJetpack]: https://developer.mozilla.org/en/nsIJetpack
-[Jetpack process]: https://developer.mozilla.org/en/Jetpack_Processes
@@ -6,4 +6,3 @@
### [XPI Generation](dev-guide/module-development/xpi.html) ###
-### [Out-of-Process Add-ons](dev-guide/module-development/e10s.html) ###
@@ -8,4 +8,3 @@
### [XPI Generation](dev-guide/module-development/xpi.html) ###
-### [Out-of-Process Add-ons](dev-guide/module-development/e10s.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.3/" >
+ <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.4/" >
<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>
@@ -49,6 +49,7 @@
<h1>
<a href="dev-guide/welcome.html">Add-on SDK<span></span></a>
</h1>
+ <div id="version">Version 1.4</div>
</div>
</header>
@@ -202,6 +203,10 @@ <h4>
<a href="packages/addon-kit/docs/self.html">self</a>
</li>
+<li class="module">
+<a href="packages/addon-kit/docs/simple-prefs.html">simple-prefs</a>
+</li>
+
<li class="module">
<a href="packages/addon-kit/docs/simple-storage.html">simple-storage</a>
</li>
@@ -245,7 +250,6 @@ <h3 class="sidebar-subsection-header"><a href="dev-guide/module-development/guid
<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>
@@ -303,7 +307,7 @@ <h4>
</li>
<li class="module">
-<a href="packages/api-utils/docs/e10s.html">e10s</a>
+<a href="packages/api-utils/docs/environment.html">environment</a>
</li>
<li class="module">
@@ -322,6 +326,10 @@ <h4>
<a href="packages/api-utils/docs/hidden-frame.html">hidden-frame</a>
</li>
+<li class="module">
+<a href="packages/api-utils/docs/httpd.html">httpd</a>
+</li>
+
<li class="module">
<a href="packages/api-utils/docs/light-traits.html">light-traits</a>
</li>
@@ -338,6 +346,10 @@ <h4>
<a href="packages/api-utils/docs/memory.html">memory</a>
</li>
+<li class="module">
+<a href="packages/api-utils/docs/namespace.html">namespace</a>
+</li>
+
<li class="module">
<a href="packages/api-utils/docs/observer-service.html">observer-service</a>
</li>
@@ -354,10 +366,6 @@ <h4>
<a href="packages/api-utils/docs/runtime.html">runtime</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>
Oops, something went wrong.

0 comments on commit 0c79c82

Please sign in to comment.