| | 73 | |
| | 74 | |
| | 75 | === Writing documentation === |
| | 76 | |
| | 77 | A number of word and latex template files are contained in the repository. To access these to your local machine, you can use: |
| | 78 | {{{ |
| | 79 | svn co https://svn.grassaf.org/ropp/ropp_doc/trunk/ropp_templates |
| | 80 | }}} |
| | 81 | |
| | 82 | The word/ directory contains the latest versions of the Word document templates. |
| | 83 | |
| | 84 | |
| | 85 | |
| | 86 | The tex/ and bibtex/ directories contain the necessary latex class files and logo image files for generating documents using latex. The GRAS SAF report templates include versions for latex (gsr.cls) and pdflatex (gsr_pdf.cls). The other directories under ropp_doc/trunk contain example Makefiles and top level template files for reference. |
| | 87 | |
| | 88 | The following illustrates how you might add new GRAS SAF report document files to the repository. |
| | 89 | |
| | 90 | 1. Checkout the current GRAS SAF reports repository |
| | 91 | {{{ |
| | 92 | svn co https://svn.grassaf.org/ropp/ropp_doc/trunk/grassaf_report |
| | 93 | }}} |
| | 94 | 2. Add a new directory to contain your new GRAS SAF report, and write it! Use the existing reports for templates of setups, Makefiles etc. |
| | 95 | {{{ |
| | 96 | mkdir MyNewGSR/ |
| | 97 | ...add report files, figures etc to your local working version |
| | 98 | }}} |
| | 99 | 3. Commit your updates back to the repository |
| | 100 | {{{ |
| | 101 | svn add MyNewGSR |
| | 102 | svn commit |
| | 103 | }}} |