dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #22844
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 748: Added chapter for Apps
------------------------------------------------------------
revno: 748
committer: Saptarshi <sunbiz@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Thu 2013-05-30 20:09:09 +0200
message:
Added chapter for Apps
added:
src/docbkx/en/dhis2_user_man_apps.xml
src/docbkx/en/resources/images/apps/
src/docbkx/en/resources/images/apps/appList.png
src/docbkx/en/resources/images/apps/appSettings.png
src/docbkx/en/resources/images/apps/appStore.png
modified:
src/docbkx/en/dhis2_user_manual_en.xml
--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs
Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== added file 'src/docbkx/en/dhis2_user_man_apps.xml'
--- src/docbkx/en/dhis2_user_man_apps.xml 1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_user_man_apps.xml 2013-05-30 18:09:09 +0000
@@ -0,0 +1,108 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
+<chapter>
+ <title>Apps</title>
+ <para>A Packaged App is an <ulink
+ url="https://developer.mozilla.org/en-US/docs/Open_Web_apps_and_Web_standards";>Open Web
+ App</ulink> that has all of its resources (HTML, CSS, JavaScript, app manifest, and so on)
+ contained in a zip file, that can be uploaded to a DHIS 2 installation on runtime. A Packaged
+ App is simply a zip file with the <ulink url="http://www.w3.org/2008/webapps/manifest/";>app
+ manifest</ulink> in its root directory. The manifest must be named manifest.webapp. Since DHIS
+ 2.12, an implementer can install Packaged Apps into DHIS 2 and extend the web interface of
+ DHIS2.</para>
+ <section>
+ <title>Purpose of Packaged Apps</title>
+ <para>The purpose of Packaged Apps is to extend the web interface of DHIS 2. As Health
+ Management Information Systems implementers and developers, we understand that each health
+ system has different and unique requirements. By using Apps, the flexibility of DHIS 2 can be
+ exposed through a custom user-interface that is suited to the context of
+ implementation.</para>
+ <para>Apps are lightweight extensions to underlying DHIS 2 functionality through a different web
+ interface. Packaged Apps do not have permissions to interact directly with DHIS 2 Java API.
+ Instead, Apps are supposed to use functionality by calling the Web API and other parts of the
+ DHIS2 web layer.</para>
+ </section>
+ <section>
+ <title>Creating Apps</title>
+ <para>Creating in Apps is a very simple. One needs to create HTML, JavaScript, CSS files similar
+ to how they would do on any web application. Then, one needs to create a file called <emphasis
+ role="italic">manifest.webapp</emphasis>. This file has the format as specified by the
+ <ulink url="http://www.w3.org/2008/webapps/manifest/";>W3C Manifest for Web
+ Applications</ulink>. A simple basic example of the <emphasis role="italic"
+ >manifest.webapp</emphasis> is shown below:</para>
+ <para>
+ <screen>{
+ "version": "0.1",
+ "name": "My App",
+ "description": "My App is a Packaged App",
+ "launch_path": "/index.html",
+ "icons": {
+ "16": "/img/icons/mortar-16.png",
+ "48": "/img/icons/mortar-48.png",
+ "128": "/img/icons/mortar-128.png"
+ },
+ "developer": {
+ "name": "Me",
+ "url": "http://me.com";
+ },
+ "default_locale": "en",
+ "activities": {
+ "dhis": {
+ "href": "*"
+ }
+ }
+}</screen>
+ </para>
+ <para>The <emphasis role="italic">manifest.webapp</emphasis> file must be located at the root of
+ the project. Among the properties, the <emphasis role="italic">activities</emphasis> property
+ is an extension meant to differentiate between standard Open Web App and App that can be
+ installed into DHIS 2. The <emphasis role="italic">*</emphasis> value for <emphasis
+ role="italic">href</emphasis> is converted to the appropriate URL when the App is installed
+ into DHIS 2. This value can then be used by the application's JavaScript and HTML files to
+ make Web API calls to DHIS 2 and identify the correct location of DHIS 2 server on which the
+ App has been installed. The <emphasis role="italic">icons→48</emphasis> property is
+ used for the icon that is displayed on the list of Apps that are installed on a DHIS 2
+ instance.</para>
+ <para><inlinegraphic fileref="resources/images/apps/appList.png"/></para>
+ <para>All the files in the project should then be compressed into a standard zip package. This
+ zip package can then be installed into DHIS 2 as you will see in the next section</para>
+ </section>
+ <section>
+ <title>Configuring DHIS 2 for Apps Installation</title>
+ <para>The App manager is found under Services → Apps. If your logged in user has
+ permissions to view and edit settings, in the left menu you'll see the Settings link.</para>
+ <para><inlinegraphic fileref="resources/images/apps/appSettings.png"/></para>
+ <para>The following are the settings that can be configured:</para>
+ <orderedlist>
+ <listitem>
+ <para>App Installation Folder - The folder on the file system where apps are unpacked. By
+ default this is under the expanded DHIS folder. If you'd like to install the Apps in
+ another location, say www folder of Apache 2, the apps will be unpacked at that
+ location.</para>
+ </listitem>
+ <listitem>
+ <para>App Base URL - The URL through which the apps can be located. By default this is the
+ same as your DHIS2 url. If you are installing apps through a different web server, one
+ needs to provide the URL for that web server</para>
+ </listitem>
+ <listitem>
+ <para>AppStore URL - The app respository through which new apps can be downloaded and
+ installed. Each country/implementation can host their own approved set of Apps that can be
+ installed into DHIS 2. We plan to host the global DHIS 2 AppStore at - <ulink
+ url="https://appstore.dhis2.org";>https://appstore.dhis2.org</ulink>
+ </para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>Installing Apps into DHIS 2</title>
+ <para>Apps can be installed by uploading zip file into the App manager. In, Services →
+ Apps, click on the <emphasis role="italic">Get New Apps</emphasis> menu item.</para>
+ <para><inlinegraphic fileref="resources/images/apps/appStore.png"/></para>
+ <para>The App package can be uploaded by pressing the Browse button and after selecting the zip
+ package, the file is uploaded automatically and installed on DHIS 2. You can also browse
+ through Apps on the app store and download apps from there. The App Store allows for
+ searching, reviewing, commenting, requesting features, rating etc. on the Apps by the
+ community.</para>
+ </section>
+</chapter>
=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml 2013-03-11 18:04:11 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml 2013-05-30 18:09:09 +0000
@@ -34,6 +34,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_persons_and_programs.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_web_api.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_integration.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_apps.xml"/>
<!--
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_excel_reports.xml" encoding="UTF-8"/>
-->
=== added directory 'src/docbkx/en/resources/images/apps'
=== added file 'src/docbkx/en/resources/images/apps/appList.png'
Binary files src/docbkx/en/resources/images/apps/appList.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/apps/appList.png 2013-05-30 18:09:09 +0000 differ
=== added file 'src/docbkx/en/resources/images/apps/appSettings.png'
Binary files src/docbkx/en/resources/images/apps/appSettings.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/apps/appSettings.png 2013-05-30 18:09:09 +0000 differ
=== added file 'src/docbkx/en/resources/images/apps/appStore.png'
Binary files src/docbkx/en/resources/images/apps/appStore.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/apps/appStore.png 2013-05-30 18:09:09 +0000 differ
