Files
tubestation/addon-sdk/source/doc/dev-guide-source/guides/index.md

4.7 KiB

Guides

This page lists more theoretical in-depth articles about the SDK.


SDK Infrastructure

<td>
  <h4><a href="dev-guide/guides/program-id.html">Program ID</a></h4>
  The Program ID is a unique identifier for your add-on. This guide
  explains how it's created, what it's used for and how to define your
  own.
</td>
<td>
</td>

<td>
  <h4><a href="dev-guide/guides/firefox-compatibility.html">Firefox compatibility</a></h4>
  Working out which Firefox releases a given SDK release is
  compatible with, and dealing with compatibility problems.
</td>
<td>
  <h4><a href="dev-guide/guides/stability.html">SDK API lifecycle</a></h4>
  Definition of the lifecycle for the SDK's APIs, including the stability
  ratings for APIs.
</td>

<td>
</td>

Module structure of the SDK

The SDK, and add-ons built using it, are of composed from reusable JavaScript modules. This explains what these modules are, how to load modules, and how the SDK's module tree is structured.

SDK Idioms

<td>
  <h4><a href="dev-guide/guides/two-types-of-scripts.html">Two Types of Scripts</a></h4>
  This article explains the differences between the APIs
  available to your main add-on code and those available
  to content scripts.
</td>

Working With Events

Write event-driven code using the the SDK's event emitting framework.

Content Scripts

<td>
  <h4><a href="dev-guide/guides/content-scripts/loading.html">Loading content scripts</a></h4>
  Load content scripts into web pages, specified either as strings
  or in separate files, and how to control the point at which they are
  executed.
</td>
<td>
  <h4><a href="dev-guide/guides/content-scripts/communicating-with-other-scripts.html">Communicating with other scripts</a></h4>
  Detail about how content scripts can communicate with "main.js", with other
  content scripts, and with scripts loaded by the web page itself.
</td>
<td>
  <h4><a href="dev-guide/guides/content-scripts/using-port.html">Using "port"</a></h4>
  Communicating between a content script and the rest of your add-on
  using the <code>port</code> object.
</td>


<td>
  <h4><a href="dev-guide/guides/content-scripts/using-postmessage.html">Using "postMessage()"</a></h4>
  Communicating between a content script and the rest of your add-on
  using the <code>postMessage()</code> API, and a comparison between
  this technique and the <code>port</code> object.
</td>
<td>
  <h4><a href="dev-guide/guides/content-scripts/reddit-example.html">Reddit example</a></h4>
  A simple add-on which uses content scripts.
</td>

Introducing content scripts

An overview of content scripts.

Accessing the DOM

Detail about the access content scripts get to the DOM.

XUL Migration

<td>
  <h4><a href="dev-guide/guides/sdk-vs-xul.html">XUL versus the SDK</a></h4>
  A comparison of the strengths and weaknesses of the SDK,
  compared to traditional XUL-based add-ons.
</td>
<td>
  <h4><a href="dev-guide/guides/library-detector.html">Porting Example</a></h4>
  A walkthrough of porting a relatively simple XUL-based
  add-on to the SDK.
</td>

<td>
</td>

XUL Migration Guide

Techniques to help port a XUL add-on to the SDK.