dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 938
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Fri 2014-01-03 15:00:30 +0100
message:
  Data set categories / attributes docs
added:
  src/docbkx/en/resources/images/datasets/dataset-categories.png
modified:
  src/docbkx/en/dhis2_user_man_datasets_forms.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

=== modified file 'src/docbkx/en/dhis2_user_man_datasets_forms.xml'
--- src/docbkx/en/dhis2_user_man_datasets_forms.xml	2013-12-30 04:13:45 +0000
+++ src/docbkx/en/dhis2_user_man_datasets_forms.xml	2014-01-03 14:00:30 +0000
@@ -8,8 +8,8 @@
       data sets in Maintenance-&gt;Data sets. A data set is a collection of data elements grouped
       together for data collection and data export between instances of DHIS2 (e.g. from a district
       office local installation to a national server). </para>
-    <para>A data set has  a data collection frequency which can be set through the period type
-      property.  The frequency can be daily, weekly, monthly, quarterly, six-monthly, or yearly.
+    <para>A data set has a data collection frequency which can be set through the period type
+      property. The frequency can be daily, weekly, monthly, quarterly, six-monthly, or yearly.
       Which data elements to include in the data set and the frequency are set in the Add/Edit Data
       set window. In order to use a data set to collect data for a specific orgunit you must assign
       the orgunit to the data set, and this mechanism controls which org units that can use which
@@ -38,8 +38,8 @@
           message will be delivered through the DHIS messaging system.</para>
       </listitem>
       <listitem>
-        <para>Approve data: Define whether data for this data set should be Approved.
-          (See the Data approval chapter.)</para>
+        <para>Approve data: Define whether data for this data set should be Approved. (See the Data
+          approval chapter.)</para>
       </listitem>
       <listitem>
         <para>Skip aggregation: Define whether data for this data set should be skipped during data
@@ -50,14 +50,14 @@
       <listitem>
         <para>Allow future periods: Defines whether it should be possible to enter data for future
           periods for this data set in data entry. The default behavior is to allow data entry only
-          for periods which have passed, i.e. the end date is after today&apos;s date. If set to yes you
-          can enter data for future periods, which is useful e.g. for population, target and
+          for periods which have passed, i.e. the end date is after today&apos;s date. If set to yes
+          you can enter data for future periods, which is useful e.g. for population, target and
           planning data.&apos;</para>
       </listitem>
       <listitem>
         <para>All fields for data elements required: Defines whether it is mandatory to fill all
           values for a data element in data entry if one or more values have been filled. This means
-          that if the user enters one data value for a data element in an entry field  (i.e. for a
+          that if the user enters one data value for a data element in an entry field (i.e. for a
           category option combination), then she must enter data for all fields belonging to that
           data element (i.e. all category option combinations).</para>
       </listitem>
@@ -70,7 +70,7 @@
       <listitem>
         <para>Skip Offline: Controls whether this data entry form should be downloaded and saved in
           the user&apos;s web browser. Normally you should leave this on no, which is the default
-          behavior. If  you have forms which are rarely used and are very big you can consider
+          behavior. If you have forms which are rarely used and are very big you can consider
           setting it to yes to speed up initial loading of the data entry module.</para>
       </listitem>
     </itemizedlist>
@@ -85,7 +85,8 @@
       <screenshot>
         <mediaobject>
           <imageobject>
-            <imagedata width="70%" align="center" fileref="resources/images/datasets/datasets_0.png"/>
+            <imagedata align="center" fileref="resources/images/datasets/datasets_0.png"
+            />
           </imageobject>
         </mediaobject>
       </screenshot>
@@ -99,7 +100,8 @@
           <para>Add new: Adds a new data set. When pressing this button, you can create a new data
             set. You need to provide a name, shortname and frequency. The &quot;Code&quot; attribute
             is optional. Data elements can be added to the &quot;Selected data element&quot; list by
-            selecting them individually. and pressing the <inlinegraphic fileref="resources/images/dhis2_images/move_right.png"/> button. Indicators can also
+            selecting them individually. and pressing the <inlinegraphic
+              fileref="resources/images/dhis2_images/move_right.png"/> button. Indicators can also
             be added to data sets and will be available to be placed in custom data entry forms when
             they need to be shown along with data elements on the same data entry form. Press
             &quot;Save&quot; to add the new data set. </para>
@@ -125,7 +127,10 @@
             detailed information of how to use this function. </para>
         </listitem>
         <listitem>
-          <para><inlinegraphic fileref="resources/images/dhis2_images/edit_compulsory_data_elements.png"/> Edit compulsory data elements: This dialog will allow you to add or remove data elements which will be marked as compulsory during data entry. </para>
+          <para><inlinegraphic
+              fileref="resources/images/dhis2_images/edit_compulsory_data_elements.png"/> Edit
+            compulsory data elements: This dialog will allow you to add or remove data elements
+            which will be marked as compulsory during data entry. </para>
         </listitem>
         <listitem>
           <para><inlinegraphic fileref="resources/images/dhis2_images/delete.png"/> Delete:
@@ -145,6 +150,37 @@
         </listitem>
       </itemizedlist>
     </section>
+    <section>
+      <title>Data set categories</title>
+      <para>Before reading this section it is recommended to familiarize oneself with the sections
+        on categories in the data element chapter. Whereas data element categories can be used for
+        capturing disaggregations of data elements, data set categories are used to capture
+        information which is common to an entire form.</para>
+      <para>To set up categories for data set, start by creating category options, categories and
+        category combinations like described in the data element chapter. Make sure that you set the
+        type of categories and category combinations to "Attribute". To assign a category
+        combination to a data set, you can select it while creating or updating the data set from
+        the "Combination of categories" drop-down box.</para>
+      <para>When a data set is linked to a category combination, those categories will be displayed
+        as drop-down boxes in the data entry module. Data captured in the form will then be linked
+        to the selected category options from those drop-down boxes.</para>
+      <para>An scenario for when data set categories are useful is when you need to capture a data
+        entry form for a implementer partner organisation and a project. In that case, start by
+        creating category options and categories for all partner organisations and projects, before
+        linking these in a new category combination. Then, link te category combination to the data
+        set (form) which you need to capture this information. When opening this data set in data
+        entry module, the partner organisation and project categories will automatically be rendered
+        as drop-down boxes, allowing you to select a specific organisation and project before
+        starting to do data entry.</para>
+      <screenshot>
+        <mediaobject>
+          <imageobject>
+            <imagedata align="center" fileref="resources/images/datasets/dataset-categories.png"
+            />
+          </imageobject>
+        </mediaobject>
+      </screenshot>
+    </section>
   </section>
   <section>
     <title>Data Entry Forms</title>
@@ -201,7 +237,7 @@
           <screenshot>
             <mediaobject>
               <imageobject>
-                <imagedata width="60%" align="center" fileref="resources/images/datasets/grey_field_management.png"/>
+                <imagedata align="center" fileref="resources/images/datasets/grey_field_management.png"/>
               </imageobject>
             </mediaobject>
           </screenshot>
@@ -216,7 +252,7 @@
         <screeninfo>Section form example</screeninfo>
         <mediaobject>
           <imageobject>
-            <imagedata width="100%" fileref="resources/images/dhis2UserManual/section_form.png" format="PNG"/>
+            <imagedata fileref="resources/images/dhis2UserManual/section_form.png" format="PNG"/>
           </imageobject>
         </mediaobject>
       </screenshot>
@@ -242,7 +278,7 @@
       <screenshot>
         <mediaobject>
           <imageobject>
-            <imagedata width="50%" align="center" fileref="resources/images/datasets/custom_forms_data_elements.png"/>
+            <imagedata align="center" fileref="resources/images/datasets/custom_forms_data_elements.png"/>
           </imageobject>
         </mediaobject>
       </screenshot>

=== added file 'src/docbkx/en/resources/images/datasets/dataset-categories.png'
Binary files src/docbkx/en/resources/images/datasets/dataset-categories.png	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/datasets/dataset-categories.png	2014-01-03 14:00:30 +0000 differ