Skip to content
Browse files

Imporved the documentation for flatfile enrolment plugin on the confi…

…guration page
  • Loading branch information...
1 parent aa6bdce commit 71767f13f9f310ced70d7f4c377454dab560fc5a patrickslee committed
Showing with 11 additions and 1 deletion.
  1. +11 −1 lang/en/enrol_flatfile.php
View
12 lang/en/enrol_flatfile.php
@@ -2,7 +2,17 @@
$string['enrolname'] = 'Flat file';
-$string['description'] = 'This method will repeatedly check for and process a specially-formatted text file in the location that you specify. The file can look something like this:
+$string['description'] = 'This method will repeatedly check for and process a specially-formatted text file in the location that you specify.
+The file is a comma separated file assumed to have four or six fields per line:
+* operation, role, idnumber(user), idnumber(course) [, starttime, endtime]
+where:
+* operation = add | del
+* role = student | teacher | teacheredit
+* idnumber(user) = idnumber in the user table NB not id
+* idnumber(course) = idnumber in the course table NB not id
+* starttime = start time (in seconds since epoch) - optional
+* endtime = end time (in seconds since epoch) - optional
+It could look something like this:
<pre>
add, student, 5, CF101
add, teacher, 6, CF101

0 comments on commit 71767f1

Please sign in to comment.
Something went wrong with that request. Please try again.