| 1 | = What you need = |
| 2 | Test procedures document is compiled using [http://www.latex-project.org/ latex]. |
| 3 | (for windows, one can use [http://miktex.org/ MiKTeX] and [http://www.winshell.de/ Winshell]). |
| 4 | |
| 5 | Furthermore, all documents can be found in |
| 6 | ''project_examples/tests/TestsEllidiss'' Cheddar source code directory. |
| 7 | |
| 8 | = Compiling test procedures document = |
| 9 | Test procedures document is split in 2 parts : |
| 10 | * Main document (''!CheddarTest.tex'') : in this file, all tests are described. |
| 11 | * Report documents : test results description. This file shall be included in the main document. |
| 12 | |
| 13 | == Compilation instructions == |
| 14 | Copy the ''!DefaultReport'' file and rename it (the name can be freely chosen) : it |
| 15 | will be your report test file. |
| 16 | |
| 17 | In this file, all test description "variables" can be found (e.g. ''\def\testtaska''). |
| 18 | These description must be modified following this pattern : |
| 19 | |
| 20 | {{{ |
| 21 | \def\testtaska |
| 22 | { |
| 23 | \mytabulartestresult{result}{observation} |
| 24 | } |
| 25 | }}} |
| 26 | |
| 27 | Where ''result'' can be chosen between : |
| 28 | * OK : test result is ok. |
| 29 | * KO : test result is not ok. |
| 30 | * NA : test result is not available. |
| 31 | * ND : test has not been done. |
| 32 | |
| 33 | And ''observation'' is a comment on the test. |
| 34 | |
| 35 | For example, |
| 36 | {{{ |
| 37 | \def\testtaska |
| 38 | { |
| 39 | \mytabulartestresult{OK}{No problem for this test} |
| 40 | } |
| 41 | }}} |
| 42 | |
| 43 | Note : the ''\mytabulartestresult'' macro display a tabular on the main document. |
| 44 | |
| 45 | Your test description file shall be included in the main document : find the following |
| 46 | line ''\include{!DefaultReport}'' and put your filename. |