next up previous contents index
Next: The lay out of Up: Documenting your code Previous: Documenting your code   Contents   Index

Use LATEX

The documentation should be written in LATEX. This decision was made by the LSC software committee. The primary reason for this choice was the need for the equation-writing capability of LATEX.

The danger in using LATEX is that not everyone will have the same version of LATEX installed on their machine. [Actually, this problem might be as bad, or worse, with some other documenting tool.] Try to help us minimize this problem by using vanilla LATEX.

Along with the LAL distribution, we supply a class file (lal/doc/lal.sty). Although this is helpful and it makes thing look nicer, it is not essential. You can remove it from the \usepackage[] command in the various files and they should still successfully LATEX without it.



LAL test account 2003-10-23