From: Sebastien Douheret Date: Mon, 19 Jun 2017 14:52:06 +0000 (+0200) Subject: Re-order doc chapters X-Git-Tag: dab/3.99.2~14 X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?p=src%2Fapp-framework-main.git;a=commitdiff_plain;h=d1b49a7d26bf344d9f00ae12144cbcc7d930b08b Re-order doc chapters Change-Id: I44cf2054fa06816480e26fc19b45c6f8a464a708 Signed-off-by: Sebastien Douheret --- diff --git a/docs/afm-daemons.md b/docs/1-afm-daemons.md similarity index 100% rename from docs/afm-daemons.md rename to docs/1-afm-daemons.md diff --git a/docs/2-widgets.md b/docs/2-widgets.md index e69de29..24de661 100644 --- a/docs/2-widgets.md +++ b/docs/2-widgets.md @@ -0,0 +1,8 @@ +The widgets +=========== + +The widgets are described by the W3C's technical recommendations +[Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets) and [XML Digital Signatures for Widgets](http://www.w3.org/TR/widgets-digsig) + +In summary, **widgets are ZIP files that can be signed and +whose content is described by the file **. diff --git a/docs/widgets.md b/docs/2.1-widgets.md similarity index 94% rename from docs/widgets.md rename to docs/2.1-widgets.md index 3966eab..93cd788 100644 --- a/docs/widgets.md +++ b/docs/2.1-widgets.md @@ -1,12 +1,3 @@ -The widgets -=========== - -The widgets are described by the W3C's technical recommendations -[Packaged Web Apps (Widgets)][widgets] and [XML Digital Signatures for Widgets][widgets-digsig] - -In summary, **widgets are ZIP files that can be signed and -whose content is described by the file **. - Tools for managing widgets -------------------------- diff --git a/docs/config.xml.md b/docs/2.2-config.xml.md similarity index 98% rename from docs/config.xml.md rename to docs/2.2-config.xml.md index 8894667..cccedd4 100644 --- a/docs/config.xml.md +++ b/docs/2.2-config.xml.md @@ -1,5 +1,5 @@ -The configuration file config.xml -=========== +Configuration file - config.xml +=============================== The widgets are described by the W3C's technical recommendations [Packaged Web Apps (Widgets)][widgets] and [XML Digital Signatures for Widgets][widgets-digsig] @@ -16,7 +16,7 @@ to the framework: - the type of the application - the icon of the application - the permissions linked to the application -- the services and dependancies of the application +- the services and dependencies of the application The file MUST be at the root of the widget and MUST be case sensitively name ***config.xml***. @@ -32,7 +32,7 @@ Here is the example of the config file for the QML application SmartHome. SmartHome - This is the Smarthome QML demo application. It shows some user interfaces for controlling an + This is the Smarthome QML demo application. It shows some user interfaces for controlling an automated house. The user interface is completely done with QML. Qt team GPL @@ -284,7 +284,7 @@ The mimetype of the provided unit. #### param name="content.src" -A path to the +A path to the #### other parameters @@ -367,7 +367,7 @@ how to create systemd units for widgets. Known types for the type of content are: -- ***text/html***: +- ***text/html***: HTML application, content.src designates the home page of the application diff --git a/docs/permissions.md b/docs/3-permissions.md similarity index 100% rename from docs/permissions.md rename to docs/3-permissions.md diff --git a/docs/quick-tutorial.md b/docs/4-quick-tutorial.md similarity index 100% rename from docs/quick-tutorial.md rename to docs/4-quick-tutorial.md diff --git a/docs/1-frameworks.md b/docs/5-frameworks.md similarity index 100% rename from docs/1-frameworks.md rename to docs/5-frameworks.md diff --git a/docs/application-framework.md b/docs/5.1-application-framework.md similarity index 100% rename from docs/application-framework.md rename to docs/5.1-application-framework.md diff --git a/docs/security-framework.md b/docs/5.2-security-framework.md similarity index 100% rename from docs/security-framework.md rename to docs/5.2-security-framework.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7357214..30c105f 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,11 +1,12 @@ # Summary * [Overview](README.md) -* [Quick tutorial](quick-tutorial.md) -* [The frameworks](1-frameworks.md) - * [The application framework](application-framework.md) - * [The security framework](security-framework.md) -* [The afm daemons](afm-daemons.md) -* [Widgets of the framework](2-widgets.md) - * [Overview of widgets](widgets.md) - * [The configuration file](config.xml.md) \ No newline at end of file +* [The afm daemons](1-afm-daemons.md) +* [Widgets](2-widgets.md) + * [Overview of widgets](2.1-widgets.md) + * [The configuration file](2.2-config.xml.md) +* [The permissions](3-permissions.md) +* [Quick tutorial](4-quick-tutorial.md) +* [The frameworks](5-frameworks.md) + * [The application framework](5.1-application-framework.md) + * [The security framework](5.2-security-framework.md)