Context sensitive help

GUI/CKAN-GUI.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="14.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <AssemblyName>CKAN-GUI</AssemblyName>
@@ -346,6 +346,7 @@
     <Compile Include="SingleAssemblyResourceManager.cs" />
     <Compile Include="TabController.cs" />
     <Compile Include="URLHandlers.cs" />
+    <Compile Include="HelpURLs.cs" />
     <Compile Include="Util.cs" />
     <Compile Include="X11.cs" />
   </ItemGroup>

GUI/Controls/DeleteDirectories.cs

@@ -79,6 +79,14 @@ public bool Wait(out HashSet<string> toDelete)
             }
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.DeleteDirectories);
+        }
+
         private void DirectoriesListView_ItemSelectionChanged(Object sender, ListViewItemSelectionChangedEventArgs e)
         {
             ContentsListView.Items.Clear();

GUI/Controls/EditModpack.cs

@@ -121,6 +121,14 @@ private void LoadRelationships(IRegistryQuerier registry)
             RelationshipsListView_ItemSelectionChanged(null, null);
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.ModPacks);
+        }
+
         private void AddGroup(List<RelationshipDescriptor> relationships, ListViewGroup group, IRegistryQuerier registry)
         {
             if (relationships != null)

GUI/Controls/PlayTime.cs

@@ -42,6 +42,14 @@ public void loadAllPlayTime(GameInstanceManager manager)
         /// </summary>
         public event Action Done;
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.PlayTime);
+        }
+
         private void ShowTotal()
         {
             if (rows != null)

GUI/Dialogs/CloneFakeGameDialog.cs

@@ -3,6 +3,7 @@
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
+using System.ComponentModel;
 using System.Windows.Forms;
 using Autofac;
 using CKAN.Versioning;
@@ -332,5 +333,22 @@ private void buttonPathBrowser_Click(object sender, EventArgs e)
             }
 
         }
+
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.CloneFakeInstances);
+        }
+
+        /// <summary>
+        /// Open the user guide when the user clicks the help button
+        /// </summary>
+        protected override void OnHelpButtonClicked(CancelEventArgs evt)
+        {
+            evt.Cancel = Util.TryOpenWebPage(HelpURLs.CloneFakeInstances);
+        }
+
     }
 }

GUI/Dialogs/CompatibleGameVersionsDialog.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 using System.IO;
+using System.ComponentModel;
 using System.Windows.Forms;
 using System.Collections.Generic;
 using Autofac;
@@ -42,6 +43,22 @@ public CompatibleGameVersionsDialog(GameInstance inst, bool centerScreen)
             SortAndAddVersionsToList(knownVersions, compatibleVersions);
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.CompatibleGameVersions);
+        }
+
+        /// <summary>
+        /// Open the user guide when the user clicks the help button
+        /// </summary>
+        protected override void OnHelpButtonClicked(CancelEventArgs evt)
+        {
+            evt.Cancel = Util.TryOpenWebPage(HelpURLs.CompatibleGameVersions);
+        }
+
         private void CompatibleGameVersionsDialog_Shown(object sender, EventArgs e)
         {
             if (_inst.CompatibleVersionsAreFromDifferentGameVersion)
@@ -91,7 +108,7 @@ private void AddVersionToListButton_Click(object sender, EventArgs e)
             {
                 return;
             }
-            if (AddVersionToListTextBox.Text.ToLower() == "any") 
+            if (AddVersionToListTextBox.Text.ToLower() == "any")
             {
                 MessageBox.Show(
                     Properties.Resources.CompatibleGameVersionsDialogInvalidFormat,

GUI/Dialogs/EditLabelsDialog.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 using System.Drawing;
+using System.ComponentModel;
 using System.Windows.Forms;
 using log4net;
 
@@ -72,6 +73,22 @@ private void LoadTree()
             LabelSelectionTree.EndUpdate();
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.Labels);
+        }
+
+        /// <summary>
+        /// Open the user guide when the user clicks the help button
+        /// </summary>
+        protected override void OnHelpButtonClicked(CancelEventArgs evt)
+        {
+            evt.Cancel = Util.TryOpenWebPage(HelpURLs.Labels);
+        }
+
         private void LabelSelectionTree_BeforeSelect(Object sender, TreeViewCancelEventArgs e)
         {
             if (e.Node == null)

GUI/Dialogs/InstallFiltersDialog.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using System.ComponentModel;
 using System.Windows.Forms;
 
 using CKAN.Configuration;
@@ -15,6 +16,22 @@ public InstallFiltersDialog(IConfiguration globalConfig, GameInstance instance)
             this.instance     = instance;
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.Filters);
+        }
+
+        /// <summary>
+        /// Open the user guide when the user clicks the help button
+        /// </summary>
+        protected override void OnHelpButtonClicked(CancelEventArgs evt)
+        {
+            evt.Cancel = Util.TryOpenWebPage(HelpURLs.Filters);
+        }
+
         private void InstallFiltersDialog_Load(object sender, EventArgs e)
         {
             GlobalFiltersTextBox.Text = string.Join(Environment.NewLine, globalConfig.GlobalInstallFilters);

GUI/Dialogs/ManageGameInstancesDialog.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.ComponentModel;
 using System.Windows.Forms;
 using System.IO;
 
@@ -128,6 +129,22 @@ private string[] rowItems(GameInstance instance, bool includeGame, bool includeP
             return list.ToArray();
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.ManageInstances);
+        }
+
+        /// <summary>
+        /// Open the user guide when the user clicks the help button
+        /// </summary>
+        protected override void OnHelpButtonClicked(CancelEventArgs evt)
+        {
+            evt.Cancel = Util.TryOpenWebPage(HelpURLs.ManageInstances);
+        }
+
         private static string FormatVersion(GameVersion v)
         {
             return v == null

GUI/HelpURLs.cs

@@ -0,0 +1,21 @@
+namespace CKAN
+{
+    /// <summary>
+    /// Holds URLs that we launch for F1 help
+    /// </summary>
+    public static class HelpURLs
+    {
+        public const string UserGuide = "https://github.com/KSP-CKAN/CKAN/wiki/User-guide";
+        public const string ManageInstances = "https://github.com/KSP-CKAN/CKAN/wiki/User-guide#adding-game-folders";
+        public const string CompatibleGameVersions = "https://github.com/KSP-CKAN/CKAN/wiki/User-guide#choosing-compatible-game-versions";
+        public const string ModPacks = "https://github.com/KSP-CKAN/CKAN/wiki/Sharing-a-modlist-%28metapackages%29";
+
+        public const string CloneFakeInstances = "https://github.com/KSP-CKAN/CKAN/pull/2627";
+        public const string DeleteDirectories = "https://github.com/KSP-CKAN/CKAN/pull/2962";
+        public const string Filters = "https://github.com/KSP-CKAN/CKAN/pull/3458";
+        public const string Labels = "https://github.com/KSP-CKAN/CKAN/pull/2936";
+        public const string PlayTime = "https://github.com/KSP-CKAN/CKAN/pull/3543";
+
+        public const string Discord = "https://discord.gg/Mb4nXQD";
+    }
+}

GUI/Main/Main.cs

@@ -336,6 +336,14 @@ protected override void OnShown(EventArgs e)
             base.OnShown(e);
         }
 
+        /// <summary>
+        /// Open the user guide when the user presses F1
+        /// </summary>
+        protected override void OnHelpRequested(HelpEventArgs evt)
+        {
+            evt.Handled = Util.TryOpenWebPage(HelpURLs.UserGuide);
+        }
+
         protected override void OnFormClosed(FormClosedEventArgs e)
         {
             // Stop all running play time timers
@@ -711,12 +719,12 @@ private void MainTabControl_OnSelectedIndexChanged(object sender, EventArgs e)
 
         private void userGuideToolStripMenuItem_Click(object sender, EventArgs e)
         {
-            Utilities.ProcessStartURL("https://github.com/KSP-CKAN/CKAN/wiki/User-guide");
+            Utilities.ProcessStartURL(HelpURLs.UserGuide);
         }
 
         private void discordToolStripMenuItem_Click(object sender, EventArgs e)
         {
-            Utilities.ProcessStartURL("https://discord.gg/Mb4nXQD");
+            Utilities.ProcessStartURL(HelpURLs.Discord);
         }
 
         private void reportClientIssueToolStripMenuItem_Click(object sender, EventArgs e)