Documentation

I wrote the user manual in Microsoft Mord. Mostly screen shots with a complete walkthrough of performing the scenarios and some references for file formats. I was looking into Visual Studio Help Integration Kit (VSHIK), but it seems more than I needed. Try searching a help file for the word help! I finally found System.Windows.Forms.Help.ShowHelp() which launches your default browser to the specified path. I assume it’s using file extensions to choose the reader/handler, but I never tried anyting besides HTML. I just saved the word document as a filtered HTML, added it to the installer, and launch ShowHelp() using the application’s directory combined with the HTML file name. Good enough!

private void miHelpContents_Click(object sender, System.EventArgs e)
{
System.IO.FileInfo fileinf = new System.IO.FileInfo(Assembly.GetExecutingAssembly().Location);
System.Windows.Forms.Help.ShowHelp(this,fileinf.Directory.FullName + "\\User Manual.htm");
}

Comments are closed.