Merge pull request #3395 from ControlSystemStudio/CSSTUDIO-3165-branch2

CSSTUDIO-3165 Open Phoebus Help in the default web browser instead of in the JavaFX WebView

Author: shroffk

core/ui/src/main/java/org/phoebus/ui/help/HelpApplication.java

@@ -7,12 +7,20 @@
  *******************************************************************************/
 package org.phoebus.ui.help;
 
-import org.phoebus.framework.workbench.ApplicationService;
+import org.phoebus.framework.workbench.Locations;
 import org.phoebus.ui.application.Messages;
 import org.phoebus.ui.javafx.ImageCache;
 import org.phoebus.ui.spi.MenuEntry;
 
 import javafx.scene.image.Image;
+import org.phoebus.ui.web.WebBrowserApplication;
+
+import java.io.File;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.logging.Level;
+
+import static org.phoebus.ui.application.PhoebusApplication.logger;
 
 /** Menu entry to open help
  *  @author Kay Kasemir
@@ -23,7 +31,7 @@ public class OpenHelp implements MenuEntry
     @Override
     public String getName()
     {
-        return HelpApplication.DISPLAY_NAME;
+        return Messages.Help;
     }
 
     @Override
@@ -41,7 +49,39 @@ public Image getIcon()
     @Override
     public Void call()
     {
-        ApplicationService.createInstance(HelpApplication.NAME);
+        try {
+            URI helpLocationURI = new URI(determineHelpLocation());
+            WebBrowserApplication webBrowserApplication = new WebBrowserApplication();
+            webBrowserApplication.create(helpLocationURI);
+        } catch (URISyntaxException uriSyntaxException) {
+            throw new RuntimeException(uriSyntaxException);
+        }
         return null;
     }
+
+    public static String determineHelpLocation()
+    {
+        final File phoenix_install = Locations.install();
+
+        // The distribution includes a lib/ and a doc/ folder.
+        // Check for the doc/index.html
+        File loc = new File(phoenix_install, "doc/index.html");
+        if (loc.exists())
+            return loc.toURI().toString();
+
+        // During development,
+        // product is started from IDE as ....../git/phoebus/phoebus-product.
+        // Check for copy of docs in      ....../git/phoebus/docs/build/html
+        loc = new File(phoenix_install, "docs");
+        if (loc.exists())
+        {
+            loc = new File(loc, "build/html/index.html");
+            if (loc.exists())
+                return loc.toURI().toString();
+            logger.log(Level.WARNING, "Found phoebus-doc repository, but no build/html/index.html. Run 'make html'");
+        }
+
+        // Fall back to online copy of the manual
+        return "https://control-system-studio.readthedocs.io";
+    }
 }

core/ui/src/main/java/org/phoebus/ui/help/HelpBrowser.java

@@ -1,5 +1,4 @@
 org.phoebus.ui.welcome.Welcome
 org.phoebus.ui.pv.PVListApplication
 org.phoebus.ui.jobs.JobViewerApplication
-org.phoebus.ui.help.HelpApplication
 org.phoebus.ui.web.WebBrowserApplication