dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #04015
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 84: Completed first draft of data element maintainance section
------------------------------------------------------------
revno: 84
committer: Jason Pickering <jason@jason-laptop>
branch nick: dhis2-docbook-docs
timestamp: Sat 2010-01-23 13:17:19 +0200
message:
Completed first draft of data element maintainance section
added:
src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png
src/docbkx/en/resources/images/maintainence/data_element_categories_edit.png
src/docbkx/en/resources/images/maintainence/data_element_categories_start.png
src/docbkx/en/resources/images/maintainence/data_element_category_combinations_start.png
src/docbkx/en/resources/images/maintainence/data_element_category_combo_add_new.png
src/docbkx/en/resources/images/maintainence/data_element_category_combo_edit.png
src/docbkx/en/resources/images/maintainence/data_element_group_set.png
src/docbkx/en/resources/images/maintainence/data_element_group_set_main.png
modified:
src/docbkx/en/dhis2_user_man_data_elements.xml
src/docbkx/en/dhis2_user_manual_en.xml
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-01-21 16:51:36 +0000
+++ src/docbkx/en/dhis2_user_man_data_elements.xml 2010-01-23 11:17:19 +0000
@@ -207,7 +207,7 @@
<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>"Maintaience->Data elements and indicators->Data element group editor"</guimenu> from the main DHIS2 menu. The following screen will appear. <screenshot>
<mediaobject>
<imageobject>
- <imagedata fileref="resources/images/maintainence/data_element_group_editor_start.png" align="center" width="80%" format="PNG"/>
+ <imagedata width="80%" align="center" fileref="resources/images/maintainence/data_element_group_editor_start.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot></para>
@@ -215,14 +215,93 @@
<screenshot>
<mediaobject>
<imageobject>
- <imagedata fileref="resources/images/maintainence/data_element_group_editor_select.png" align="center" width="80%" format="PNG"/>
+ <imagedata width="80%" align="center" fileref="resources/images/maintainence/data_element_group_editor_select.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
</section>
<section>
<title>Data element group sets</title>
- <para>Data element group sets allow multiple data element groups to be categorized into a set. </para>
+ <para>Data element group sets allow multiple data element groups to be categorized 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 maintainence module, choose "Maintainence->Data elements and indicators->Data element group set". Similar to the other data element maintainence 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="70%" align="center" fileref="resources/images/maintainence/data_element_group_set_start.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <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="70%" align="center" fileref="resources/images/maintainence/data_element_group_set.png" format="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 elemente 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>
+ </section>
+ <section>
+ <title>Data element categories</title>
+ <para>Data element categories can be used to disaggregate data elements into individual atomic components. Data element categories are typically a concept, such as Gender, Age or Disease Status. Data elements such as "Number of cases of confirmed malaria" are often broken into smaller component parts to determine, for instance, the number of confirmed malaria cases of particular age groups. As an example, three data element categories: Under 1, 1-5 and Over 5 could be created. They could be assigned as categories to the data element, which would then create in the data entry screens, three seperate fields for this data element namely: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Number of confirmed malaria cases (Under 1)</para>
+ </listitem>
+ <listitem>
+ <para>Number of confirmed malaria cases (1-5)</para>
+ </listitem>
+ <listitem>
+ <para>Number of confirmed malaria cases (Over 5)</para>
+ </listitem>
+ </itemizedlist>
+ <para>Effective use of data element categories greatly simplifies the process of setting up the DHIS2 system, as the data element categories can be reused to disaggregate many different data elements. Otherwise, each of the data elements listed above, would need to be created seperately. Judicious use of data element categories will greatly simplify the DHIS2 implementation, and allow for subsequent advanced analysis. </para>
+ <para>Data element categories are composed of category options. Category options must be defined when a data element category is created for the first time. Subsequent changes to the data element category, i.e. adding or deleting new category options, are not allowed once the data element category has been created. </para>
+ <caution>
+ <para>It is critical that the proper categories and category options are defined in the intial definition step, as further changes to the category and its options will are not possible. </para>
+ </caution>
+ <para>To access the data element category maintaince module, press "Maintainance->Data elements and indicators->Data element category". The following screen will be displayed. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="70%" align="center" fileref="resources/images/maintainence/data_element_categories_start.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Similar to the other data element maintiance 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"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Type the name of the new data element category in the "Name" field in the "Details" region. Category options can be added by typing the name of the category option in the "Category option" region and pressing the <guibutton>"Add category option"</guibutton> button. Category options can be reordered using the "MoveUp"<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"/> buttons. Categories options can be deleted by selecting the data element category option and pressing the "Delete"<inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> button. Once all data element categories options have been added to the data elemente category, press the <guibutton>"Add"</guibutton> button to save all changes or the <guibutton>"Cancel"</guibutton> button to discard any changes.<caution>
+ <para>All data element category options must be added and defined properly in this step. Subsequent alterations to the data element category (other than reordering of the category options themselves) is not possible. </para>
+ </caution></para>
+ </section>
+ <section>
+ <title>Data element category combinations</title>
+ <para>Data element category combinations allow multiple data element categories to be combined into a related set. As an example, a data element "Number of new HIV infections" might be disaagrgated according to the following categories. </para>
+ <itemizedlist>
+ <listitem>
+ <para>Age: "Under 5", "5-15", "15-24", "24 and above"</para>
+ </listitem>
+ <listitem>
+ <para>Gender: Male, Female</para>
+ </listitem>
+ </itemizedlist>
+ <para> In this example, there would be two levels of disaggreation, consisting of two seperate data element categories, each consisting of several data element category options. In most HMIS systems, different data elements are disaggregated according to a common set of categories. By combining these different categories into a data element category combination and assigning these combinations to data elements, the appropriate disaggregation levels can be applied efficiently and quickly to a large number of data elements. </para>
+ <para>To access the data element category combination maintainence module, select "Maintainence->Data element and indicators->Data element category combinations" from the main DHIS2 menu. As with the other maintaince modules, you can filter the listed cateogry combinations by entering the name (or portion thereof) of the category combination. Other operations such as "Edit", "Delete" and "Information" should be familiar to the reader. </para>
+ <para>To add a new category combination, click the "Add new" button. The following dialog will be displayed. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" align="center" fileref="resources/images/maintainence/data_element_category_combo_add_new.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Type the name of the category combination in the "Name" field, and then select the desired categories from the left panel. Press the "Move right" button to add the selected categories to the category combination. Press "Move left" to remove any categories that should not be part of the category combination. </para>
+ <caution>
+ <para>Categories can only be added to a category combination at this step. Categories can be removed from category combinations later by editing the category combination, however, it is not allowed to add additional categories once the combination has been created. Ensure that the category combination and its respective categories is final before you create the category combination and assign it to a data element. </para>
+ </caution>
</section>
</section>
</chapter>
=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml 2010-01-22 08:55:40 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml 2010-01-23 11:17:19 +0000
@@ -1,8 +1,22 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. -->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
<book>
- <title>DHIS 2 User Manual</title>
+ <bookinfo>
+ <title>DHIS 2 User Manual</title>
+ <subtitle>The Complete Guide</subtitle>
+ <authorgroup>
+ <author>
+ <firstname>DHIS2</firstname>
+ <surname> Documentation Team</surname>
+ </author>
+ </authorgroup>
+ <legalnotice>
+ <formalpara>
+ <title/>
+ <para>THIS DOCUMENT IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS MANUAL AND PRODUCTS MENTIONED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</para>
+ </formalpara>
+ </legalnotice>
+ </bookinfo>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod1.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod2.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod3.xml" encoding="UTF-8"/>
=== added 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 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png 2010-01-23 11:17:19 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_element_categories_edit.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_categories_edit.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_edit.png 2010-01-23 11:17:19 +0000 differ
=== added 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 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_start.png 2010-01-23 11:17:19 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_element_category_combinations_start.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_category_combinations_start.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_category_combinations_start.png 2010-01-23 11:17:19 +0000 differ
=== added 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 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_category_combo_add_new.png 2010-01-23 11:17:19 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_element_category_combo_edit.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_category_combo_edit.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_category_combo_edit.png 2010-01-23 11:17:19 +0000 differ
=== added 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 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_group_set.png 2010-01-23 11:17:19 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_element_group_set_main.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_group_set_main.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_element_group_set_main.png 2010-01-23 11:17:19 +0000 differ
=== modified file 'src/docbkx/en/resources/xsl/fop-cust.xsl'
--- src/docbkx/en/resources/xsl/fop-cust.xsl 2009-12-11 18:57:46 +0000
+++ src/docbkx/en/resources/xsl/fop-cust.xsl 2010-01-23 11:17:19 +0000
@@ -1,5 +1,3 @@
-<?xml version="1.0"?>
-
<!--
This is the XSL FO (PDF) stylesheet for the Spring reference
@@ -11,7 +9,6 @@
-->
<!DOCTYPE xsl:stylesheet [
- <!ENTITY admon_gfx_path "../images/admons/">
<!ENTITY copyright "©">
]>
@@ -59,13 +56,13 @@
<fo:table-row>
<fo:table-cell text-align="center">
<fo:block padding-before="45mm">
- <fo:external-graphic height="5cm" scaling="uniform" src="file:documentation/src/docbkx/images/logo.jpg"/>
- </fo:block>
- <fo:block font-family="Helvetica" font-size="16pt" padding-before="40mm">
- <xsl:value-of select="bookinfo/title"/>
- </fo:block>
+ <fo:external-graphic height="5cm" scaling="uniform" src="file:./resources/images/dhis2_images/logo.jpg"/>
+ </fo:block>
+ <fo:block>
+ <xsl:value-of select="bookinfo/title" />
+ </fo:block>
<fo:block font-family="Helvetica" font-size="14pt">
- <xsl:value-of select="bookinfo/subtitle"/>
+ <xsl:text>The Complete Guide</xsl:text>
</fo:block>
<fo:block font-family="Helvetica" font-size="12pt">
<xsl:text>Version </xsl:text><xsl:value-of select="bookinfo/releaseinfo"/>
@@ -75,15 +72,15 @@
<fo:table-row>
<fo:table-cell text-align="center">
<fo:block font-family="Helvetica" font-size="12pt">
- <xsl:value-of select="bookinfo/pubdate"/>
+ <xsl:value-of select="book/bookinfo/pubdate"/>
</fo:block>
</fo:table-cell>
</fo:table-row>
<fo:table-row>
<fo:table-cell text-align="center">
<fo:block font-family="Helvetica" font-size="10pt" padding-before="80mm">
- <xsl:text>Copyright ©right; 2004-2008 </xsl:text>
- <xsl:for-each select="bookinfo/authorgroup/author">
+ <xsl:text>Copyright ©right; 2006-2010 </xsl:text>
+ <xsl:for-each select="book/bookinfo/authorgroup/author">
<xsl:if test="position() > 1">
<xsl:text>, </xsl:text>
</xsl:if>
@@ -93,7 +90,7 @@
</xsl:for-each>
</fo:block>
<fo:block font-family="Helvetica" font-size="9pt" padding="1mm">
- <xsl:value-of select="bookinfo/legalnotice"/>
+ <xsl:value-of select="book/bookinfo/legalnotice"/>
</fo:block>
</fo:table-cell>
</fo:table-row>
@@ -402,7 +399,7 @@
<!-- Left aligned text and no hyphenation -->
<xsl:param name="alignment">justify</xsl:param>
- <xsl:param name="hyphenate">true</xsl:param>
+ <xsl:param name="hyphenate">false</xsl:param>
<!-- Default Font size -->
<xsl:param name="body.font.family">Times-Roman</xsl:param>
@@ -622,7 +619,6 @@
<!-- Use nice graphics for admonitions -->
<xsl:param name="admon.graphics">'1'</xsl:param>
- <xsl:param name="admon.graphics.path">&admon_gfx_path;</xsl:param>
<!--###################################################
Misc
@@ -706,4 +702,4 @@
-</xsl:stylesheet>
\ No newline at end of file
+</xsl:stylesheet>
