locked
Adding help to MEF extension: F1 doesn't work RRS feed

  • Question

  • I'm developing a Visual Studio MEF extension that provides support for a language: colorization, completion, quick info etc.

    I also provide help system for the language and integrate it into Visual Studio help. The help files are packaged into mshc file which I install through Microsoft Help Viewer. I used this tutorial to make this work: http://thirdblogfromthesun.com/2011/05/create-a-basic-help-file-for-the-microsoft-help-viewer/

    I can browse my help from Contents tab in Help Viewer. I added Microsoft.Help.F1 meta tags to my help files with all the correct keywords and I expect help files to be shown when I press F1 with a cursor positioned on a keyword, as it happens when I do this in C# file for example. This doesn't happen for my language though, and a generic help page is displayed instead ("Writing Code in the Code and Text Editor")

    I used Ook sample to build the extension. As a test I even tried to add a help for Ook the same way I do it for the language I'm working on but I get the same result: even though I can see the help files in Help Viewer, a generic help page is displayed when press F1 with cursor on a "ook" word.

    I enabled "Debug Help Context" window in Visual Studio and I can see that no F1 keywords are being fired when I place cursor on keywords of my language.

    Can anyone provide any insight? Should I maybe do something more than Ook sample when registering my language file extension?

    Best regads,

    Serge

    Tuesday, September 16, 2014 12:09 PM

Answers

  • Hi Serge,

    Looks like the article only instucts you how to create a mshc help file, but it doesn't tell you how to integrate the help file with the VS Shell. I would like you check this MSDN document:

    http://msdn.microsoft.com/en-us/library/dd627473.aspx

    In this document, you'll find out not only how to create a help file, but also how to integrate it with Visual Studio Shell. In VS2008, there was a Help Integration Wizard, but it's moved since VS2010. It should be helpful if you use VS2008:

    http://msdn.microsoft.com/en-us/library/cc138528(v=vs.90).aspx


    We are trying to better understand customer views on social support experience, so your participation in this interview project would be greatly appreciated if you have time. Thanks for helping make community forums a great place.
    Click HERE to participate the survey.



    • Edited by Caillen Friday, September 19, 2014 12:52 AM
    • Marked as answer by Caillen Tuesday, September 23, 2014 10:06 AM
    Friday, September 19, 2014 12:51 AM