Home

This project is a Sandcastle build component that converts LaTeX embedded in the XML comments to images in the final help file. The component is built against the May 2008 Sandcastle release (Version 2.4.10520) and mimeTeX 1.7.

Current Alpha Build: latex_sandcastle.zip

For any problems or suggestions, please use the Issue Tracker or send me a message.

Instructions:

1. Place the three files from the binary directory of the zip file into the Sandcastle Help File Builder (SHFB) BuildComponents directory. This directory differs depending on your OS.
Vista: ProgramData\EWSoftware\Sandcastle Help File Builder\Build Components
Windows XP: ALLUSERSPROFILE\Application Data\EWSoftware\Sandcastle Help File Builder\Build Components

2. In your SHFB configuration file add the “LaTeX Build Component” to the ComponentConfigurations property of the build section.

3. Add <latex> tags to your XML comments. The <latex> tag must be placed inside regular XML comment tags. Example: ///<summary><latex>f(x)=x^2</latex></summary> For complex LaTeX code, it should be placed in in CDATA tag, i.e.: ///<summary><latex><!CDATA[f(x)=x^2]]></summary>

4. Run SHFB as usual.