Added some comments/instructions in the task.py files, answered some questions in DEVELOPMENT-FAQ.txt

git-svn-id: https://svn.lusy.fri.uni-lj.si/kpov-public-svn/kpov-public@95 5cf9fbd1-b2bc-434c-b4b7-e852f4f63414

1 files changed, 54 insertions, 2 deletions

diff --git a/kpov_judge/DEVELOPMENT-FAQ.txt b/kpov_judge/DEVELOPMENT-FAQ.txt
index 40a7c4b..11a3121 100644
--- a/kpov_judge/DEVELOPMENT-FAQ.txt
+++ b/kpov_judge/DEVELOPMENT-FAQ.txt
@@ -12,5 +12,57 @@ Vprašanje:
 
 Vprašanje (06-isc_live_boot):
   - lahko prosim razložite bolj potrobno prvi del navodil (ne razumemo kaj naj bi bila ta datoteka A, ter kako so mišljeni ti IP-ji pri parametru IP_DHCP ter IP_GW).
-Vprašanje (in general)
-What is the difference between simpleArbiter, simpleArbiterDhcp, simpleArbiter-base?
+
+Question:
+  - What is the difference between simpleArbiter, simpleArbiterDhcp, simpleArbiter-base?
+
+Answer:
+  - The image simpleArbiter-base is a base image which should not be altered. simpleArbiter is derived from simpleArbiter-base
+     and is the minimal system that should be used for testing. simpleArbiterDhcp is the same as simpleArbiter, but includes a DHCP server.
+     simpleArbiterGW includes a DHCP server and is configured to act as a router using NAT.
+
+Question:
+  - How do I add a translation of the instructions?
+
+Answer:
+  - Add a key, value pair into the instructions dictionary. For example (orig):
+    instructions = {'en':'Do the locomotion'}
+    corrected:
+    instructions = {'en':'Do the locomotion', 'si':'Izvedi gibanje'}
+
+Question:
+  - How do I add a parameter to params_meta / what is the meaning of each field?
+
+Answer:
+  - params_meta is a simple dictionary. If, for example, the parameters are SOME_IP, SOME_MAC and SOME_FNAME and
+    if the student is supposed to be shown SOME_IP and SOME_MAC but is supposed to find SOME_FNAME by inspecting the
+    filesystem of their computer, params_meta might look like this:
+
+params_meta = {
+    'SOME_IP': {
+        'descriptions': {'en': 'THE IP of the server'}, # this will be shown in the dialog when test_task.py is run
+        'w': False, # the student is not allowed to change the value of SOME_IP
+        'public': True, # the student should be shown the value of SOME_IP if they run test_task.py
+        'type':'IP', # this can be used to pick the right function to generate the random value
+                     # Look at kpov_random_helpers.default_generators and kpov_random_helpers.IPv4_addr_gen 
+                     # for more info.
+        'generated': True # this parameter should be generated by gen_params
+    },
+    'SOME_MAC': {
+        'descriptions': {'en': 'The MAC of the server', 'si': u'MAC naslov strežnika'},
+        'w': True, # the student can change this value
+        'public': True, # the student should see this parameter when they run test_task.py
+        'type':'MAC', # if 'MAC' were a key in kpov_random_helpers.default_generators, the value
+                      # in that dictionary should be a random function for generating MAC addresses.
+                      # Also, in the future, the 'type' field could be used for validation.
+        'generated': False # the student should enter this value his or herself.
+    },
+    'SOME_FNAME': {
+        'descriptions': {'en': 'The name of the file to find'}, # this won't be shown anywhere
+        'w': False, # the student is not allowed to change this
+        'public': False, # the student will not be shown this parameter when they run test_task.py
+        'type': 'filename', # this can be used by gen_params or kpov_random_helpers for generation
+        'generated': True # the value should be generated in gen_params
+    },
+}
+