#81 : Help buttons linking to wiki added to forms

HISTORY

@@ -14,6 +14,7 @@ Version 17.0 (20??-??-??)
 - Improved tooltips in Settings application
 - Can now copy paths of .url (internet shortcut) and .website (pinned website) files [https://github.com/clechasseur/pathcopycopy/issues/77]
 - New Expert Mode for editing custom commands [https://github.com/clechasseur/pathcopycopy/issues/5]
+- Settings application now has Help buttons linking to the wiki [https://github.com/clechasseur/pathcopycopy/issues/81]
 
 
 Version 16.0.1 (2018-11-30)

PathCopyCopySettings/Properties/Resources.resx

@@ -408,4 +408,13 @@ Control-click to avoid displaying an icon for this command.</value>
   <data name="PipelineElement_RemoveExt_HelpText" xml:space="preserve">
     <value>Remove any extension from the file at the end of the path</value>
   </data>
+  <data name="WikiLink_CustomCommands" xml:space="preserve">
+    <value>https://github.com/clechasseur/pathcopycopy/wiki/Custom-Commands</value>
+  </data>
+  <data name="WikiLink_CustomCommandsExpertMode" xml:space="preserve">
+    <value>https://github.com/clechasseur/pathcopycopy/wiki/Custom-Commands-:-Expert-Mode</value>
+  </data>
+  <data name="WikiLink_Settings" xml:space="preserve">
+    <value>https://github.com/clechasseur/pathcopycopy/wiki/Settings</value>
+  </data>
 </root>

PathCopyCopySettings/UI/Forms/AdvancedPipelinePluginForm.cs

@@ -36,9 +36,6 @@ namespace PathCopyCopy.Settings.UI.Forms
     /// </summary>
     public partial class AdvancedPipelinePluginForm : Form
     {
-        /// URL to navigate to to get help about Expert Mode.
-        private const string EXPERT_MODE_HELP_URL = "https://github.com/clechasseur/pathcopycopy/wiki/Custom-Commands-:-Expert-Mode";
-
         /// Plugin info for the plugin we're editing.
         private PipelinePluginInfo pluginInfo;
 
@@ -391,14 +388,17 @@ private void MoveElementDownBtn_Click(object sender, EventArgs e)
         }
 
         /// <summary>
-        /// Called when the user presses the button to get help.
-        /// We navigate to the proper help page.
+        /// Called when the user presses the Help button in the form's caption bar.
+        /// We navigate to the wiki to show help in such a case.
         /// </summary>
         /// <param name="sender">Event sender.</param>
         /// <param name="e">Event arguments.</param>
-        private void HelpBtn_Click(object sender, EventArgs e)
+        private void AdvancedPipelinePluginForm_HelpButtonClicked(object sender, CancelEventArgs e)
         {
-            Process.Start(EXPERT_MODE_HELP_URL);
+            // Open wiki link to Expert Mode page, then cancel the event to avoid
+            // displaying a help mouse pointer like the default behavior.
+            Process.Start(Resources.WikiLink_CustomCommandsExpertMode);
+            e.Cancel = true;
         }
     }
 }

PathCopyCopySettings/UI/Forms/AdvancedPipelinePluginForm.resx

@@ -120,6 +120,9 @@
   <metadata name="AdvancedPipelinePluginToolTip.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>17, 17</value>
   </metadata>
+  <metadata name="AdvancedPipelinePluginToolTip.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>17, 17</value>
+  </metadata>
   <metadata name="ElementsImageList.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>240, 17</value>
   </metadata>
@@ -128,7 +131,7 @@
         AAEAAAD/////AQAAAAAAAAAMAgAAAFdTeXN0ZW0uV2luZG93cy5Gb3JtcywgVmVyc2lvbj00LjAuMC4w
         LCBDdWx0dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPWI3N2E1YzU2MTkzNGUwODkFAQAAACZTeXN0
         ZW0uV2luZG93cy5Gb3Jtcy5JbWFnZUxpc3RTdHJlYW1lcgEAAAAERGF0YQcCAgAAAAkDAAAADwMAAABs
-        CgAAAk1TRnQBSQFMAgEBBAEAATABAAEwAQABEAEAARABAAT/AQkBAAj/AUIBTQE2AQQGAAE2AQQCAAEo
+        CgAAAk1TRnQBSQFMAgEBBAEAATgBAAE4AQABEAEAARABAAT/AQkBAAj/AUIBTQE2AQQGAAE2AQQCAAEo
         AwABQAMAASADAAEBAQABCAYAAQgYAAGAAgABgAMAAoABAAGAAwABgAEAAYABAAKAAgADwAEAAcAB3AHA
         AQAB8AHKAaYBAAEzBQABMwEAATMBAAEzAQACMwIAAxYBAAMcAQADIgEAAykBAANVAQADTQEAA0IBAAM5
         AQABgAF8Af8BAAJQAf8BAAGTAQAB1gEAAf8B7AHMAQABxgHWAe8BAAHWAucBAAGQAakBrQIAAf8BMwMA

PathCopyCopySettings/UI/Forms/MainForm.cs

@@ -1337,5 +1337,19 @@ private void MainForm_SizeChanged(object sender, EventArgs e)
                 settings.SettingsFormSizeHeight = this.Size.Height;
             }
         }
+
+        /// <summary>
+        /// Called when the user presses the Help button in the form's caption bar.
+        /// We navigate to the wiki to show help in such a case.
+        /// </summary>
+        /// <param name="sender">Event sender.</param>
+        /// <param name="e">Event arguments.</param>
+        private void MainForm_HelpButtonClicked(object sender, CancelEventArgs e)
+        {
+            // Open wiki link to Settings page, then cancel the event to avoid
+            // displaying a help mouse pointer like the default behavior.
+            Process.Start(Resources.WikiLink_Settings);
+            e.Cancel = true;
+        }
     }
 }

PathCopyCopySettings/UI/Forms/MainForm.resx

@@ -135,6 +135,21 @@
   <metadata name="PluginsDataGridBindingSource.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>15, 39</value>
   </metadata>
+  <metadata name="IconCol.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
+  <metadata name="PluginCol.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
+  <metadata name="InMainMenuCol.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
+  <metadata name="InSubmenuCol.UserAddedColumn" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+    <value>True</value>
+  </metadata>
+  <metadata name="PluginsDataGridBindingSource.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>15, 39</value>
+  </metadata>
   <metadata name="CtrlKeyPluginComboBindingSource.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>209, 40</value>
   </metadata>

PathCopyCopySettings/UI/Forms/PipelinePluginForm.cs

@@ -21,6 +21,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.Diagnostics;
 using System.IO;
 using System.Windows.Forms;
@@ -414,5 +415,19 @@ private void BasePluginLst_SelectedIndexChanged(object sender, EventArgs e)
             OKBtn.Enabled = BasePluginLst.SelectedIndex >= 0 &&
                 !(((Plugin) BasePluginLst.SelectedItem) is SeparatorPlugin);
         }
+
+        /// <summary>
+        /// Called when the user presses the Help button in the form's caption bar.
+        /// We navigate to the wiki to show help in such a case.
+        /// </summary>
+        /// <param name="sender">Event sender.</param>
+        /// <param name="e">Event arguments.</param>
+        private void PipelinePluginForm_HelpButtonClicked(object sender, CancelEventArgs e)
+        {
+            // Open wiki link to Custom Commands page, then cancel the event to avoid
+            // displaying a help mouse pointer like the default behavior.
+            Process.Start(Resources.WikiLink_CustomCommands);
+            e.Cancel = true;
+        }
     }
 }