← Back to team overview

dhis2-devs team mailing list archive

[Branch ~dhis2-devs-core/dhis2/trunk] Rev 1510: Implement help center based on docbook source. Can be accessed from the Help link in the top menu

 

------------------------------------------------------------
revno: 1510
committer: Lars Helge Oeverland <larshelge@xxxxxxxxx>
branch nick: trunk
timestamp: Thu 2010-02-25 19:35:33 +0100
message:
  Implement help center based on docbook source. Can be accessed from the Help link in the top menu
added:
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.js
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.vm
modified:
  dhis-2/dhis-options/src/main/resources/help_content.xml
  dhis-2/dhis-options/src/main/resources/helpitems_stylesheet.xsl
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/main.vm
  dhis-2/dhis-web/dhis-web-commons/src/main/resources/dhis-web-commons.xml
  dhis-2/dhis-web/dhis-web-commons/src/main/resources/i18n_global.properties


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription.
=== modified file 'dhis-2/dhis-options/src/main/resources/help_content.xml'
--- dhis-2/dhis-options/src/main/resources/help_content.xml	2010-02-25 13:53:26 +0000
+++ dhis-2/dhis-options/src/main/resources/help_content.xml	2010-02-25 18:35:33 +0000
@@ -407,7 +407,7 @@
     </section>
   </chapter>
   <chapter>
-    <title>Data Administration in DHIS 2</title>
+    <title>Data Administration</title>
     <para>The data administration module provides a range of functions to ensure that the data stored in the DHIS2 database is integral and that the database performance is optimised. These functions should be executed on a regular basis by a data administrator to ensure that the quality of the data stored is optimal. </para>
     <section id="dataBrowser">
       <title>Data browser</title>

=== modified file 'dhis-2/dhis-options/src/main/resources/helpitems_stylesheet.xsl'
--- dhis-2/dhis-options/src/main/resources/helpitems_stylesheet.xsl	2010-02-25 16:37:29 +0000
+++ dhis-2/dhis-options/src/main/resources/helpitems_stylesheet.xsl	2010-02-25 18:35:33 +0000
@@ -2,12 +2,12 @@
 <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform";>
 
 <xsl:template match="chapter">
-  <h3><xsl:value-of select="title"/></h3>
+  <h4><xsl:value-of select="title"/></h4>
   <ul><xsl:apply-templates select="descendant::section[@id]"/></ul>
 </xsl:template>
 
 <xsl:template match="section">
-  <li><a href="getHelpContent('{@id}')"><xsl:value-of select="title"/></a></li>
+  <li><a href="javascript:getHelpItemContent('{@id}')"><xsl:value-of select="title"/></a></li>
 </xsl:template>
 
 <xsl:template match="/">

=== added file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.js'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.js	1970-01-01 00:00:00 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.js	2010-02-25 18:35:33 +0000
@@ -0,0 +1,21 @@
+
+$( document ).ready( function()
+{
+    $.get( 
+       '../dhis-web-commons-help/getHelpItems.action',
+       function( data )
+       {
+           $( "div#helpMenu" ).html( data );
+       } );
+} );
+
+function getHelpItemContent( id )
+{
+	$.get( 
+       '../dhis-web-commons-help/getHelpContent.action',
+       { "id": id },
+       function( data )
+       {
+           $( "div#helpContent" ).html( data );
+       } );
+}

=== added file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.vm'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.vm	1970-01-01 00:00:00 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/about/help.vm	2010-02-25 18:35:33 +0000
@@ -0,0 +1,9 @@
+
+<h3>$i18n.getString( "help_center" )</h3>
+
+<table>
+<tr>
+<td valign="top"><div id="helpMenu"></div></td>
+<td valign="top"><div id="helpContent">$i18n.getString( "help_intro" )</div></td>
+</tr>
+</table>
\ No newline at end of file

=== modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css	2010-02-25 13:53:26 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css	2010-02-25 18:35:33 +0000
@@ -49,6 +49,41 @@
 }
 
 /*----------------------------------------------------------------------------*/
+/* Help page                                                                  */
+/*----------------------------------------------------------------------------*/
+
+div#helpMenu
+{
+  width: 260px;
+  padding-top: 7px;
+  padding-bottom: 13px;
+  padding-left: 20px;
+  padding-right: 20px;
+  border: 1px solid #a0a0a0;
+}
+
+div#helpMenu ul
+{
+  list-style-type: none;
+}
+
+div#helpMenu a
+{
+  text-decoration: none;
+}
+
+div#helpContent
+{
+  padding-left: 20px;
+  padding-right: 20px;
+}
+
+div#helpContent ul,ol
+{
+  padding-left: 17px;
+}
+
+/*----------------------------------------------------------------------------*/
 /* Thingy                                                                     */
 /*----------------------------------------------------------------------------*/
 

=== modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/main.vm'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/main.vm	2010-02-25 13:53:26 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/main.vm	2010-02-25 18:35:33 +0000
@@ -76,7 +76,7 @@
       
       <div id="menuDropDown3" class="menuDropDownArea" onmouseover="cancelHideDropDownTimeout()" onmouseout="hideDropDownTimeout()">
         <ul class="menuDropDownBox">
-          <li class="menuDropDownItem" onclick="window.location.href='../dhis-web-commons-about/help.action'">$i18n.getString( "help_contents" )&nbsp;</li>
+          <li class="menuDropDownItem" onclick="window.location.href='../dhis-web-commons-about/help.action'">$i18n.getString( "help_center" )&nbsp;</li>
           <li class="menuDropDownItem" onclick="window.location.href='../dhis-web-commons-about/displayFeedbackForm.action'">$i18n.getString( "feedback" )&nbsp;</li>
           <li class="menuDropDownItem" onclick="window.location.href='../dhis-web-commons-about/displayChangeLog.action'">$i18n.getString( "change_log" )&nbsp;</li>
           <li class="menuDropDownItem" onclick="window.location.href='../dhis-web-commons-about/showUpdateUserAccountForm.action'">$i18n.getString( "user_account" )&nbsp;</li>

=== modified file 'dhis-2/dhis-web/dhis-web-commons/src/main/resources/dhis-web-commons.xml'
--- dhis-2/dhis-web/dhis-web-commons/src/main/resources/dhis-web-commons.xml	2010-02-25 15:43:36 +0000
+++ dhis-2/dhis-web/dhis-web-commons/src/main/resources/dhis-web-commons.xml	2010-02-25 18:35:33 +0000
@@ -228,6 +228,12 @@
 	<package name="dhis-web-commons-help" extends="dhis-web-commons"
 		namespace="/dhis-web-commons-help">
 
+		<action name="help" class="org.hisp.dhis.commons.action.NoAction">
+			<result name="success" type="velocity">/main.vm</result>
+			<param name="page">/dhis-web-commons/about/help.vm</param>
+			<param name="javascripts">../dhis-web-commons/about/help.js</param>
+		</action>
+
 		<action name="getHelpContent" class="org.hisp.dhis.help.action.GetHelpContentAction">
 			<result name="success" type="outputStreamResult"></result>
 		</action>
@@ -474,11 +480,12 @@
 			<result name="success" type="redirect">about.action</result>
 		</action>
 
-		<action name="help" class="org.hisp.dhis.about.action.HelpAction">
-			<result name="success" type="velocity">/main.vm</result>
-			<param name="page">/dhis-web-commons/help/help.vm</param>
-			<param name="menu">/dhis-web-commons/about/menu.vm</param>
-		</action>
+        <action name="help" class="org.hisp.dhis.commons.action.NoAction">
+            <result name="success" type="velocity">/main.vm</result>
+            <param name="page">/dhis-web-commons/about/help.vm</param>
+            <param name="menu">/dhis-web-commons/about/menu.vm</param>
+            <param name="javascripts">../dhis-web-commons/about/help.js</param>
+        </action>
 
 		<action name="displayChangeLog" class="org.hisp.dhis.commons.action.NoAction">
 			<result name="success" type="velocity">/main.vm</result>

=== modified file 'dhis-2/dhis-web/dhis-web-commons/src/main/resources/i18n_global.properties'
--- dhis-2/dhis-web/dhis-web-commons/src/main/resources/i18n_global.properties	2010-02-25 13:53:26 +0000
+++ dhis-2/dhis-web/dhis-web-commons/src/main/resources/i18n_global.properties	2010-02-25 18:35:33 +0000
@@ -262,5 +262,7 @@
 password_not_match  = Password not match
 update_user_success	= Update Informations Success
 
+help_center = Help Center
+help_intro = Welcome to the DHIS 2 Help Center. Please select an item from the menu to the left.
 close = Close
 please_wait_while_the_system_is_processing = Please wait while the system is processing