dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #25515
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 839: DV, GIS docs updated.
------------------------------------------------------------
revno: 839
committer: Jan Henrik Overland <janhenrik.overland@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2013-10-15 16:18:28 +0200
message:
DV, GIS docs updated.
added:
src/docbkx/en/resources/images/gis/chart_integration.png
src/docbkx/en/resources/images/visualizer/chart_integration.png
modified:
src/docbkx/en/dhis2_user_man_using_data_visualizer.xml
src/docbkx/en/dhis2_user_man_using_gis.xml
src/docbkx/en/dhis2_user_man_using_pivot_table.xml
src/docbkx/en/resources/images/gis/gis_boundary_layer.png
src/docbkx/en/resources/images/gis/gis_facility_layer.png
src/docbkx/en/resources/images/gis/gis_main.png
src/docbkx/en/resources/images/gis/gis_thematic_mapping.png
src/docbkx/en/resources/images/visualizer/column_chart.png
src/docbkx/en/resources/images/visualizer/favorites.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_using_data_visualizer.xml'
--- src/docbkx/en/dhis2_user_man_using_data_visualizer.xml 2013-06-01 12:33:28 +0000
+++ src/docbkx/en/dhis2_user_man_using_data_visualizer.xml 2013-10-15 14:18:28 +0000
@@ -59,6 +59,9 @@
the proportion of data for individual data elements compared to the total sum of all data
elements in the chart.</para>
</listitem>
+ <listitem>
+ <para>Radar chart: Displaying multivariate data on axes starting from the same point. Also known as spider chart.</para>
+ </listitem>
</orderedlist>
</section>
<section id="dvSeriesCategoryFilter">
@@ -110,48 +113,47 @@
<para>The visualizer can display reporting rates in a chart, by itself or together with indicators and data elements. Reporting rates can be selected by clicking at the "Reporting rates" header. Reporting rates are defined by data sets. It can be selected by double-clicking in the list of available data sets to the left.</para>
</section>
<section>
- <title>Selecting relative periods</title>
- <para>To select relative periods click on the "Relative periods" header. You can select any number of periods from the set of periods listed under the header, such as "Last month", "Months this year" and "Last 5 years". The names should be fairly self-descriptive. All periods are relative to the current date, meaning that if the current month is March and you select "Last month", the month of February will be included in the chart.</para>
- </section>
- <section>
- <title>Selecting fixed periods</title>
- <para>To select fixed periods click on the "Fixed periods" header and select a period type from the combo box. You can select any number of fixed periods from any period type. You are free to combine fixed periods and relative periods in the same chart. Overlapping periods will be filtered so that they only appear once.</para>
+ <title>Selecting fixed and relative periods</title>
+ <para>Click on the "Periods" header. For fixed periods, select a period type from the combo box. You can select any number of fixed periods from any period type. Below the fixed period you will find the relative period checkboxes and you may select as many as you like. The names should be fairly self-descriptive and they are relative to the current date, meaning that if the current month is March and you select "Last month", the month of February will be included in the chart. You are also free to combine fixed periods and relative periods in the same chart. Overlapping periods will be filtered so that they only appear once.</para>
</section>
<section>
<title>Selecting organisation units</title>
<para>You can select which organisation units to include in the chart by clicking the
- "Organisation units" header. This section features a tree including all organisation
- units in the system. You can select any of the organisation units by clicking them. If you
- want to select multiple, arbitrary organisation units you can press the Ctrl button and then
- click away in the tree. If you want to include all organisation units existing directly under
- a specific organisation unit (the children of the parent organisation unit in other terms) you
- can right-click on the organisation unit and select "Select all children". You can
- also automatically select all organisation units in a particular organisation unit group.
- Click the "Group" button on the far right of the toolbar above the tree and select a
- group in the drop down list.</para>
- <para>This panel also features two checkboxes. Checking "User organisation unit" will disable the organisation unit tree and give you the organisation unit that is related to the current/logged in user instead. This is also useful for administrators as they can create a meaningful "system" favorite with this option checked and all users will find their respective organisation unit when they open it. The the same concept goes for the "User organisation unit children" checkbox.</para>
+ "Organisation units" header. This section features three ways of selecting organisation units. The default mode is called "Organisation units" and lets you select the organisation units you want to appear in the chart from the tree. This mode also features three checkboxes. Checking "User org unit" will disable the organisation unit tree and give you the organisation unit that is related to the current/logged in user instead. This is also useful for administrators as they can create a meaningful "system" favorite with this option checked and all users will find their respective organisation unit when they open it. The the same concept goes for "Org unit children" and "Org unit grand children". The second mode is called "Select levels". Here you can select all organisation units at one or more levels. However, at the same time you also have the option to select parent organisation units in the tree, which makes it easy to select e.g. all facilities inside one or more districts. The same thing goes for the third mode called "Select groups". Here you can select all organisation units inside one or more groups and parent organisation units at the same time.</para>
</section>
<section>
- <title>Selecting organisation unit groups</title>
- <para>You can break down the national level into organisation unit groups by simply selecting a group set in the combo box. The groups in the selected group set will replace any selected organisation units in the organisation unit panel.</para>
+ <title>Selecting organisation unit group sets and data element group sets</title>
+ <para>All dimension tabs listed below "Organisation units" are organisation unit group sets and data element group sets. You are free to add groups from any of these group sets to your chart. Remember to add the group set in either the series, category or filters combobox.</para>
</section>
<section>
<title>Selecting chart options</title>
- <para>You can set various chart options by clicking on the "Chart options" header in the panel to the left. </para>
+ <para>You can set various chart options by clicking on the "Options" button the chart toolbar.</para>
<itemizedlist>
<listitem>
- <para>Show series data: Displays the corresponding value next to columns and bars in the chart.</para>
- </listitem>
- <listitem>
<para>Show trend line: The trend line will visualize how your data evolves over time - e.g.
is performance improving or deteriorating. Makes sense when periods are selected as
category. </para>
</listitem>
<listitem>
- <para>Hide chart subtitle: Hides the title and subtitle of your chart.</para>
- </listitem>
- <listitem>
- <para>Hide chart legend: Hides the legend and leave more room for the chart itself.</para>
+ <para>Show series data: Displays the corresponding value next to columns and bars in the chart.</para>
+ </listitem>
+ <listitem>
+ <para>Target line value/title: Displays a horizontal line at the given domain value. Useful e.g. when you want to compare your performance to the current target.</para>
+ </listitem>
+ <listitem>
+ <para>Base line value/title: Displays a horizontal line at the given domain value. Useful e.g. when you want to visualize how your performance has evolved since the beginning of a process.</para>
+ </listitem>
+ <listitem>
+ <para>Show values: Shows the values above the series in the chart.</para>
+ </listitem>
+ <listitem>
+ <para>Hide chart legend: Hides the legend and leaves more room for the chart itself.</para>
+ </listitem>
+ <listitem>
+ <para>Hide chart title: Hides the title of your chart.</para>
+ </listitem>
+ <listitem>
+ <para>Chart title: Type any title you like and it will appear above the chart.</para>
</listitem>
<listitem>
<para>Domain axis label: Displays a label below the domain axis (also referred to as the X axis). Can give context information to the chart, e.g. the type of periods being listed.</para>
@@ -159,18 +161,6 @@
<listitem>
<para>Range axis label: Displays a label next to the range axis (also referred to as the Y axis). Can give context information to the chart, e.g. the unit of measure being used.</para>
</listitem>
- <listitem>
- <para>Target line value: Displays a horizontal line at the given domain value. Useful e.g. when you want to compare your performance to the current target.</para>
- </listitem>
- <listitem>
- <para>Target line label: Displays a label next to the target line.</para>
- </listitem>
- <listitem>
- <para>Base line value: Displays a horizontal line at the given domain value. Useful e.g. when you want to visualize how your performance has evolved since the beginning of a process.</para>
- </listitem>
- <listitem>
- <para>Base line label: Displays a label next to the baseline.</para>
- </listitem>
</itemizedlist>
</section>
<section id="dvDisplayChart">
@@ -179,32 +169,14 @@
<para>Notice that you can hide and show individual data series in the chart by clicking directly on the series label in the chart - they appear either at the top or to the right of the chart.</para>
<para>If you want to give the chart more space on your screen you can click on the triple left-arrow button on the top centre menu. This will collapse the left side menu. You can get this menu back by clicking on the same button again.</para>
</section>
- <section id="dvDisplayDataTable">
- <title>Displaying a data table</title>
- <para>After you have rendered a chart you can display the data in a table by clicking on the "Data table" button on the top centre menu (next to "Update"). This will show a table with four columns, one for data (meaning data element or indicator), period, organisation unit and data value. This table can be sorted ascending or descending on any of the columns.</para>
- <screenshot>
- <screeninfo>Example chart illustrating the concepts of series, categories and filter.</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="70%" fileref="resources/images/visualizer/data_table.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </section>
<section id="dvSaveChart">
<title>Downloading chart as image or PDF</title>
- <para>After you have rendered a chart you can save that view as file and download it to your local computer by clicking on "Save as" on the top centre menu. You can select between PNG (image) or PDF. The file will be automatically downloaded to your computer - for instance can you now embed the image file into a text document as part of a report.</para>
+ <para>After you have rendered a chart you can download it to your local computer as and image or pdf by clicking on "Download" on the top centre menu. The file will be automatically downloaded to your computer - for instance can you now embed the image file into a text document as part of a report. You can also download the data source behind the chart in json, xml, csv or Microsoft Excel format.</para>
</section>
<section id="dvFavorites">
<title>Saving chart as favorite</title>
- <para>Once you have rendered a chart you can save it as a favorite. Click on the
- "Favorites" button on the top menu and then on the "Manage favorites"
- link. In the name field enter the desired name for your chart. By ticking the
- "System" checkbox the chart will be visible to all users of the system, if you do
- not tick it the chart will be visible only to yourself. This requires that your user account
- has the privilege to create system charts. You can rename any favorite by selecting it in the
- list, modifying its name in the name input field and clicking "Rename". You can
- delete any favorite by selecting it and then clicking "Delete".</para>
+ <para>Once you have rendered a chart you can save it as a favorite to able to access it easily at a later point. Click on the
+ "Favorites" button on the top menu to open up the favorites window. Click "Add new" and in the name field enter the desired name for your chart. The chart will be visible only to yourself. For every favorite in the list you have four options to the right. You can rename the chart (grey button), overwrite the chart (green button), modify the sharing settings of the chart (blue button) or delete the chart (red button).</para>
<para>These favorite charts can later be included on your personal dashboard. After saving you can navigate to the dashboard module, click on the "Insert" link over the chart areas and select your preferred chart.</para>
<screenshot>
<screeninfo>Data visualizer module displaying a column chart.</screeninfo>
@@ -228,7 +200,21 @@
toolbar.</para>
</section>
<section>
+ <title>Analysis integration</title>
+ <para>The analysis apps in DHIS 2 are completely integrated, so you can easily switch
+ between pivot table, chart and map visualization of your data. When you have made a chart
+ you can click e.g. "Map" in the top right corner and then select "Open this table as map".</para>
+ <screenshot>
+ <screeninfo>Analysis integration</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="25%" fileref="resources/images/visualizer/chart_integration.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </section>
+ <section>
<title>Exiting the data visualizer module</title>
- <para>If you want to exit the module and go back to the DHIS start page you can click on the "Exit" button to the right side of the top centre menu.</para>
+ <para>If you want to exit the module and go back to the DHIS start page you can click on the "Home" button to the right side of the top centre menu.</para>
</section>
</chapter>
=== modified file 'src/docbkx/en/dhis2_user_man_using_gis.xml'
--- src/docbkx/en/dhis2_user_man_using_gis.xml 2013-06-01 12:33:28 +0000
+++ src/docbkx/en/dhis2_user_man_using_gis.xml 2013-10-15 14:18:28 +0000
@@ -17,14 +17,32 @@
<para>Lets take a look at the map toolbar. The four icons from the left represent the mentioned vector layers and this is the starting point of the GIS application. Further to the right we have "Favorites": Save your maps to easily restore them later. Saving a map as a favorite also gives you the opportunity of sharing it with other users as an interpretation or put it on the dashboard. "Legend": Create you own legend sets to ensure meaningful maps. "Download": Export the maps as a PNG image. "Share": Share your favorites as map interpretations with other users.</para>
- <para>In the top right corner of the map viewport you find four buttons: "Zoom in", "zoom out", "zoom to visible extent" (automatically adjusts the zoom level and map center position to focus on your map) and "measure distances".</para>
+ <para>In the top right corner of the map viewport you find four buttons: "Zoom in", "zoom out", "zoom to visible extent" (automatically adjusts the zoom level and map center position to put the data on your map in focus) and "measure distances".</para>
<para>The current longitude/latitude position of the mouse cursor is displayed in the bottom right corner of the map viewport.</para>
</section>
<section>
<title>Thematic mapping</title>
- <para>This section describes the four vector layers which the user has at his disposal for thematic mapping: "Boundary layer", "Thematic layer 1", "Thematic layer 2" and "Facility layer".</para>
+ <para>This section describes the four vector layers which the user has at his disposal for thematic mapping: "Facility layer", "Boundary layer" and "Thematic layer" 1-4.</para>
+
+ <section id="gisFacilityMap">
+ <title>Facility layer</title>
+ <screenshot>
+ <screeninfo>Facility layer</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/gis/gis_facility_layer.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>This layer displays icons that represent facilities based on the facility type. Polygons will not show up on the map, so make sure to select an organisation unit level that has facilities. Click an icon on the map to open the context menu with two options. "Show information sheet" provides you with data for several data elements for this organisation unit. The data element group and period type are "system settings" called "Infrastructural data elements" and "Infrastructural period type". The second option in the context menu is "Relocate" and lets you graphically move the organisation unit to a different location. The new coordinate will be stored permanently. Browser cache must be deleted to see the change if you reload the page.</para>
+
+ <para>In the "Edit layer" window will find "surrounding areas" in addition to group set, level
+ and parent. This lets you draw a circle around each facility with a desired radius in
+ kilometers.</para>
+ </section>
+
<section id="gisBoundaryMap">
<title>Boundary layer</title>
<screenshot>
@@ -53,7 +71,7 @@
</section>
<section id="gisThematicMap">
- <title>Thematic layer 1 and 2</title>
+ <title>Thematic layer 1-4</title>
<screenshot>
<screeninfo>Thematic mapping</screeninfo>
<mediaobject>
@@ -62,30 +80,14 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>The two thematic layer panels let you use your data for thematic mapping. All you need to do is selecting your desired combination of indicator/dataelement, period and map combination. Then the organisation unit level and parent to define the boundaries. If your database has coordinates and aggregated data values for these organisation units they will appear on the map. Note that the DHIS2 data mart must be run in order to have aggregated values available.</para>
+ <para>The four thematic layer panels let you use your data for thematic mapping. All you need to do is selecting your desired combination of indicator/dataelement, period and map combination. Then the organisation unit level and parent to define the boundaries. If your database has coordinates and aggregated data values for these organisation units they will appear on the map. Note that the DHIS2 data mart must be run in order to have aggregated values available.</para>
<para>You may choose between legend types: <guimenuitem>automatic</guimenuitem> and <guimenuitem>predefined</guimenuitem>. Automatic means that the application will create a legend set for you based on your what method, number of classes, low color and high color you select. 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. The legend will appear as an even gradation from the start color to the end color. Predefined legend sets are described in <xref linkend="gisLegendSet"/> .</para>
<para>Low radius and high radius only have effect on points (facilities) and decides the
circle radius for points with the lowest and highest value.</para>
- <para>Thematic layer 1 and 2 menu have a "Filter" option in addition to the boundary layer menu options. It lets you apply value filters to the organisation units on the map. The filter is removed when you close the filter window.</para>
- </section>
- <section id="gisFacilityMap">
- <title>Facility layer</title>
- <screenshot>
- <screeninfo>Facility layer</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/gis/gis_facility_layer.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>This layer displays icons that represent facilities based on the facility type. Polygons will not show up on the map, so make sure to select an organisation unit level that has facilities. Click an icon on the map to open the context menu with two options. "Show information sheet" provides you with data for several data elements for this organisation unit. The data element group and period type are "system settings" called "Infrastructural data elements" and "Infrastructural period type". The second option in the context menu is "Relocate" and lets you graphically move the organisation unit to a different location. The new coordinate will be stored permanently. Browser cache must be deleted to see the change if you reload the page.</para>
-
- <para>In the "Edit layer" window will find "surrounding areas" in addition to group set, level
- and parent. This lets you draw a circle around each facility with a desired radius in
- kilometers.</para>
+ <para>Thematic layer 1-4 menu have a "Filter" option in addition to the boundary layer menu options. It lets you apply value filters to the organisation units on the map. The filter is removed when you close the filter window.</para>
</section>
</section>
<section>
@@ -129,5 +131,20 @@
<title>Share map interpretation</title>
<para>Open a favorite or save a new map as a favorite. Then click the "Share" button on the map toolbar. Type in your interpretation and click "Share".</para>
</section>
+
+ <section>
+ <title>Analysis integration</title>
+ <para>The analysis apps in DHIS 2 are completely integrated, so you can easily switch
+ between pivot table, chart and map visualization of your data. When you have made a map
+ you can click e.g. "Chart" in the top right corner and then select "Open this map as chart".</para>
+ <screenshot>
+ <screeninfo>Analysis integration</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="25%" fileref="resources/images/visualizer/chart_integration.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </section>
</section>
</chapter>
=== modified file 'src/docbkx/en/dhis2_user_man_using_pivot_table.xml'
--- src/docbkx/en/dhis2_user_man_using_pivot_table.xml 2013-10-14 16:24:23 +0000
+++ src/docbkx/en/dhis2_user_man_using_pivot_table.xml 2013-10-15 14:18:28 +0000
@@ -108,7 +108,7 @@
<screeninfo>Pivot table where organisation units and periods are repeated on rows.</screeninfo>
<mediaobject>
<imageobject>
- <imagedata width="85%" fileref="resources/images/pivot_table/pivot_rows.png" format="PNG"/>
+ <imagedata width="90%" fileref="resources/images/pivot_table/pivot_rows.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -184,7 +184,7 @@
<screeninfo>Analysis integration</screeninfo>
<mediaobject>
<imageobject>
- <imagedata width="30%" fileref="resources/images/pivot_table/pivot_integration.png" format="PNG"/>
+ <imagedata width="25%" fileref="resources/images/pivot_table/pivot_integration.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -195,7 +195,7 @@
<screeninfo>Chart integration</screeninfo>
<mediaobject>
<imageobject>
- <imagedata width="30%" fileref="resources/images/pivot_table/pivot_integration.png" format="PNG"/>
+ <imagedata width="90%" fileref="resources/images/pivot_table/pivot_integration_table.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
=== added file 'src/docbkx/en/resources/images/gis/chart_integration.png'
Binary files src/docbkx/en/resources/images/gis/chart_integration.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/gis/chart_integration.png 2013-10-15 14:18:28 +0000 differ
=== modified file 'src/docbkx/en/resources/images/gis/gis_boundary_layer.png'
Binary files src/docbkx/en/resources/images/gis/gis_boundary_layer.png 2012-11-13 13:16:30 +0000 and src/docbkx/en/resources/images/gis/gis_boundary_layer.png 2013-10-15 14:18:28 +0000 differ
=== modified file 'src/docbkx/en/resources/images/gis/gis_facility_layer.png'
Binary files src/docbkx/en/resources/images/gis/gis_facility_layer.png 2012-11-13 13:16:30 +0000 and src/docbkx/en/resources/images/gis/gis_facility_layer.png 2013-10-15 14:18:28 +0000 differ
=== modified file 'src/docbkx/en/resources/images/gis/gis_main.png'
Binary files src/docbkx/en/resources/images/gis/gis_main.png 2012-11-13 13:16:30 +0000 and src/docbkx/en/resources/images/gis/gis_main.png 2013-10-15 14:18:28 +0000 differ
=== modified file 'src/docbkx/en/resources/images/gis/gis_thematic_mapping.png'
Binary files src/docbkx/en/resources/images/gis/gis_thematic_mapping.png 2012-11-13 13:16:30 +0000 and src/docbkx/en/resources/images/gis/gis_thematic_mapping.png 2013-10-15 14:18:28 +0000 differ
=== added file 'src/docbkx/en/resources/images/visualizer/chart_integration.png'
Binary files src/docbkx/en/resources/images/visualizer/chart_integration.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/visualizer/chart_integration.png 2013-10-15 14:18:28 +0000 differ
=== modified file 'src/docbkx/en/resources/images/visualizer/column_chart.png'
Binary files src/docbkx/en/resources/images/visualizer/column_chart.png 2012-07-27 21:17:29 +0000 and src/docbkx/en/resources/images/visualizer/column_chart.png 2013-10-15 14:18:28 +0000 differ
=== modified file 'src/docbkx/en/resources/images/visualizer/favorites.png'
Binary files src/docbkx/en/resources/images/visualizer/favorites.png 2012-07-27 21:17:29 +0000 and src/docbkx/en/resources/images/visualizer/favorites.png 2013-10-15 14:18:28 +0000 differ
