This project has moved and is read-only. For the latest updates, please go here.

sandcastle Index

Topics: Developer Forum, User Forum
Jun 12, 2012 at 10:49 AM

Hi guys,

I'm currently writing a help file using sandcastle and I have built up my HTML files that includes all the user support information about the software. Everything went pretty well until I need to put up keywords in the Index section of the .CHM file. 

I have no idea how can I put those keywords into the Index section so that it would link to the content page. Could anyone tell me how to do that?


Jun 12, 2012 at 8:27 PM

If you are referring to manually created HTML content, you'll need to add an XML data island in the <head> element for the tools to parse for keyword information at build time.  For example:


    <MSHelp:Keyword Index="K" Term="Index term here" />
    <MSHelp:Keyword Index="K" Term="Term, Sub-Term" />
    <MSHelp:Keyword Index="K" Term="Another term" />


Be aware that HTML content has been deprecated.  MAML content is preferred now.  With MAML content, the keywords are entered into the content layout file in each topic entry.



Jun 13, 2012 at 2:35 AM

Thank you so much !!!!! It really helps