<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title xmlns:d="http://docbook.org/ns/docbook">2.6. Addons</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta xmlns:d="http://docbook.org/ns/docbook" name="generator" content="publican v4.3.2" /><meta xmlns:d="http://docbook.org/ns/docbook" name="package" content="AppStream-AppStream-0.11-en-US-0.0-0" /><link rel="home" href="index.html" title="AppStream" /><link rel="up" href="chap-Metadata.html" title="Chapter 2. Upstream Metadata" /><link rel="prev" href="sect-Metadata-Service.html" title="2.5. Services" /><link rel="next" href="sect-Metadata-Fonts.html" title="2.7. Fonts" /></head><body><p id="title"><a class="left" href="http://www.freedesktop.org/wiki/Distributions/AppStream/"><img alt="Product Site" src="Common_Content/images//image_left.png" /></a><a class="right" href="http://www.freedesktop.org/software/appstream/docs/"><img alt="Documentation Site" src="Common_Content/images//image_right.png" /></a></p><ul class="docnav top"><li class="previous"><a accesskey="p" href="sect-Metadata-Service.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Metadata-Fonts.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a id="sect-Metadata-Addon">
</a>2.6. Addons</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-addondata-introduction">
</a>2.6.1. Introduction</h3></div></div></div><div class="para">
Some software is not standalone, but rather extends existing software installed on the system. The <code class="literal">addon</code> component type exists to reflect that.
</div><div class="para">
Software which provides addons can ship one or more files in <code class="filename">/usr/share/metainfo/%{id}.metainfo.xml</code>.
</div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-addoncdata-example">
</a>2.6.2. Example file</h3></div></div></div><div class="para">
A addon meta-info file should look like this:
</div><pre class="programlisting"><span xmlns="" class="line"></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><?xml</span> version="1.0" encoding="UTF-8"<span xmlns="" class="perl_Keyword">?></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><component</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"addon"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><id></span>org.gnome.gedit-code-assistance<span xmlns="" class="perl_Keyword"></id></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><extends></span>org.gnome.gedit.desktop<span xmlns="" class="perl_Keyword"></extends></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><name></span>Code Assistance<span xmlns="" class="perl_Keyword"></name></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><summary></span>Code assistance for C, C++ and Objective-C<span xmlns="" class="perl_Keyword"></summary></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><url</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"homepage"</span><span xmlns="" class="perl_Keyword">></span>http://projects.gnome.org/gedit<span xmlns="" class="perl_Keyword"></url></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><metadata_license></span>CC0-1.0<span xmlns="" class="perl_Keyword"></metadata_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><project_license></span>GPL-3.0+<span xmlns="" class="perl_Keyword"></project_license></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></component></span></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-addondata-filespec">
</a>2.6.3. File specification</h3></div></div></div><div class="para">
Note that the XML root must have the <code class="literal">type</code> property set to <code class="code">addon</code>. This clearly identifies this metainfo document as describing an addon to existing software.
</div><div class="variablelist"><dl class="variablelist"><dt><a id="tag-id-addon">
</a><span class="term"><id/></span></dt><dd><div class="para">
For addons, the <code class="literal">%{id}</code> must follow the component-id naming conventions (see <a class="xref" href="chap-Metadata.html#tag-id-generic"><id/></a>).
</div></dd><dt><a id="tag-extends">
</a><span class="term"><extends/></span></dt><dd><div class="para">
This tag is refers to the ID of the component this addon is extending.
</div><div class="para">
For example, if there is a plugin "kipi" which extens the application "Gwenview", it needs to be referred to as:
</div><pre class="programlisting"><span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><extends></span>org.kde.Gwenview<span xmlns="" class="perl_Keyword"></extends></span></pre><div class="para">
The <code class="code"><extends/></code> tag may be specified multiple times.
</div></dd></dl></div><div class="para">
For a component of type <code class="literal">addon</code>, the following tags are required and must be present: <a class="xref" href="sect-Metadata-Addon.html#tag-id-addon"><id/></a>, <a class="xref" href="chap-Metadata.html#tag-name"><name/></a>, <a class="xref" href="chap-Metadata.html#tag-summary"><summary/></a>, <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a>, <a class="xref" href="sect-Metadata-Addon.html#tag-extends"><extends/></a>.
</div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="sect-Metadata-Service.html"><strong>Prev</strong>2.5. Services</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="sect-Metadata-Fonts.html"><strong>Next</strong>2.7. Fonts</a></li></ul></body></html>
