2007年7月30日星期一

firefox扩展开发(一) : 扩展的基本结构

firefox扩展开发(一) : 扩展的基本结构

galeki posted @ 2007年05月18日 11:09PM in Firefox扩展开发 with tags extension 开发 扩展 firefox
firefox扩展开发(五) : 驱动XUL界面

用过firefox的人肯定要安装firefox的扩展,这样才能发挥火狐的全部实力。一般扩展是一个后缀为.xpi的文件,其实这个文件就是zip格式的压缩包,压缩了一个扩展所需要的所有目录和文件,基本的目录结构如下:

extension.xpi:
              /install.rdf                   
              /components/* 
              /components/cmdline.js                   
              /defaults/
              /defaults/preferences/*.js     
              /plugins/*                       
              /chrome.manifest               
              /chrome/icons/default/*       
              /chrome/
              /chrome/content/

看似很复杂,让我们从最重要的文件开始介绍起:

1. install.rdf

从名字可以看出,这个文件描述了扩展安装所需要的信息,包括了扩展的标识、版本、适用的应用程序、作者等等等等。本身是一个rdf文件。

基本的install.rdf示例:

  1. <?xml version="1.0"?>
  2.  
  3.  
  4.       <!-- 标识和版本 -->
  5.   <Description about="urn:mozilla:install-manifest">
  6.     <em:id >galeki@linuxge.org</em:id >
  7.     <em:version >1.0</em:version>
  8.     <em:type >2</em:type>
  9.    
  10.     <!-- 针对的应用程序 -->
  11.  
  12.     <em:targetApplication >
  13.       <Description >
  14.         <em:id >{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
  15.         <em:minVersion >1.5</em:minVersion>
  16.         <em:maxVersion >2.0.0.*</em:maxVersion>
  17.       </Description >
  18.     </em:targetApplication >
  19.    
  20.     <!-- 名称、介绍、作者和网站地址 -->
  21.     <em:name >Hello</em:name>
  22.     <em:description >扩展测试</em:description>
  23.     <em:creator >galeki</em:creator>
  24.     <em:homepageURL >http://blog.linuxgem.org/galeki</em:homepageURL >
  25.   </Description >     
  26. </RDF >

8~10行是标识信息,第8行的<em:id>段是此软件包唯一的标识,可以是作者的email,目的是唯一标识此软件包。第9行是目 前的版本。第10行的<em:type>,值为2代表"我是扩展",4代表"我是主题",这里是扩展,所以值为2。

14~20行的<em:targetApplication>段描述了软件包针对的应用程序,16行那段古怪的<em: id>表明此扩展是针对firefox的,而不是thunderbird、sunbird,所以,只要是针对firefox的扩展,此id的值都不 变。17~18行描述了此扩展适用的firefox版本。

23~26行描述了扩展的基本信息,从标签的名称上就可以看出意思,扩展管理器中显示的扩展信息,就是来源于这里。

2. chrome目录 

 chrome是扩展最重要的一个目录,所有描述扩展的文件,称为chrome。

chrome一般包括3类文件,content、locale、skin:

content:描述扩展界面、外观的定义文件,比如按钮布局,对话框,通过XUL文件和js文件来设定,后面我们可以看到XUL的介绍。

locale: 描述多语言信息的文件,一般是xml的dtd文件。

skin: 定义界面样式的css文件和所需要的图片文件。

一个典型(并不绝对)的chrome目录下包含这么几个子目录:       

              /chrome
                    content/
                    locale/
                    skin/

三个子文件夹存放了扩展对应的content、locale和skn类型的文件。

3.chrome.manifest文件

接下来,得让fierfox找到扩展的content、locale、skin文件在哪里,chrome.manifest就是这个作用。

这个文件让firefox知道扩展的content、locale、skin等文件在哪里,例如:

content     hello    chrome/content/

简单来说,就是指明,hello这个扩展的content类型文件,在chrome目录的content子目录下。

locale的定义稍有区别:

locale  hello  zh-CN   chrome/locale/zh-CN/

指明hello这个扩展的zh-CN,也就是中文的locale,在chrome/locale/zh-CN/目录下。

skin的定义和locale相似:

skin   hello  classic/1.0   chrome/skin/classv1/

指明hello这个扩展,名叫classic/1.0的skin,在chrome/skin/classv1/目录下。

通过chrome.manifest文件的指定,firefox就可以找到对应的文件。在firefox中,引用web服务器上的文件是用的 "http://"前缀,引用硬盘上的文件是用的"file://"前缀,引用扩展中的文件有单独的引用前缀,就是"chrome://",比如:

chrome://hello/content/about.xul
引用了hello扩展content类型文件中的about.xul文件。这样一来,不管在硬盘上扩展的content、locale、skin是在什么 地方,只要chrome.manifest文件配置好,就可以让firefox通过"chrome://"引用到特定的文件了。

FireFTP的例子:

由上图的地址栏可以看出,打开FireFTP这个扩展,实际上就是打开了fireftp的content类型文件中的fireftp.xul文件。

--
一步一步教你从互联网赚钱 http://www.zqzn.com/index.asp?rid=key480769
投资理财 http://li-cai.blogspot.com/

没有评论: