[Tux4kids-commits] r399 - tuxmath/trunk/doc

[tholy-guest at alioth.debian.org]

Author: tholy-guest
Date: 2007-12-31 13:19:37 +0000 (Mon, 31 Dec 2007)
New Revision: 399

Modified:
   tuxmath/trunk/doc/README.txt
Log:
Add documentation on new reporting features.


Modified: tuxmath/trunk/doc/README.txt
===================================================================
--- tuxmath/trunk/doc/README.txt	2007-12-31 13:04:09 UTC (rev 398)
+++ tuxmath/trunk/doc/README.txt	2007-12-31 13:19:37 UTC (rev 399)
@@ -351,13 +351,20 @@
 
 Game Summary Files
 ------------------
-  "Tux, of Math Command" saves summaries of the last ten games in the player's
-  .tuxmath directory.  The files are named "summary1" through "summary10",
-  with "summary1" the most recent. The files includes lists of questions asked
-  and questions missed, along with the numbers of correct and incorrect
-  answers and the percent correct.
+  "Tux, of Math Command" saves summaries of the last ten games in the
+  player's .tuxmath directory.  The files are named "summary1" through
+  "summary10", with "summary1" the most recent. The files includes
+  lists of questions asked and questions missed, along with the
+  numbers of correct and incorrect answers and the percent correct and
+  information about how long a given question was typically displayed
+  on the screen before it was answered.
 
-  [ UNDER CONSTRUCTION ]
+  In addition to these summary files, there is also a log.csv file
+  that contains a one-line summary of each attempted mission (the user
+  must have answered at least one question to count as an attempt).
+  This file can be imported into a spreadsheet program (OpenOffice.org
+  calc, Microsoft Excel, KSpread, Gnumeric, Google Docs, etc.) to
+  examine or chart student progress.
 
 
 Configuring Multiple Users
@@ -549,6 +556,16 @@
   Note there is no security insuring that students select themselves.
 
 
+Tracking Progress in Multiple-User Configurations
+-------------------------------------------------
+  tuxmathadmin contains a feature, "--consolidatelogs", that creates a
+  consolidated_log.csv file in all directories that are one above the
+  lowest level.  The basic use-case is to combine the reports on all
+  students in a particular class.  Teachers/parents can open this file
+  with a spreadsheet program as described above under "Game Summary
+  Files."
+
+
 License
 -------
   "Tux, of Math Command" is Free Software, distributable under the