Bug 114179 - Concentration, improvement, and templatisation of Bugzilla general user help system. Patch by gerv; r,a=justdave.

4 files changed, 126 insertions, 1 deletions

diff --git a/template/en/default/global/footer.html.tmpl b/template/en/default/global/footer.html.tmpl
index 017e8d810..7baf3207a 100644
--- a/template/en/default/global/footer.html.tmpl
+++ b/template/en/default/global/footer.html.tmpl
@@ -23,8 +23,12 @@
   # This template has no interface. However, you must fulfill the interface to
   # global/useful-links.html.tmpl.
   #%]
+
+[% INCLUDE "global/help.html.tmpl" %]
   
-[%# Migration note: this whole file corresponds to the old Param 'footerhtml' %]
+[%# Migration note: below this point, this file corresponds to the old Param
+  # 'footerhtml' 
+  #%]
   
 <table border="0">
   <tr>
diff --git a/template/en/default/global/header.html.tmpl b/template/en/default/global/header.html.tmpl
index ed133140d..825f3c333 100644
--- a/template/en/default/global/header.html.tmpl
+++ b/template/en/default/global/header.html.tmpl
@@ -69,6 +69,8 @@
       </script>
     [% END %]
     
+    [%+ INCLUDE "global/help-header.html.tmpl" %]        
+
     [% IF style %]
       <style type="text/css">
         [% style %]
diff --git a/template/en/default/global/help-header.html.tmpl b/template/en/default/global/help-header.html.tmpl
new file mode 100644
index 000000000..3cbb4e371
--- /dev/null
+++ b/template/en/default/global/help-header.html.tmpl
@@ -0,0 +1,88 @@
+<!-- 1.0@bugzilla.org -->
+[%# The contents of this file are subject to the Mozilla Public
+  # License Version 1.1 (the "License"); you may not use this file
+  # except in compliance with the License. You may obtain a copy of
+  # the License at http://www.mozilla.org/MPL/
+  #
+  # Software distributed under the License is distributed on an "AS
+  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+  # implied. See the License for the specific language governing
+  # rights and limitations under the License.
+  #
+  # The Original Code is the Bugzilla Bug Tracking System.
+  #
+  # The Initial Developer of the Original Code is Netscape Communications
+  # Corporation. Portions created by Netscape are
+  # Copyright (C) 1998 Netscape Communications Corporation. All
+  # Rights Reserved.
+  #
+  # Contributor(s): Gervase Markham <gerv@gerv.net>
+  #%]
+
+[% IF help %]
+  [% IF user_agent.search("Mozilla/5") %]
+    <style type="text/css">
+    .help {
+        border-style: solid;
+        border-color: #F0A000;
+        background-color: #FFFFFF;
+        padding: 5;
+        position: absolute;
+    }
+    </style>
+
+    <script type="application/x-javascript">
+    var currentHelp;
+
+    function initHelp() {
+        for (var i = 0; i < document.forms.length; i++) {
+            for (var j = 0; j < document.forms[i].elements.length; j++) {
+                [%# MS decided to add fieldsets to the elements array; and 
+                  # Mozilla decided to copy this brokenness. Grr. 
+                  #%]
+                if (document.forms[i].elements[j].tagName != 'FIELDSET') {
+                    document.forms[i].elements[j].onmouseover = showHelp;
+                }
+            }
+        }
+
+        document.body.onclick = hideHelp;
+    }
+
+    function showHelp() {      
+        hideHelp();
+        var newHelp = document.getElementById(this.name + '_help');
+        if (newHelp) {
+            currentHelp = newHelp;
+
+            var mytop = this.offsetTop;
+            var myleft = this.offsetLeft;
+            var myparent = this.offsetParent;
+            while (myparent.tagName != 'BODY') {
+                mytop = mytop + myparent.offsetTop;
+                myleft = myleft + myparent.offsetLeft;
+                myparent = myparent.offsetParent;
+            }
+
+            currentHelp.style.top = mytop + this.offsetHeight + 5;
+            currentHelp.style.left = myleft;
+            currentHelp.style.display='';
+        }
+    }
+
+    function hideHelp() {
+        if (currentHelp) {
+            currentHelp.style.display='none';
+        }
+    }
+    </script>
+  [% END %]
+[% ELSE %]
+  <script type="text/javascript">
+  <!--
+  [%# Avoid warnings by having a dummy function %]
+  function initHelp() {}
+  // -->
+  </script>
+[% END %]
+
diff --git a/template/en/default/global/help.html.tmpl b/template/en/default/global/help.html.tmpl
new file mode 100644
index 000000000..2e43bcee6
--- /dev/null
+++ b/template/en/default/global/help.html.tmpl
@@ -0,0 +1,31 @@
+<!-- 1.0@bugzilla.org -->
+[%# The contents of this file are subject to the Mozilla Public
+  # License Version 1.1 (the "License"); you may not use this file
+  # except in compliance with the License. You may obtain a copy of
+  # the License at http://www.mozilla.org/MPL/
+  #
+  # Software distributed under the License is distributed on an "AS
+  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+  # implied. See the License for the specific language governing
+  # rights and limitations under the License.
+  #
+  # The Original Code is the Bugzilla Bug Tracking System.
+  #
+  # The Initial Developer of the Original Code is Netscape Communications
+  # Corporation. Portions created by Netscape are
+  # Copyright (C) 1998 Netscape Communications Corporation. All
+  # Rights Reserved.
+  #
+  # Contributor(s): Gervase Markham <gerv@gerv.net>
+  #%]
+                  
+[% IF help %]
+  [% IF user_agent.search("Mozilla/5") %]
+      [% FOREACH h = help_html %]
+      <div id="[% h.id %]_help" class="help" style="display: none;">
+        [%- h.html -%]  
+      </div>
+      [% END %]
+  [% END %]
+[% END %]
+