CodePlexProject Hosting for Open Source Software

and have this transformed into an image and inserted into the final output.

- While working on a company product's documentation recently, we needed math equations embedded into the documents, and bought a commercial tool for this. The quality of the output was not very impressive, and the whole process was time consuming.
- The conceptual help MAML supports a tag
**<math/>**, which by the documentation is used for math equations so all that was needed was the tool to transform that into images. With a background in TeX/LaTeX, we started looking for a LaTeX-based solution and found it easy. This is what we are sharing with the Sandcastle community.

- LaTeX, the undisputed leader in math equations, is fully supported,
- MathML, the support is planned but not currently available.

The implementation is flexible, and could be easily extended to support any format. The conversion is done in

**MathML**: This is currently not implemented and there is no requirement yet.**LaTeX**: The requirements and installations depends your choice of rendering engine:- Using MimeTeX: This is a simple TeX implementation, which parses a LaTeX math expression and immediately emits the corresponding gif image, rather than the usual TeX dvi.
- It requires no installation or configurations, and it comes with the Sandcastle Assist package.
- It is very small (548 KB) and fast
- The quality of the output is poor, but not be good for most documentation requirements.

- Using MikTeX: This is the most is an up-to-date TeX implementation for the Windows operating system, and produces full dvi.
- It requires installation and configuration, but the math component is fully functional with the
*Basic*installation. - It is big 77.79 MB, and may be slower.
- The quality is very high and offers many customizations.

- It requires installation and configuration, but the math component is fully functional with the

- Using MimeTeX: This is a simple TeX implementation, which parses a LaTeX math expression and immediately emits the corresponding gif image, rather than the usual TeX dvi.

- In-line mathematical equations.
- Displayed mathematical equations.
- Use of two different rendering engines depending on user's quality requirement and machine specifications.
- Automatic equation numbering, with customization of format and style.
- Customization of the math environment styles.
- No change to the current limited environment defined by the conceptual
**<math/>**tag. - Easy and highly flexible.

As stated above, we did not change the current <math/> tag or added new attributes, since that will break the current MAML schema.

We, however, took the advantage of lack of the <math/> tag in the references documents to introduce more flexible extensions.

- The quality output of the MikTeX.
- The use of 12pts font size instead of the default 10pts.
- The in-line and displayed equations.
- Use of custom equation number format, which includes "
*Eqn.*" text and page number.

Last edited Jul 4, 2008 at 6:59 AM by SelormeyPaul, version 10