Merge pull request #5155 from nadment/5154

Add help to perspective #5154

Author: hansva

plugins/tech/neo4j/src/main/java/org/apache/hop/neo4j/perspective/HopNeo4jPerspective.java

@@ -92,7 +92,8 @@
     id = "HopNeo4jPerspective",
     name = "Neo4j",
     description = "Neo4j Perspective",
-    image = "neo4j_logo.svg")
+    image = "neo4j_logo.svg",
+    documentationUrl = "/hop-gui/perspective-neo4j.html")
 @GuiPlugin
 public class HopNeo4jPerspective implements IHopPerspective {
 

ui/src/main/java/org/apache/hop/ui/hopgui/HopGui.java

@@ -17,6 +17,8 @@
 
 package org.apache.hop.ui.hopgui;
 
+import static org.apache.hop.core.Const.getDocUrl;
+
 import java.io.FileOutputStream;
 import java.io.PrintStream;
 import java.nio.file.Files;
@@ -107,6 +109,7 @@
 import org.apache.hop.ui.hopgui.file.workflow.HopGuiWorkflowGraph;
 import org.apache.hop.ui.hopgui.perspective.EmptyHopPerspective;
 import org.apache.hop.ui.hopgui.perspective.HopPerspectiveManager;
+import org.apache.hop.ui.hopgui.perspective.HopPerspectivePlugin;
 import org.apache.hop.ui.hopgui.perspective.HopPerspectivePluginType;
 import org.apache.hop.ui.hopgui.perspective.IHopPerspective;
 import org.apache.hop.ui.hopgui.perspective.configuration.ConfigurationPerspective;
@@ -1625,6 +1628,20 @@ public boolean isActivePerspective(IHopPerspective perspective) {
     return false;
   }
 
+  @GuiKeyboardShortcut(key = SWT.F1)
+  @GuiOsxKeyboardShortcut(key = SWT.F1)
+  public void help() {
+    HopPerspectivePlugin plugin =
+        activePerspective.getClass().getAnnotation(HopPerspectivePlugin.class);
+    if (plugin != null) {
+      try {
+        EnvironmentUtils.getInstance().openUrl(getDocUrl(plugin.documentationUrl()));
+      } catch (Exception e) {
+        new ErrorDialog(shell, "Error", "Error opening URL", e);
+      }
+    }
+  }
+
   /**
    * What are the contexts to consider: - the file types registered - the available metadata types
    *

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/HopPerspectivePlugin.java

@@ -38,4 +38,6 @@
   String image() default "";
 
   String category() default "";
+
+  String documentationUrl() default "";
 }

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/HopPerspectivePluginType.java

@@ -62,4 +62,9 @@ protected String extractImageFile(HopPerspectivePlugin annotation) {
   protected String extractCategory(HopPerspectivePlugin annotation) {
     return annotation.category();
   }
+
+  @Override
+  protected String extractDocumentationUrl(HopPerspectivePlugin annotation) {
+    return annotation.documentationUrl();
+  }
 }

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/configuration/ConfigurationPerspective.java

@@ -51,7 +51,8 @@
     id = "160-HopConfigurationPerspective",
     name = "i18n::ConfigurationPerspective.Name",
     description = "i18n::ConfigurationPerspective.Description",
-    image = "ui/images/gear.svg")
+    image = "ui/images/gear.svg",
+    documentationUrl = "/hop-gui/perspective-configuration.html")
 @GuiPlugin(description = "i18n::HopConfigurationPerspective.GuiPlugin.Description")
 public class ConfigurationPerspective implements IHopPerspective, TabClosable {
 

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/dataorch/HopDataOrchestrationPerspective.java

@@ -73,7 +73,8 @@
     id = "100-HopDataOrchestrationPerspective",
     name = "i18n::DataOrchestrationPerspective.Name",
     image = "ui/images/data_orch.svg",
-    description = "i18n::DataOrchestrationPerspective.Description")
+    description = "i18n::DataOrchestrationPerspective.Description",
+    documentationUrl = "/hop-gui/perspective-data-orchestration.html")
 @GuiPlugin(description = "i18n::DataOrchestrationPerspective.GuiPlugin.Description")
 public class HopDataOrchestrationPerspective implements IHopPerspective, TabClosable {
 

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/execution/ExecutionPerspective.java

@@ -93,7 +93,8 @@
     id = "150-HopExecutionPerspective",
     name = "i18n::ExecutionPerspective.Name",
     description = "i18n::ExecutionPerspective.Description",
-    image = "ui/images/execution.svg")
+    image = "ui/images/execution.svg",
+    documentationUrl = "/hop-gui/perspective-execution-information.html")
 @GuiPlugin
 public class ExecutionPerspective implements IHopPerspective, TabClosable {
 

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/explorer/ExplorerPerspective.java

@@ -117,7 +117,8 @@
     id = "300-HopExplorerPerspective",
     name = "i18n::ExplorerPerspective.Name",
     description = "The Hop Explorer Perspective",
-    image = "ui/images/folder.svg")
+    image = "ui/images/folder.svg",
+    documentationUrl = "/hop-gui/perspective-file-explorer.html")
 @GuiPlugin(description = "i18n::ExplorerPerspective.GuiPlugin.Description")
 @SuppressWarnings("java:S1104")
 public class ExplorerPerspective implements IHopPerspective, TabClosable {

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/metadata/MetadataPerspective.java

@@ -96,7 +96,8 @@
     id = "200-HopMetadataPerspective",
     name = "i18n::MetadataPerspective.Name",
     description = "i18n::MetadataPerspective.Description",
-    image = "ui/images/metadata.svg")
+    image = "ui/images/metadata.svg",
+    documentationUrl = "/hop-gui/perspective-metadata.html")
 @GuiPlugin(description = "i18n::MetadataPerspective.GuiPlugin.Description")
 public class MetadataPerspective implements IHopPerspective, TabClosable {
 

ui/src/main/java/org/apache/hop/ui/hopgui/perspective/pluginexplorer/HopPluginExplorePerspective.java

@@ -65,7 +65,8 @@
     id = "500-HopPluginExplorerPerspective",
     name = "i18n::PluginExplorerPerspective.Name",
     description = "i18n::PluginExplorerPerspective.Description",
-    image = "ui/images/plugin.svg")
+    image = "ui/images/plugin.svg",
+    documentationUrl = "/hop-gui/perspective-plugin.html")
 @GuiPlugin(description = "i18n::PluginExplorerPerspective.GuiPlugin.Description")
 public class HopPluginExplorePerspective implements IHopPerspective {
   public static final Class<?> PKG = HopPluginExplorePerspective.class; // i18n