Draft/MetaInfo: Difference between revisions

Revision as of 10:13, 17 April 2014

Under Construction

This is a new page, currently under construction!

Introduction

These pages contain information on how KDE can make use of the MetaInfo data provided by the Freedesktop.org AppStream project.

Outline

MetaInfo files are used to describe a software component in a distribution. The metadata these XML files provide contains information about the public interfaces this component provides, the descriptions of the component, as well as additional things such as icon information and categorization. There are several special components, for example for applications, web-applications, fonts, codecs and input-methods. The information defined in these files is used by AppStream-compatible software centers (such as Apper or GNOME-Software) to display them to the user. In the following, we describe for different kinds of KDE software components how to write proper AppStream MetaInfo files. A project may ship multiple metadata definitions, for example if it ships an application and a library, or multiple applications.

Metadata Types

Application

Applications are (usually graphical) programs which show up in the applications menu, meaning they have a .desktop-file. You can read more about how to write metadata for them on the page about desktop-apps.

Component

A generic component is a software project which doesn't fit into a specific category. This is usually a shared library or framework which wants to publish information about the public interfaces it provides in a distribution, to make it easier for developers to find the component in the distribution's repositories. You can find information on how to write metadata for a generifc component on the page about generic components.

Web Application

Further Information

For further reading, we suggest taking a look at the AppStream documentation and it's XDG wiki page.

@@ Line 1: / Line 1: @@
 {{Construction}}
 == Introduction ==
-This page will be used to provide information on how KDE can make use of the AppData specification, in order to integrate KDE applications into software-centers based on the AppStream Freedesktop specification.
+These pages contain information on how KDE can make use of the MetaInfo data provided by the Freedesktop.org [http://www.freedesktop.org/wiki/Distributions/AppStream/ AppStream] project.
-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 Do I want to install this application?
+== Outline ==
+MetaInfo files are used to describe a software component in a distribution. The metadata these XML files provide contains information about the public interfaces this component provides, the descriptions of the component, as well as additional things such as icon information and categorization.
+There are several special components, for example for applications, web-applications, fonts, codecs and input-methods. The information defined in these files is used by AppStream-compatible software centers (such as Apper or GNOME-Software) to display them to the user.
+In the following, we describe for different kinds of KDE software components how to write proper AppStream MetaInfo files. A project may ship multiple metadata definitions, for example if it ships an application and a library, or multiple applications.
-Traditionally in Linux distributions, we have none of this data for the vast majority of our desktop user-installable applications. To solve this, a new translatable data file was defined. Rather than create a new schema from scratch, a subset of the [http://www.freedesktop.org/software/appstream/docs/chap-AppStream-Metadata.html AppStream] metadata proposal is used.
+== Metadata Types ==
+=== Application ===
+Applications are (usually graphical) programs which show up in the applications menu, meaning they have a .desktop-file.
+You can read more about how to write metadata for them on [[/DesktopApps|the page about desktop-apps]].
+=== Component ===
+A generic component is a software project which doesn't fit into a specific category. This is usually a shared library or framework which wants to publish information about the public interfaces it provides in a distribution, to make it easier for developers to find the component in the distribution's repositories.
+You can find information on how to write metadata for a generifc component on  [[/Components|the page about generic components]].
+=== Web Application ===
+== Further Information ==
+For further reading, we suggest taking a look at the [http://www.freedesktop.org/software/appstream/docs/ AppStream documentation] and it's XDG [http://www.freedesktop.org/wiki/Distributions/AppStream/ wiki page].