Build The Manual

How to Build the Manual into a PDF.

The manual is written using LaTeX. All of the manual is inside of the manual/ folder in the SVN repository. To build the manual, you need to instal LaTeX. I know that Debian/Ubuntu has a latex repository that should probably work. I think that the windows package MikTeX should probably work (http://miktex.org/). I have been building the manual on the Mac using MacTeX (http://www.tug.org/mactex/). I know that MacTeX comes with most of the specail LaTeX packages that I am using. I don't know about the other distributions. The two packages that I am using that MacTeX doesn't provide are fncychap (http://www.ctan.org/tex-archive/help/Catalogue/entries/fncychap.html) and breakurl (http://www.ctan.org/tex-archive/help/Catalogue/entries/breakurl.html). The easiest way to add these packages is to download them from CTAN and put them into the directory with the TeX files. The breakurl documentation describes how to actually add breakurl into the TeX installation so that you don't have to see the file ever time look into the folder with TeX files:

If you need to do a manual installation (eventually needed under Unix-like
systems), following instructions may come in handy:

a) Download the package files from CTAN or the TUG server.

b) Generate the `breakurl.sty' file:

     latex breakurl.ins

c) Install the file `breakurl.sty' in your TDS tree:

     mkdir [prefix]/texmf/tex/latex/breakurl
     cp breakurl.sty [prefix]/texmf/tex/latex/breakurl/

   where `[prefix]' is the prefix of your TDS tree.

d) Update the databases if necessary, eg. for teTeX:

     mktexlsr [prefix]/texmf

This worked for me on the Mac. I don't know about windows.

Inside of the manual/ folder are all the .tex files for the paper, a shell script and the folder figures/ containing all the figures. The shell script (http://areadiffractionmachine.googlecode.com/svn/trunk/manual/make_manual) should work on the Mac and Linux. It will build the program by calling latex, bibtex, and makeindex enough times and in the right order to create a good .dvi file of the paper. The shell script then runs dvips and ps2pdf with the right command line arguments to turn the paper into a pdf. It finally deletes all the intermediate files. To run the shell script, use the command line to go to the manual/ folder and type

$ ./make_manual

I also created a small Makefile wrapper which does this for you so you can really just type

$ make

Because I am including pstricks figures in my paper, I cannot use pdflatex. That is why the shell script calls dvips and ps2pdf. By the way, all of the screenshots I took were converted to .eps using the Gimp (http://www.gimp.org/) and can be edited pretty easily using the Gimp. All of the pstricks vector diagrams in the paper were drawn using the program LaTeXDraw (http://latexdraw.sourceforge.net/). LaTeX draw nativly saves its files out as .ldp but also exports .tex pstricks files. Inside of the folders/ file are a .ldp and .tex file for each figure. If you want to edit one of the vector diagrams, I suggest opening the .ldp file in pstricks, doing the edit, saving the .ldp file, and then exporting the .tex file into the figures folder.