Changes between Version 3 and Version 4 of BoltRef

Timestamp:

Dec 4, 2007, 5:44:22 PM (16 years ago)

Author:

davea

Comment:

--

BoltRef

@@ -40 +40 @@
 to use separate lesson files, selected in the course document.
 
-== Creating exercises ==
+== Exercises ==
 
-A Bolt exercise is a PHP script.
+Exercises are PHP script that call Bolt API functions.
 Here's an example consisting of a multiple-choice question:
 {{{
@@ -79 +79 @@
 == Course documents ==
 
-The structure of a Bolt course is defined by a [RFC:4627 JSON] document.
+The structure of a Bolt course is defined by a PHP script.
+The script calls Bolt API functions to create a hierarchy of "units".
+Each unit has a "name", used to identify the unit within the course
+(it is now shown to students).
+
+The basic types of units are lessons and exercises.
+Each has accompanying filename.
+For example, the following course consists of a single lesson:
+{{{
+<?php
+return lesson(
+    name('lesson 1'),
+    filename('lesson_1.php');
+);
+?>
+}}}
+=== Sequences ===
 Here's an example of a course with two lessons followed by an exercise:
 {{{
-{
-   "name": "Identifying Sierra Conifers",
-   "description: "Learn to identify the major conifers of California's Sierra Nevada",
-   "items": [
-      {
-          "type": "lesson",
-          "name": "Introduction",
-          "file": "intro.html"
-      },
-      {
-          "type": "lesson",
-          "name": "The Linnaean hierarchy",
-          "file": "linnaean.html"
-      },
-      {
-          "type": "exercise",
-          "file": "linnaean.php"
-      }
-   ]
-}
+<?php
+return sequence(
+    name('course'),
+    lesson(
+        name('lesson 1'),
+        filename('bolt_sample_lesson1.php')
+    ),
+    lesson(
+        name('lesson 2'),
+        filename('bolt_sample_lesson2.php')
+    ),
+    exercise(
+        name('exercise 1'),
+        filename('bolt_sample_exercise1.php')
+    ),
+);
+?>
 }}}