Widget Doc
[src/app-framework-main.git] / doc / widgets.html
1 <html>
2 <head>
3   <link rel="stylesheet" type="text/css" href="doc.css">
4   <meta charset="UTF-8">
5 </head>
6 <body>
7 <a name="The.widgets"></a>
8 <h1>The widgets</h1>
9
10 <pre><code>version: 1
11 Date:    29 mai 2016
12 Author:  José Bollo
13 </code></pre>
14
15 <p><ul>
16  <li><a href="#The.widgets">The widgets</a>
17  <ul>
18   <li><a href="#The.widgets">The widgets</a>
19   <ul>
20    <li><a href="#signature.of.the">signature of the</a></li>
21    <li><a href="#directory.where.are.stored.applications">directory where are stored applications</a>
22 </li>
23   </ul>
24   </li>
25  </ul>
26  </li>
27  <li><a href="#Organisation.of.directory.of.applications">Organisation of directory of applications</a>
28  <ul>
29   <li><a href="#Identity.of.installed.files">Identity of installed files</a></li>
30   <li><a href="#Labelling.the.directories.of.applications">Labelling the directories of applications</a></li>
31  </ul>
32  </li>
33  <li><a href="#Organisation.of.data">Organisation of data</a></li>
34 </ul></p>
35
36 <a name="The.widgets"></a>
37 <h2>The widgets</h2>
38
39 <p>The widgets are described by the technical recommendations
40 <a href="http://www.w3.org/TR/widgets" title="Packaged Web Apps">widgets</a> and <a href="http://www.w3.org/TR/widgets-digsig" title="XML Digital Signatures for Widgets">widgets-digsig</a>.</p>
41
42 <a name="signature.of.the"></a>
43 <h3>signature of the</h3>
44
45 <p>The application framework</p>
46
47 <p>This is the original part of our work here</p>
48
49 <a name="directory.where.are.stored.applications"></a>
50 <h3>directory where are stored applications</h3>
51
52 <p>Applications can be installed in few places: on the system itself or on an extension device.
53 For my phone, for example, it is the sd card.</p>
54
55 <p>This translates to:</p>
56
57 <ul>
58 <li>/usr/applications: for system wide applications</li>
59 <li>/opt/applications: for removable applications</li>
60 </ul>
61
62
63 <p>In the remaining of the document, these places are writen &ldquo;APPDIR&rdquo;.</p>
64
65 <a name="Organisation.of.directory.of.applications"></a>
66 <h1>Organisation of directory of applications</h1>
67
68 <p>The main path for applivcations are: APPDIR/PKGID/VER.</p>
69
70 <p>Where:</p>
71
72 <ul>
73 <li>APPDIR is as defined above</li>
74 <li>PKGID is a directory whose name is the package identifier</li>
75 <li>VER is the version of the package MAJOR.MINOR</li>
76 </ul>
77
78
79 <p>This organisation has the advantage to allow several versions to leave together.
80 This is needed for some good reasons (rolling back) and also for less good reasons (user habits).</p>
81
82 <a name="Identity.of.installed.files"></a>
83 <h2>Identity of installed files</h2>
84
85 <p>All the files are installed as the user &ldquo;userapp&rdquo; and group &ldquo;userapp&rdquo;.
86 All files have rw(x) for user and r-(x) for group and others.</p>
87
88 <p>This allows any user to read the files.</p>
89
90 <a name="Labelling.the.directories.of.applications"></a>
91 <h2>Labelling the directories of applications</h2>
92
93 <a name="Organisation.of.data"></a>
94 <h1>Organisation of data</h1>
95
96 <p>The data of a user are in its directory and are labelled using the labels of the application</p>
97 </body>
98 </html>