dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #09549
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 239: DHIS 2 user doc improvements (work in progress).
------------------------------------------------------------
revno: 239
committer: Jan Henrik Overland <janhenrik.overland@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Thu 2011-01-13 17:35:18 +0100
message:
DHIS 2 user doc improvements (work in progress).
modified:
src/docbkx/en/dhis2_user_man_data_elements.xml
src/docbkx/en/resources/images/dhis2UserManual/user_management.png
src/docbkx/en/resources/images/dhis2_images/delete.png
src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png
src/docbkx/en/resources/images/maintainence/data_element_categories_start.png
src/docbkx/en/resources/images/maintainence/data_element_category_combo_add_new.png
src/docbkx/en/resources/images/maintainence/data_element_edit.png
src/docbkx/en/resources/images/maintainence/data_element_group_add.png
src/docbkx/en/resources/images/maintainence/data_element_group_editor_start.png
src/docbkx/en/resources/images/maintainence/data_element_group_set.png
src/docbkx/en/resources/images/maintainence/data_element_main.png
src/docbkx/en/resources/images/maintainence/data_element_main2.png
src/docbkx/en/resources/images/maintainence/data_element_translate.png
src/docbkx/en/resources/xsl/fop-cust.xsl
--
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_data_elements.xml'
--- src/docbkx/en/dhis2_user_man_data_elements.xml 2010-12-08 13:58:54 +0000
+++ src/docbkx/en/dhis2_user_man_data_elements.xml 2011-01-13 16:35:18 +0000
@@ -6,7 +6,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_main.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_main.png"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -40,7 +40,7 @@
<section id="dataElement">
<title>Data elements</title>
<para>Data elements form the basis of DHIS2. Data elements define what is actually recorded in system, e.g. number of immunisations or number of cases of malaria. The actual creation and definition of the data elements themselves are far beyond the scope of this manual to describe, but it is assumed that an administrator will be provided with a list of standardised data elements for inclusion into the DHIS2 system. </para>
- <para>To access the data element maintenance module, choose Maintenance->Data elements->Data element. </para>
+ <para>To access the data element maintenance module, choose Maintenance -> Data elements and Indicators -> Data element. </para>
<para>The ‘Filter by name’ will allow you to filter a range of data elements if you know either the full name of the data element, or just a part of it. Type the name
into the search field and any matching data elements are displayed below.
You can also choose ‘Filter by group/view all’ to narrow down a data
@@ -51,7 +51,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_main2.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_main2.png"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -62,7 +62,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_edit.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_edit.png"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -102,43 +102,24 @@
</listitem>
<listitem>
<para>Data element group sets: Click the check box to activate this option hen choose which data element group sets this data element should belong to. Available data element group sets are displayed din the upper window. Click the desired data element group set, then the <guibutton>"Add selected"</guibutton> button to add the data element to the group set. To remove a data element from a group set, click the data element group set in the lower list, and then click<guibutton> "Remove selected"</guibutton>. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_elements_group_sets.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
</listitem>
<listitem>
<para>Calculated: This option is available only when a data element is created. </para>
- <para>Select the data elements that will be used to define the calculated data element, and then click "Add selected" to add them calculated data element composition list. Fill in the correct factor for the data element calculation component (defaults to 1). Component elements of the calculated data element can be removed from the definition by pressing the "Remove" button. <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_calculated_define.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
+ <para>Select the data elements that will be used to define the calculated data element, and then click "Add selected" to add them calculated data element composition list. Fill in the correct factor for the data element calculation component (defaults to 1). Component elements of the calculated data element can be removed from the definition by pressing the "Remove" button.</para>
</listitem>
<listitem>
- <para>Aggregation levels: The Aggregation Levels option allows the data element to be aggregated at one or more levels. When the user clicks on the Aggregation levels option, a drop down menu appears which displays available aggregation levels. The desired aggregation level is then selected by clicking the ‘Add Selected’ button. By default, the aggregation will start at the lowest assigned organisation unit. If e.g. Chiefdom is selected below it means that Chiefdom, District, and National aggregates will use Chiefdom (the highest aggregation level available) as the data source, and PHU data will not be included. PHU data will still be available for the PHU level, but not included in aggregations to the levels above. If District and Chiefdom are both selected then the District and National level aggregates will use District data as their source, Chiefdom will use Chiefdom, and PHU will use PHU. Read more about aggregation levels in the Reporting chapter i the section on data sources for reporting. <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_aggregation_levels.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
+ <para>Aggregation levels: The Aggregation Levels option allows the data element to be aggregated at one or more levels. When the user clicks on the Aggregation levels option, a drop down menu appears which displays available aggregation levels. The desired aggregation level is then selected by clicking the ‘Add Selected’ button. By default, the aggregation will start at the lowest assigned organisation unit. If e.g. Chiefdom is selected below it means that Chiefdom, District, and National aggregates will use Chiefdom (the highest aggregation level available) as the data source, and PHU data will not be included. PHU data will still be available for the PHU level, but not included in aggregations to the levels above. If District and Chiefdom are both selected then the District and National level aggregates will use District data as their source, Chiefdom will use Chiefdom, and PHU will use PHU. Read more about aggregation levels in the Reporting chapter i the section on data sources for reporting.</para>
</listitem>
</itemizedlist>
<para>After making the required changes, click ‘Save’ to institute them. The ‘Cancel’ button aborts all changes made.</para>
</section>
<section>
<title>Data element translation</title>
- <para>DHIS2 provides functionality to translate existing data elements into other languages. Simply press the translate button <inlinegraphic fileref="resources/images/dhis2_images/i18n.png" align="center"/> to get stared. The following dialogue will appear. </para>
+ <para>DHIS2 provides functionality to translate existing data elements into other languages. Simply press the translate button <inlinegraphic fileref="resources/images/dhis2_images/i18n.png" align="center"/> to get started. The following dialogue will appear. </para>
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_translate.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_translate.png"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -158,14 +139,7 @@
</section>
<section>
<title>Deleting a data element</title>
- <para>Simply press the delete button <inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> to delete a data element. Note that this operation is only possible if there is no data attached to the data element itself. The user will be prompted to ensure that the data element should be deleted. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_delete.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>Simply press the delete button <inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> to delete a data element. Note that this operation is only possible if there is no data attached to the data element itself. The user will be prompted to ensure that the data element should be deleted.</para>
</section>
<section>
<title>Displaying data element details</title>
@@ -174,56 +148,36 @@
</section>
<section id="dataElementGroup">
<title>Data element groups</title>
- <para>Data element groups provide a mechanism for classifying related data elements into a common theme. For instance, two data elements "Measles immunisation" and "BCG Immunisation" might be grouped together into a data element group "Childhood immunisation". To access the data element group maintenance page, click Maintenance->Data elements and indicators->Data Element Group . The following screen will be displayed. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_groups_main.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>Data element groups provide a mechanism for classifying related data elements into a common theme. For instance, two data elements "Measles immunisation" and "BCG Immunisation" might be grouped together into a data element group "Childhood immunisation". To access the data element group maintenance page, click Maintenance -> Data elements and Indicators -> Data Element Group.</para>
<para>Similar to the "Data element" maintenance page, data elements groups can be searched with by entering a search string in the "Filter by name" field. </para>
- <para>To add a new data element group, click the <guibutton>"Add new"</guibutton> button. <screenshot>
+ <para>To add a new data element group, click the <guibutton>"Add new"</guibutton> button and the following screen will be displayed:</para>
+ <screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_group_add.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_group_add.png"/>
</imageobject>
</mediaobject>
- </screenshot></para>
+ </screenshot>
<para>Fill in the "Name" field and then select all data elements that should belong to the group from the left panel. Click the "Move selected" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/>button to add the selected data elements to the data element group. Click the "Remove selected" button to remove all data elements from the group that have been selected in the right panel. Finally, click the "Add" button to save changes, or the "Cancel" button to discard any changes. </para>
</section>
<section id="dataElementGroupEditor">
<title>Data element group editor</title>
- <para>The data element group editor provides advanced functionality to the administrator to allow multiple data elements to be added or removed from a group. It is also possible to create new data element groups, rename existing groups, and delete groups entirely. To access the data element group editor, press <guimenu>"Maintainers->Data elements and indicators->Data element group editor"</guimenu> from the main DHIS2 menu. The following screen will appear. <screenshot>
+ <para>The data element group editor provides advanced functionality to the administrator to allow multiple data elements to be added or removed from a group. It is also possible to create new data element groups, rename existing groups, and delete groups entirely. To access the data element group editor, go to <guimenu>"Maintenance -> Data elements and Indicators -> Data Element Group Editor"</guimenu>. The following screen will appear.<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_group_editor_start.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_group_editor_start.png"/>
</imageobject>
</mediaobject>
</screenshot></para>
- <para>Data element groups area listed alphabetically in the leftmost panel. By clicking on a data element group, the current members of that group (data elements) are listed in the centre panel. Available data elements that can be added to the data element group appear are listed alphabetically in the rightmost panel. To remove an existing data element from the group, click the name of the data element in the centre panel, and then press the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. To add data elements to the group, select them from the leftmost panel, and click the "Move left" <inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. Press the <guibutton>"Update data element group member"</guibutton> button to save your changes. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_group_editor_select.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>Data element groups area listed alphabetically in the leftmost panel. By clicking on a data element group, the current members of that group (data elements) are listed in the centre panel. Available data elements that can be added to the data element group appear are listed alphabetically in the rightmost panel. To remove an existing data element from the group, click the name of the data element in the centre panel, and then press the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. To add data elements to the group, select them from the leftmost panel, and click the "Move left" <inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. Press the <guibutton>"Update data element group member"</guibutton> button to save your changes.</para>
</section>
<section id="dataElementGroupSet">
<title>Data element group sets</title>
- <para>Data element group sets allow multiple data element groups to be categorised into a set. Data element group sets are used during analysis and reporting to combine similar data element groups into a common theme. To access the data element group set maintenance module, choose "Maintenance->Data elements and indicators->Data element group set". Similar to the other data element maintenance modules, new data element group sets can be added by pressing the "Add new button". Other operations include Edit, Translate, Delete and Information, similar to the other modules in this section. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_group_set_start.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>Data element group sets allow multiple data element groups to be categorised into a set. Data element group sets are used during analysis and reporting to combine similar data element groups into a common theme. To access the data element group set maintenance module, choose "Maintenance -> Data elements and Indicators -> Data Element Group Set". Similar to the other data element maintenance modules, new data element group sets can be added by pressing the "Add new button". Other operations include Edit, Translate, Delete and Information, similar to the other modules in this section.</para>
<para>Existing data element group set members can be edited by clicking the "Edit" button <inlinegraphic fileref="resources/images/dhis2_images/edit.png" align="center"/> of the desired data element group set as seen below.</para>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_group_set.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_group_set.png"/>
</imageobject>
</mediaobject>
<para>Available data element groups are displayed in the left panel. They can be moved into the selected data element group set by pressing the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. Data element groups that are currently members of the data element group set are displayed in the right hand panel. They can be removed from the data element group set by clicking the desired data element group and pressing the "Move left"<inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. The ordering of the data element groups can be set with the "Move Up" <inlinegraphic fileref="resources/images/dhis2_images/move_up.png" align="center"/> and "Move Down" <inlinegraphic fileref="resources/images/dhis2_images/move_down.png" align="center"/>arrows. This ordering will be used in the datamart and reports to order the data element groups. Press the <guibutton>"Update"</guibutton> button to save any changes and the <guibutton>"Cancel"</guibutton> button to discard all changes. </para>
@@ -247,19 +201,19 @@
<caution>
<para>It is critical that the proper categories and category options are defined in the initial definition step, as further changes to the category and its options will are not possible. </para>
</caution>
- <para>To access the data element category maintenance module, press "Maintenance->Data elements and indicators->Data element category". The following screen will be displayed. </para>
+ <para>To access the data element category maintenance module, press "Maintenance -> Data Elements and Indicators->Data Element Category". The following screen will be displayed:</para>
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_categories_start.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_categories_start.png"/>
</imageobject>
</mediaobject>
</screenshot>
- <para>Similar to the other data element maintains modules, data element categories can be filtered by typing the name of the data element category (or a portion of it) into the "Filter by name" field. To add a new data element category, press the "Add new" button which will then display the following screen. </para>
+ <para>Similar to the other data element maintains modules, data element categories can be filtered by typing the name of the data element category (or a portion of it) into the "Filter by name" field. To add a new data element category, press the "Add new" button which will then display the following screen:</para>
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="40%" align="center" fileref="resources/images/maintainence/data_element_categories_add_new.png" format="PNG"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_categories_add_new.png"/>
</imageobject>
</mediaobject>
</screenshot>
@@ -284,7 +238,7 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_category_combo_add_new.png"/>
+ <imagedata width="100%" format="PNG" fileref="resources/images/maintainence/data_element_category_combo_add_new.png"/>
</imageobject>
</mediaobject>
</screenshot>
=== modified file 'src/docbkx/en/resources/images/dhis2UserManual/user_management.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/user_management.png 2011-01-13 14:46:08 +0000 and src/docbkx/en/resources/images/dhis2UserManual/user_management.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/dhis2_images/delete.png'
Binary files src/docbkx/en/resources/images/dhis2_images/delete.png 2010-01-19 19:29:45 +0000 and src/docbkx/en/resources/images/dhis2_images/delete.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png 2010-01-23 11:17:19 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_categories_start.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_categories_start.png 2010-01-23 11:17:19 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_start.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_category_combo_add_new.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_category_combo_add_new.png 2010-01-23 11:17:19 +0000 and src/docbkx/en/resources/images/maintainence/data_element_category_combo_add_new.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_edit.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_edit.png 2010-01-18 15:58:42 +0000 and src/docbkx/en/resources/images/maintainence/data_element_edit.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_group_add.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_group_add.png 2010-01-19 19:29:45 +0000 and src/docbkx/en/resources/images/maintainence/data_element_group_add.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_group_editor_start.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_group_editor_start.png 2010-01-21 16:51:36 +0000 and src/docbkx/en/resources/images/maintainence/data_element_group_editor_start.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_group_set.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_group_set.png 2010-01-23 11:17:19 +0000 and src/docbkx/en/resources/images/maintainence/data_element_group_set.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_main.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_main.png 2010-01-18 15:58:42 +0000 and src/docbkx/en/resources/images/maintainence/data_element_main.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_main2.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_main2.png 2010-01-18 15:58:42 +0000 and src/docbkx/en/resources/images/maintainence/data_element_main2.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_translate.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_translate.png 2010-01-19 19:29:45 +0000 and src/docbkx/en/resources/images/maintainence/data_element_translate.png 2011-01-13 16:35:18 +0000 differ
=== modified file 'src/docbkx/en/resources/xsl/fop-cust.xsl'
--- src/docbkx/en/resources/xsl/fop-cust.xsl 2011-01-13 14:46:08 +0000
+++ src/docbkx/en/resources/xsl/fop-cust.xsl 2011-01-13 16:35:18 +0000
@@ -50,10 +50,10 @@
<xsl:template name="book.titlepage.recto">
- <fo:block font-family="Helvetica" font-size="26pt" text-align="center" padding-before="85mm">
+ <fo:block font-family="Helvetica" font-size="30pt" text-align="center" padding-before="85mm">
<xsl:text>DHIS 2 User Manual</xsl:text>
</fo:block>
- <fo:block padding-before="6mm">
+ <fo:block padding-before="5mm">
<fo:table table-layout="fixed" width="175mm">
<fo:table-column column-width="175mm"/>
<fo:table-body>
@@ -67,7 +67,7 @@
</fo:table-body>
</fo:table>
</fo:block>
- <fo:block font-family="Helvetica" font-size="12pt" text-align="center" padding-before="7mm">
+ <fo:block font-family="Helvetica" font-size="11pt" text-align="center" padding-before="7mm">
<xsl:text>Copyright ©right; 2006-2010</xsl:text>
</fo:block>
</xsl:template>
