创建Firefox扩展 [A]  [A] 原文地址：https://developer.mozilla.org/en/Building_an_Extension

翻译：Karl Ma
email: karlcpp@gmail.com

Instruction

• 传统的，经典的，或者说是XUL扩展。这种类型的扩展功能强大，但是安装此类扩展时需要重新启动Firefox。
• 非重启，或者说是自启动的扩展。这种类型的扩展在安装后不用重新启动，但是，与传统类型的扩展相比，它会受到更多的限制。Add-on SDK和Add-on Builder可以让你在创建非重启型扩展时容易一点。

Quick Start

Setting up the Development Environment

Create the Install Manifest

<?xml version="1.0"?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"xmlns:em="http://www.mozilla.org/2004/em-rdf#"><Description about="urn:mozilla:install-manifest"><em:id>sample@example.net</em:id><em:version>1.0</em:version><em:type>2</em:type><!-- Target Application this extension can install into,with minimum and maximum supported versions. --><em:targetApplication><Description><em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id><em:minVersion>1.5</em:minVersion><em:maxVersion>4.0.*</em:maxVersion></Description></em:targetApplication><!-- Front End MetaData --><em:name>sample</em:name><em:description>A test extension</em:description><em:creator>Your Name Here</em:creator><em:homepageURL>http://www.example.com/</em:homepageURL></Description>
</RDF>

• sample@example.net - extension的ID。这是一个email格式的值（不一定就真的是你的邮件），用来标识你的这个extension。之所以要使用email，主要是为了使这个extension标识有唯一性而已。你可能会用GUID。注：这个参数必须是email格式，虽然它可能不是一个合法的email地址。
• <em:type>2</em:type> - 类型是2表示正在安装是一个extension，如果是一个theme的话，这个值应该是4（其它的类型看这里）。
• {ec8030f7-c20a-464f-9b0e-13a3a9e97384} - Firefox应用程序是的ID。
• 1.5 - 你的extension可以工作的最早的Firefox版本，要是一个精确的版本号，不能是＊。如果你说什么也要写＊的话，我敢保证它一定不会是你希望的那样在的工作。
• 4.0.* - 你的extension可以工作的最高的Firefox版本。4.0.＊的意思是可以在4.0.x版本上工作。这个版本号应该要小于Firefox宣布的版本号。默认情况下，在Firefox 10或以后的版本不会强制约束maxVersion。你可以通过配置<em:strictCompatibility>项来要求应用程序强制约束maxVersion。

Extending the Browser with XUL

<statusbar id="status-bar">... <statusbarpanel>s ...
</statusbar>

XUL Overlays

<?xml version="1.0"?>
<overlay id="sample" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"><statusbar id="status-bar"><statusbarpanel id="my-panel" label="Hello, World"  /></statusbar>
</overlay>

Chrome URIs

• 第一、URI方案(chrome)，它告诉Firefox网络库，这是一个Chrome URI。它指示URI的内容应该按(chrome)方式处理。而(http)URI则要Firefox按网页的方式处理。
• 第二、包的名字（例子中就是browser），它标识了用户界面组件的集合。对于你的程序来说，它应该是独一无二的，以避免不同extension间的冲突。
• 第三、请求的数据类型。有三种类型：content(XUL，Javascript，XBL绑定等等，是应用程序的结构和行为)，locale(DTD，属性文件等，是UI的本地化字符串)，skin(CSS和image，是UI的主题)。
• 最后，加载文件的路径。

Create a Chrome Manifest

content     sample    chrome/content/

1. 这个chrome包的类型。
2. chrome包的名字（你要确保包的名字全部都是小写字母，如“sample"。这是因为Firefox和Thunderbird的2.0以前的版本不支持混合（或驼型）大小写）
3. chrome包文件的位置。

Register an Overlay

overlay chrome://browser/content/browser.xul chrome://sample/content/sample.xul

Test

1. 找到profile文件夹 [C]  [C] 译者注：在linux操作系统下，此目录在~/.mozilla在它的下面找到你想要用于开发的profile(如：Firefox/Profiles/<profile_id>.default) [D]  [D] 译者注：这是default profile，一般情况下最好新建一个专门用于开发的profile。执行命令firefox -P dev，会创建一个<profile_id>.dev的profile。
2. 打开extensions/文件夹，如果还没有，就创建它。
3. 创建一个文本文件，将你的开发路径放写在文件里（如：C:\extensions\my_extension\ or ~/extensions/my_extension/），Windows用户应保持反斜杠的方向，并且，所有的人都应该记得要包括最后一个斜杠同时去掉所有的尾部空格。
4. 将这个文本文件保存成你的extension的id值（如：sample@example.net），没有文件扩展名。

Package

Installing from web page

Using addons.mozilla.org

Installing Extensions using a Separate Installer

More on XUL Overlays

<statusbarpanel position="1" ...  />
<statusbarpanel insertbefore="other-id" ...  />
<statusbarpanel insertafter="other-id" ...  />

Create New User Interface Components

Default Files

pref("extensions.sample.username", "Joe"); //a string pref
pref("extensions.sample.sort", 2); //an int pref
pref("extensions.sample.showAdvanced", true); //a boolean pref

XPCOM Components

Application Command Line

Localization

locale sample en-US chrome/locale/en-US/

<!ENTITY my-panel.label "Hello, World">

<?xml version="1.0"?>
<!DOCTYPE window SYSTEM "chrome://packagename/locale/filename.dtd">
...

<statusbarpanel id="my-panel" label="&my-panel.label;"  />

Understanding the Browser

Debuging Extensions

Analytical Tools for Debugging

• DOM Inspector- 检查属性，DOM结构，生效的CSS样式规则（例如：找出为什么你的样式表不能在某个元素的显现－直是一个无价的工具！）
• Venkman- 在javascript脚本中设置断点，并检查堆栈
• JavaScript的arguments.callee.caller - 访问函数调用堆栈

printf debugging

• 用dump("string") - 这个需要对工作上属性进行一点配置，详情请参阅这里。
• 用Components.utils.reportError()或nsIConsoleService将日志写到JavaScript终端

Advanced debugging

• 运行一个debug版本的Firefox，在Firefox或你的c++组件中设置断点。对于一个有经验的开发者，这通过是最快的诊断问题的方法。详情请参阅Build Documentation 和Developing Mozilla。
• 参见Debugging a XULRunner Application会看到更多的技巧和帮助。

Further Information

• Extension FAQ
• Extensions