diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2016-09-19 12:34:51 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2016-09-19 12:34:51 +0200 |
| commit | 81fb32aadb02fc2be77ac25d5368c3af50b03c09 (patch) | |
| tree | aeda1cdb5718e957e7bef3c706f7059995c36919 /doc | |
| parent | 028707375969d857cf3fd1e73069592d09ec851e (diff) | |
documentation: adds required-binding entry
Change-Id: Id8a62f5f6d9e54399fc12e10e922bf1ca121eb49
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/writing-config.xml.html | 52 | ||||
| -rw-r--r-- | doc/writing-config.xml.md | 54 |
2 files changed, 72 insertions, 34 deletions
diff --git a/doc/writing-config.xml.html b/doc/writing-config.xml.html index 35c7372..152b68e 100644 --- a/doc/writing-config.xml.html +++ b/doc/writing-config.xml.html @@ -4,6 +4,7 @@ <meta charset="utf-8"> <meta name="generator" content="pandoc"> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> + <meta name="author" content="José Bollo"> <title>Writing the configuration file "config.xml"</title> <style type="text/css">code{white-space: pre;}</style> <style type="text/css"> @@ -51,7 +52,8 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <body> <header> <h1 class="title">Writing the configuration file "config.xml"</h1> -<h3 class="date">02 septembre 2016</h3> +<h2 class="author">José Bollo</h2> +<h3 class="date">12 septembre 2016</h3> </header> <nav id="TOC"> <ul> @@ -65,9 +67,10 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf </ul></li> <li><a href="#known-widget-types-and-content">Known widget types and content</a></li> <li><a href="#agl-features">AGL features</a><ul> +<li><a href="#feature-nameurnaglrequired-binding">feature name="urn:AGL:required-binding"</a></li> +<li><a href="#feature-nameurnaglrequired-permissions">feature name="urn:AGL:required-permissions"</a></li> <li><a href="#feature-nameurnaglprovides-binding">feature name="urn:AGL:provides-binding"</a></li> -<li><a href="#feature-nameurnaglrequired-permission">feature name="urn:AGL:required-permission"</a></li> -<li><a href="#feature-nameurnagl-permission">feature name="urn:AGL:-permission"</a></li> +<li><a href="#feature-nameurnagldefined-permissions">feature name="urn:AGL:defined-permissions"</a></li> </ul></li> </ul></li> </ul> @@ -132,18 +135,36 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <p>The AGL framework uses the feature tag for specifying security and binding requirement of the widget.</p> <p>The current version of AGL (up to 2.0.1, blowfish) has no fully implemented features.</p> <p>The features planned to be implemented are described below.</p> +<h3 id="feature-nameurnaglrequired-binding">feature name="urn:AGL:required-binding"</h3> +<p>List of the bindings required by the widget.</p> +<p>Each required binding must be explicited using a <param> entry.</p> +<h4 id="param-namerequired-binding-name">param name=[required binding name]</h4> +<p>The value is either:</p> +<ul> +<li>required: the binding is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.</li> +<li>optional: the binding is optional</li> +</ul> +<h3 id="feature-nameurnaglrequired-permissions">feature name="urn:AGL:required-permissions"</h3> +<p>List of the permissions required by the widget.</p> +<p>Each required permission must be explicited using a <param> entry.</p> +<h4 id="param-namerequired-permission-name">param name=[required permission name]</h4> +<p>The value is either:</p> +<ul> +<li>required: the permission is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.</li> +<li>optional: the permission is optional</li> +</ul> <h3 id="feature-nameurnaglprovides-binding">feature name="urn:AGL:provides-binding"</h3> <p>Use this feature for each provided binding of the widget. The parameters are:</p> -<h5 id="param-namename">param name="name"</h5> +<h4 id="param-namename">param name="name"</h4> <p>REQUIRED</p> <p>The value is the string that must match the binding prefix. It must be unique.</p> -<h5 id="param-namesrc">param name="src"</h5> +<h4 id="param-namesrc">param name="src"</h4> <p>REQUIRED</p> <p>The value is the path of the shared library for the binding.</p> -<h5 id="param-nametype">param name="type"</h5> +<h4 id="param-nametype">param name="type"</h4> <p>REQUIRED</p> <p>Currently it must be <strong><em>application/vnd.agl.binding.v1</em></strong>.</p> -<h5 id="param-namescope">param name="scope"</h5> +<h4 id="param-namescope">param name="scope"</h4> <p>REQUIRED</p> <p>The value indicate the availability of the binidng:</p> <ul> @@ -151,18 +172,19 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <li>public: available to allowed clients as a remote service (requires permission+)</li> <li>inline: available to allowed clients inside their binding (unsafe, requires permission+++)</li> </ul> -<h5 id="param-nameneeded-binding">param name="needed-binding"</h5> +<h4 id="param-nameneeded-binding">param name="needed-binding"</h4> <p>OPTIONAL</p> <p>The value is a space separated list of binding's names that the binding needs.</p> -<h3 id="feature-nameurnaglrequired-permission">feature name="urn:AGL:required-permission"</h3> -<p>Several permission can be listed or none whether no permission is requested for the widget.</p> +<h3 id="feature-nameurnagldefined-permissions">feature name="urn:AGL:defined-permissions"</h3> <p>Each required permission must be explicited using a <param> entry.</p> -<h5 id="param-namerequired-permission-name">param name=[required permission name]</h5> -<p>The value is either:</p> +<h4 id="param-namedefined-permission-name">param name=[defined permission name]</h4> +<p>The value is the level of the defined permission. Standard levels are:</p> <ul> -<li>required: the permission is really needed.</li> -<li>optional: the permission isn't mandatory</li> +<li>system</li> +<li>platform</li> +<li>partner</li> +<li>public</li> </ul> -<h3 id="feature-nameurnagl-permission">feature name="urn:AGL:-permission"</h3> +<p>This level defines the level of accreditation required to get the given permission. The accreditions are given by signatures of widgets.</p> </body> </html> diff --git a/doc/writing-config.xml.md b/doc/writing-config.xml.md index 9010112..0c0a1ac 100644 --- a/doc/writing-config.xml.md +++ b/doc/writing-config.xml.md @@ -139,6 +139,34 @@ 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 <param> 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-permissions" + +List of the permissions required by the widget. + +Each required permission must be explicited using a <param> 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:provides-binding" Use this feature for each provided binding of the widget. @@ -180,34 +208,22 @@ OPTIONAL The value is a space separated list of binding's names that the binding needs. -### feature name="urn:AGL:required-permissions" - -List of the permissions required by the widget. - -Each required permission must be explicited using a <param> 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:defined-permissions" Each required permission must be explicited using a <param> entry. #### param name=[defined permission name] -The value is the level of the defined permission: +The value is the level of the defined permission. +Standard levels are: -- system: -- platform: +- system +- platform - partner -- public: - +- public +This level defines the level of accreditation required to get the given +permission. The accreditions are given by signatures of widgets. |