Changes between Version 3 and Version 4 of BoltImpl

Timestamp:

Jun 19, 2008, 11:41:12 AM (16 years ago)

Author:

davea

Comment:

--

BoltImpl

@@ -1 @@
-= Implementation notes =
+= Bolt implementation notes =
 
 == Source code ==
@@ -50 +50 @@
 that shows the students the correct answers,
 and whether the student's responses were right or wrong.
+
+== Structures ==
+
+=== Database tables ===
+
+|| Table name || What it represents ||
+|| bolt_user || A student, their demographic info, and project-defined attributes ||
+|| bolt_course || A course, and the name of its course structure file ||
+|| bolt_enrollment || A student taking a course, and the ID of their last view ||
+|| bolt_view || A view of an item, created when we show the item, and finalized when the student clicks on something ||
+|| bolt_result || The result of a single exercise ||
+|| bolt_xset_result || The result of a completed exercise set ||
+|| bolt_select_finished || The completion of a select structure ||
+|| bolt_refresh || The refresh/repeat of an exercise set, either pending or in progress ||
+|| bolt_question || A question asked by a student ||
+
+Each table has a corresponding PHP class with names like BoltUser etc.
+
+=== PHP "unit" class hierarchy ===
+
+A "course structure" is a tree of objects of the following types:
+
+ * \BoltUnit
+  * BoltItem
+   * BoltLesson
+   * BoltExercise
+  * BoltSet
+   * BoltRandom
+    * BoltExerciseSet
+   * BoltSelect
+
+=== Course state ===
+
+A '''course state''' represents a student's position in a course.
+It consists of an array that maps unit names to "unit state" structures.
+The contents of a unit state structure depends on the unit.
+Typically it includes the name of the current child,
+and its order in the unit's subunits.
+
+A course state is like a call stack,
+and unit states are like stack frames.
+One difference: a course state can include records for units
+that the student is not currently in.
+
+Each BoltView record contains the course state when the view started.
+
+=== BoltIter ===
+
+This data structure is used within the Bolt scheduler.
+It includes:
+
+'''top''':: the root of the course structure.
+
+'''state''':: the course state (from the latest BoltView record).
+
+'''xset''':: the xset we're currently in, if any.
+
+'''item''':: the current item
+
+'''frac_done''':: fraction of course completed so far
+
+
+