Manifest Definition (pre 5.14)

Overview

The package manifest or metadata file, info.yaml, is a YAML file following the same rules as all the other YAML files used in the application manager.

While the application manager can support other file formats, such as XML, currently the only metadata loader implemented is based on YAML.

Dynamically installed applications are described by a single info.yaml file, in their root directory. Built-in applications, that are shipped as part of the System UI can optionally have multiple aliases. This behavior is similar to a Microsoft Windows shortcut, where you can start the same program using a different icon, name, and command line arguments. These files have to be in the same folder as the application's basic info.yaml file and need to be named info-<descriptive name>.yaml. See below for a description of these alias manifests.

Basic Manifest

This is an example of a full-featured info.yaml file, that also shows how you can mix and match classic YAML and JSON style in YAML 1.1 documents:

%YAML 1.1
---
formatVersion: 1
formatType: am-application
---
id: 'com.pelagicore.radio'
icon: 'FM-Radio.png'
name:
  en: "FM Radio"
  de: "UKW-Rundfunk"
code: "radio.qml"

runtime: qml
runtimeParameters: { loadDummyData: true }
documentUrl: "fm"

mimeTypes: [ "x-scheme-handler/x-radio" ]

capabilities:
- cameraAccess
- locationAccess

version: '1.2.1-alpha3'

The fields within the info.yaml file header (first YAML document) are as follows:

The fields within the info.yaml manifest data (second YAML document) are as follows:

The runtimeParameters are specific to the runtimes, so the table below has an additional column that specifies which runtime a configuration option applies to:

Alias Manifests

This is an example of an alias manifest, info-am.yaml, for the info.yaml file in the Basic Manifest. This way, you can have one single tuner application radio.qml running, that can be started using two different entries, both with different text and icons, in the application launcher.

%YAML 1.1
---
formatVersion: 1
formatType: am-application-alias
---
aliasId: 'com.pelagicore.radio@am'
icon: 'AM-Radio.png'
name:
  en: "AM Radio"
  de: "Langwellenrundfunk"

documentUrl: "x-radio://am"

If you start an alias while the application is already running, it does not start another instance. Only if a documentUrl is set, then does the instance currently running receive the ApplicationInterface::openDocument signal, that contains the respective strings that were set via the documentUrl parameter. Then, the application can change its UI accordingly. The alias manifests have to be in the same folder as the application's info.yaml file and must be named info-<descriptive name>.yaml.

The meaning of the fields within the info-am.yaml file header (first YAML document) is as follows:

The meaning of the fields within the alias manifest data (second YAML document) is as follows: