From Fedora Project Wiki

(Writeup of
(Remove old content and replace with redirect.)
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== AppData files ==
If a package contains a GUI application, then it '''SHOULD''' also install a <code>.appdata.xml</code> file into <code>%{_datadir}/appdata/</code>. Installed <code>.appdata.xml</code> files '''MUST''' follow the [ AppData specification page], and they must correctly validate using <code>appdata-validate --relax</code>.
=== .appdata.xml file creation ===
If the package doesn't already include and install its own <code>.appdata.xml</code> file, you can make your own and sending it upstream. Benefits of sending the file upstream is that upstream can translate the file using the existing translation resources and can also modify the screenshots and descriptions as the application changes over time. You can do this by including a <code>.appdata.xml</code> file you create as a Source: (e.g. Source3: %{name}.appdata.xml) or generating it in the spec file. Here is the contents of a sample <code>.appdata.xml</code> file (comical.appdata.xml):
<?xml version="1.0" encoding="UTF-8"?>
<!-- Copyright 2014 Richard Hughes <> -->
  <id type="desktop">comical.desktop</id>
  <project_license>GPL-2.0+ and GFDL-1.3</project_license>
  <summary>A Comic Archive Reader</summary>
  <summary xml:lang="fr">Un Comic Archive Lecteur</fr>
      Comical is an easy to use and cross-platform CBR and CBZ reader which
      prefetches and caches pages for speed.
    <p xml:lang="fr">
      Comical est une CBR et CBZ lecteur facile à utiliser et
      multi-plateforme qui prélectures et caches pages pour la vitesse.
      Resized images are crisp, and you can view pages one or two at a time.
      Comical is open-source, so feel free to contribute new features!
    <p xml:lang="fr">
      Images redimensionnées sont nettes, et vous pouvez voir une ou deux pages à la fois.
      Comical est open-source, alors n'hésitez pas à apporter de nouvelles fonctionnalités!
    <screenshot type="default"></screenshot>
  <url type="homepage"></url>
The AppData file '''MUST''' be named with the same root as the .desktop file, so if the .desktop file is named <code>org.gnome.SomeApp.desktop</code> then the AppData file MUST be called <code>org.gnome.SomeApp.appdata.xml</code>.
=== app-data-validate usage ===
Although you can just include the .appdata.xml file in the package, you '''MUST''' run  <code>appdata-validate --relax</code> (in <code>%check</code> or <code>%install</code>) and have <code>BuildRequires: libappstream-glib</code>, to help ensure .appdata.xml file safety and spec-compliance. Here are some examples of usage:
appstream-util validate-relax --nonet %{buildroot}/%{_datadir}/appdata/*.appdata.xml
[[Category:Packaging guidelines]]

Latest revision as of 23:54, 22 January 2019

The current version of this document is located at Please update your bookmarks.