path: root/files/zh-cn/mozilla/tech/xul/tutorial/manifest_files/index.html

---
title: Manifest Files
slug: Mozilla/Tech/XUL/Tutorial/Manifest_Files
translation_of: Archive/Mozilla/XUL/Tutorial/Manifest_Files
---
<h3 id="Contents.rdf_.E6.96.87.E4.BB.B6" name="Contents.rdf_.E6.96.87.E4.BB.B6">Contents.rdf 文件</h3>
<p>这部分内容，我们将了解如何将chrome和XUL文件打成包，以及为它们创建manifest文件。</p>
<p>&lt;big&gt;<b>包</b>&lt;/big&gt;</p>
<p>一个包，就是一组XUL文件和定义了用户界面功能的脚本的集合，它可以直接存成一个目录，也可以打成JAR文件。包可以被安装到Mozilla里，并且可以被chrome URL 引用。一个包里面包含了多种类型的文件，这些文件也可以划分到包内的不同的子目录里。</p>
<p>&lt;big&gt;<b>Manifest 文件</b>&lt;/big&gt;</p>
<p>manifest文件描述了包在硬盘上的物理存放位置与chrome URL的映射关系。当一个Mozilla应用启动时，它将检查chrome文件夹中的manifest文件，从而知道已经安装了哪些包。也就是说，当安装了一个新包时，你需要在应用程序的chrome目录下或者用户自己的chrome目录中加入一个新的manifest文件。一般情况下，当应用程序没有足够的权限向其目录中写入manifest文件时，才会将manifest文件放到用户自己的chrome目录中。</p>
<p>如果你想在Firefox浏览器中测试一下XUL代码的效果，只要在manifest文件中加入一行，就可以轻松实现了：</p>
<ol>
 <li>创建一个目录. 例如, 在系统盘下创建一个目录, 就可以用 C:\testfiles</li>
 <li>在chrome目录下创建一个新的名为 test.manifest 的文件（实际上，文件叫什么名字并不重要，只要扩展名是.manifest就可以了），则用下面一句:</li>
</ol>
<p><code>content tests <a class="external" rel="freelink">file:///C:/testfiles/</a></code></p>
<blockquote>
 这里的文件路径是指向上面创建的目录的。如果你不知道应该怎么写这个文件路径，可以在浏览器中打开那个目录，然后将地址栏里面的URL拷贝下来，就可以了。</blockquote>
<p>好了，现在，你只需要向上面新建的那个目录中加入一些XUL文件，然后，按照chrome://tests/content/&lt;filename&gt; 的格式键入chrome URL,就可以看到你的成果了。当然，为了你的修改能够起作用，需要重启浏览器。如果你创建的文件没有被加载，确认一下你键入的文件路径是否是正确的。</p>
<p>manifest 文件中每一行的基本语法是：</p>
<p><code>content &lt;packagename&gt; &lt;filepath&gt;</code></p>
<p>第一个字段指明了包类型。主题包是'skin'，语言地区包是'locale'。上面例子中，包名为'tests'，也就意味着chrome URL中第一个部分是'tests'，例如：<a class="external" rel="freelink">chrome://tests/content/sample.xul</a>。如果包名为'browser'，那么chrome <a class="external" href="URL就变成chrome://browser/content/" rel="freelink">URL就变成chrome://browser/content/</a>。基本语法中最后一个字段为文件所在的路径。这既可以是用file URL(译者注：如file:///c:/dir/a)表示的本地文件路径，又可以是下面我们马上要说到的jar URL表示的JAR包。在manifest文件中添加多行，可以指定多个包。</p>
<p>Firefox用到的browser.manifest文件看起来是这样的：</p>
<pre><code>content branding jar:browser.jar!/content/branding/ xpcnativewrappers=yes
content browser jar:browser.jar!/content/browser/ xpcnativewrappers=yes
overlay chrome://global/content/viewSource.xul chrome://browser/content/viewSourceOverlay.xul
overlay chrome://global/content/viewPartialSource.xul chrome://browser/content/viewSourceOverlay.xul
overlay chrome://browser/content/pageInfo.xul chrome://pippki/content/PageInfoOverlay.xul
</code></pre>
<p>这里有两个包，'branding'和'browser'。此外还有三个overlay，它们使得来自不同包的内容可以组合在一起。扩展(Extension)中会大量使用overlay，因为overlay的功能是将包的用户界面与浏览器的用户界面融合在一起。</p>
<p>由于内容被打包成jar，branding和browser包中文件的路径使用了jar URL。一个jar包可以通过ZIP工具来生成。在chrome目录中的JAR文件，语法相当简单：</p>
<p><code>jar:&lt;filename.jar&gt;!/&lt;path_in_archive&gt;</code></p>
<p>browser包对应的JAR包是browser.jar，与manifest文件放在同一个chrome目录中。'content/browser'指明了在JAR压缩包中XUL的路径。若压缩包里面不含任何目录，则无需指明任何路径。在我们的例子中，压缩包里面有目录，所以这里需要指明。</p>
<p>对于上面我们建立的'tests'包，文件没有压缩到一个jar包里，所以我们用直接的文件路径来代替jar路径。这样做有利于开发——我们就不用每次在改动文件后重新打包。不过，在发布一个扩展或者应用是，为了避免安装一堆的小文件，通产都会采用打包的方式。</p>
<p>在manifest文件的最后，<b>xpcnativewrappers=yes</b>是一个可选的标志。JavaScript可以将网页中内置的函数替换成自己的代码。如果有xpcnativewrappers标志，这就表明在特权环境(privileged context)下的脚本不运行覆盖的版本而是运行原始自带的版本。否则，如果一个扩展试图调用一个修改版的脚本，就有可能无法正常工作甚至更糟——产生安全漏洞。添加这个标志就是为了避免类似的问题，在新的扩展中应当坚持使用，而对于那些无法兼容改变的老扩展可以不用这个标志。</p>
<h3 id=".E4.B8.BB.E9.A2.98.EF.BC.88Themes.EF.BC.89.E5.92.8C.E6.9C.AC.E5.9C.B0.E5.8C.96.EF.BC.88Locales.EF.BC.89" name=".E4.B8.BB.E9.A2.98.EF.BC.88Themes.EF.BC.89.E5.92.8C.E6.9C.AC.E5.9C.B0.E5.8C.96.EF.BC.88Locales.EF.BC.89">主题（Themes）和本地化（Locales）</h3>
<p>主题（Themes）和本地化（Locales)的打包语法,与内容（content）打包的语法上是相似的。如果你要提供一个主题（Themes）和本地化（Locales）时，你需要了解更多细节。例如:</p>
<p><code>skin browser classic/1.0 jar:classic.jar!/skin/classic/browser/</code><br>
 <code>locale browser en-US jar:en-US.jar!/locale/browser/</code></p>
<p>如上面例子, 浏览器用来表示皮肤和本地化的特殊的项被加入。皮肤的名称是 'classic/1.0'。这里, 版本号被作为主体的一部分来使用, 但如果你制作自己的主题它是可选的。 Mozilla浏览器并不是用特殊方式来处理版本号;版本号仅仅作为主体名称的一部分。本地化语言是 'en-US'。映射的chrome <a class="external" href="URL应该是chrome://browser/skin和chrome://browser/locale" rel="freelink">URL应该是chrome://browser/skin和chrome://browser/locale</a>。如果你正在创作你自己的主题或者本地化浏览器,你说要做的全部是建立一个包含着两行内容的manifest文件，再修改内容来适应你的主题（Themes）和本地化（Locales）。</p>
<p>如果必要，也能够合并全部的三种类型内容放到一个单独文件里面。这种情况通常发生在当创建一个扩展（extension/Add on）时，你也许会把所有部分放到一个文件里面。例如，我们想做一个查找文件对话框时可以这样做。在chrome目录建立一个名称为findfiles.manifest的文件。把下面的内容加到文件里面：</p>
<pre><code>content findfiles file:///findfiles/content/
skin findfiles classic/1.0 file:///findfiles/skin/
locale findfiles en-US file:///findfiles/locale/
</code></pre>
<p>通常， 你希望目录路径内够适应你的系统（不同的文件系统，目录的结构不同）。 这种情况下, 我们仅仅建立测试路径。如果我们在发布这个包，我们应该把全部内容打包成一个JAR文件，并且修改路径。这里只是一个例子，今后可以参照这个例子来做。注意，例子里的skinhe和 locale行的第二项被指定为'findfiles'。这意味着，skin和locale可以访问和修改在第一行定义的findfiles包。</p>
<p>上述的三个路径每部分有自己的子路径，意味着你可以给每一部分建立和指定的特殊子路径。</p>
<h3 id=".E5.AE.89.E8.A3.85.E5.8C.85" name=".E5.AE.89.E8.A3.85.E5.8C.85">安装包</h3>
<p>为了安装一个应用，你将需要建立一个安装器，或者把它作为另一个应用的一部分。方式依赖于你所创建的是那种应用，一般来说不同的应用类型安装包是不同的。例如<a href="cn/%e6%89%a9%e5%b1%95">扩展</a>，你需要建立一个名为install.rdf的安装描述文件，它描述了哪些东西被安装，以及扩展的作者和兼容性（那一个版本的浏览器，与那些程序兼容等等）。 还需要一个<a href="cn/Bundles">专用的目录结构</a>，安装文件也许被安装到里面，并被限制在这个目录。一个扩展通常打包成一个 <a href="cn/XPI">XPI</a> 文件。 <a href="cn/XPI">XPI</a> 是XPInstall的缩写，被以Mozilla为基础的浏览器用来安装组件。类似于JAR文件，一个 XPI文件仅仅是一个带有不同的扩展的ZIP文件，所以你可以用ZIP格式兼容的工具来创建和察看 <a href="cn/XPI">XPI</a> 文件。</p>
<p>Firefox的扩展管理器能够自动的安装 <a href="cn/XPI">XPI</a> 文件内部的扩展包。他建议上传你的扩展到[<a class="external" href="https://addons.mozilla.org/|Mozilla">Add-ons site</a>]，用户通常在这个地址寻找扩展包来安装特殊的应用。当然他们也可以从任何网址安装，不过不是Firefox默认的网址。</p>
<p>也可以用JavaScript写一个安装脚本来安装文件。这样你可以把文件复制到任何位置并执行文件管理任务。但是，用脚本安装的应用不能够被扩展管理器列出，意味着不能像其他应用那样自动地卸载。所以通常不使用脚本安装文件。</p>
<p>标准的应用，可以使用<a href="cn/XULRunner">XULRunner</a>来打包。由于与执行文件分离，可以被发布成与浏览器版本无依赖的应用。</p>
<p>创建<a href="cn/%e6%89%a9%e5%b1%95">扩展</a>的更多信息请参照<a href="cn/%e6%9e%84%e5%bb%ba%e4%b8%80%e4%b8%aa%e6%89%a9%e5%b1%95">构建一个扩展</a>。 <a href="cn/XULRunner">XULRunner</a>的更多信息请参照http://developer.mozilla.org/en/docs/XULRunner</p>
<h3 id=".E6.97.A7.E7.89.88.E6.9C.AC.E5.BA.94.E7.94.A8.E7.A8.8B.E5.BA.8F" name=".E6.97.A7.E7.89.88.E6.9C.AC.E5.BA.94.E7.94.A8.E7.A8.8B.E5.BA.8F">旧版本应用程序</h3>
<p>如果你为旧版本的Mozilla软件创建应用程序，比如Firefox 1.5或者Mozilla 1.8，那么这一章就很重要的。以下便是讲解怎样为先前版本建立包。如果你正在写新的扩展或者XUL应用程序的话，完全可以跳过此章。</p>
<p>1. 在你的磁盘上创建一个目录。许多人喜欢在Mozilla的chrome目录下面创建一个子目录，这样是没有必要的。这个目录可以在任何地方建立，随你喜欢。然后将你的XUL文件放置其中。</p>
<p>2. 创建一个名为contents.rdf，并放置在前面你所建立的目录中。将下面的文本框中的内容复制粘贴进新的contents.rdf文件中。这个文件是用来区别应用程序的id，它的名字，作者，版本等等的。</p>
<table class="standard-table">
 <tbody>
  <tr>
   <td>
    <pre class="eval">
     &lt;?xml version="1.0"?&gt;
</pre>
    <pre class="eval">
     &lt;RDF:RDF xmlns:RDF="<a class="external" href="http://www.w3.org/1999/02/22-rdf-syntax-ns#" rel="freelink">http://www.w3.org/1999/02/22-rdf-syntax-ns#</a>"
              xmlns:chrome="<a class="external" href="http://www.mozilla.org/rdf/chrome#" rel="freelink">http://www.mozilla.org/rdf/chrome#</a>"&gt;
</pre>
    <pre class="eval">
       &lt;RDF:Seq about="urn:mozilla:package:root"&gt;
         &lt;RDF:li resource="urn:mozilla:package:myapplication"/&gt;
       &lt;/RDF:Seq&gt;
</pre>
    <pre class="eval">
       &lt;RDF:Description about="urn:mozilla:package:myapplication"
               chrome:displayName="Application Title"
               chrome:author="Author Name"
               chrome:name="myapplication"
               chrome:extension="true"/&gt;
</pre>
    <pre class="eval">
     &lt;/RDF:RDF&gt;
</pre>
   </td>
  </tr>
 </tbody>
</table>
<p>3. 将文本中的高亮显示部分改换成你自己的信息。比如红色部分“myapplication”应该是你应用程序的ID。你把它填写上，这个ID和你的应用程序名是相似的。用你的应用程序的题目和作者来替换文本中的蓝色高亮部分。</p>
<p>4. 如果'chrome:extension'字段为真，那么这个应用程序是Mozilla Firefox Extension（即Mozilla Firefox的扩展），而且还会在浏览器相应的附加软件窗口中见到。否则，它将不会显示。</p>
<p>5. 保存contents.rdf文件，同时确认它在你在步骤一中创建的那个文件内。</p>
<p>6. 打开&lt;mozilla-directory&gt;/chrome/installed-chrome.txt 这个文件，&lt;mozilla-directory&gt;就是Mozilla程序所安装的那个目录。记住在此之前先退出Mozilla程序。</p>
<p>7. 接下来，你必须在注册新的应用程序，这样Mozilla程序就可以找到它。在installed-chrome.txt中的最后添加新的一行，来指向你在步骤一中创建的那个目录。</p>
<p> </p>
<pre class="eval">     content,install,url,<a class="external" rel="freelink">file:///main/app/</a>
</pre>
<blockquote>
 用你的目录的URL来替换掉上面高亮的文字。并且必须在最后的保留一个斜杠再加一个回车。如果你不能确定那个URL是什么，那么就用Mozilla浏览器来打开该目录，并复制地址栏中所显示的URL。注意这一项必须是个目录的显示，而不是具体到文件的显示。</blockquote>
<p>8. 删除 &lt;mozilla-directory&gt;/chrome/chrome.rdf 文件.</p>
<p>9. 打开 Mozilla 程序.你将可以看到任何你放到那个目录下的XUL文件，以下面的URL：<b><a class="external" rel="freelink">chrome://</a><font color="red">applicationid</font>/content/file.xul</b>其中file.xul是文件名。主XUL文件应该是：<b>applicationid.xul</b>，你可以用以下的方式打开它<b><a class="external" rel="freelink">chrome://</a><font color="red">applicationid</font>/content/</b>。</p>
<p>如果你要创建skin和locale这两项的话，重复以上步骤，除了contents.rdf的形式略有不同。可以参考contents.rdf为其它应用程序所设置的细节。</p>
<p>创建一个chrome包是一件艰难的事情，诊断问题也很困难。以下是一些小小的提示，如果你遇到困难时也许用得着。</p>
<ul>
 <li>打开&lt;mozilla-directory&gt;/chrome/chrome.rdf。你应该能够找到，你的应用程序ID。否则说明注册存在问题。如果有的话，也许你在调用文件时用了错误的chrome URL。</li>
 <li>当你试着删除&lt;mozilla-directory&gt;/chrome/chrome.rdf时，它会自动重新建立。甚至是删除整个&lt;mozilla-directory&gt;/chrome/overlayinfo/目录也一样，因为你用了overlays（叠加）。</li>
 <li>确定在installed-chrome.txt中的URL最后又一个斜杠，还有这个文件的最后有一个空行。</li>
 <li>在Windows操作系统中，文件的URLs是这样的形式：///C|/files/app/，其中C 是盘符。</li>
 <li>确认contents.rdf在正确的目录下，并有着正确的格式。在Mozilla程序中打开contents.rdf来看是不是一个完好的XML。否则，你就会看到有带着黄色的背景的错误显示。</li>
 <li>如果你应用Mozilla调试构建，有些信息会显示到终端，在最开始会提示哪些chrome应用程序checked（被查出问题？）。请自己清查一些那上面所列出的应用程序。</li>
</ul>
<hr>
<div>
 <a href="cn/XUL_%e6%95%99%e7%a8%8b/%e5%85%b3%e4%ba%8eChrome_URL">&lt;&lt; 前页</a> <a href="cn/XUL_%e6%95%99%e7%a8%8b/%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e7%aa%97%e5%8f%a3">后页 &gt;&gt;</a></div>