dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 222
committer: staringk <staringk@HQWD0066385>
branch nick: dhis2-docbook-docs
timestamp: Sun 2010-09-05 20:50:31 +0200
message:
  Converted all backslashes to forward slashes to enable translation of documentation using xml2po
modified:
  src/docbkx/en/dhis2_implementation_guide.xml
  src/docbkx/en/dhis2_user_man_data_dimensions.xml
  src/docbkx/en/dhis2_user_man_excel_reports.xml
  src/docbkx/en/dhis2_user_man_import_export.xml
  src/docbkx/en/dhis2_user_man_mobile.xml
  src/docbkx/en/dhis2_user_man_reporting.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_implementation_guide.xml'
--- src/docbkx/en/dhis2_implementation_guide.xml	2010-07-15 09:51:14 +0000
+++ src/docbkx/en/dhis2_implementation_guide.xml	2010-09-05 18:50:31 +0000
@@ -40,7 +40,7 @@
     <title>Compiling DHIS2</title>
     <para>First, create an environment variable called <envar>JAVA_OPTS</envar>, and set its value to: <parameter>-Xms128m -Xmx512m -XX:PermSize=128m -XX:MaxPermSize=512m</parameter> . In addition to this environment variable, you will need to ensure that maven is accessible through your console. </para>
     <para>A sample Windows batch script is provided below. There are two seperate steps during the build process: 1) Building the DHIS2 core modules 2) Building the DHIS2 Web modules and portal.</para>
-    <para><literallayout><computeroutput>set start_time=%time% echo Building DHIS 2 Core cd trunk\dhis-2\ call mvn clean install -Dtest=skip -DfailIfNoTests=false echo Building DHIS 2 Web cd dhis-web call mvn clean install -Dtest=skip -DfailIfNoTests=false echo start %start_time% echo finish %time%</computeroutput> </literallayout></para>
+    <para><literallayout><computeroutput>set start_time=%time% echo Building DHIS 2 Core cd trunk/dhis-2 call mvn clean install -Dtest=skip -DfailIfNoTests=false echo Building DHIS 2 Web cd dhis-web call mvn clean install -Dtest=skip -DfailIfNoTests=false echo start %start_time% echo finish %time%</computeroutput> </literallayout></para>
     <para>A sample Linux build script is provided below. </para>
     <para><literallayout><computeroutput>#!/bin/sh echo &quot;Building DHIS 2 Core...&quot; cd dhis/trunk/dhis-2 mvn clean install -Dtest=skip -DfailIfNoTests=false echo &quot;Building DHIS 2 Web...&quot; cd dhis-web mvn clean install -Dtest=skip -DfailIfNoTests=false </computeroutput></literallayout></para>
     <para>Both of these scripts have been included in the <filename>/dhis2/dhis2/dhis2-live-installer</filename> directory. Review the <filename>INSTALLER-README.txt</filename> file for more details of these build scripts and their functionality.</para>

=== modified file 'src/docbkx/en/dhis2_user_man_data_dimensions.xml'
--- src/docbkx/en/dhis2_user_man_data_dimensions.xml	2010-05-13 08:46:48 +0000
+++ src/docbkx/en/dhis2_user_man_data_dimensions.xml	2010-09-05 18:50:31 +0000
@@ -502,7 +502,7 @@
     <para><screenshot>
         <mediaobject>
           <imageobject>
-            <imagedata width="60%" align="center" fileref="resources\images\data_dimensions\pivot_hiv_age_gender.jpg" format="JPG"/>
+            <imagedata width="60%" align="center" fileref="resources/images/data_dimensions/pivot_hiv_age_gender.jpg" format="JPG"/>
           </imageobject>
         </mediaobject>
       </screenshot></para>
@@ -544,7 +544,7 @@
       <para><screenshot>
           <mediaobject>
             <imageobject>
-              <imagedata width="60%" align="center" fileref="resources\images\data_dimensions\PHUF3.jpg" format="JPG"/>
+              <imagedata width="60%" align="center" fileref="resources/images/data_dimensions/PHUF3.jpg" format="JPG"/>
             </imageobject>
           </mediaobject>
         </screenshot> </para>

=== modified file 'src/docbkx/en/dhis2_user_man_excel_reports.xml'
--- src/docbkx/en/dhis2_user_man_excel_reports.xml	2010-07-02 05:20:42 +0000
+++ src/docbkx/en/dhis2_user_man_excel_reports.xml	2010-09-05 18:50:31 +0000
@@ -16,7 +16,7 @@
     <para>There are six function of this module.</para>
     <orderedlist>
       <listitem>
-        <para><emphasis role="italic">Configuration</emphasis>: Set a path to the directory where the excel template files are stored. This file path should be an absolute directory on your system. For instance, if the templates are stored in C:\Program Files\DHIS2\conf\excelreporting\templates&quot;, you should navigate to this directory by clicking the &quot;Browse&quot; button.  These templates are used to define the layout of the report, and must be produced through a process documented below.</para>
+        <para><emphasis role="italic">Configuration</emphasis>: Set a path to the directory where the excel template files are stored. This file path should be an absolute directory on your system. For instance, if the templates are stored in C:/Program Files/DHIS2/conf/excelreporting/templates&quot;, you should navigate to this directory by clicking the &quot;Browse&quot; button.  These templates are used to define the layout of the report, and must be produced through a process documented below.</para>
       </listitem>
       <listitem>
         <para><emphasis role="italic">List of reports</emphasis>: This module allows users to assign reports to different organizational units . There are four types of reports that are currently supported: a report containing standard data elements,  a report listing organisation unit groups as rows, a report listing period of time as columns, a report generating data elements combined with categories.</para>

=== modified file 'src/docbkx/en/dhis2_user_man_import_export.xml'
--- src/docbkx/en/dhis2_user_man_import_export.xml	2010-05-12 06:45:52 +0000
+++ src/docbkx/en/dhis2_user_man_import_export.xml	2010-09-05 18:50:31 +0000
@@ -42,7 +42,7 @@
           </imageobject>
         </mediaobject>
       </screenshot>
-      <para>The exported data values are stored in an ‘xml file’. The file name is defined by the name of the source organisation unit and the period to allow the receiving organisation unit to identify the source and the period of the export file. The XML is placed in your home directory (On Windows this is normally <filename>C:\Documents and Settings\</filename> under the sub-directories <filename>/dhis / import-export</filename>.
+      <para>The exported data values are stored in an ‘xml file’. The file name is defined by the name of the source organisation unit and the period to allow the receiving organisation unit to identify the source and the period of the export file. The XML is placed in your home directory (On Windows this is normally <filename>C:/Documents and Settings/</filename> under the sub-directories <filename>/dhis / import-export</filename>.
 </para>
   </section>
       <section>

=== modified file 'src/docbkx/en/dhis2_user_man_mobile.xml'
--- src/docbkx/en/dhis2_user_man_mobile.xml	2010-07-15 09:15:30 +0000
+++ src/docbkx/en/dhis2_user_man_mobile.xml	2010-09-05 18:50:31 +0000
@@ -44,7 +44,7 @@
         following pom.xml files:</para>
         <itemizedlist>
           <listitem>
-            <para>in dhis-web-portal\pom.xml, add dependency to dhis-web-mobile:
+            <para>in dhis-web-portal/pom.xml, add dependency to dhis-web-mobile:
               <screen>
 &lt;dependency&gt;
       &lt;groupId&gt;org.hisp.dhis&lt;/groupId&gt;
@@ -56,12 +56,12 @@
             </para>
           </listitem>
           <listitem>
-            <para>in dhis-web\pom.xml, add module dhis-web-mobile:
+            <para>in dhis-web/pom.xml, add module dhis-web-mobile:
               <screen>&lt;module&gt;dhis-web-mobile&lt;/module&gt;</screen>
             </para>
           </listitem>
           <listitem>
-            <para>in dhis-services\pom.xml, add module dhis-service-mobile:
+            <para>in dhis-services/pom.xml, add module dhis-service-mobile:
               <screen>&lt;module&gt;dhis-service-mobile&lt;/module&gt;</screen>
             </para>
           </listitem>
@@ -69,8 +69,8 @@
         <para>After the pom-files are altered, build your .war-file using 
       <code>mvn clean install</code>. (To skip the tests, use 
       <code>mvn clean install -Dtest=false -DfailIfNoTests=false</code>.)</para>
-        <para>Copy the dhis.war file from dhis-web-portal\target to the 
-      tomcat\webapps folder. Rename it if you want.</para>
+        <para>Copy the dhis.war file from dhis-web-portal/target to the 
+      tomcat/webapps folder. Rename it if you want.</para>
       </section>
       <section>
         <title>Install the GSM modem</title>
@@ -82,18 +82,18 @@
         <itemizedlist>
           <listitem>
             <para>comm.jar</para>
-            <para>Copy it to your <code>java\jreX\lib\ext</code> folder. If you&apos;ve got multiple 
+            <para>Copy it to your <code>java/jreX/lib/ext</code> folder. If you&apos;ve got multiple 
           installations of JRE, you can find the path to the installation used by 
           DHIS 2 by right clicking the Monitor Tomcat icon in the system tray, 
           then Configure -&gt; Java.</para>
           </listitem>
           <listitem>
             <para>javax.comm.properties</para>
-            <para>Copy it to your <code>java\jreX\lib</code> folder.</para>
+            <para>Copy it to your <code>java/jreX/lib</code> folder.</para>
           </listitem>
           <listitem>
             <para>win32com.dll</para>
-            <para>Copy it to your <code>java\jreX\bin</code> folder.</para>
+            <para>Copy it to your <code>java/jreX/bin</code> folder.</para>
             <para><emphasis>Note: You might need administrator privileges to do this. If you still can&apos;t do it, try starting Windows in Safe Mode.</emphasis></para>
           </listitem>
           <listitem>
@@ -105,7 +105,7 @@
           </listitem>
           <listitem>
             <para>formIDLayout.csv</para>
-            <para>Copy it to your <code>DHIS2_HOME\mi</code> folder. If you have not yet deployed your latest build of DHIS2, you&apos;ll have to create the mi folder manually.</para>
+            <para>Copy it to your <code>DHIS2_HOME/mi</code> folder. If you have not yet deployed your latest build of DHIS2, you&apos;ll have to create the mi folder manually.</para>
             <para>This file specifies which data elements are to be imported. There&apos;s one line for each different mobile application in use. The lines start with a mobile application&apos;s id, then followed by comma separated data element ids and their categoryoptioncombo ids. The lines will be on the form
             <screen>
 1 = &lt;data element id&gt;.&lt;categoryoptioncombo id&gt;, 
@@ -160,7 +160,7 @@
         <title>Import pending messages</title>
         <para>If SMSs are sent from the phones to the SIM card in the GSM modem 
         while the SMS Service is inactive, the messages will be stored as xml 
-        files in the folder <code>DHIS2_HOME\mi\pending</code> short time after 
+        files in the folder <code>DHIS2_HOME/mi/pending</code> short time after 
         the service is started. On the Receive Data and Import page it will say 
         how many SMSs are pending. These can be imported by pressing the &quot;Import 
         All Pending&quot; button.</para>

=== modified file 'src/docbkx/en/dhis2_user_man_reporting.xml'
--- src/docbkx/en/dhis2_user_man_reporting.xml	2010-08-24 10:48:43 +0000
+++ src/docbkx/en/dhis2_user_man_reporting.xml	2010-09-05 18:50:31 +0000
@@ -274,7 +274,7 @@
       </section>
       <section>
         <title>Using report tables</title>
-        <para>To make the report tables reusable over time and across orgunits they can have \ parameters. Three types of parameters are allowed; orgunit, parent orgunit (for listing of orgunits in one area) and reporting month. As a side note I can mention that we are looking into expanding this to include reporting quarter and year, or to make that period parameter more generic with regard to period type somehow. Be able to use period as a parameter makes the report table reusable over time and as such fits nicely with report needs such as monthly, quarterly or annual reports. When a report is run by the user in the DHIS 2 the user must specify the values for the report tables that are linked to the report, and first the report table is re-generated (deleted and re-created with updated data) and then the report is run (in BIRT report engine).
+        <para>To make the report tables reusable over time and across orgunits they can have parameters. Three types of parameters are allowed; orgunit, parent orgunit (for listing of orgunits in one area) and reporting month. As a side note I can mention that we are looking into expanding this to include reporting quarter and year, or to make that period parameter more generic with regard to period type somehow. Be able to use period as a parameter makes the report table reusable over time and as such fits nicely with report needs such as monthly, quarterly or annual reports. When a report is run by the user in the DHIS 2 the user must specify the values for the report tables that are linked to the report, and first the report table is re-generated (deleted and re-created with updated data) and then the report is run (in BIRT report engine).
 
 </para>
         <para>Report tables can consist of either values related to data elements or indicators, and not a mix of the two. A third report table type is data completeness, which is related to completeness of reporting across orgunits for a given month. Completeness reports will be covered in a separate section. The reason for not mixing data elements and indicators in one report table is due to the cross tab functionality that would be very complex and less useful with yet another dimension. Since two or more report tables can easily be linked to one report this limitation should not have much effect on report design possibilities.
@@ -364,14 +364,14 @@
 (these examples use the postgres driver, just replace as needed)</para>
           <para><emphasis role="bold">2)</emphasis> <emphasis role="bold">Designer:</emphasis>
 </para>
-          <para>Copy the file postgresql-8.3-603.jdbc3.jar to the folder &lt;BIRT_designer_install_path&gt;\plugins\org.eclipse.birt.report.data.oda.jdbc_2.3.0.v20080610\drivers, for the designer version 2-3-0
+          <para>Copy the file postgresql-8.3-603.jdbc3.jar to the folder &lt;BIRT_designer_install_path&gt;/plugins/org.eclipse.birt.report.data.oda.jdbc_2.3.0.v20080610/drivers, for the designer version 2-3-0
 
 </para>
           <para><emphasis role="bold">3) Viewer:</emphasis>
 </para>
           <para>The birt viewer distributed by HISP already contains the necessary drivers. If you download the BIRT viewer from the Eclipse BIRT project you need to put the driver yourself:
 </para>
-          <para>Copy the file postgresql-8.3-603.jdbc3.jar to the folder (inside tomcat/webapps/) &lt;BIRT_viewer_path&gt;\WEB-INF\platform\plugins\org.eclipse.birt.report.data.oda.jdbc_2.3.0.v20080610\drivers 
+          <para>Copy the file postgresql-8.3-603.jdbc3.jar to the folder (inside tomcat/webapps/) &lt;BIRT_viewer_path&gt;/WEB-INF/platform/plugins/org.eclipse.birt.report.data.oda.jdbc_2.3.0.v20080610/drivers 
 
 </para>
           <para>This will serve as a connection between the reports to be designed and the database from which you will be fetching data.
@@ -383,7 +383,7 @@
 </para>
           <para>In Reports-&gt;Standard reports fill in the in the details on where the BIRT viewer web application is located
 </para>
-          <para>Home: the absolute path to your birt viwer, e.g. E:\dhis2\tomcat\webapps\birt
+          <para>Home: the absolute path to your birt viwer, e.g. E:/dhis2/tomcat/webapps/birt
 Directory: the name of the birt viewer folder, e.g. birt
 </para>
         </section>