Rules for developers

Only authorized users are allowed to commit changes to the repositories. 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/). Each .tex file might be complemented by a folder containing figures used in the presentation (e.g. .../SOURCE/basic_equations_figures). Additionally, compiled PDF files are available in the trac system for web presentation and download.

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). In case you want to update figures, simply replace them in the respective folders. For the web version it is recommended to add additional notes (so-called pdfnotes) to the slides using the following scheme (replace "yourlastname" by your svn username):

      \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.
   
   You might also want to compile all available tutorial files using

      compile_tutorial
   

   This procedure might, however, take several minutes.

3. Test the compiled tutorial files (PDF).

Commit changes to svn repository

1. Test the compiled tutorial files (PDF).

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). Please note that only source code and figures are commited, but not the locally compiled PDF files. Furthermore, note that submitting changes to the svn system does not affect the trac version of the tutorial (see below)!
   
   

Commit changes to the trac system

Only special authorized users are allowed to commit changes to the trac system!

1. Test the compiled tutorial files.

2. Submit the PDF files to the trac system using

      release_tutorial
   

   You will be asked four times for your password for the trac server. This is a preliminary solution (May 2013) and might change in future. Please note that submitting changes to the trac system does not affect the svn version of the tutorial (see above)!