dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 398
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2011-09-14 13:02:00 +0200
message:
  Added a preface to the main user document which explains conventions used.
added:
  src/docbkx/en/dhis2_preface.xml
modified:
  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

=== added file 'src/docbkx/en/dhis2_preface.xml'
--- src/docbkx/en/dhis2_preface.xml	1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_preface.xml	2011-09-14 11:02:00 +0000
@@ -0,0 +1,27 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
+<preface>
+  <title>About this guide</title>
+  <para>The DHIS2 documentation is a collective effort and has been developed by the development team and users. While the guide strives to be complete, there may be certain functionalities which have been omitted or which have yet to be documented. This section explains some of the conventions which are used throughout the document. </para>
+  <para>DHIS2 is a browser-based application. In many cases, screeenshots have been included for enhanced clarity. Shortcuts to various functionalities are displayed such as &quot;Maintenance-&gt;Data administration&quot;. The &quot;-&gt;&quot; character indicates that you should choose &quot;Maintenance&quot; and then click on &quot;Data administration&quot; in the menu which appears through the browser. </para>
+  <para>Different styles of text have been used to highlight important parts of the text or particular types of text, such as source code. Each of the conventions used in the document are explained below.</para>
+  <note>
+    <para>A note contains additional information which should be considered or a reference to more information which may be helpful.</para>
+  </note>
+  <tip>
+    <para>A tip can be a useful piece of advice, such as how to perform a particular task more efficiently.</para>
+  </tip>
+  <important>
+    <para>Important information should not be ignored, and usually indicates something which is required by the application. </para>
+  </important>
+  <caution>
+    <para>Information contained in these sections should be carefully considered, and if not heeded, could result in unexpected results in analysis, performance, or functionality.</para>
+  </caution>
+  <warning>
+    <para>Information contained in these sections, if not heeded, could result in permanent data loss or affect the overall usability of the system.</para>
+  </warning>
+  <para><programlisting>Program listings usually contain some type of computer code.
+They will be displayed with a shaded background and a different font. </programlisting></para>
+  <para><command>Commands will be displayed in bold text, and represent a command which would need to be executed on the operating system or database.</command></para>
+  <para>Links to external web sites or cross references will be displayed in blue text, and underlined like <ulink url="http://www.dhis2.org";>this</ulink>.</para>
+</preface>

=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml	2011-08-27 18:08:37 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml	2011-09-14 11:02:00 +0000
@@ -40,6 +40,7 @@
     </legalnotice>
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="../build.properties" encoding="UTF-8"/>
   </bookinfo>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_preface.xml" encoding="UTF-8"/>
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_introduction.xml" encoding="UTF-8"/>
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_getting_started.xml" encoding="UTF-8"/>
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_orgunits.xml" encoding="UTF-8"/>

=== modified file 'src/docbkx/en/resources/xsl/fop-cust.xsl'
--- src/docbkx/en/resources/xsl/fop-cust.xsl	2011-09-14 05:12:06 +0000
+++ src/docbkx/en/resources/xsl/fop-cust.xsl	2011-09-14 11:02:00 +0000
@@ -144,7 +144,8 @@
         </fo:block>	
 	</xsl:template>
 
-        
+	
+		
 <!--###################################################
                       Header
     ################################################### -->  
@@ -405,7 +406,6 @@
 	  </xsl:attribute>
 	</xsl:attribute-set>
 
-        
 <!--###################################################
                    Paper & Page Size
     ################################################### -->  
@@ -650,12 +650,12 @@
     </xsl:attribute-set>    
 
     <!-- Shade (background) programlistings -->    
-<!--
+
     <xsl:param name="shade.verbatim">1</xsl:param>
     <xsl:attribute-set name="shade.verbatim.style">
         <xsl:attribute name="background-color">#f0f0f0</xsl:attribute>
     </xsl:attribute-set>
-    -->
+    
     
     <xsl:template match="programlistings/emphasis"> 
         <fo:inline font-weight="bold">