From 4a1409460a7c0a5d26fe10b5f84368b3cb8b8b5a Mon Sep 17 00:00:00 2001 From: José Bollo Date: Wed, 26 Oct 2016 18:24:13 +0200 Subject: doc: switch to mkdocs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: José Bollo --- doc/writing-config.xml.html | 190 -------------------------------------------- 1 file changed, 190 deletions(-) delete mode 100644 doc/writing-config.xml.html (limited to 'doc/writing-config.xml.html') diff --git a/doc/writing-config.xml.html b/doc/writing-config.xml.html deleted file mode 100644 index 2024b94..0000000 --- a/doc/writing-config.xml.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - - Writing the configuration file "config.xml" - - - - - - -

Writing the configuration file "config.xml"

José Bollo

19 septembre 2016

- -

Writing the configuration file "config.xml"

About "config.xml"

The file config.xml describes important data of the application to the framework:

the unique identifier of the application
the name of the application
the type of the application
the icon of the application
the permissions linked to the application
the services and dependancies of the application

The file MUST be at the root of the widget and MUST be case sensitively name config.xml.

The file config.xml is a XML file described by the document widgets.

Example of "config.xml"

Here is the example of the config file for the QML application SmartHome.

<?xml version="1.0" encoding="UTF-8"?>
-<widget xmlns="http://www.w3.org/ns/widgets" id="smarthome" version="0.1">
-  <name>SmartHome</name>
-  <icon src="smarthome.png"/>
-  <content src="qml/smarthome/smarthome.qml" type="text/vnd.qt.qml"/>
-  <description>
-    This is the Smarthome QML demo application.
-    It shows some user interfaces for controlling an automated house.
-    The user interface is completely done with QML.
-  </description>
-  <author>Qt team</author>
-  <license>GPL</license>
-</widget>

Standard elements of "config.xml"

- - -

The attribute id is mandatory (for version 2.x, blowfish) and must be unique.

Values for id are any non empty string containing only latin letters, arabic digits, and the three characters '.' (dot), '-' (dash) and '_' (underscore).

Authors can use a mnemonic id or can pick a unique id using command uuid or uuidgen.

- -

The attribute version is mandatory (for version 2.x, blowfish).

Values for id are any non empty string containing only latin letters, arabic digits, and the three characters '.' (dot), '-' (dash) and '_' (underscore).

Version values are dot separated fields MAJOR.MINOR.REVISION.

The element content

The element content is mandatory (for version 2.x, blowfish) and must designate a file (subject to localisation) with its attribute src.

The content designed depends on its type. See below for the known types.

The element icon

The element icon is mandatory (for version 2.x, blowfish) and must be unique. It must designate an image file with its attribute src.

- -

The configuration file /etc/afm/afm-launch.conf defines the types of widget known and how to launch it.

Known types for the type of content are (for version 2.x, blowfish):

text/html: HTML application, content.src designates the home page of the application
application/x-executable: Native application, content.src designates the relative path of the binary
application/vnd.agl.url: Internet url, content.src designates the url to be used
application/vnd.agl.service: AGL service defined as a binder, content.src designates the directory of provided binders, http content, if any, must be put in the subdirectory htdocs of the widget
application/vnd.agl.native: Native application with AGL service defined as a binder, content.src designates the relative path of the binary, bindings, if any must be put in the subdirectory lib of the widget, http content, if any, must be put in the subdirectory htdocs of the widget
text/vnd.qt.qml, application/vnd.agl.qml: QML application, content.src designate the relative path of the QML root, imports must be put in the subdirectory imports of the widget
application/vnd.agl.qml.hybrid: QML application with bindings, content.src designate the relative path of the QML root, bindings, if any must be put in the subdirectory lib of the widget, imports must be put in the subdirectory imports of the widget
application/vnd.agl.html.hybrid: HTML application, content.src designates the home page of the application, bindings, if any must be put in the subdirectory lib of the widget, http content must be put in the subdirectory htdocs of the widget

AGL features

The AGL framework uses the feature tag for specifying security and binding requirement of the widget.

The current version of AGL (up to 2.0.1, blowfish) has no fully implemented features.

The features planned to be implemented are described below.

feature name="urn:AGL:required-binding"

List of the bindings required by the widget.

Each required binding must be explicited using a entry.

param name=[required binding name]

The value is either:

required: the binding is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.
optional: the binding is optional

feature name="urn:AGL:required-permission"

List of the permissions required by the widget.

Each required permission must be explicited using a entry.

param name=[required permission name]

The value is either:

required: the permission is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.
optional: the permission is optional

feature name="urn:AGL:provided-binding"

Use this feature for each provided binding of the widget. The parameters are:

param name="name"

REQUIRED

The value is the string that must match the binding prefix. It must be unique.

param name="src"

REQUIRED

The value is the path of the shared library for the binding.

param name="type"

REQUIRED

Currently it must be application/vnd.agl.binding.v1.

param name="scope"

REQUIRED

The value indicate the availability of the binidng:

private: used only by the widget
public: available to allowed clients as a remote service (requires permission+)
inline: available to allowed clients inside their binding (unsafe, requires permission+++)

param name="needed-binding"

OPTIONAL

The value is a space separated list of binding's names that the binding needs.

feature name="urn:AGL:defined-permission"

Each required permission must be explicited using a entry.

param name=[defined permission name]

The value is the level of the defined permission. Standard levels are:

system
platform
partner
public

This level defines the level of accreditation required to get the given permission. The accreditions are given by signatures of widgets.

- - -- cgit 1.2.3-korg

Writing the configuration file "config.xml"

José Bollo

19 septembre 2016

Writing the configuration file "config.xml"

About "config.xml"

Example of "config.xml"

Standard elements of "config.xml"

The element widget

the attribute id of widget

the attribute version of widget

The element content

The element icon

Known widget types and content

AGL features

feature name="urn:AGL:required-binding"

param name=[required binding name]

feature name="urn:AGL:required-permission"

param name=[required permission name]

feature name="urn:AGL:provided-binding"

param name="name"

param name="src"

param name="type"

param name="scope"

param name="needed-binding"

feature name="urn:AGL:defined-permission"

param name=[defined permission name]