X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2F2.2-config.xml.md;h=c50567d3cb05e4a0b1b9a0fcb3280eb72bfe76e4;hb=bb31b7e66d4ab9bef791a9d87f4790f085c99a4b;hp=cccedd45c6dbb291548ff2d39fdec683ef368b52;hpb=d1b49a7d26bf344d9f00ae12144cbcc7d930b08b;p=src%2Fapp-framework-main.git diff --git a/docs/2.2-config.xml.md b/docs/2.2-config.xml.md index cccedd4..c50567d 100644 --- a/docs/2.2-config.xml.md +++ b/docs/2.2-config.xml.md @@ -75,13 +75,13 @@ arabic digits, and the three characters '.' (dot), '-' (dash) and '\_' (underscore). Version values are dot separated fields MAJOR.MINOR.REVISION. -Such version would preferabily follow guidelines of -[semantic versionning][semantic-version]. +Such version would preferably follow guidelines of +[semantic versioning][semantic-version]. ### 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*. +(subject to localization) with its attribute *src*. The content designed depends on its type. See below for the known types. @@ -104,7 +104,7 @@ the features are of important use to: - declare the expected permissions - declare the exported apis -The specification of [widgets][widgets] is intentded to describe +The specification of [widgets][widgets] is intended to describe only one application. In the present case, we expect to describe more than just an application. For example, a publisher could provide a widget containing a service, an application for tuning @@ -177,7 +177,7 @@ It is either: - link: - The framework connect in memory by dinamically linking + The framework connect in memory by dynamically linking - cloud: [PROPOSAL - NOT IMPLEMENTED] @@ -398,6 +398,7 @@ out at the moment. - ***application/vnd.agl.html.hybrid*** + The configuration file afm-unit.conf ==================================== @@ -407,7 +408,7 @@ files corresponding to the need and requirements of the installed widgets. This configuration file named `afm-unit.conf` installed -on the system wiht the path `/etc/afm/afm-unit.conf` +on the system with the path `/etc/afm/afm-unit.conf` describes how to generate all units from the *config.xml* configuration files of widgets. The description uses an extended version of the templating formalism of [mustache][] @@ -418,7 +419,7 @@ describes graphically the workflow of creating the unit files for systemd `afm-unit.conf` from the configuration file of the widget `config.xml`: -![make-units][make-units] +![make-units](pictures/make-units.svg) In a first step, and because [mustache][] is intended to work on JSON representations, the configuration file is @@ -427,15 +428,15 @@ representation is shown along the examples of the documentation of the config files of widgets. In a second step, the mustache template `afm-unit.conf` -is instanciated using the C library [mustach][] that follows +is instantiated using the C library [mustach][] that follows the rules of [mustache][mustache] and with all its available extensions: - use of colon (:) for explicit substitution - test of values with = or =! -In a third step, the result of instanciating `afm-unit.conf` -for the widget is splited in units. To achieve that goal, +In a third step, the result of instantiating `afm-unit.conf` +for the widget is split in units. To achieve that goal, the lines containing specific directives are searched. Any directive occupy one full line. The directives are: @@ -477,20 +478,13 @@ Variables starting with `X-AFM--` are private to the framework. By example, the variable `X-AFM--http-port` is used to record the allocated port for applications. - [mustach]: https://gitlab.com/jobol/mustach "basic C implementation of mustache" [mustache]: http://mustache.github.io/mustache.5.html "mustache - Logic-less templates" -[make-units]: pictures/make-units.svg [widgets]: http://www.w3.org/TR/widgets "Packaged Web Apps" [widgets-digsig]: http://www.w3.org/TR/widgets-digsig "XML Digital Signatures for Widgets" [libxml2]: http://xmlsoft.org/html/index.html "libxml2" [app-manifest]: http://www.w3.org/TR/appmanifest "Web App Manifest" - - [meta-intel]: https://github.com/01org/meta-intel-iot-security "A collection of layers providing security technologies" -[widgets]: http://www.w3.org/TR/widgets "Packaged Web Apps" -[widgets-digsig]: http://www.w3.org/TR/widgets-digsig "XML Digital Signatures for Widgets" -[libxml2]: http://xmlsoft.org/html/index.html "libxml2" [openssl]: https://www.openssl.org "OpenSSL" [xmlsec]: https://www.aleksey.com/xmlsec "XMLSec" [json-c]: https://github.com/json-c/json-c "JSON-c" @@ -498,10 +492,9 @@ record the allocated port for applications. [libzip]: http://www.nih.at/libzip "libzip" [cmake]: https://cmake.org "CMake" [security-manager]: https://wiki.tizen.org/wiki/Security/Tizen_3.X_Security_Manager "Security-Manager" -[app-manifest]: http://www.w3.org/TR/appmanifest "Web App Manifest" [tizen-security]: https://wiki.tizen.org/wiki/Security "Tizen security home page" [tizen-secu-3]: https://wiki.tizen.org/wiki/Security/Tizen_3.X_Overview "Tizen 3 security overview" -[semantic-version]: http://semver.org/ "Semantic versionning" +[semantic-version]: http://semver.org/ "Semantic versioning"