ll-database-binding/conf.d/app-templates/samples.d/config.xml.in.sample

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <widget xmlns="http://www.w3.org/ns/widgets" id="@PROJECT_NAME@" version="@PROJECT_VERSION@">
   3         <name>@PROJECT_NAME@</name>
   4         <icon src="@PROJECT_ICON@"/>
   5         <content src="@WIDGET_ENTRY_POINT@" type="@WIDGET_TYPE@"/>
   6         <description>@PROJECT_DESCRIPTION@</description>
   7         <author>@PROJECT_AUTHOR@ &lt;@PROJECT_AUTHOR_MAIL@&gt;</author>
   8         <license>@PROJECT_LICENSE@</license>
   9
  10 <!-- Feature : required-api ------------------------------------------------------
  11 #### param name="#target" OPTIONAL
  12
  13 Declares the name of the unit requiring the listed apis.
  14 Only one instance of the param "#target" is allowed.
  15 When there is not instance of this param, it behave as if
  16 the target main was specified.
  17
  18 #### param name=[required api name]
  19
  20 The name is the name of the required API.
  21 The value describes how to connect to the required api.
  22 It is either:
  23
  24  - local: The binding is a local shared object.
  25         In that case, the name is the relative path of the
  26         shared object to be loaded.
  27  - auto: The framework set automatically the kind of
  28         the connection to the API
  29  - ws: The framework connect using internal websockets
  30  - dbus: The framework connect using internal dbus
  31  - link: The framework connect in memory by dinamically linking
  32
  33 Example:
  34         <feature name="urn:AGL:widget:required-api">
  35                 <param name="#target" value="low-can" />
  36                 <param name="<a-required-api>" value="auto" />
  37                 <param name="<another-required-api>" value="auto" />
  38         </feature>
  39 --------------------------------------------------------------------------------->
  40
  41 <!-- Feature : required-permission ------------------------------------------
  42
  43 List of the permissions required by the unit.
  44 Each required permission must be explicited using a <param> entry.
  45
  46 #### param name="#target" OPTIONAL
  47
  48 Declares the name of the unit requiring the listed permissions.
  49 Only one instance of the param "#target" is allowed.
  50 When there is not instance of this param, it behave as if
  51 the target main was specified.
  52
  53 #### param name=[required permission name]
  54
  55 The value is either:
  56 - required: the permission is mandatorily needed except if the feature
  57 isn't required (required="false") and in that case it is optional.
  58 - optional: the permission is optional
  59
  60 Example:
  61 <feature name="urn:AGL:widget:required-permission">
  62         <param name="#target" value="geoloc" />
  63         <param name="urn:AGL:permission:real-time" value="required" />
  64         <param name="urn:AGL:permission:syscall:*" value="required" />
  65 </feature>
  66 --------------------------------------------------------------------------------->
  67
  68 <!-- Feature : provided-unit -------------------------------------------------
  69 This feature is made for declaring new units
  70 for the widget. Using this feature, a software publisher
  71 can provide more than one application in the same widget.
  72
  73 #### param name="#target" REQUIRED
  74
  75 Declares the name of the unit. The default unit, the unit
  76 of the main of the widget, has the name "main". The value
  77 given here must be unique within the widget file. It will
  78 be used in other places of the widget config.xml file to
  79 designate the unit.
  80
  81 Only one instance of the param "#target" is allowed.
  82 The value can't be "main".
  83
  84 #### param name="content.type" REQUIRED
  85
  86 The mimetype of the provided unit.
  87
  88 #### param name="content.src"
  89
  90 A path to the file (subject to localisation), this is the entry point
  91 to that unit.
  92
  93 #### other parameters
  94
  95 The items that can be set for the main unit
  96 can also be set using the params if needed.
  97
  98  - description
  99  - name.content
 100  - name.short
 101  - ...
 102
 103 Example:
 104 <feature name="urn:AGL:widget:provided-unit">
 105         <param name="#target" value="geoloc" />
 106         <param name="description" value="binding of name geoloc" />
 107         <param name="content.src" value="index.html" />
 108         <param name="content.type" value="application/vnd.agl.service" />
 109 </feature>
 110 --------------------------------------------------------------------------------->
 111
 112 <!-- Feature: provided-api ---------------------------------------------------
 113 Use this feature for exporting one or more API of a unit
 114 to other widgets of the platform.
 115
 116 This feature is an important feature of the framework.
 117
 118 #### param name="#target" OPTIONAL
 119
 120 Declares the name of the unit exporting the listed apis.
 121 Only one instance of the param "#target" is allowed.
 122 When there is not instance of this param, it behave as if
 123 the target main was specified.
 124
 125 #### param name=[name of exported api]
 126
 127 The name give the name of the api that is exported.
 128
 129 The value is one of the following values:
 130
 131 - ws: export the api using UNIX websocket
 132 - dbus: export the API using dbus
 133 - auto: export the api using the default method(s).
 134
 135 Example:
 136 <feature name="urn:AGL:widget:provided-api">
 137         <param name="#target" value="geoloc" />
 138         <param name="geoloc" value="auto" />
 139         <param name="moonloc" value="auto" />
 140 </feature>
 141 --------------------------------------------------------------------------------->
 142 </widget>