/usr/share/doc/appstream/html/chap-Quickstart.html is in appstream-doc 0.10.6-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | <?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">Chapter 4. Metadata Quickstart</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.10-en-US-0.0-0" /><link rel="home" href="index.html" title="AppStream" /><link rel="up" href="index.html" title="AppStream" /><link rel="prev" href="sect-AppStream-IconCache.html" title="3.3. Icon Cache" /><link rel="next" href="sect-Quickstart-Addons.html" title="4.2. For upstream projects providing addons" /></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-AppStream-IconCache.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Quickstart-Addons.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="chapter" lang="en-US"><div class="titlepage"><div><div><h1 class="title"><a id="chap-Quickstart">
</a>Chapter 4. Metadata Quickstart</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="chap-Quickstart.html#sect-Quickstart-DesktopApps">4.1. For GUI application upstream maintainers</a></span></dt><dt><span class="section"><a href="sect-Quickstart-Addons.html">4.2. For upstream projects providing addons</a></span></dt><dt><span class="section"><a href="sect-Quickstart-Translation.html">4.3. Translating Metadata</a></span></dt></dl></div><div class="para">
These pages are designed to give upstream authors compressed information on how to write metadata for their applications. The documents describe just the basic information, and don't resemble the whole specification, to give upstreams an easy way to get started with AppStream.
</div><div xml:lang="en-US" class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a id="sect-Quickstart-DesktopApps">
</a>4.1. For GUI application upstream maintainers</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="qsr-app-introduction">
</a>4.1.1. Introduction</h3></div></div></div><div class="para">
Every software center that exists allows the user to look at screenshots and a long description of the application before it is installed. For most users it allows them to answer the question <span class="quote">“<span class="quote">Do I want to install this application?</span>”</span>. Traditionally in Linux distributions, we have none of this data for the vast majority of our desktop user-installable applications. The packages-descriptions are describing all contents of a package, and not just a single application. They are also often written in a technical language and refer to other packages, which makes it hard for beginners to understand what the application they want to install really does. Additionally, if you are not using Debian or Ubuntu, the package descriptions are often untranslated. Also, packages do not provide some metadata users might be interested in before installing an application.
</div><div class="para">
To solve this, we have defined a new data file, which the upstream project can optionally translate using the same technique as <a href="http://standards.freedesktop.org/desktop-entry-spec/latest/">Desktop files</a> or GSetting schemas. The AppData specification is a subset of the AppStream metadata (see <a class="xref" href="chap-CollectionData.html#sect-AppStream-XML">Section 3.1, “AppStream collection XML”</a>) and extends the generic component metadata with fields specific for applications (see <a class="xref" href="chap-Metadata.html#sect-Metadata-GenericComponent">Section 2.1, “Generic Component”</a>).
</div><div class="para">
The AppData files override any values which are automatically fetched by the AppStream data generator. Applications can ship one or more files in <code class="filename">/usr/share/metainfo/%{id}.appdata.xml</code>.
</div><div class="para">
AppData files can - just like all other metainfo files - be translated. See the section about translation for more information about that.
</div><div xmlns:d="http://docbook.org/ns/docbook" class="note"><div class="admonition_header"><p><strong>Note</strong></p></div><div class="admonition"><div class="para">
All tags defined in the generic component specification are valid in AppData as well, an application is just defined as a specialized component, which has the additional benefit of being displayed in a software-center application.
</div></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="qsr-app-example">
</a>4.1.2. Example file</h3></div></div></div><div class="para">
The file should contain something 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_Comment"><!-- Copyright 2013 First Lastname <your@email.com> --></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">"desktop-application"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><id></span>org.gnome.gnome-power-statistics<span xmlns="" class="perl_Keyword"></id></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><metadata_license></span>CC0<span xmlns="" class="perl_Keyword"></metadata_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><project_license></span>GPL-2.0+<span xmlns="" class="perl_Keyword"></project_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><name></span>Power Statistics<span xmlns="" class="perl_Keyword"></name></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><summary></span>Observe power management<span xmlns="" class="perl_Keyword"></summary></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> Power Statistics is a program used to view historical and current battery
<span xmlns="" class="line"></span> information and will show programs running on your computer using power.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>Example list:<span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><ul></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><li></span>First item<span xmlns="" class="perl_Keyword"></li></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><li></span>Second item<span xmlns="" class="perl_Keyword"></li></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></ul></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> You probably only need to install this application if you are having problems
<span xmlns="" class="line"></span> with your laptop battery, or are trying to work out what programs are using
<span xmlns="" class="line"></span> significant amounts of power.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></description></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><screenshots></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><screenshot</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"default"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><caption></span>The options dialog<span xmlns="" class="perl_Keyword"></caption></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><image></span>http://www.hughsie.com/en_US/main.png<span xmlns="" class="perl_Keyword"></image></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></screenshot></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><screenshot></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><image></span>http://www.hughsie.com/en_US/preferences.png<span xmlns="" class="perl_Keyword"></image></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></screenshot></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></screenshots></span>
<span xmlns="" class="line"></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://www.gnome.org/projects/en_US/gnome-power-manager<span xmlns="" class="perl_Keyword"></url></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><project_group></span>GNOME<span xmlns="" class="perl_Keyword"></project_group></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><provides></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><binary></span>gnome-power-statistics<span xmlns="" class="perl_Keyword"></binary></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></provides></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><releases></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><release</span><span xmlns="" class="perl_Others"> version=</span><span xmlns="" class="perl_String">"3.12.2"</span><span xmlns="" class="perl_Others"> date=</span><span xmlns="" class="perl_String">"2013-04-12"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>Fixes issues X, Y and Z<span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></release></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></releases></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="qsr-app-contents">
</a>4.1.3. Recommended metadata file contents</h3></div></div></div><div class="para">
This is a list of tags you might want to define for your application. For a full list of all possible tags, take a look at the definition of a generic component (<a class="xref" href="chap-Metadata.html#spec-component-filespec">Section 2.1.3, “XML Specification”</a>) and an application-component (<a class="xref" href="sect-Metadata-Application.html#spec-appdata-filespec">Section 2.2.2, “File specification”</a>).
</div><div class="variablelist"><dl class="variablelist"><dt><span class="term"><id/></span></dt><dd><div class="para">
For applications, the <code class="code"><id/></code> tag value must be the same name as the installed <code class="filename">.desktop</code> file for the application, the <code class="filename">.desktop</code> suffix of the filename may be omitted.
</div><div class="para">
Usually, modern <code class="filename">.desktop</code> files follow the reverse-DNS scheme name already. If they do not follow the scheme, it is strongly recommended to change the <code class="filename">.desktop</code> filename. Refer to <a href="https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s02.html">the desktop entry specification</a> for more information.
</div><div class="para">
Example: If your application's <code class="filename">.desktop</code> file is named <code class="filename">org.example.FooBar.desktop</code> the component-id must be <code class="code">org.example.FooBar</code> (or <code class="code">org.example.FooBar.desktop</code>). If your application's <code class="filename">.desktop</code> file is named <code class="filename">frobnicator.desktop</code> the component-id must be <code class="code">frobnicator</code> (or <code class="code">frobnicator.desktop</code>) - it is highly recommended to modernize the <code class="filename">.desktop</code> filename to follow the Desktop Entry specification in these cases though.
</div></dd><dt><span class="term"><metadata_license/></span></dt><dd><div class="para">
The <code class="code"><metadata_license/></code> tag is indicating the content license that you are releasing the one metadata file as. This is not typically the same as the project license. By ommitting the license value would probably mean your data would not be incorporated into the distribution metadata. Permissible license codes include:
</div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para">
CC0-1.0
</div></li><li class="listitem"><div class="para">
CC-BY-3.0
</div></li><li class="listitem"><div class="para">
CC-BY-SA-3.0
</div></li><li class="listitem"><div class="para">
GFDL-1.3
</div></li><li class="listitem"><div class="para">
MIT
</div></li></ul></div><div class="para">
The license codes correspond to the identifiers found at the <a href="http://spdx.org/licenses/">SPDX OpenSource License Registry</a>. Take a look at <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a> for more details about this tag.
</div></dd><dt><span class="term"><project_license/></span></dt><dd><div class="para">
The <code class="literal"><project_license/></code> tag is indicating the license(s) this application is released under. Take a look at the specification of the <a class="xref" href="chap-Metadata.html#tag-project_license"><project_license/></a> tag for details on how to properly use it.
</div></dd><dt><span class="term"><name/></span></dt><dd><div class="para">
While this tag is always requited for a generic component, for an application metainfo file it is not necessary, but only recommended. You can omit this tag if you want the software center to have the same strings as defined in the <code class="literal">Name</code> field of the <code class="filename">.desktop</code> file. In some cases it might be required to have a different name in the software center, but most metainfo files will not need this.
</div><div class="para">
If no <code class="literal">name</code> tag and no <code class="literal">Name</code> field is present, the metadata is considered invalid and might be ignored by the AppStream generator.
</div></dd><dt><span class="term"><summary/></span></dt><dd><div class="para">
While this tag is always requited for a generic component, for a <code class="literal">desktop-application</code> metainfo file it is only essential if the accompanying <code class="filename">.desktop</code> file does not have a <code class="literal">Comment=</code> field. If the metainfo file has a <code class="literal">summary</code>, it wil override the value found in the <code class="literal">Comment</code> field of the <code class="filename">.desktop</code> file.
</div><div class="para">
If no <code class="literal">summary</code> tag and no <code class="literal">Comment</code> field is present, the metadata is considered invalid and might be ignored by the AppStream generator.
</div></dd><dt><span class="term"><description/></span></dt><dd><div class="para">
The long description is an important part of the file. Important things to consider when writing the application description:
</div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para">
Include 2-3 paragraphs of interesting easy to read prose.
</div></li><li class="listitem"><div class="para">
Ensure you provide a description of what the application actually does.
</div></li><li class="listitem"><div class="para">
Describe any important features.
</div></li><li class="listitem"><div class="para">
Do not use possily trademarked product names when refering to competitors.
</div></li><li class="listitem"><div class="para">
Break down each paragraph into easily translated paragraphs.
</div></li><li class="listitem"><div class="para">
Use lists sparingly.
</div></li><li class="listitem"><div class="para">
Never refer to installable items as packages.
</div></li><li class="listitem"><div class="para">
Never start the first sentence with "This application..."
</div></li><li class="listitem"><div class="para">
Try not use more than 100 words.
</div></li><li class="listitem"><div class="para">
Do not be too geeky. Aim for an intelligent semi-technical reader.
</div></li><li class="listitem"><div class="para">
Don't mention what language an application is written in, users don't care
</div></li><li class="listitem"><div class="para">
Only mention what the application can do now, rather than what is planned
</div></li></ul></div><div class="para">
Do not assume the format is HTML. Only paragraph, ordered list and unordered list are supported at this time.
</div><div class="para">
In metainfo files, this tag should be translated by-paragraph, meaning that in a translated file, each translated <code class="literal"><p/></code> child has a language property.
</div></dd><dt><a id="qsr-app-screenshots-info">
</a><span class="term"><screenshots/></span></dt><dd><div class="para">
A screenshot presents your application to the outside world, and could be seen by hundreds or thousands of people.
</div><div class="para">
The <code class="code"><screenshots/></code> tag contains multiple <code class="code"><screenshot/></code> children, where at least one of them must have the property <code class="code">type="default"</code> to indicate the application's primary screenshot. Every <code class="code"><screenshot/></code> tag must have at least one <code class="code"><image/></code> child, which may define the width and height of the referenced image in it's properties. The value of the <code class="code"><image/></code> tag is a direct URL to a screenshot uploaded to a public location on the web.
</div><div class="para">
Optionally, a <code class="code"><screenshot/></code> tag may have a <code class="code"><caption/></code> child, defining a short (not more than 180 characters!) description of what the user can see on the referenced screenshot.
</div><div class="para">
Screenshots are an important part of how people choose which applications to install, so it's important to get them right. Consistent, good looking screenshots will make your application look more attractive and will expand your userbase. Consistent screenshots also provide a more predictable experience for people using the software center.
</div><div class="para">
Screenshot size, shape and format:
</div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para">
All screenshots should have a 16:9 aspect ratio, and should have a width that is no smaller than 620px (software center applications will be able to fill in the screenshots in the space they provide for that more easily then).
</div><div class="para">
Ideally the window will be resized to a 16:9 aspect ratio, but screenshots can also be cropped if only a small area of the window needs to be shown.
</div></li><li class="listitem"><div class="para">
Screenshots should be in PNG or JPEG format. PNG is the preferred format; JPEG should only be used when screenshots include large photographs or other images where a lossy format like JPEG may compress better.
</div></li><li class="listitem"><div class="para">
Do not scale screenshots below their original size.
</div></li></ul></div><div class="para">
Basic guidelines for things to include (and not include) in your screenshots:
</div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para">
Use the default visual and theme settings, including the default font, icons, and window controls. Avoid including your own tweaks to the standard distribution offering.
</div></li><li class="listitem"><div class="para">
Screenshots should be taken with English as the display language.
</div></li><li class="listitem"><div class="para">
Your default screenshot should give an overview of your application, and should show an entire application window. It can be combined with screenshots which show specific aspects of the application.
</div></li><li class="listitem"><div class="para">
Screenshots should not show anything outside the application's windows (including the background wallpaper). If you are taking a screenshot of the whole window, use your screenshot tool's "window" mode (including any window borders in the screenshot, and ensuring that the resulting image has an alpha mask for the rounded corners).
</div></li><li class="listitem"><div class="para">
Some applications, such as games, primarily run full screen. Screenshots of these applications should be taken with the application running full screen - there should be no visible window controls in the screenshot.
</div></li><li class="listitem"><div class="para">
Don't add shadows to your screenshots.
</div></li><li class="listitem"><div class="para">
Do not include content that might be considered offensive or controversial, and avoid showing personal information. Remember that your screenshots will be visible to the internet at large.
</div></li></ul></div><div class="para">
Additional advice on how to take effective screenshots:
</div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para">
Each of your screenshots should focus on one thing and one thing only. Screenshot one window at a time, and avoid having overlapping windows or user interface elements. This will make it much easier for people to understand what you are showing them.
</div></li><li class="listitem"><div class="para">
If a screenshot is demonstrating a single feature or aspect of the application, crop it to exclude irrelevant detail.
</div></li><li class="listitem"><div class="para">
Screenshots often need to feature content, such as images, documents, web pages or videos. Don’t show your application in an ‘empty’ state, and try and use high quality content which has positive associations and broad appeal.
</div></li><li class="listitem"><div class="para">
In general, you shouldn't include the mouse pointer in your screenshots.
</div></li></ul></div><div class="para">
Some advice for a good screenshot caption:
</div><div xmlns:d="http://docbook.org/ns/docbook" class="itemizedlist"><ul><li class="listitem"><div class="para">
The caption should be short. Try not to use more than a few words to describe the image.
</div></li><li class="listitem"><div class="para">
Try not to state the obvious: "Main window displaying an image" is something the user can see on the screenshot already.
</div></li><li class="listitem"><div class="para">
Try not to repeat the application's name in the caption.
</div></li><li class="listitem"><div class="para">
Do not end your caption with a fullstop.
</div></li></ul></div><div class="para">
Some examples of good and bad screenshot choices:
</div><div class="informaltable"><table xmlns:d="http://docbook.org/ns/docbook" class="lt-4-cols lt-7-rows"><colgroup><col width="48px" /><col width="48px" /></colgroup><tbody><tr><td> <div class="mediaobject"><img src="images/scr-examples/xterm-bad.png" /><div class="caption"><div class="para">
<span class="bold bold"><strong>BAD:</strong></span> Not on Linux
</div></div></div>
</td><td> <div class="mediaobject"><img src="images/scr-examples/geany-good.png" /><div class="caption"><div class="para">
<span class="bold bold"><strong>GOOD</strong></span>
</div></div></div>
</td></tr><tr><td> <div class="mediaobject"><img src="images/scr-examples/xmedcon-bad.png" /><div class="caption"><div class="para">
<span class="bold bold"><strong>BAD:</strong></span> Not 16:9, shows the whole desktop and too many small windows
</div></div></div>
</td><td> <div class="mediaobject"><img src="images/scr-examples/xonotic-good.png" /><div class="caption"><div class="para">
<span class="bold bold"><strong>GOOD:</strong></span> No window border required for fullscreen game
</div></div></div>
</td></tr><tr><td> <div class="mediaobject"><img src="images/scr-examples/gameconqueror-bad.png" /><div class="caption"><div class="para">
<span class="bold bold"><strong>BAD:</strong></span> Uses custom font, custom color theme and is not 16:9
</div></div></div>
</td><td> <div class="mediaobject"><img src="images/scr-examples/wireshark-good.png" /><div class="caption"><div class="para">
<span class="bold bold"><strong>GOOD</strong></span>
</div></div></div>
</td></tr></tbody></table></div></dd><dt><span class="term"><url/></span></dt><dd><div class="para">
This is a recommended tag for links of type <code class="code">homepage</code>. Links of type <code class="code">homepage</code> should be a link to the upstream homepage for the application.
</div><div class="para">
For other possible values, tage a look at the tag's description at <a class="xref" href="chap-Metadata.html#tag-url"><url/></a>.
</div></dd><dt><span class="term"><project_group/></span></dt><dd><div class="para">
This tag is described for generic components at <a class="xref" href="chap-Metadata.html#tag-project_group"><project_group/></a>. You should use it for your application if appropriate.
</div></dd><dt><span class="term"><developer_name/></span></dt><dd><div class="para">
The <code class="code"><developer_name/></code> tag is designed to represent the developers or project responsible for development of the project described in the metadata.
</div><div class="para">
Values might be for example "The GNOME Foundation" or "The KDE Community". You must not include hyperlinks or emails in this field, if you want to link to the developer's homepage, use the <a class="xref" href="chap-Metadata.html#tag-url"><url/></a>-tag instead.
</div><div class="para">
This tag is translatable.
</div></dd><dt><span class="term"><update_contact/></span></dt><dd><div class="para">
The <code class="code"><update_contact/></code> tag is an optional tag which can be added to provide an email address distributors can use to contact the project about invalid or incomplete metadata, or in case the specification has changed, about old metadata. It can also be used to ask general questions in case of an update of the component described in the metadata file. Spam protection using <code class="code">_AT_</code> is valid.
</div><div class="para">
Example:
</div><pre class="programlisting"><span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><update_contact></span>developer_AT_example.com<span xmlns="" class="perl_Keyword"></update_contact></span></pre></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="qsr-app-contents-suggestions">
</a>4.1.4. Suggested metadata file contents</h3></div></div></div><div class="para">
It is useful to add these tags as well if they make sense for the described application. They are not strictly required to be present though.
</div><div class="variablelist"><dl class="variablelist"><dt><span class="term"><releases/></span></dt><dd><div class="para">
The application metainfo may include one <code class="code"><releases/></code> tag, which has one or multiple <code class="code"><release/></code> subnodes to define the version and release date of this application. For details, see <a class="xref" href="chap-Metadata.html#tag-releases"><releases/></a> .
</div><div class="para">
It is very useful to attach short release-notes to a <code class="code"><release/></code> using the <code class="code"><description/></code> subnode. These release-notes should contain brief information about what is new in the release, in a way which is understandable by non-technical users.
</div></dd><dt><span class="term"><provides/></span></dt><dd><div class="para">
This tag is described in detail for generic components at <a class="xref" href="chap-Metadata.html#tag-provides"><provides/></a>.
</div><div class="para">
If your application ships a binary in a location in the default <code class="envar">PATH</code>, it is useful to add at least a child of type <code class="code"><binary/></code> to make it easily possible to find your application's metadata using the name of its binary.
</div></dd></dl></div></div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="sect-AppStream-IconCache.html"><strong>Prev</strong>3.3. Icon Cache</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-Quickstart-Addons.html"><strong>Next</strong>4.2. For upstream projects providing addons</a></li></ul></body></html>
|