From b06c3ba8cf6f80f4ad9513d22831dbe5943a3c37 Mon Sep 17 00:00:00 2001
From: moodler <moodler>
Date: Tue, 6 Jan 2004 03:29:14 +0000
Subject: [PATCH] Help file for user uploads

---
 lang/en/help/uploadusers.html | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100755 lang/en/help/uploadusers.html

diff --git a/lang/en/help/uploadusers.html b/lang/en/help/uploadusers.html
new file mode 100755
index 0000000000..69a39483a3
--- /dev/null
+++ b/lang/en/help/uploadusers.html
@@ -0,0 +1,28 @@
+<p align="center"><b>Upload users</b></p>
+
+<p>Firstly, note that <strong>it is  usually not necessary to import users in bulk</strong> - to keep your own maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as connecting to existing external databases or letting the users create their own accounts. See the Authentication section in the admin menus.</p>
+<p>If you are sure you want to import multiple user accounts from a text file, then you need to format your text file as follows:</p>
+
+<ul>
+  <li>Each line of the file contains one record</li>
+  <li>Each record is a series of data separated by commas</li>
+  <li>The first record of the file is special, and contains a list of fieldnames. This defines the format of the rest of the file.
+    <blockquote>
+      <p><strong>Required fieldnames:</strong> these fields must be included in the first record, and defined for each user</p>
+      <p></p>
+      <font color="#990000" face="Courier New, Courier, mono">username, password, firstname, lastname, email</font></p>
+</p>
+      <p><strong>Default fieldnames:</strong> these are optional - if they are not included then the values are taken from the primary admin</p>
+      <p><font color="#990000" face="Courier New, Courier, mono">institution, department, city, country, lang, timezone</font> </p>
+      <p><strong>Optional fieldnames: </strong>all of these are completely optional. The  course names are the &quot;shortnames&quot; of the courses - if present then the user  will be enrolled as students in those courses</p>
+      <p> <font color="#990000" face="Courier New, Courier, mono">idnumber, icq, phone1, phone2, address, url, description, mailformat, maildisplay, htmleditor, autosubscribe, course1, course2, course3, course4, course5</font></p>
+    </blockquote>
+    </li>
+  <li>You should also avoid commas within the data. For Boolean fields, use 0 for false and 1 for true. </li>
+</ul>
+  
+  
+<p>Here is an example of a valid import file:</p>
+<p><font size="-1" face="Courier New, Courier, mono">username, password, firstname, lastname, email, lang, idnumber, maildisplay<br>
+jonest, verysecret, Tom, Jones, jonest@someplace.edu, en, 3663737, 1<br>
+reznort, somesecret, Trent, Reznor, reznort, reznort@someplace.edu, en_us, 6736733, 0</font></p>
-- 
2.39.5