Integrating Help into a Project

When you generate MBOs or client applications for Windows Mobile from Unwired WorkSpace, an XML file is generated for the MBOs. The generated Visual Studio project for the forms can also generate a XML file. When you compile a project, an XML file is generated. You can use these XML files to generate online help.

To generate online help for Visual Studio 2008, you can use Sandcastle and Sandcastle Help File Builder. You can download and install Sandcastle and Sandcastle Help File Builder from these locations:

http://sandcastle.codeplex.com/Wikipage
http://shfb.codeplex.com/releases/view/29710

To integrate help into your project build:

Add the /doc option in your project build, so that it can generate an XML file from the comments. You can also configure this option in the Visual Studio project properties. On the Build tab, select XML documentation and provide a file name.
Create a SandCastle Help File Builder project (.shfb file). Specify the assemblies and the XML file generated from the comments as input. You can also specify other help properties.

Use the .shfb project file in a script to build the document. For example:

<Target Name="Documentation"> 
   <Exec Command="$(SandCastleHelpBuilderPath) <shfb project file>.shfb" /> 
</Target>