dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #04848
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 126: GIS doc update.
------------------------------------------------------------
revno: 126
committer: Jan Henrik Overland <janhenrik.overland@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Thu 2010-03-11 12:45:09 +0100
message:
GIS doc update.
modified:
src/docbkx/en/dhis2_user_man_gis.xml
src/docbkx/en/resources/images/GIS/admin_panel.png
src/docbkx/en/resources/images/GIS/assign_org_units.png
src/docbkx/en/resources/images/GIS/register_geodata.png
--
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.
=== modified file 'src/docbkx/en/dhis2_user_man_gis.xml'
--- src/docbkx/en/dhis2_user_man_gis.xml 2010-03-01 14:31:31 +0000
+++ src/docbkx/en/dhis2_user_man_gis.xml 2010-03-11 11:45:09 +0000
@@ -1,3 +1,261 @@
+<<<<<<< TREE
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
+<article>
+ <articleinfo>
+ <title>DHIS 2 GIS User Manual</title>
+ <keywordset>
+ <keyword>DHIS</keyword>
+ <keyword>GIS</keyword>
+ <keyword>Mapping</keyword>
+ </keywordset>
+ <author>
+ <surname>Øverland</surname>
+ <firstname>Jan Henrik</firstname>
+ </author>
+ <author>
+ <surname>Pickering</surname>
+ <firstname>Jason Paul</firstname>
+ </author>
+ <revhistory>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>12/09/2009</date>
+ <authorinitials>JPP</authorinitials>
+ <revdescription>
+ <para>Initial conversion of document to DocBook format</para>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </articleinfo>
+ <sect1 id="gis_1">
+ <title>Conversion of geographical data to GeoJSON format</title>
+ <para>The DHIS2 mapping client relies on GeoJSON files in order to display
+ a map in the browser window. Often times, geographical data is received in
+ many different formats, but the ESRI shape file format is one of the most
+ common. Several procedures will be described below. It is important, but
+ not required, that the names in your geographical data match those in the
+ DHIS2 organizational hierarchy. If they do not, you will need to manually
+ match them in a later step</para>
+ <sect2>
+ <title>Production of GeoJSON files with Geoserver</title>
+ <para>Geoserver is capable of outputting GeoJSON formats. If you have
+ geoserver running someplace, you can execute the following query.</para>
+ <para><ulink url="http://localhost:8080/geoserver/ows?service=WFS&version=1.0.0&request=GetFeature&typename=topp:states&outputformat=json&srs_name=EPSG:4326";>http://localhost:8080/geoserver/ows?service=WFS&version=1.0.0&request=GetFeature&typename=topp:states&outputformat=json&srs_name=EPSG:4326</ulink></para>
+ <para> Take note that you need to specify the spatial coordinate system. By defualt, Geoserver will return GeoJSON files with the format "long/lat" while
+the DHIS mapping client expects the ordering of the coordinates in "lat/long" format. The expllicit declartaion of the spatial reference system will ensure that coordinates are returned in the proper order. At the time of writing, the DHIS mapping client does not support spatial reference systems other than EPSG 4326. If you are using Geoserver, the application will handle the reprojection from the native format of the geographical data to EPSG 4326. If you are using other methods as described below to generate the GeoJSON file, you will need to ensure that the GeoJSON output is set to EPSG 4326 (Geographical Lat/long). </para>
+ <para>You will need to adjust the host destination if the machine is not
+ your local machine as well as defining the actual layer in Geoserver
+ which should be output to GeoJSON (in this case
+ <parameter>topp:states</parameter>).</para>
+ <para>Upon execution of the URL, Geoserver will produce a GeoJSON file,
+ and you will be asked to save it. Once it has finished downloading,
+ rename the file following the suggested naming convention:</para>
+ <para>ISO2CountryCode followed by an underscore, followed by the layer
+ type (e.g. “admin†for administrative layers, “health†for health
+ administrative boundaries). For instance, the first administrative layer
+ for Zambia would be named as "zm_admin1".</para>
+ </sect2>
+ <sect2>
+ <title>Production of GeoJSON files with GDAL</title>
+ <para>GDAL is a multi-platform toolkit for the manipulation of
+ geographical data. It is freely available for a wide-range of platforms
+ at <ulink url="http://gdal.org";>http://gdal.org</ulink></para>
+ <para>Production of GeoJSON files are straightforward with GDAL. Just
+ execute (on Windows)</para>
+ <programlisting>ogr2ogr.exe -f "GeoJSON" dst_datasource_name src_datasource_name</programlisting>
+ <para>or on Linux<programlisting>ogr2ogr -f "GeoJSON"dst_datasource_name src_datasource_name</programlisting></para>
+ <para>Replace <parameter>dst_datasource_name</parameter> with the path
+ to the destination geographical data file (following the naming
+ convention described above) and
+ <parameter>src_datasource_name</parameter> with the source geographical
+ data file. Take note that you may need to specify input and output coordinate systems as described above.</para>
+ </sect2>
+ <sect2>
+ <title>Copying files to the DHIS application</title>
+ <para>Currently, your GeoJSON files should be placed in the
+ DHIS_HOME/geoson of your DHIS application to be accessible to the GIS
+ module. If the GeoJSON directory does not exist, you will need to create
+ it manually and copy your GeoJSON files there.</para>
+ </sect2>
+ </sect1>
+ <sect1 id="gis_2">
+ <title>Administrator panel</title>
+ <screenshot>
+ <graphic fileref="resources/images/GIS/admin_panel.png" align="center"/>
+ </screenshot>
+ <para><variablelist>
+ <varlistentry>
+ <term>Map source</term>
+ <listitem>
+ <para><guilabel>GeoJSON files:</guilabel> you will find your own
+ registered maps in the Map combo box in the Thematic map panel.
+ The Admin panels check box will become visible.</para>
+ <para><guilabel>Shapefiles:</guilabel> same as GeoJSON files, except that the files are generated from shapefiles installed in your running version of Geoserver on the fly. </para>
+ <para><guilabel>DHIS database:</guilabel> the Map combo box will
+ simply be populated by the existing organisation unit levels and
+ GeoJSON files will be created by the application automatically
+ Organisation units must have coordinates stored in the database in
+ order to be displayed in the map. This function is mainly intended
+ for the facility level as it is easy to maintain and thus will
+ offer up-to-date shapefiles.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Admin panels</term>
+ <listitem>
+ <para>Show/hide the shapefile management panels.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Longitude/latitude</term>
+ <listitem>
+ <para>The base coordinate for the current country. This coordinate will appear as default when registering maps and overlays.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </sect1>
+ <sect1 id="gis_3">
+ <title>Registering geographical information</title>
+ <para>In order to view data in the GIS module, you must import your
+ geographical data into your DHIS installation. Once you have produced
+ GeoJSON files according to the procedure in the first section of the documentation, and imported them into the
+ system, you will need to establish a correspondence between the
+ information in the DHIS database, and the GeoJSON file.</para>
+ <screenshot>
+ <screeninfo>Register Geodata Panel</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="resources/images/GIS/register_geodata.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Display name:</guilabel> This name represents your map in the Map combo box in the Thematic map
+ panel.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Organisation unit level:</guilabel> The level of the organization units displayed in the GeoJSON
+ file.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Map source file:</guilabel> The GeoJSON file name. The files that are placed in the
+ mapping/geojson folder will appear in the combo box. Use e.g. Geoserver to
+ easily produce GeoJSON from your shapefiles.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Name column:</guilabel> The shapefile data column (case sensitive!) that will be
+ matched against DHIS organisation unit names. If you have an
+ instance of Geoserver installed, you can view the layer through the
+ built-in OpenLayers client. Click on a particular area, and the
+ possible fields will be displayed.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Longitude / latitude:</guilabel> The longitude and latitude refer to the approximate point
+ where the map will be centered after rendering. If you have
+ Geoserver running, you can view the layer through the integrated
+ OpenLayers client and determine a good center point for your map.
+ You can also use the background map of the DHIS GIS module, and
+ determine an approximate location. You may need to experiment a bit
+ with the center point and zoom level in order to get it
+ correct.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Zoom:</guilabel> The zoom level controls the extent of the map. Some
+ experimentation will be required to get the correct zoom level.
+ Start with a value of "7" and increase or decrease the zoom level
+ depending on the extent of the map that should be displayed.</para>
+ </listitem>
+ </itemizedlist>
+ </sect1>
+ <sect1 id="gis_4">
+ <title>Assign organization units to map</title>
+ <para>Select a registered map and wait for it to load. The organisation
+ units (OU) in your database on this level will appear in the list and
+ colors will appear in the map. What we want to do here is creating
+ relations between OUs in the database and the corresponding OUs in the
+ shapefile. This is often necessary because of inconsistencies in the
+ naming in the geographical data, and what is present in the DHIS database.
+ First, try "Assign all" at the bottom toolbar to let the application link
+ the OUs with a matching OU name in the shapefile. The polygons that remain
+ white, you will have to link manually. First select a white OU in the map
+ and a window appears in the top right corner. The link operation is now active and you may terminate it by closing the window. To map the selected OU simply click a white OU in the left side grid list.</para>
+ <screenshot>
+ <screeninfo>Assigning Organizational Units to the map</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" align="center" fileref="resources/images/GIS/assign_org_units.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The remove button at the left side bottom button tool bar removes the link of the OU that is selected in the list. The remove all button removes all OU links for the selected
+ map.</para>
+ </sect1>
+ <sect1 id="gis_5">
+ <title>Register overlays</title>
+ <para>Overlays are geographical layers that do not have any direct linkage
+ to data in the database. Example include roads, rivers, airports, ports,
+ and other geographical information that you may want to display on your
+ map, but that is not neccsarily linked ot data contained in the DHIS
+ database. The <guimenu>Register Overlay</guimenu> panel will allow you to
+ add new layers and determine how they will be represented visually on the
+ map. </para>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Display name:</guilabel> Represents your overlay in
+ the layer tree in the upper right corner.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Map source file: </guilabel>The GeoJSON file
+ name.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Fill color: </guilabel>Decides the fill color if the
+ layer is a polygon layer. </para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Fill opacity: </guilabel>Select an opacity level
+ between 0 (invisible) and 1 (solid).</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Stroke color: </guilabel>The stroke color over lines
+ and polygon borders.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Stroke width: </guilabel>Select a stroke width between
+ 0 and 4.</para>
+ </listitem>
+ </itemizedlist>
+ </sect1>
+ <sect1 id="gis_6">
+ <title>Thematic map</title>
+ <para>This panel lets you use your registered maps for thematic mapping. All you need to do is selecting your desired indicator-period-map combination in the left side menu.</para>
+ <para>Calculation method
+ alludes to the size of the legend classes. Set to <guimenuitem>Equal intervals</guimenuitem> they will be “highest map value – lowest map value
+ / number of classesâ€. Set to <guimenuitem>Equal group count</guimenuitem> the legend creator will try to distribute the organisation units evenly. Choose <guimenuitem>Fixed bounds </guimenuitem>and
+ you may define your own class break values, e.g. “20,40,60†using a comma to
+ seperate each of them.</para>
+ <para>The map view combo box lists all map views (favorites) saved by the user. The settings that are stored in the map view will be automatically applied to the thematic map panel.</para>
+ </sect1>
+ <sect1 id="gis_7">
+ <title>Register views</title>
+ <para>This panel will save the current thematic map view, including zoom level and center position, in order to
+ restore it whenever you want via the <guimenuitem>Map view </guimenuitem>combo box in the <guimenu>Thematic map</guimenu> panel. By
+ adding your views to DHIS 2 Dashboard you may access them there by
+ inserting <guimenuitem>Map views</guimenuitem> into one of link
+ areas.</para>
+ </sect1>
+ <sect1 id="gis_8">
+ <title>Register legend sets</title>
+ <para>A legend set may be connected to many indicators, but an indicator
+ may only have one legend set. Thus, you may select many indicators when
+ you create a legend set. When an indicator that has a legend set is
+ selected in the <guimenu>Thematic map</guimenu> panel, the number of
+ classes, low color and high color is automatically set.</para>
+ </sect1>
+</article>
+=======
<?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>
@@ -273,3 +531,4 @@
classes, low color and high color is automatically set.</para>
</section>
</chapter>
+>>>>>>> MERGE-SOURCE
=== modified file 'src/docbkx/en/resources/images/GIS/admin_panel.png'
Binary files src/docbkx/en/resources/images/GIS/admin_panel.png 2009-10-27 19:28:34 +0000 and src/docbkx/en/resources/images/GIS/admin_panel.png 2010-03-11 11:45:09 +0000 differ
=== modified file 'src/docbkx/en/resources/images/GIS/assign_org_units.png'
Binary files src/docbkx/en/resources/images/GIS/assign_org_units.png 2009-10-27 19:28:34 +0000 and src/docbkx/en/resources/images/GIS/assign_org_units.png 2010-03-11 11:45:09 +0000 differ
=== modified file 'src/docbkx/en/resources/images/GIS/register_geodata.png'
Binary files src/docbkx/en/resources/images/GIS/register_geodata.png 2009-10-27 19:28:34 +0000 and src/docbkx/en/resources/images/GIS/register_geodata.png 2010-03-11 11:45:09 +0000 differ
