dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 551
committer: Jan Henrik Overland <janhenrik.overland@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2012-07-27 23:17:29 +0200
message:
  DV docs updated.
modified:
  src/docbkx/en/dhis2_user_man_using_data_visualizer.xml
  src/docbkx/en/resources/images/visualizer/column_chart.png
  src/docbkx/en/resources/images/visualizer/data_table.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	2012-04-28 07:44:34 +0000
+++ src/docbkx/en/dhis2_user_man_using_data_visualizer.xml	2012-07-27 21:17:29 +0000
@@ -21,7 +21,7 @@
       <screeninfo>Data visualizer module displaying a column chart.</screeninfo>
       <mediaobject>
         <imageobject>
-          <imagedata width="100%" fileref="resources/images/visualizer/column_chart.png" format="PNG"/>
+          <imagedata width="100%" height="100%" fileref="resources/images/visualizer/column_chart.png" format="PNG"/>
         </imageobject>
       </mediaobject>
     </screenshot>
@@ -58,7 +58,7 @@
     <para>This section lets you define which dimension of the data you want to appear as series, category and filter. This asks for a closer explanation. Dimension in this regard refers to the elements which describe the data values in the system. We have three main dimensions in the system:</para>
     <orderedlist>
       <listitem>
-        <para>Data: Includes data elements and indicators, describing the phenomena or event of the data.</para>
+        <para>Data: Includes data elements, indicators and datasets (reporting rates), describing the phenomena or event of the data.</para>
       </listitem>
       <listitem>
         <para>Periods: Describes when the event took place.</para>
@@ -99,34 +99,37 @@
     <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 &quot;Reporting rates&quot; 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 periods</title>
-    <para>To select periods click on the &quot;Periods&quot; header. You can select any number of periods from the set of periods listed under the header, such as &quot;Last month&quot;, &quot;Months this year&quot; and &quot;Last 5 years&quot;. 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 &quot;Last month&quot;, the month of February will be included in the chart.</para>
+    <title>Selecting relative periods</title>
+    <para>To select relative periods click on the &quot;Relative periods&quot; header. You can select any number of periods from the set of periods listed under the header, such as &quot;Last month&quot;, &quot;Months this year&quot; and &quot;Last 5 years&quot;. 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 &quot;Last month&quot;, 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 &quot;Fixed periods&quot; 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>
   </section>
   <section>
     <title>Selecting organisation units</title>
-    <para>You can select which organisation units to include in the chart by clicking on the &quot;Organisation units&quot; header. This section features a tree including all organisaiton units in the system. You can select any of the organisation units by clicking on 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 &quot;Select all children&quot;.</para>
+    <para>You can select which organisation units to include in the chart by clicking the &quot;Organisation units&quot; header. This section features a tree including all organisatiton 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 &quot;Select all children&quot;. You can also automatically select all organisation units in a particular organisation unit group. Click the &quot;Group&quot; 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 &quot;User organisation unit&quot; 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 &quot;system&quot; 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 &quot;User organisation unit children&quot; checkbox.</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>
   </section>
   <section>
     <title>Selecting chart options</title>
     <para>You can set various chart options by clicking on the &quot;Chart options&quot; header in the panel to the  left. </para>
     <itemizedlist>
       <listitem>
-        <para>Show data: Displays the corresponding value next to columns and bars in the chart.</para>
-      </listitem>
-      <listitem>
-        <para>Hide subtitle: Hides the title and subtitle of your chart.</para>
-      </listitem>
-      <listitem>
-        <para>User org unit: Includes the organisation unit of the  currently logged in user in the organisation unit selection. Useful when displaying the chart on the dashboard since each user will get a relevant chart for their own location. </para>
-      </listitem>
-      <listitem>
-        <para>Trend line: The trend line will visualize how your data evolves over time - e.g. is performance improving or detoriating. Makes sense when periods are selected as category. </para>
-      </listitem>
-      <listitem>
-        <para>Hide legend: Hides the legend and leave more room for the chart itself.</para>
-      </listitem>
-      <listitem>
-        <para>User org unit children: Includes the direct children of the organisation unit of the currently logged in user in the organisation unit selection.</para>
+        <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 detoriating. 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>
       </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>
@@ -150,9 +153,9 @@
   </section>
   <section id="dvDisplayChart">
     <title>Displaying a chart</title>
-    <para>You can display a chart based on your selections simply by clicking the &quot;Update&quot; button on the top centre menu. This requires that you have selected one or more elements from all of the three dimensions - data, periods and organisation units. Note that &quot;Months this year&quot; from the period dimension and the root organisation unit are selected by default.</para>
-    <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 at the left of the chart.</para>
-    <para>If you want to give the chart more space on your screen you can click on the triple-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>
+    <para>You can display a chart based on your selections simply by clicking the &quot;Update&quot; button on the top centre menu. This requires that you have selected one or more elements from all of the three dimensions - data (indicators, data elements, reporting rates), periods (relative, fixed) and organisation units (units or groups). Note that &quot;Months this year&quot; from the period dimension and the root organisation unit are selected by default.</para>
+    <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>
@@ -183,6 +186,10 @@
       </mediaobject>
     </screenshot>
   </section>
+  <section id="dvInterpretations">
+    <title>Sharing interpretations</title>
+    <para>For certain analysis-related resources in DHIS, like charts and report tables, one can share a data interpretation. An interpretation is simply a link to the the relevant resource together with a text expressing some insight about the data. If you want to share a chart interpretation you need to first save the chart you want to share as a favorite. Then, without making any changes to the chart, click the &quot;Share&quot; button the toolbar. A window will open up and this is where you write your interpretation. When you are done, click share button in the bottom right corner of the window. The window will close automatically and if the interpretation was shared successfully you will find a notification on the bottom toolbar.</para>
+  </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 &quot;Exit&quot; button to the right side of the top centre menu.</para>

=== modified file 'src/docbkx/en/resources/images/visualizer/column_chart.png'
Binary files src/docbkx/en/resources/images/visualizer/column_chart.png	2011-11-26 20:50:19 +0000 and src/docbkx/en/resources/images/visualizer/column_chart.png	2012-07-27 21:17:29 +0000 differ
=== modified file 'src/docbkx/en/resources/images/visualizer/data_table.png'
Binary files src/docbkx/en/resources/images/visualizer/data_table.png	2011-11-26 20:50:19 +0000 and src/docbkx/en/resources/images/visualizer/data_table.png	2012-07-27 21:17:29 +0000 differ
=== modified file 'src/docbkx/en/resources/images/visualizer/favorites.png'
Binary files src/docbkx/en/resources/images/visualizer/favorites.png	2012-02-08 19:12:20 +0000 and src/docbkx/en/resources/images/visualizer/favorites.png	2012-07-27 21:17:29 +0000 differ