1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
<?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>2.3. 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 name="generator" content="publican 3.2.1" /><meta name="package" content="AppStream-AppStream-0.7-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-Application.html" title="2.2. Desktop Applications" /><link rel="next" href="sect-Metadata-Codec.html" title="2.4. Codecs" /></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-Application.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Metadata-Codec.html"><strong>Next</strong></a></li></ul><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="sect-Metadata-Addon"></a>2.3. Addons</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-addondata-introduction"></a>2.3.1. Introduction</h3></div></div></div><div class="para">
Some software is not standalone, but rather extends existing software installed on the system. The "Addon" 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/appdata/%{id}.metainfo.xml</code>.
</div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-addoncdata-example"></a>2.3.2. Example file</h3></div></div></div><div class="para">
A addon meta-info file should look like this:
</div><pre class="programlisting">
<span class="perl_Keyword"><?xml</span> version="1.0" encoding="UTF-8"<span class="perl_Keyword">?></span>
<span class="perl_Keyword"><component</span><span class="perl_Others"> type=</span><span class="perl_String">"addon"</span><span class="perl_Keyword">></span>
<span class="perl_Keyword"><id></span>gedit-code-assistance<span class="perl_Keyword"></id></span>
<span class="perl_Keyword"><extends></span>gedit.desktop<span class="perl_Keyword"></extends></span>
<span class="perl_Keyword"><name></span>Code Assistance<span class="perl_Keyword"></name></span>
<span class="perl_Keyword"><summary></span>Code assistance for C, C++ and Objective-C<span class="perl_Keyword"></summary></span>
<span class="perl_Keyword"><url</span><span class="perl_Others"> type=</span><span class="perl_String">"homepage"</span><span class="perl_Keyword">></span>http://projects.gnome.org/gedit<span class="perl_Keyword"></url></span>
<span class="perl_Keyword"><metadata_license></span>CC0-1.0<span class="perl_Keyword"></metadata_license></span>
<span class="perl_Keyword"><project_license></span>GPL-3.0+<span class="perl_Keyword"></project_license></span>
<span 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.3.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 identified this metainfo document as describing an addon to an existing software.
</div><div class="variablelist"><dl class="variablelist"><dt><span class="term"><id/></span></dt><dd><div class="para">
For addons, there are no special requirements for what their <code class="literal">%{id}</code> should be. You might want to prefix your id with "addon-" though, to make it easily recognizable.
</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">
So for example if I have a plugin "kipi" which extends the application "Gwenview", I need to refer to it's identifier like:
</div><pre class="programlisting"><span class="perl_Keyword"><extends></span>gwenview.desktop<span 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="chap-Metadata.html#tag-id-generic"><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-Application.html"><strong>Prev</strong>2.2. Desktop Applications</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-Codec.html"><strong>Next</strong>2.4. Codecs</a></li></ul></body></html>
|
