locked
F1 context sensitive help and code RRS feed

  • Question

  • How does the f1 context sensitive help work when pressing F1 on a hightlighted keyword in a VS 2005 texteditor?
    What I'd really like to know is how does the H2 Help know which page to display when F1 is pressed while some code is highlighted in the editor? Are there some keyords I can add to the help file pages?
    I have my own help integrated into VS2005 help but it does not always go to the correct page in help when I press F1.
    Thursday, April 6, 2006 2:35 PM

Answers

  • The Help system uses F index keywords to locate the topic that matches the name in which the cursor is embedded. If you view source in the Help viewer, you can see the F keywords for each topic (and all the other keywords) in the XML island at the top of the topic.

    For example:

      <head>
        <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=utf-8" />
        <META NAME="save" CONTENT="history" />
        <title>Array.GetLongLength Method</title>
        <xml>
          <MSHelp:TOCTitle Title="GetLongLength Method" />
          <MSHelp:RLTitle Title="Array.GetLongLength Method (System)" />
          <MSHelp:Keyword Index="K" Term="GetLongLength method" />
          <MSHelp:Keyword Index="K" Term="Array.GetLongLength method" />
          <MSHelp:Keyword Index="F" Term="System.Array.GetLongLength" />
          <MSHelp:Keyword Index="F" Term="Array.GetLongLength" />
          <MSHelp:Keyword Index="F" Term="GetLongLength" />
     
         <MSHelp:Keyword Index="A" Term="frlrfSystemArrayClassGetLongLengthTopic" />
          <MSHelp:Keyword Index="A" Term="M:System.Array.GetLongLength(System.Int32)" />
          <MSHelp:Attr Name="APIType" Value="Managed" />
          <MSHelp:Attr Name="TopicType" Value="apiref" />

    ....

    Hope this helps,

    David Carlson
    Content Architect
    Developer Division User Education

    **This message is provided "AS IS" with no warranties, and confers no rights.**

    Friday, April 7, 2006 8:51 PM
  • In addition to looking at the attribution on the document, you can look at the active context in VS by enabling Debug Output in the Dynamic Help toolwindow:

    Set this key: [HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\8.0\Dynamic Help] "Display Debug Output in Retail"="YES".

    Open Dynamic Help and you'll see the active context.

    Thanks,
    Jeremy

    Monday, April 10, 2006 7:42 PM
    Moderator

All replies

  • The Help system uses F index keywords to locate the topic that matches the name in which the cursor is embedded. If you view source in the Help viewer, you can see the F keywords for each topic (and all the other keywords) in the XML island at the top of the topic.

    For example:

      <head>
        <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=utf-8" />
        <META NAME="save" CONTENT="history" />
        <title>Array.GetLongLength Method</title>
        <xml>
          <MSHelp:TOCTitle Title="GetLongLength Method" />
          <MSHelp:RLTitle Title="Array.GetLongLength Method (System)" />
          <MSHelp:Keyword Index="K" Term="GetLongLength method" />
          <MSHelp:Keyword Index="K" Term="Array.GetLongLength method" />
          <MSHelp:Keyword Index="F" Term="System.Array.GetLongLength" />
          <MSHelp:Keyword Index="F" Term="Array.GetLongLength" />
          <MSHelp:Keyword Index="F" Term="GetLongLength" />
     
         <MSHelp:Keyword Index="A" Term="frlrfSystemArrayClassGetLongLengthTopic" />
          <MSHelp:Keyword Index="A" Term="M:System.Array.GetLongLength(System.Int32)" />
          <MSHelp:Attr Name="APIType" Value="Managed" />
          <MSHelp:Attr Name="TopicType" Value="apiref" />

    ....

    Hope this helps,

    David Carlson
    Content Architect
    Developer Division User Education

    **This message is provided "AS IS" with no warranties, and confers no rights.**

    Friday, April 7, 2006 8:51 PM
  • In addition to looking at the attribution on the document, you can look at the active context in VS by enabling Debug Output in the Dynamic Help toolwindow:

    Set this key: [HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\8.0\Dynamic Help] "Display Debug Output in Retail"="YES".

    Open Dynamic Help and you'll see the active context.

    Thanks,
    Jeremy

    Monday, April 10, 2006 7:42 PM
    Moderator