Skip to content
Philip Johnson edited this page Mar 18, 2015 · 1 revision

How to develop techreports using csdl-techreports.

This page provides step-by-step instructions on how to get started using this library.

1.0 Download and install Tex Live

If you have not done so already, you must download a distribution of TeX. We strongly recommend Tex Live, which runs on Unix, Windows, and Macintosh.

If you are using Windows, you should download TeX Live using the installer package made available on the TeX Live availability page. (See the section entitled, "TeX Live installation over the internet".) This involves downloading a file named install-tl.zip, uncompressing it, then double-clicking the file named install-tl.bat to start the downloading process. (This results in downloading over 1800 files which takes several hours on my office machine.)

If you are using Macintosh, you should download the MacTex package for Tex Live. This involves downloading a file called MacTeX.mpkg.zip (over 1 GB) and double-clicking it to start the installation process.

2.0 Set up your local texmf/ directory

Different CSDL techreports use different styles, depending upon the requirements of the journal or conference to which they were submitted. In addition, CSDL has developed a number of different LaTeX bibliography databases (i.e. .bib files) for the various research areas. To facilitate reuse of these styles and bibliography databases, you should create a local texmf/ directory that will be referenced by the TeX Live system when it runs on your tech report.

Set up your local texmf/ directory in the following way.

First, create a directory inside your home directory called "texmf". For example, on my Windows machine, this directory is C:\Documents and Settings\johnson\texmf. On my Macintosh, this directory is /Users/johnson/Library/texmf. (Note that on Macintosh, it must be in the Library/ directory.)

Next, SVN checkout the contents of https://csdl-techreports.googlecode.com/svn/trunk/texmf into your local texmf/ directory. The resulting directory structure should look something like this:

/Users/johnson/Library/texmf/
                         bibtex/
                                bib/
                                    csdl-trs.bib, tdd.bib, etc.
                                bst/
                                   IEEE_CS_Latex/
                                                latex8.bst
                                   svjour3/
                                           spbasic.bst
                         tex/
                             latex/
                                   acm/
                                       acm_proc_article-sp.cls, etc.
                                   IEEE_CS_Latex/
                                                 latex8.sty, etc.
                                   svjour3/
                                           svjour3.cls, etc.
                                   latex-uhm-thesis-1.1.0/
                                                          uhthesis2e.cls, etc.

This is less complicated than it might seem:

  • The bibtex/bib/ directory contains CSDL bibtex database files. For example, csdl-trs.bib contains citations for all CSDL techreports. Other files contain domain-specific bibtex databases. For example, tdd.bib contains references for test-driven design.

  • The IEEE_CS_Latex/ directories contain [http://www.cs.uoregon.edu/events/icse2009/calls/format/?n=DR IEEE conference style files].

  • The svjour3/ directories contain [http://www.springer.com/math/math+authors?SGWID=0-40017-2-94399-0 Springer-Verlag publication style files].

  • The acm/ directory contains [http://www.acm.org/sigs/publications/proceedings-templates ACM publications and conferences style files].

  • The latex-uhm-thesis-1.1.0/ directory contains [http://code.google.com/p/latex-uhm-thesis/ University of Hawaii thesis style files].

Feel free to add your own .bib files to the bibtex/bib directory. This enables you to reuse the same bib file across multiple publications. Remember to SVN add and commit your new file so others can reference it.

3.0 Set up your local techreports directory

Now create a directory called "techreports" in a location of your choosing, then SVN checkout https://csdl-techreports.googlecode.com/svn/trunk/techreports into this directory. The resulting directory structure should look something like this:

 /Users/johnson/techreports/
                       00-00/
                             00-00.tex, etc.
                       09-01/
                             09-01.tex, etc.
                       09-02/
                             09-02.tex, etc.

As should be obvious, this directory contains the source files for techreports under development, except for 00-00/, which is a directory used for testing your installation, as discussed next.

6.0 Generate your own tech report

Once you can generate the 00-00.pdf file locally, you are ready to start developing your own technical report. To do so, you will generally do the following:

First, "claim" a tech report number by editing the Directory page. If you are unsure of how to do this, contact Philip Johnson.

Next, create the directory inside the techreports/ directory to hold your files. If your tech report number is 09-04, then the directory should be named "09-04".

Next, copy the 00-00.tex file and the make files from the 00-00/ directory to your new directory. Rename 00-00.tex to the number associated with your tech report.

Finally, edit your .tex file appropriately. Run 'make' as desired to preview your document.