Bug 423486 - Remove help viewer from Firefox and point to SUMO, r=gavin, ui-r=beltzner, a1.9b5=beltzner

browser/app/profile/firefox.js

@@ -725,3 +725,6 @@ pref("editor.singleLine.pasteNewlines", 2);
 
 // The breakpad report server to link to in about:crashes
 pref("breakpad.reportURL", "http://crash-stats.mozilla.com/report/index/");
+
+// base URL for web-based support pages
+pref("app.support.baseURL", "http://support.mozilla.com/1/%APP%/%VERSION%/%OS%/%LOCALE%/");

browser/base/content/baseMenuOverlay.xul

@@ -49,7 +49,6 @@
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
 <script type="application/x-javascript" src="chrome://browser/content/utilityOverlay.js"/>
-<script type="application/x-javascript" src="chrome://help/content/contextHelp.js"/>
 
 #ifdef XP_MACOSX
 <!-- nsMenuBarX hides these and uses them to build the Application menu.
@@ -77,8 +76,7 @@
           accesskey="&helpMenu.accesskey;">
 #endif
       <menupopup id="menu_HelpPopup" onpopupshowing="buildHelpMenu();">
-        <menuitem id="menu_openHelp"
+        <menuitem oncommand="openHelpLink('firefox-help')"
-                  oncommand="openHelp('firefox-help', 'chrome://browser/locale/help/help.rdf');"
 #ifdef XP_MACOSX
                   label="&helpContentsMac.label;"
                   key="key_openHelpMacFrontend"/>
@@ -91,7 +89,7 @@
 #ifdef XP_WIN
         <menuitem label="&helpForIEUsers.label;"
                   accesskey="&helpForIEUsers.accesskey;"
-                  oncommand="openHelp('ieusers', 'chrome://browser/locale/help/help.rdf');"/>
+                  oncommand="openHelpLink('ieusers');"/>
 #endif
         <menuitem id="releaseNotes"
                   accesskey="&helpReleaseNotes.accesskey;"
@@ -117,7 +115,7 @@
 <!-- On mac, we map Cmd+Shift+/, but show Cmd+?
      (that's for en-US, it might be different for other keyboard layouts) -->
         <key id="key_openHelpMac"
-             oncommand="openHelp('firefox-help', 'chrome://browser/locale/help/help.rdf');"
+             oncommand="openHelpLink('firefox-help');"
              key="&openHelpMac.commandkey;"
              modifiers="&openHelpMac.modifiers;"/>
         <key id="key_openHelpMacFrontend"
@@ -135,7 +133,7 @@
              modifiers="&hideOtherAppsCmdMac.modifiers;"/>
 #else
         <key id="key_openHelp"
-            oncommand="openHelp('firefox-help', 'chrome://browser/locale/help/help.rdf');"
+            oncommand="openHelpLink('firefox-help');"
             keycode="&openHelp.commandkey;"/>
 #endif
     </keyset>

browser/base/content/pageinfo/pageInfo.js

@@ -392,7 +392,7 @@ function doHelpButton()
 
   var deck  = document.getElementById("mainDeck");
   var helpdoc = helpTopics[deck.selectedPanel.id] || "pageinfo_general";
-  openHelp(helpdoc, 'chrome://browser/locale/help/help.rdf');
+  openHelpLink(helpdoc);
 }
 
 function showTab(id)

browser/base/content/pageinfo/pageInfo.xul

@@ -71,7 +71,6 @@
   <script type="application/x-javascript" src="chrome://browser/content/pageinfo/permissions.js"/>
   <script type="application/x-javascript" src="chrome://browser/content/pageinfo/security.js"/>
   <script type="application/x-javascript" src="chrome://global/content/strres.js"/>
-  <script type="application/x-javascript" src="chrome://help/content/contextHelp.js"/>
   <script type="application/x-javascript" src="chrome://browser/content/utilityOverlay.js"/>
 
   <stringbundleset id="pageinfobundleset">
@@ -100,8 +99,9 @@
     <key keycode="VK_ESCAPE"                       command="cmd_close"/>
 #ifdef XP_MACOSX
     <key key="."                 modifiers="meta"  command="cmd_close"/>
-#endif
+#else
     <key keycode="VK_F1"                           command="cmd_help"/>
+#endif
     <key key="&copy.key;"        modifiers="accel" command="cmd_copy"/>
     <key key="&selectall.key;"   modifiers="accel" command="cmd_selectall"/>
     <key key="&selectall.key;"   modifiers="alt"   command="cmd_selectall"/>

browser/base/content/utilityOverlay.js

@@ -673,3 +673,25 @@ function getOfflineAppUsage(host)
   return usage;
 }
 
+// aCalledFromModal is optional
+function openHelpLink(aHelpTopic, aCalledFromModal) {
+  var url = Components.classes["@mozilla.org/toolkit/URLFormatterService;1"]
+                      .getService(Components.interfaces.nsIURLFormatter)
+                      .formatURLPref("app.support.baseURL");
+  url += aHelpTopic;
+
+  var where = aCalledFromModal ? "window" : "tab";
+  openUILinkIn(url, where);
+}
+
+function openPrefsHelp() {
+  var prefs = Components.classes["@mozilla.org/preferences-service;1"]
+                        .getService(Components.interfaces.nsIPrefBranch2);
+
+  // non-instant apply prefwindows are usually modal, so we can't open in the topmost window, 
+  // since its probably behind the window.
+  var instantApply = prefs.getBoolPref("browser.preferences.instantApply");
+
+  var helpTopic = document.getElementsByTagName("prefwindow")[0].currentPane.helpTopic;
+  openHelpLink(helpTopic, !instantApply);
+}

browser/components/preferences/advanced-scripts.xul

@@ -45,10 +45,13 @@
 <prefwindow id="AdvancedJSDialog" type="child"
             xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
             title="&advancedJSDialog.title;"
-            dlgbuttons="accept,cancel,help">
+            dlgbuttons="accept,cancel,help"
+            ondialoghelp="openPrefsHelp()">
+
+  <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
 
   <prefpane id="AdvancedJSDialogPane"
-            helpTopic="prefs-advanced-javascript" helpURI="chrome://browser/locale/help/help.rdf">
+            helpTopic="prefs-advanced-javascript">
 
     <preferences>
      <preference id="dom.event.contextmenu.enabled"  name="dom.event.contextmenu.enabled"  type="bool"/>

browser/components/preferences/advanced.xul

@@ -52,8 +52,7 @@
 <overlay id="AdvancedPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
-  <prefpane id="paneAdvanced" onpaneload="gAdvancedPane.init();"
+  <prefpane id="paneAdvanced" onpaneload="gAdvancedPane.init();">
-            helpURI="chrome://browser/locale/help/help.rdf">
 
     <preferences id="advancedPreferences">
       <preference id="browser.preferences.advanced.selectedTabIndex"

browser/components/preferences/applications.xul

@@ -53,8 +53,10 @@
 <overlay id="ApplicationsPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
-  <prefpane id="paneApplications" onpaneload="gApplicationsPane.init();" flex="1"
+  <prefpane id="paneApplications"
-            helpTopic="prefs-applications" helpURI="chrome://browser/locale/help/help.rdf">
+            onpaneload="gApplicationsPane.init();"
+            flex="1"
+            helpTopic="prefs-applications">
 
     <preferences id="feedsPreferences">
       <preference id="browser.feeds.handler"

browser/components/preferences/colors.xul

@@ -49,14 +49,16 @@
             xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
             title="&colorsDialog.title;"
             dlgbuttons="accept,cancel,help"
+            ondialoghelp="openPrefsHelp()"
 #ifdef XP_MACOSX
             style="width: &window.macWidth; !important;">
 #else
             style="width: &window.width; !important;">
 #endif
 
+  <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
   <prefpane id="ColorsDialogPane"
-            helpTopic="prefs-fonts-and-colors" helpURI="chrome://browser/locale/help/help.rdf">
+            helpTopic="prefs-fonts-and-colors">
   
     <preferences>
       <preference id="browser.display.use_document_colors"  name="browser.display.use_document_colors"  type="bool"/>

browser/components/preferences/connection.xul

@@ -48,14 +48,17 @@
             dlgbuttons="accept,cancel,help"
             onbeforeaccept="return gConnectionsDialog.beforeAccept();"
             onload="gConnectionsDialog.checkForSystemProxy();"
+            ondialoghelp="openPrefsHelp()"
 #ifdef XP_MACOSX
             style="width: &window.macWidth; !important;">
 #else
             style="width: &window.width; !important;">
 #endif
 
+  <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
+
   <prefpane id="ConnectionsDialogPane"
-            helpTopic="prefs-connection-settings" helpURI="chrome://browser/locale/help/help.rdf">
+            helpTopic="prefs-connection-settings">
 
     <preferences>
       <preference id="network.proxy.type"         name="network.proxy.type"         type="int" onchange="gConnectionsDialog.proxyTypeChanged();"/>

browser/components/preferences/content.xul

@@ -49,8 +49,9 @@
 <overlay id="ContentPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
-  <prefpane id="paneContent" onpaneload="gContentPane.init();"
+  <prefpane id="paneContent" 
-            helpTopic="prefs-content" helpURI="chrome://browser/locale/help/help.rdf">
+            onpaneload="gContentPane.init();"
+            helpTopic="prefs-content">
 
     <preferences id="contentPreferences">
       <!--XXX buttons prefs -->

browser/components/preferences/fonts.xul

@@ -52,6 +52,7 @@
             xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
             title="&fontsDialog.title;"
             dlgbuttons="accept,cancel,help"
+            ondialoghelp="openPrefsHelp()"
 #ifdef XP_UNIX
 #ifdef XP_MACOSX
             style="width: &window.macWidth; !important;">
@@ -62,8 +63,10 @@
             style="width: &window.width; !important;">
 #endif
 
+  <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
+
   <prefpane id="FontsDialogPane"
-            helpTopic="prefs-fonts-and-colors" helpURI="chrome://browser/locale/help/help.rdf">
+            helpTopic="prefs-fonts-and-colors">
   
     <preferences id="fontPreferences">
       <preference id="font.language.group"  name="font.language.group"  type="wstring"/>

browser/components/preferences/languages.xul

@@ -50,10 +50,14 @@
             xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
             title="&languages.customize.Header;"
             dlgbuttons="accept,cancel,help"
+            ondialoghelp="openPrefsHelp()"
             style="width: &window.width;;">
 
-  <prefpane id="LanguagesDialogPane" onpaneload="gLanguagesDialog.init();"
+  <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
-            helpTopic="prefs-languages" helpURI="chrome://browser/locale/help/help.rdf">
+
+  <prefpane id="LanguagesDialogPane"
+            onpaneload="gLanguagesDialog.init();"
+            helpTopic="prefs-languages">
 
     <preferences>
       <preference id="intl.accept_languages" name="intl.accept_languages" type="wstring"/>

browser/components/preferences/main.xul

@@ -50,8 +50,9 @@
 <overlay id="MainPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
            
-  <prefpane id="paneMain" onpaneload="gMainPane.init();"
+  <prefpane id="paneMain" 
-            helpTopic="prefs-main" helpURI="chrome://browser/locale/help/help.rdf">
+            onpaneload="gMainPane.init();"
+            helpTopic="prefs-main">
 
     <script type="application/x-javascript" src="chrome://browser/content/preferences/main.js"/>
 

browser/components/preferences/preferences.xul

@@ -72,6 +72,7 @@
 <prefwindow type="prefwindow"
             id="BrowserPreferences"
             windowtype="Browser:Preferences"
+            ondialoghelp="openPrefsHelp()"
 #ifdef USE_WIN_TITLE_STYLE
             title="&prefWindow.titleWin;"
 #else
@@ -92,6 +93,8 @@
 #endif
 #endif
 
+    <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
+
     <stringbundle id="bundleBrand" src="chrome://branding/locale/brand.properties"/>
     <stringbundle id="bundlePreferences"
                   src="chrome://browser/locale/preferences/preferences.properties"/>

browser/components/preferences/privacy.xul

@@ -49,9 +49,9 @@
 <overlay id="PrivacyPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
-  <prefpane id="panePrivacy" onpaneload="gPrivacyPane.init();"
+  <prefpane id="panePrivacy"
-            helpTopic="prefs-privacy"
+            onpaneload="gPrivacyPane.init();"
-            helpURI="chrome://browser/locale/help/help.rdf">
+            helpTopic="prefs-privacy">
 
     <preferences id="privacyPreferences">
 

browser/components/preferences/sanitize.xul

@@ -50,10 +50,13 @@
 <prefwindow id="SanitizeDialog" type="child"
             xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
             dlgbuttons="accept,cancel,help"
+            ondialoghelp="openPrefsHelp()"
             title="&sanitizeDialog.title;">
 
+  <script type="application/javascript" src="chrome://browser/content/utilityOverlay.js"/>
+
   <prefpane id="SanitizeDialogPane"
-            helpTopic="prefs-clear-private-data" helpURI="chrome://browser/locale/help/help.rdf">
+            helpTopic="prefs-clear-private-data">
 
     <preferences>
       <preference id="privacy.item.history"               name="privacy.item.history"               type="bool"/>

browser/components/preferences/security.xul

@@ -47,8 +47,9 @@
 <overlay id="SecurityPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
-  <prefpane id="paneSecurity" onpaneload="gSecurityPane.init();"
+  <prefpane id="paneSecurity"
-            helpTopic="prefs-security" helpURI="chrome://browser/locale/help/help.rdf">
+            onpaneload="gSecurityPane.init();"
+            helpTopic="prefs-security">
 
     <preferences id="securityPreferences">
       <!-- XXX buttons -->

browser/components/preferences/tabs.xul

@@ -49,7 +49,8 @@
 <overlay id="TabsPaneOverlay"
          xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
-  <prefpane id="paneTabs" helpTopic="prefs-tabs" helpURI="chrome://browser/locale/help/help.rdf">
+  <prefpane id="paneTabs"
+            helpTopic="prefs-tabs">
 
     <preferences id="tabsPreferences">
       <preference id="browser.link.open_external"      name="browser.link.open_external"      type="int"/>

browser/locales/jar.mn

@@ -69,6 +69,7 @@
     locale/browser/sidebar/sidebar.properties      (%chrome/browser/sidebar/sidebar.properties)
 % locale browser-region @AB_CD@ %locale/browser-region/
     locale/browser-region/region.properties        (%chrome/browser-region/region.properties)
+#ifdef MOZ_HELP_VIEWER
     locale/browser/help/help.rdf                      (%chrome/help/firebirdhelp.rdf)
     locale/browser/help/firebird-toc.rdf              (%chrome/help/firebird-toc.rdf)
     locale/browser/help/search-db.rdf                 (%chrome/help/search-db.rdf)
@@ -87,6 +88,7 @@
     locale/browser/help/platformStrings.dtd           (%chrome/help/platformStrings.dtd)
     locale/browser/help/tabbed_browsing.xhtml         (%chrome/help/tabbed_browsing.xhtml)
     locale/browser/help/glossary.xhtml                (%chrome/help/glossary.xhtml)
+#endif
 # the following files are browser-specific overrides
 *   locale/browser/netError.dtd                (%chrome/overrides/netError.dtd)
 *   locale/browser/appstrings.properties       (%chrome/overrides/appstrings.properties)

toolkit/components/Makefile.in

@@ -75,6 +75,10 @@ ifdef MOZ_FEEDS
 DIRS += feeds
 endif
 
+ifdef MOZ_HELP_VIEWER
+DIRS += help
+endif
+
 ifdef MOZ_PLACES
 DIRS += places
 endif
@@ -112,10 +116,6 @@ endif # MOZ_PLACES
 endif # MOZ_SUITE
 endif # MOZ_THUNDERBIRD
 
-ifdef MOZ_XUL
-DIRS += help
-endif
-
 ifndef MOZ_SUITE
 # XXX Suite doesn't want these just yet
 ifdef MOZ_RDF

toolkit/content/widgets/preferences.xml

@@ -655,7 +655,17 @@
           return val;
         </setter>          
       </property>
-      <field name="currentPane">null</field>
+      <property name="currentPane"
+                onset="return this._currentPane = val;">
+        <getter>
+          if (!this._currentPane)
+            this._currentPane = this.preferencePanes[0];
+          
+          return this._currentPane;
+        </getter> 
+      </property>
+      <field name="_currentPane">null</field>
+      
       
       <method name="_makePaneButton">
         <parameter name="aPaneElement"/>
@@ -744,7 +754,7 @@
             document.title = paneTitle;
 #endif
           var helpButton = document.documentElement.getButton("help");
-          if (aPaneElement.hasAttribute("helpURI"))
+          if (aPaneElement.helpTopic)
             helpButton.hidden = false;
           else
             helpButton.hidden = true;
@@ -981,67 +991,8 @@
         ]]>
         </body>
       </method>
-      
-      // copied from contextHelp.js
-      // Locate existing help window for this helpFileURI.
-      <method name="locateHelpWindow">
-        <parameter name="helpFileURI"/>
-        <body>
-        <![CDATA[
-          const wm = Components.classes['@mozilla.org/appshell/window-mediator;1']
-                               .getService(Components.interfaces.nsIWindowMediator);
-          const iterator = wm.getEnumerator("mozilla:help");
-          var topWindow = null;
-          var aWindow;
-
-          // Loop through help windows looking for one with selected helpFileURI
-          while (iterator.hasMoreElements()) {
-            aWindow = iterator.getNext();
-            if (aWindow.getHelpFileURI() == helpFileURI)
-              topWindow = aWindow;
-          }
-          return topWindow;
-        ]]>
-        </body>
-      </method>
-      
-      // copied from contextHelp.js
-      // Opens up the Help Viewer with the specified topic and helpFileURI.
-      <method name="openHelp">
-        <parameter name="topic"/>
-        <parameter name="helpFileURI"/>
-        <body>
-        <![CDATA[
-          // Try to find previously opened help.
-          var topWindow = this.locateHelpWindow(helpFileURI);
-
-          if (topWindow) {
-          // Open topic in existing window.
-            topWindow.focus();
-            topWindow.displayTopic(topic);
-          }
-          else {
-          // Open topic in new window.
-            const params = Components.classes["@mozilla.org/embedcomp/dialogparam;1"]
-                                     .createInstance(Components.interfaces.nsIDialogParamBlock);
-            params.SetNumberStrings(2);
-            params.SetString(0, helpFileURI);
-            params.SetString(1, topic);
-            const ww = Components.classes["@mozilla.org/embedcomp/window-watcher;1"]
-                                 .getService(Components.interfaces.nsIWindowWatcher);
-            ww.openWindow(null, "chrome://help/content/help.xul", "_blank", "chrome,all,alwaysRaised,dialog=no", params);
-          }
-        ]]>
-        </body>
-      </method>
     </implementation>
     <handlers>
-      <handler event="dialoghelp">
-        // currentPane is set in _selectPane for prefwindows which aren't childs.
-        // So if there's no currentPane, just use the first pane.
-        var pane = this.currentPane ? this.currentPane : this.preferencePanes[0];
-        this.openHelp(pane.helpTopic, pane.getAttribute("helpURI"));
-      </handler>
       <handler event="dialogaccept">
       <![CDATA[
         if (!this._fireEvent("beforeaccept", this))