Generating Online Help for Visual Studio

You can generate online help for your mobile application project using the .xml file that is generated with the Object API code.

When you generate the C# Object API code for the mobile application project, an .xml file is generated for the mobile business objects. You can use the generated .xml file to build online help for the mobile application project in Visual Studio.

  1. Use the Code Generation wizard to generate the C# Object API Code.
  2. Build the generated solution in Visual Studio:
    1. In Visual Studio, select File > Open > Project/Solution.
    2. Browse to the solution file (.sln) you want to open and double-click the file.
    3. In Solution Explorer, right-click the solution and select Rebuild Solution.
    4. Select File > Save.
      The source .xml file for building online help is included with the generated project, which contains all assemblies and runtime support DLLs required to access the object API.
  3. There are different tools available for building online help. This procedure uses the free tool called Sandcastle Help File Builder. You can download Sandcastle Help File Builder installer from http://shfb.codeplex.com.
  4. Create a SandCastle Helpfile builder project (.shfb) in Sand Castle File Builder by specifying the assemblies and the generated xml file as input.
  5. Use the .shfb project file in the daily build script to build the document. For example:
    <Target Name="Documentation">
      <Exec Command="$(SandCastleHelpBuilderPath) Infrastructure.Core.shfb" />
    </Target>