Install.rdf
This page is part of the extension development documentation project.
Ask your questions in MozillaZine Forums. Also try browsing example code.
Note: development documentation is in process of being moved to Mozilla Development Center (MDC).
- Most of information here applies to install.rdf used in themes too. See below for detailed information.
Firefox 0.9, Thunderbird 0.7, Nvu 0.? and all subsequent versions of these products use the Extension Manager ("the EM") for managing extensions and themes. In order to have your extension supported by it you have to package your extensions as described in "Packaging Firefox/Thunderbird Extensions" document at mozilla.org. This includes providing a valid install.rdf file.
Creating install.rdf using tools
You can use any of these tools:
- Extension developer's extension has Extension Builder functionality.
- Ted Mielczarek's webapp for install.rdf creation.
- Extenzilla - Windows-only install.rdf and XPI generator by Will Ryan (disscussion thread at MZ forums).
- Extensionmaker - A Tcl Starkit for windows, that generates an install.rdf. You need a tclkit runtime for Windows to start it (see [1]). It's currently beta.
Template
If you choose to manually create an "install.rdf" file, you can use the template below as a guide.
<?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>{XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}</em:id> <em:name>Sample Extension</em:name> <em:version>1.0</em:version> <em:description>A sample extension with advanced features</em:description> <em:creator>Your Name Here</em:creator> <!-- optional items --> <em:contributor>A person who helped you</em:contributor> <em:contributor>Another one</em:contributor> <em:homepageURL>http://sampleextension.mozdev.org/</em:homepageURL> <em:optionsURL>chrome://sampleext/content/settings.xul</em:optionsURL> <em:aboutURL>chrome://sampleext/content/about.xul</em:aboutURL> <em:iconURL>chrome://sampleext/skin/mainicon.png</em:iconURL> <em:updateURL>http://sampleextension.mozdev.org/update.rdf</em:updateURL> <em:type>2</em:type> <!-- type=extension --> <!-- Firefox --> <em:targetApplication> <Description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minVersion>0.9</em:minVersion> <em:maxVersion>1.0</em:maxVersion> </Description> </em:targetApplication> <!-- This is not needed for Firefox 1.1 and later. Only include this if you want to make your extension compatible with older versions --> <em:file> <Description about="urn:mozilla:extension:file:sampleext.jar"> <em:package>content/</em:package> <!-- optional items --> <em:skin>skin/classic/</em:skin> <em:locale>locale/en-US/</em:locale> <em:locale>locale/ru-RU/</em:locale> </Description> </em:file> </Description> </RDF>
Target applications' GUIDs
Firefox | {ec8030f7-c20a-464f-9b0e-13a3a9e97384} |
Thunderbird | {3550f703-e582-4d05-9a08-453d09bdfdc6} |
Nvu | {136c295a-4a5a-41cf-bf24-5cee526720d5} |
Mozilla Suite | {86c18b42-e466-45a9-ae7a-9b95ba6f5640} |
"Seamonkey" | {92650c4d-4b8e-4d2a-b7eb-24ecf4f6b63a} |
Sunbird | {718e30fb-e89b-41dd-9da7-e25a45638b28} |
Netscape Browser | {3db10fab-e461-4c80-8b97-957ad5f8ea47} |
Notes
- Mozilla Suite ignores install.rdf, but you ought to include corresponding
targetApplication
item in install.rdf if