Rev 2448 | Rev 3263 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
23 | reyssat | 1 | |
2 | <center><h3>The format OEF</h3></center> <p> |
||
3 | |||
4 | OEF means ``online exercise format'', a format for mathematical exercises |
||
5 | destinated to computer-aided teaching systems. The goal of the creation |
||
6 | of this format is to help the exchanges of content between different |
||
7 | systems. Therefore this format only contains mathematical informations of |
||
8 | the exercise. |
||
9 | <p> |
||
10 | The advantage of the OEF format is that exercises under it are very easy |
||
11 | to create. But it should be said that these exercises, in particular those |
||
12 | created by $module_title, are not as performing as native exercises of a |
||
13 | system such as WIMS. It is hard to imagine, at least for the time being, |
||
14 | the WIMS exercises such as Q-Puzzle, the Coincidence series or again the |
||
15 | Shoot series, be transformed into oef format. |
||
16 | <p> |
||
17 | Please refer also to |
||
18 | !href cmd=help&special_parm=examples the examples |
||
19 | to have an idea of the structure of an OEF file. <p> |
||
20 | <h4>Basic syntax</h4> <p> |
||
21 | The format of a OEF file is very similar to LaTeX. It is composed of |
||
22 | directives followed by one or more parameters. A directive is a word |
||
23 | preceeded by the character <tt><b><font color=green>\</font></b></tt>, |
||
24 | and the parameters are enclosed in braces. |
||
25 | For example, in the following sentence |
||
26 | <pre> |
||
27 | \choice{The answer is}{yes}{no} |
||
28 | </pre> |
||
29 | there is a directive named <tt>choice</tt>, |
||
30 | which has 3 parameters, namely, <tt>The answer is</tt>, <tt>yes</tt> |
||
31 | and <tt>no</tt>. |
||
32 | <p><h4>List of directives</h4> <p> |
||
33 | Here is a brief list of directives recognized by the OEF manager of WIMS. |
||
34 | See also |
||
35 | !href cmd=help&special_parm=parameters help on parameters |
||
36 | for the syntax to define parameters. |
||
37 | <p>$table_header |
||
38 | $table_hdtr<th>directive<th>number of<br>parameters<th>description |
||
39 | $table_tr<td>title<td align=center>1<td>defines the title of the exercise |
||
40 | $table_tr<td>language<td align=center>1<td>the language of the exercise, such as |
||
41 | <tt>en</tt> or <tt>fr</tt> |
||
42 | $table_tr<td>author<td align=center>1<td>defines the author of the exercise |
||
43 | $table_tr<td>email<td align=center>1<td>defines the author's email |
||
44 | $table_tr<td>format<td align=center>1<td>format of the statement: see |
||
45 | !href cmd=help&special_parm=format help on formats |
||
46 | . |
||
1105 | bpr | 47 | $table_tr<td>css</td><td align=center>1</td><td>defines css style</td></tr> |
23 | reyssat | 48 | $table_tr<td>precision<td align=center>1<td>precision in comparing user's reply |
49 | with the solution. Give a positive integer n here: the comparison will |
||
50 | be done to the precision of 1/n. |
||
51 | $table_tr<td>range<td align=center>1<td>variable range when evaluating a function |
||
52 | supplied by the user. Should be given in the form <tt>n1..n2</tt>, where |
||
53 | n1 is the start point, n2 is the end point. |
||
54 | <tr> |
||
55 | $table_tr<td>statement<td align=center>1<td>the parameter is the statement of the exercise |
||
56 | $table_tr<td>plot<td align=center>?<td>a dynamic plot. (Still under construction.) |
||
57 | <tr> |
||
58 | $table_tr<td>answer<td align=center>2-5<td>defines a freestyle answer. The first |
||
59 | parameter is the prompt of the answer, and the second is the good answer. |
||
60 | Such an answer can be tested according to many different types: number, |
||
61 | function, text, etc. |
||
62 | !href module=$module&cmd=help&special_parm=reply Detail |
||
63 | . |
||
64 | <p> |
||
65 | Optional parameters: <tt>type</tt>, <tt>option</tt>, <tt>weight</tt>. |
||
66 | $table_tr<td>choice<td align=center>3-5<td>defines a multiple choice. The first |
||
67 | parameter is the prompt of the choice, the second the good choice(s), and the |
||
68 | third the other choice(s). The last two parameters may (should) be a |
||
69 | comma-separated list. Multiple good choices are allowed. If a choice appears |
||
70 | in both good and bad choice lists, it will be taken as good. |
||
71 | <p> |
||
72 | Optional parameters: <tt>option</tt>, <tt>weight</tt>. |
||
73 | <p> |
||
74 | Recognized option words: <tt>shuffle</tt>, <tt>noidontknow</tt>. |
||
75 | $table_tr<td>condition<td align=center>2-4<td>defines a special condition for the |
||
76 | evaluation of freestyle answers. See |
||
77 | !href cmd=help&special_parm=reply help on replies |
||
78 | for details. |
||
79 | <p> |
||
80 | Optional parameters: <tt>option</tt>, <tt>weight</tt>. |
||
81 | <tr> |
||
82 | $table_tr<td>solution<td align=center>1<td>gives the solution of the exercise with |
||
83 | explanation. The OEF manager may decide on whether to show this explained |
||
84 | solution to the user, according to the user setup of the difficulty level. |
||
85 | $table_tr<td>hint<td align=center>1<td>gives a hint of the exercise. The OEF |
||
86 | manager may decide on whether to show the hint, according to the user setup |
||
87 | of the difficulty level. |
||
88 | $table_tr<td>help<td align=center>1<td>gives a help to the exercise. This help |
||
89 | will always be accessible to the user, in a popup window. |
||
90 | $table_tr<td>feedback<td align=center>2<td>gives a feedback warning to the user |
||
91 | when the answer meeds a specified condition. Usually to warn of a typical |
||
92 | error. |
||
93 | !href cmd=help&special_parm=feedback Detail |
||
94 | . |
||
2461 | bpr | 95 | $table_end |
23 | reyssat | 96 |