comment update

Author: hhzl

scripts/demo.js

@@ -1,10 +1,3 @@
-"use strict";
-var LWdb = require('../src/LWdb');
-var BoxOfQuestions = require('../src/BoxOfQuestions');
-var wordlist = require('../data/wordlist-en-ge.js'); 
-
-var readline = require('readline');
-
 // ----------------------------------------------
 // LearnWords2 API usage
 //
@@ -19,26 +12,55 @@ var readline = require('readline');
 //     LW.moveQuestionForward()
 //     LW.moveQuestionBackwards()
 //
+// 
+//
+// Asks one word and then terminates
 // ----------------------------------------------
 
+"use strict";
+var readline = require('readline');
+
+
+var LWdb = require('../src/LWdb');
+var BoxOfQuestions = require('../src/BoxOfQuestions');
+
+
+var wordlist = require('../data/wordlist-en-ge.js'); 
+
+
 
+// set up the LW (learnwords) object
 
 var LW = new BoxOfQuestions(new LWdb('learnWords'));
 
 if (LW.db.numberOfWords() == 0) {LW.db.loadWords(wordlist)};
 
 
+// clear console
 console.log('\x1Bc'); 
 
+
+// write title
 console.log('LearnWords2 demo'); 
 console.log('');
-console.log('Type the answers:');
-console.log('');
 
 
-// var aWord = {_id: 1, "word": "apple", "translate": "der Apfel"};
+
+// get a question from the box
 
 var aWord = LW.question();
+// gives for example 
+// {_id: 1, "word": "apple", "translate": "der Apfel", "step": 0, "date": 0};
+
+
+
+
+// if we got a question ask for the translation of the word
+
+if (aWord) {
+
+console.log('Type the answers:');
+console.log('');
 
 
 var rl = readline.createInterface({
@@ -47,7 +69,6 @@ var rl = readline.createInterface({
 });
 
 
-
 rl.question(aWord.word + " = ", function(answer) {
      answer = answer.toString().trim();
 
@@ -57,7 +78,11 @@ rl.question(aWord.word + " = ", function(answer) {
      else {console.log('the correct answer is:', LW.answer()); 
            LW.moveQuestionBackwards()};
 rl.close();
-
-});
+})
+} else {console.log('As of now there are no more words to repeat.')};
 
 
+// currently only one question is asked and then the program quits.
+// you have to restart the program to get the next question.
+// 
+// the db entries are in the 'scratch' subdirectory