Help: Fix help system and tags. Fixes Komodo#1174 and probably others.

rn=

(integrated from the KomodoIDE master branch change 16ba6ab by Carey Hoffman <[email protected]>)

Komodo/KomodoIDE@16ba6ab

src/chrome/komodo/content/dialogs/editEnvVar.xul

@@ -177,7 +177,7 @@
  oncommand="InsertShortcut(this);"/>
  <menuseparator/>
  <menuitem label="&helpOnShortcuts.label;"
- oncommand="ko.help.open('interpolation_shortcuts');"/>
+ oncommand="ko.help.open('shortcuts.html');"/>
  </menupopup>
  </button>
  <button label="&addPath.label;" accesskey="&addPath.accesskey;"

src/chrome/komodo/content/dialogs/featureControlPanel.p.xul

@@ -88,9 +88,9 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  <separator flex="1"/>
- <button class="configure-icon button-toolbar-a"
+ <button class="icon-cog button-toolbar-a"
  tooltiptext="&configureNodeJS.tooltiptext;"
  oncommand="LaunchPrefs('nodejsItem')"/>
  </hbox>
@@ -107,9 +107,9 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  <separator flex="1"/>
- <button class="configure-icon button-toolbar-a"
+ <button class="icon-cog button-toolbar-a"
  tooltiptext="&configurePerl.tooltiptext;"
  oncommand="LaunchPrefs('perlItem')"/>
  </hbox>
@@ -126,9 +126,9 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  <separator flex="1"/>
- <button class="configure-icon button-toolbar-a"
+ <button class="icon-cog button-toolbar-a"
  tooltiptext="&configurePHP.tooltiptext;"
  oncommand="LaunchPrefs('phpItem')"/>
  </hbox>
@@ -145,9 +145,9 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  <separator flex="1"/>
- <button class="configure-icon button-toolbar-a"
+ <button class="icon-cog button-toolbar-a"
  tooltiptext="&configurePython.tooltiptext;"
  oncommand="LaunchPrefs('pythonItem')"/>
  </hbox>
@@ -164,9 +164,9 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  <separator flex="1"/>
- <button class="configure-icon button-toolbar-a"
+ <button class="icon-cog button-toolbar-a"
  tooltiptext="&configurePython3.tooltiptext;"
  oncommand="LaunchPrefs('python3Item')"/>
  </hbox>
@@ -183,9 +183,9 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  <separator flex="1"/>
- <button class="configure-icon button-toolbar-a"
+ <button class="icon-cog button-toolbar-a"
  tooltiptext="&configureRuby.tooltiptext;"
  oncommand="LaunchPrefs('rubyItem')"/>
  </hbox>
@@ -201,7 +201,7 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  </hbox>
  </row>
  <row id="other-languages-feature-row">
@@ -215,7 +215,7 @@
  />
  <button class="help-icon button-toolbar-a"
  tooltiptext="&helpOnBackgroundSyntaxChecking.tooltiptext;"
- oncommand="LaunchHelp('background_syntax_checking');"/>
+ oncommand="LaunchHelp('editor.html#Linting');"/>
  </hbox>
  </row>
  </rows>

src/chrome/komodo/content/launch.p.js

@@ -48,12 +48,17 @@ if (!("help" in ko)) {
 ko.help = {};
 (function () {
 var _log = ko.logging.getLogger("ko.help");
-
 /* XXX duplicated from help/content/contextHelp.js. We do NOT want
  alwaysRaised attribute on the window, that's obnoxious! */
 
-function openHelp(topic, path = 'Manual/')
+function openHelp(topic, path = 'manual/')
 {
+ const {Cc, Ci} = require("chrome");
+ let version = Cc["@activestate.com/koInfoService;1"].getService(Ci.koIInfoService).version;
+ // get major version
+ version = version.substr(0,version.indexOf("."));
+ path = '/'+version+"/"+path;
+
  var url = ko.prefs.getString('doc_site');
  if (topic) url += path + topic;
  ko.browse.openUrlInDefaultBrowser(url);

src/chrome/komodo/content/pref/pref-html.xul

@@ -60,7 +60,6 @@
  <![CDATA[
 
 function OnPreferencePageLoading(prefset) {
- log.debug("Loading HTML Prefs");
  //try {
  // matchingTag_toggle(document.getElementById("showMatchingTagsOnClick"));
  // const { classes: Cc, interfaces: Ci } = Components;

src/chrome/komodo/content/pref/pref-proxies.xul

@@ -48,10 +48,11 @@
  xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
  title="&connectionsDialog.title;"
  dlgbuttons="accept,cancel,help"
+ ondialoghelp="doHelp();"
  onbeforeaccept="return gConnectionsDialog.beforeAccept();">
 
  <prefpane id="ConnectionsDialogPane"
- helpTopic="prefs-connection-settings" helpURI="chrome://komododoc/locale/komodohelp.rdf">
+ helpTopic="prefs.html#http-inspector-preferences">
 
  <preferences>
  <preference id="network.proxy.type" name="network.proxy.type" type="int" onchange="gConnectionsDialog.proxyTypeChanged();"/>

src/chrome/komodo/content/pref/pref.js

@@ -102,8 +102,15 @@ function canHelp() {
 
 function doHelp() {
  var tag = getHelpTag();
- tag = "prefs#preferences_"+tag.replace(/\-/g,"_").toLowerCase();
- ko.windowManager.getMainWindow().ko.help.open(tag);
+ if (tag.indexOf(".html") >= 0)
+ {
+ ko.windowManager.getMainWindow().ko.help.open(tag);
+ }
+ else
+ {
+ tag = "prefs.html#"+tag.replace(/\_/g,"-").toLowerCase();
+ ko.windowManager.getMainWindow().ko.help.open(tag);
+ }
 }
 
 function setupFilteredTree() {