diff options
author | José Bollo <jose.bollo@iot.bzh> | 2016-09-19 17:59:52 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2016-09-19 17:59:52 +0200 |
commit | 970a20a55d3a7dba32360ce596e61a2b32c9f4ee (patch) | |
tree | a72cd1beb6629c9c0ab5e5a63f75c616626962c8 /doc | |
parent | 81fb32aadb02fc2be77ac25d5368c3af50b03c09 (diff) |
documentation: improve namings
Change-Id: I188c3246f7492e82cb00a1a1f6cefe56495d9224
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/writing-config.xml.html | 14 | ||||
-rw-r--r-- | doc/writing-config.xml.md | 6 |
2 files changed, 10 insertions, 10 deletions
diff --git a/doc/writing-config.xml.html b/doc/writing-config.xml.html index 152b68e..2024b94 100644 --- a/doc/writing-config.xml.html +++ b/doc/writing-config.xml.html @@ -53,7 +53,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <header> <h1 class="title">Writing the configuration file "config.xml"</h1> <h2 class="author">José Bollo</h2> -<h3 class="date">12 septembre 2016</h3> +<h3 class="date">19 septembre 2016</h3> </header> <nav id="TOC"> <ul> @@ -68,9 +68,9 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <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-nameurnagldefined-permissions">feature name="urn:AGL:defined-permissions"</a></li> +<li><a href="#feature-nameurnaglrequired-permission">feature name="urn:AGL:required-permission"</a></li> +<li><a href="#feature-nameurnaglprovided-binding">feature name="urn:AGL:provided-binding"</a></li> +<li><a href="#feature-nameurnagldefined-permission">feature name="urn:AGL:defined-permission"</a></li> </ul></li> </ul></li> </ul> @@ -144,7 +144,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <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> +<h3 id="feature-nameurnaglrequired-permission">feature name="urn:AGL:required-permission"</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> @@ -153,7 +153,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <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> +<h3 id="feature-nameurnaglprovided-binding">feature name="urn:AGL:provided-binding"</h3> <p>Use this feature for each provided binding of the widget. The parameters are:</p> <h4 id="param-namename">param name="name"</h4> <p>REQUIRED</p> @@ -175,7 +175,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf <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-nameurnagldefined-permissions">feature name="urn:AGL:defined-permissions"</h3> +<h3 id="feature-nameurnagldefined-permission">feature name="urn:AGL:defined-permission"</h3> <p>Each required permission must be explicited using a <param> entry.</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> diff --git a/doc/writing-config.xml.md b/doc/writing-config.xml.md index 0c0a1ac..f74f8bc 100644 --- a/doc/writing-config.xml.md +++ b/doc/writing-config.xml.md @@ -153,7 +153,7 @@ The value is either: isn't required (required="false") and in that case it is optional. - optional: the binding is optional -### feature name="urn:AGL:required-permissions" +### feature name="urn:AGL:required-permission" List of the permissions required by the widget. @@ -167,7 +167,7 @@ The value is either: isn't required (required="false") and in that case it is optional. - optional: the permission is optional -### feature name="urn:AGL:provides-binding" +### feature name="urn:AGL:provided-binding" Use this feature for each provided binding of the widget. The parameters are: @@ -208,7 +208,7 @@ OPTIONAL The value is a space separated list of binding's names that the binding needs. -### feature name="urn:AGL:defined-permissions" +### feature name="urn:AGL:defined-permission" Each required permission must be explicited using a <param> entry. |