← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 378: Incorporated mydatamart manual as appendix in user manual

 

------------------------------------------------------------
revno: 378
committer: Bob Jolliffe bobjolliffe@xxxxxxxxx
branch nick: dhis2-docbook-docs
timestamp: Sat 2011-08-27 19:08:37 +0100
message:
  Incorporated mydatamart manual as appendix in user manual
removed:
  pom_mydatamart.xml
modified:
  src/docbkx/en/dhis2_technical_architechture_guide.xml
  src/docbkx/en/dhis2_user_manual_en.xml
  src/docbkx/en/mydatamart_en.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
=== removed file 'pom_mydatamart.xml'
--- pom_mydatamart.xml	2011-06-20 23:22:00 +0000
+++ pom_mydatamart.xml	1970-01-01 00:00:00 +0000
@@ -1,133 +0,0 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";>
-  <modelVersion>4.0.0</modelVersion>
-  <groupId>org.hisp.dhis</groupId>
-  <artifactId>dhis-documentation-docbook</artifactId>
-  <name>DHIS 2 Documentation</name>
-  <version>2.2-SNAPSHOT</version>
-  <description>DHIS 2 Documentation</description>
-  <packaging>pom</packaging>
-   <pluginRepositories>
-  <pluginRepository>
-    <id>docbkx.snapshots</id>
-    <name>Maven Plugin Snapshots</name>
-    <url>http://docbkx-tools.sourceforge.net/snapshots/</url>
-			<releases>
-				<enabled>true</enabled>
-			</releases>
-			<snapshots>
-				<enabled>false</enabled>
-			</snapshots>
-		</pluginRepository>
-	</pluginRepositories>
-
-  <properties>
-    <docbkx.plugin.version>2.0.13</docbkx.plugin.version>
-    <docbook.source>${project.basedir}/src/docbkx</docbook.source>
-    <docbook.target>${project.basedir}/target/site</docbook.target>
-  </properties>
-
-  <build>
-    <plugins>
-	 <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-antrun-plugin</artifactId>
-        <executions>
-          <execution>
-            <phase>package</phase>
-            <configuration>
-              <tasks>
-                <tstamp>
-                  <format property="now" pattern="yyyy-MM-dd HH:mm:ss"/>
-                </tstamp>
-                <exec executable="bzr" outputproperty="revision" failifexecutionfails="false">
-                      <arg line="revno -q"/>
-                </exec>
-               <echo file="${project.basedir}/src/docbkx/build.properties" message="&lt;?xml version=&apos;1.0&apos; encoding=&apos;UTF-8&apos;?&gt;&lt;revhistory&gt;&lt;revision&gt;&lt;revnumber&gt; Revision ${revision}&lt;/revnumber&gt;&lt;revremark&gt;Version ${project.version} ${now}&lt;/revremark&gt;&lt;/revision&gt;&lt;/revhistory&gt;" />
-              </tasks>
-            </configuration>
-            <goals>
-              <goal>run</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>com.agilejava.docbkx</groupId>
-        <artifactId>docbkx-maven-plugin</artifactId>
-        <version>${docbkx.plugin.version}</version>
-        <configuration>
-          <xincludeSupported>true</xincludeSupported>
-        </configuration>
-
-        <executions>
-
-          <execution>
-            <id>html-docs-en</id>
-            <phase>package</phase>
-            <goals>
-              <goal>generate-html</goal>
-            </goals>
-            <configuration>
-              <htmlStylesheet>resources/css/docbook_bsd.css</htmlStylesheet>
-              <glossaryCollection>resources/glossary_en.xml</glossaryCollection>
-              <sectionAutolabel>1</sectionAutolabel>
-              <sectionLabelIncludesComponentLabel>1</sectionLabelIncludesComponentLabel>
-              <chunkedOutput>false</chunkedOutput>
-              <includes>mydatamart_en.xml</includes>
-              <sourceDirectory>${docbook.source}/en/</sourceDirectory>
-              <postProcess>
-                <copy file="target/docbkx/html/mydatamart_en.html" tofile="${docbook.target}/en/mydatamart/html/full.html" />
-              </postProcess>
-            </configuration>
-          </execution>
-          
-
-          <execution>
-            <id>pdf-docs-en-mydatamart</id>
-            <phase>package</phase>
-            <goals>
-              <goal>generate-pdf</goal>
-            </goals>
-            <configuration>
-              <argLine>-Xmx1024m</argLine>
-              <foCustomization>${docbook.source}/en/resources/xsl/fop-cust.xsl</foCustomization>
-              <doubleSided>1</doubleSided>
-              <includes>mydatamart_en.xml</includes>
-              <sourceDirectory>${docbook.source}/en/</sourceDirectory>
-              <postProcess>
-                <copy file="target/docbkx/pdf/mydatamart_en.pdf" todir="${docbook.target}/en/user" />
-              </postProcess>
-            </configuration>
-          </execution>
-
-		</executions>
-        <dependencies>
-          <dependency>
-            <groupId>org.docbook</groupId>
-            <artifactId>docbook-xml</artifactId>
-            <version>4.4</version>
-            <scope>runtime</scope>
-          </dependency>
-        </dependencies>
-      </plugin>
-      <plugin>
-        <groupId>com.agilejava.docbkx</groupId>
-        <artifactId>docbkx-fop-support</artifactId>
-        <version>${docbkx.plugin.version}</version>
-        <executions>
-          <execution>
-            <phase>generate-resources</phase>
-            <goals>
-              <goal>generate</goal>
-            </goals>
-            <configuration>
-              <ansi>false</ansi>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
-
-    </plugins>
-  </build>
-</project>

=== modified file 'src/docbkx/en/dhis2_technical_architechture_guide.xml'
--- src/docbkx/en/dhis2_technical_architechture_guide.xml	2011-02-03 14:10:08 +0000
+++ src/docbkx/en/dhis2_technical_architechture_guide.xml	2011-08-27 18:08:37 +0000
@@ -1,5 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. --><!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
+<!-- This document was created with Syntext Serna Free. -->
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
 <article>
   <title>DHIS 2 Technical Architecture</title>
   <articleinfo>

=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml	2011-06-10 07:03:53 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml	2011-08-27 18:08:37 +0000
@@ -73,6 +73,13 @@
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_documentation_guide.xml" encoding="UTF-8" xpointer="docs_10"/>
   </appendix>
   <appendix>
+    <title>MyDatamart User Manual</title>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="mydatamart_en.xml" encoding="UTF-8" xpointer="Background"/>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="mydatamart_en.xml" encoding="UTF-8" xpointer="Installation"/>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="mydatamart_en.xml" encoding="UTF-8" xpointer="Application"/>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="mydatamart_en.xml" encoding="UTF-8" xpointer="Summary"/>
+  </appendix>
+  <appendix>
     <title> DHIS Technical Architecture Guide</title>
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_technical_architechture_guide.xml" encoding="UTF-8" xpointer="technicalOverview"/>
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_technical_architechture_guide.xml" encoding="UTF-8" xpointer="technicalRequirements"/>

=== modified file 'src/docbkx/en/mydatamart_en.xml'
--- src/docbkx/en/mydatamart_en.xml	2011-06-21 16:58:00 +0000
+++ src/docbkx/en/mydatamart_en.xml	2011-08-27 18:08:37 +0000
@@ -1,56 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-                      "http://www.docbook.org/xml/4.4/docbookx.dtd";>
-<book>
-    <bookinfo>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
+<article>
         <title>MyDatamart User Manual</title>
-        <!--        <releaseinfo><?eval ${project.version}?></releaseinfo>-->
-        <releaseinfo>1.0</releaseinfo>
-        <keywordset>
+        <articleinfo>
+            <keywordset>
             <keyword>DHIS2</keyword>
             <keyword>HMIS</keyword>
             <keyword>aggregate data</keyword>
             <keyword>Health Management Information System</keyword>
             <keyword>Integrated data repository</keyword>
             <keyword>Health Information System</keyword>
-        </keywordset>
-        <copyright>
-            <year>2006-2011</year>
-        </copyright>
-        <author>
-            <firstname>Dhis2</firstname>
-            <surname>Documentation Team</surname>
-        </author>
-        <legalnotice>
-            <formalpara id="warranty">
-                <title>Warranty:</title>
-                <para> THIS DOCUMENT IS PROVIDED BY THE AUTHORS &apos;&apos;AS IS&apos;&apos; 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>
-            <formalpara id="license">
-                <title>License:</title>
-                <para> Permission is granted to copy, distribute and/or modify this document under
-                    the terms of the GNU Free Documentation License, Version 1.3 or any later
-                    version published by the Free Software Foundation; with no Invariant Sections,
-                    no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
-                    in the source of this documentation, and is available here online:<ulink
-                        url="http://www.gnu.org/licenses/fdl.html";>
-                        http://www.gnu.org/licenses/fdl.html</ulink>.</para>
-            </formalpara>
-        </legalnotice>
-        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="../build.properties"
-            encoding="UTF-8"/>
-    </bookinfo>
-    <chapter>
+            </keywordset>
+        </articleinfo> 
+    <section id="Background">
         <title>Background</title>
         <para>The Mydatamart tool was created to address a changing paradigm in the deployment of
             DHIS2. In the past, going back to the days even before DHIS was a web application, the
@@ -104,9 +66,9 @@
             configured to use ODBC connections to the local Sqlite database instead of the remote
             database server.</para>
 
-    </chapter>
+    </section>
 
-    <chapter>
+    <section id="Installation">
         <title>Installation</title>
         <para>Installation of Mydatamart has been made as simple as possible. The application itself
             is a self-contained executable which doesn't require any additional installation
@@ -174,9 +136,9 @@
                 </listitem>
             </orderedlist>
         </para>
-    </chapter>
+    </section>
 
-    <chapter>
+    <section id="Application">
         <title>The Mydatamart application</title>
         <para>The purpose of the Mydatamart application is to manage a local datamart store which is
             populated by downloading small chunks of data from the central DHIS2 web application. It
@@ -479,10 +441,10 @@
             option or by simply pressing the "F2" shortcut key.</para>
             <para>It is a good idea to capture the content of this console log when reporting problems to the developers.</para>
         </section>
-    </chapter>
-    <chapter>
+    </section>
+    <section id="Summary">
         <title>Summmary notes</title>
         <para><emphasis>Put some short quick reference notes for common tasks here - Ed.</emphasis></para>
-    </chapter>
+    </section>
 
-</book>
+</article>