Rules for developers ¶

The tutorial is written in LaTeX and is put under svn control. You find the source code in your working copy (e.g. under ~/palm/current_version/trunk/TUTORIAL/SOURCE/).

Modifying and compiling existing presentations ¶

1. Change source code of the respective .tex file(s) in your current working copy (e.g. basic_equations.tex). For the web version it is recommended to add additional notes (so-called pdfnotes) to the slides using the following scheme:

      \pdfnote{yourlastname}{
         Your additional comments go here
       }
   

   You can add manual line breaks using \textCR. Each slide should include only one pdfnote that is placed at the end of the slide.

2. Compile the presentation using

      compile_tutorial -f basic_equations.tex
   

   A presentation (for lectures), as well as a web version and handouts will be automatically compiled and should be available as PDF files under .../TUTORIAL/LECTURE, .../TUTORIAL/WEB, .../TUTORIAL/HANDOUT). You can additionally use the -d flag parameter to enable debug output.

3. Check the compiled PDF files.

Commit changes to svn repository ¶

1. Test the compiled tutorial files.

2. Commit the changes to the repository

      svn commit -m "message string" trunk/TUTORIAL
   

   where "message string" is a short, meaningful summary of the changes.
   
   

3. Enter the changes into the change log (doc/tec/changelog).