mozilla

Revision 65320 of Building a Thunderbird extension 3: install manifest

  • Revision slug: Extensions/Thunderbird/Building_a_Thunderbird_extension_3:_install_manifest
  • Revision title: Building a Thunderbird extension 3: install manifest
  • Revision id: 65320
  • Created:
  • Creator: jenzed
  • Is current revision? No
  • Comment 66 words added, 1 words removed

Revision Content

Open the file called install.rdf that you created at the top of your extension's directory hierarchy and paste the following text into the file:

<?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>myfirstext@jen.zed</em:id>
    <em:name>My First Extension</em:name>
    <em:version>1.0</em:version>
    <em:description>test extension for tutorial</em:description>
    <em:creator>jenzed</em:creator>
   
    <em:targetApplication>
      <Description>
        <em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id>
        <em:minVersion>1.5</em:minVersion>
        <em:maxVersion>3.0.0.*</em:maxVersion>
      </Description>
    </em:targetApplication>
   
  </Description>      
</RDF>

This file is an XML file that provides general information about the extension. The following items (shown in bold) should be customized for your application:

  • <em:id>myfirstext@jen.zed</em:id>: This is the ID of the extension. The first portion is the short name of the extension; the last portion is a two-part period-delimited value such as your first and last name or the top-level domain of your website. While this value is in email address format, it is not an email address. It should, however, be a unique value so that it does not conflict with other extensions. 
  • <em:name>My First Extension</em:name>: The extension name is displayed in the Thunderbird add-on Manager.
  • <em:version>1.0</em:version>: This is the version number of your extension. It must be updated each time you release a new version of your extension. It is not the Thunderbird version number (which is stored in the minVersion and maxVersion fields).
  • <em:description>test extension for tutorial</em:description>: This optional value will appear in Thunderbird's add-on list under the extension's name. It should be descriptive but reasonably short. It should not contain the extension's version number, as that value is stored in the version field.
  • <em:creator>My name</em:creator>: This optional value is used to store the extension author's name.
  • <em:minVersion>1.5</em:minVersion>: This element indicates the earliest version of Thunderbird for which the extension is intended to work. Do not use a wildcard (such as "*"). See Valid Application Versions for a list of the supported version numbers and formats.
  • <em:maxVersion>3.0.0.*</em:maxVersion>: This element indicates the most recent version of Thunderbird for which the extension is intended to work. This cannot be higher than the currently available version. "3.0.*" indicates that the extension works with Thunderbird 3.0 and any subsequent 3.0.x releases. See Valid Application Versions for a list of the supported version numbers and formats.

There are more optional elements that can be specified in install.rdf. These are described on the Install Manifests page. Note that elements can be specified in any order, as long as they are children of the <Description> node.

{{ note("If you used the Firefox / Thunderbird Extension Wizard as described in the previous step, open the install.rdf file in a text editor. The values in the elements described above were inserted based on the values you supplied on the form. The file also some additional, optional elements that you can ignore.") }}

{{ PreviousNext("en/Extensions/Thunderbird/Building_a_Thunderbird_extension_2:_extension_filesystem", "en/Extensions/Thunderbird/Building_a_Thunderbird_extension_4:_chrome_manifest") }}

Revision Source

<p>Open the file called <code>install.rdf</code> that you created at the top of your extension's directory hierarchy and paste the following text into the file:</p>
<pre class="eval">&lt;?xml version="1.0"?&gt;

&lt;RDF xmlns="<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:em="<a class=" external" href="http://www.mozilla.org/2004/em-rdf#" rel="freelink">http://www.mozilla.org/2004/em-rdf#</a>"&gt;

  &lt;Description about="urn:mozilla:install-manifest"&gt;
    &lt;em:id&gt;<strong><a class=" link-mailto" href="mailto:myfirstext@jen.zed" rel="freelink">myfirstext@jen.zed</a></strong>&lt;/em:id&gt;
    &lt;em:name&gt;<strong><span class="hilite">My First Extension</span></strong>&lt;/em:name&gt;
    &lt;em:version&gt;<strong>1.0</strong>&lt;/em:version&gt;
    &lt;em:description&gt;<strong>test extension for tutorial</strong>&lt;/em:description&gt;
    &lt;em:creator&gt;<strong>jenzed</strong>&lt;/em:creator&gt;
   
    &lt;em:targetApplication&gt;
      &lt;Description&gt;
        &lt;em:id&gt;{3550f703-e582-4d05-9a08-453d09bdfdc6}&lt;/em:id&gt;
        &lt;em:minVersion&gt;<strong>1.5</strong>&lt;/em:minVersion&gt;
        &lt;em:maxVersion&gt;<strong>3.0.0.*</strong>&lt;/em:maxVersion&gt;
      &lt;/Description&gt;
    &lt;/em:targetApplication&gt;
   
  &lt;/Description&gt;      
&lt;/RDF&gt;
</pre>
<p>This file is an XML file that provides general information about the extension. The following items (shown in bold) should be customized for your application:</p>
<ul> <li><code><strong>&lt;em:id&gt;<a class=" link-mailto" href="mailto:myfirstext@jen.zed" rel="freelink">myfirstext@jen.zed</a>&lt;/em:id&gt;</strong></code>: This is the ID of the extension. The first portion is the short name of the extension; the last portion is a two-part period-delimited value such as your first and last name or the top-level domain of your website. While this value is in email address format, it is <em>not</em> an email address. It should, however, be a unique value so that it does not conflict with other extensions. </li> <li><code><strong>&lt;em:name&gt;My First Extension&lt;/em:name&gt;</strong></code>: The extension name is displayed in the Thunderbird add-on Manager.</li> <li><code><strong>&lt;em:version&gt;1.0&lt;/em:version&gt;</strong></code>: This is the version number of your extension. It must be updated each time you release a new version of your extension. It is <em>not</em> the Thunderbird version number (which is stored in the <code>minVersion</code> and <code>maxVersion</code> fields).<strong><br> </strong></li> <li><strong><code>&lt;em:description&gt;test extension for tutorial&lt;/em:description&gt;</code></strong>: This optional value will appear in Thunderbird's add-on list under the extension's name. It should be descriptive but reasonably short. It should not contain the extension's version number, as that value is stored in the <code>version</code> field.</li> <li><code><strong>&lt;em:creator&gt;My name&lt;/em:creator&gt;</strong></code>: This optional value is used to store the extension author's name.</li> <li><strong><code>&lt;em:minVersion&gt;1.5&lt;/em:minVersion&gt;</code></strong>: This element indicates the earliest version of Thunderbird for which the extension is intended to work. Do not use a wildcard (such as "*"). See <a class="external" href="http://addons.mozilla.org/en-US/firefox/pages/appversions" title="http://addons.mozilla.org/en-US/firefox/pages/appversions">Valid Application Versions</a> for a list of the supported version numbers and formats.</li> <li><strong><code>&lt;em:maxVersion&gt;3.0.0.*&lt;/em:maxVersion&gt;</code></strong>: This element indicates the most recent version of Thunderbird for which the extension is intended to work. This cannot be higher than the currently available version. "3.0.*" indicates that the extension works with Thunderbird 3.0 and any subsequent 3.0.x releases. See <a class="external" href="http://addons.mozilla.org/en-US/firefox/pages/appversions" title="http://addons.mozilla.org/en-US/firefox/pages/appversions">Valid Application Versions</a> for a list of the supported version numbers and formats.</li>
</ul>
<p>There are more optional elements that can be specified in <code>install.rdf.</code> These are described on the <a class="internal" href="/en/Install_Manifests" title="en/Install Manifests">Install Manifests</a> page. Note that elements can be specified in any order, as long as they are children of the <code>&lt;Description&gt;</code> node.</p>
<p>{{ note("If you used the <a class="external" href="http://ted.mielczarek.org/code/mozilla/extensionwiz/" title="http://ted.mielczarek.org/code/mozilla/extensionwiz/">Firefox / Thunderbird Extension Wizard</a> as described in the <a class="internal" href="/en/Extensions/Thunderbird/Building_a_Thunderbird_extension_2:_extension_filesystem" title="en/Extensions/Thunderbird/Building a Thunderbird extension 2: extension filesystem">previous step</a>, open the <code>install.rdf</code> file in a text editor. The values in the elements described above were inserted based on the values you supplied on the form. The file also some additional, optional elements that you can ignore.") }}</p>
<p>{{ PreviousNext("en/Extensions/Thunderbird/Building_a_Thunderbird_extension_2:_extension_filesystem", "en/Extensions/Thunderbird/Building_a_Thunderbird_extension_4:_chrome_manifest") }}</p>
Revert to this revision