From 8b72dfbded08af1444a795c379d4bd588b2a8a3a Mon Sep 17 00:00:00 2001 From: eeeickythump Date: Wed, 13 Apr 2011 11:31:30 +1200 Subject: - Can now resume drill sessions after exiting with (e)dit or (q)uit commands! Use 'M-x org-drill-resume'. - Finessed the prioritisation of items during drill sessions. - We now present failed and OVERDUE items first. Overdue status is defined in days and has some leeway, defined by a new variable 'org-drill-overdue-interval-factor'. - Next we present YOUNG items (learned or relearned recently, so have short intervals). The definition of 'young' is via the variable 'org-drill-days-before-old'. - Finally we present a random mix of OLD items and NEW items. - Final report gives info about counts of pending overdue, young, and old items. - Timer shows '++:++' if > 1 hour passes while reviewing an item. --- README.html | 434 ++++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 243 insertions(+), 191 deletions(-) (limited to 'README.html') diff --git a/README.html b/README.html index 5561788..a6ac24a 100755 --- a/README.html +++ b/README.html @@ -7,7 +7,7 @@ lang="en" xml:lang="en"> Org-Drill - + @@ -83,7 +83,6 @@ lang="en" xml:lang="en">

Org-Drill

-

Table of Contents

@@ -106,17 +105,18 @@ lang="en" xml:lang="en">
  • Leeches
  • Customisation
  • Incremental reading
    • @@ -131,9 +131,9 @@ lang="en" xml:lang="en">

    -Org-Drill uses the spaced repetition algorithm in org-learn to conduct -interactive "drill sessions", using org files as sources of facts to be -memorised. The material to be remembered is presented to the student in random +Org-Drill is an extension for GNU Emacs Org mode. Org-Drill uses a spaced repetition algorithm to conduct interactive "drill sessions", using org files +as sources of facts to be memorised. Each topic is treated as a "flash +card". The material to be remembered is presented to the student in random order. The student rates his or her recall of each item, and this information is fed back to org-learn to schedule the item for later revision.

    @@ -150,19 +150,14 @@ student in different ways. For more on the spaced repetition algorithm, and examples of other programs that use it, see:

    -
    @@ -240,17 +235,13 @@ This will be adequate for some items, but usually you will want to write items where you have more control over what information is hidden from the user for recall purposes. For this reason, some other card types are defined, including:

    @@ -281,11 +272,11 @@ heading, and the answer within a subheading. For example: -
    * Item                                   :drill:
-What is the capital city of Estonia?
+
    * Item                                   :drill:
+What is the capital city of Estonia?
 
-** The Answer
-Tallinn.
+** The Answer
+Tallinn.
 
    
 
 
@@ -318,8 +309,8 @@ example:
 
 
 
-
    * Item                                   :drill:
-The capital city of Estonia is [Tallinn].
+
    * Item                                   :drill:
+The capital city of Estonia is [Tallinn].
 
    
 
 
@@ -350,8 +341,8 @@ Example:
 
 
 
-
    Type 1 hypersensitivity reactions are mediated by [immunoglobulin E|molecule]
-and [mast cells|cell type].
+
    Type 1 hypersensitivity reactions are mediated by [immunoglobulin E|molecule]
+and [mast cells|cell type].
 
    
 
 
@@ -373,7 +364,7 @@ and 
 
 
 
    
-
    Two-sided cards 
    
+
    Two-sided cards 
    
 
    
 
 
@@ -398,21 +389,21 @@ review.
 
 
 
-
    * Noun                                               :drill:
-    :PROPERTIES:
-    :DRILL_CARD_TYPE: twosided
-    :END:
+
    * Noun                                               :drill:
+    :PROPERTIES:
+    :DRILL_CARD_TYPE: twosided
+    :END:
 
 Translate this word.
 
-** Spanish
-la mujer
+** Spanish
+la mujer
 
-** English
-the woman
+** English
+the woman
 
-** Example sentence
-¿Quién fue esa mujer?
+** Example sentence
+¿Quién fue esa mujer?
 Who was that woman?
 
    
 
@@ -430,7 +421,7 @@ not one of the first two 'sides' of the topic.
 
    
 
 
    
-
    Multi-sided cards 
    
+
    Multi-sided cards 
    
 
    
 
 
@@ -443,21 +434,21 @@ subheading is always shown and all others are always hidden.
 
 
 
-
    * Noun                                               :drill:
-    :PROPERTIES:
-    :DRILL_CARD_TYPE: multisided
-    :END:
+
    * Noun                                               :drill:
+    :PROPERTIES:
+    :DRILL_CARD_TYPE: multisided
+    :END:
 
 Translate.
 
-** Spanish
-la mesa
+** Spanish
+la mesa
 
-** English
-the table
+** English
+the table
 
-** Picture
-PICTURE
+** Picture
+[[file:table.jpg][PICTURE]]
 
    
 
 
@@ -472,7 +463,7 @@ The user will be shown the main text and either 'la mujer', or 'the woman
 
    
 
 
    
-
    Multi-cloze cards 
    
+
    Multi-cloze cards 
    
 
    
 
 
@@ -484,7 +475,7 @@ facts, such as the following:
 
 
 
-
    The capital city of New Zealand is Wellington, which is located in the
+
    The capital city of New Zealand is Wellington, which is located in the
 South Island and has a population of about 400,000.
 
    
 
@@ -497,8 +488,8 @@ There is more than one fact in this statement – you could create a single
 
 
 
-
    The capital city of [New Zealand] is [Wellington], which is located in
-the [North|North/South] Island and has a population of about [400,000].
+
    The capital city of [New Zealand] is [Wellington], which is located in
+the [North|North/South] Island and has a population of about [400,000].
 
    
 
 
@@ -516,29 +507,29 @@ like this:
 
 
 
-
    * Fact
-The capital city of [New Zealand] is Wellington, which has a population of
+
    * Fact
+The capital city of [New Zealand] is Wellington, which has a population of
 about 400,000.
 
-* Fact
-The capital city of New Zealand is [Wellington], which has a population of
+* Fact
+The capital city of New Zealand is [Wellington], which has a population of
 about 400,000.
 
-* Fact
-The capital city of New Zealand is Wellington, which has a population of
-about [400,000].
+* Fact
+The capital city of New Zealand is Wellington, which has a population of
+about [400,000].
 
-* Fact
-The capital city of [New Zealand] is Wellington, which is located in the
+* Fact
+The capital city of [New Zealand] is Wellington, which is located in the
 the North Island.
 
-* Fact
-The capital city of New Zealand is [Wellington], which is located in
+* Fact
+The capital city of New Zealand is [Wellington], which is located in
 the North Island.
 
-* Fact
-The capital city of New Zealand is Wellington, which is located in
-the [North|North/South] Island.
+* Fact
+The capital city of New Zealand is Wellington, which is located in
+the [North|North/South] Island.
 
    
 
 
@@ -559,13 +550,13 @@ will be hidden.
 
 
 
-
    * Fact
-  :PROPERTIES:
-  :DRILL_CARD_TYPE: multicloze
-  :END:
+
    * Fact
+  :PROPERTIES:
+  :DRILL_CARD_TYPE: multicloze
+  :END:
 
-The capital city of [New Zealand] is [Wellington], which is located in
-the [North|North/South] Island and has a population of about [400,000].
+The capital city of [New Zealand] is [Wellington], which is located in
+the [North|North/South] Island and has a population of about [400,000].
 
    
 
 
@@ -576,7 +567,7 @@ the [North|No
 
    
 
 
    
-
    User-defined card types 
    
+
    User-defined card types 
    
 
    
 
 
@@ -612,25 +603,19 @@ argument, SCOPE, which allows it to take drill items from other
 sources. Possible values for SCOPE are:
 
    
 
    
-
    tree
    
-The subtree starting with the entry at the cursor.
+
    tree
    The subtree starting with the entry at the cursor.
 
    
-
    file
    
-The current buffer, including both hidden and non-hidden items.
+
    file
    The current buffer, including both hidden and non-hidden items.
 
    
-
    file-with-archives
    
-The current buffer, and any archives associated with it.
+
    file-with-archives
    The current buffer, and any archives associated with it.
 
    
-
    agenda
    
-All agenda files.
+
    agenda
    All agenda files.
 
    
-
    agenda-with-archives
    
-All agenda files with any archive files associated
-with them.
+
    agenda-with-archives
    All agenda files with any archive files associated
+     with them.
 
    
-
    (file1 file2 …)
    
-A list of filenames. All files in the list will be
-scanned.
+
    (file1 file2 …)
    A list of filenames. All files in the list will be
+     scanned.
 
    
 
    
 
@@ -642,28 +627,45 @@ numbers is (taken from org-learn):
 
    
 
-+
-
+
-
-
-
-
-
-
+
+
+
+
+
+
    
 

 
 
    QualitySuperMemo labelMeaning
    QualitySuperMemo labelFail?Meaning
    
     
 
    0NULLYou have forgotten this card completely.
    1BADWrong answer.
    2FAILBarely correct, the interval was too long.
    3PASSCorrect answer, but with much effort.
    4GOODCorrect answer, with a little thought.
    5BRIGHTCorrect answer, effortless.
    0NULLYesWrong, and the answer is unfamiliar when you see it.
    1BADYesWrong answer.
    2FAILYesAlmost, but not quite correct.
    3PASSNoCorrect answer, but with much effort.
    4GOODNoCorrect answer, with a little thought.
    5BRIGHTNoCorrect answer, effortless.
    
     
 
    
 
 
 
    
 You can press '?'  at the prompt if you have trouble remembering what the
-numbers 0–5 signify. At any time you can press 'q' to finish the drill early
-(your progress will be saved), 's' to skip the current item without viewing the
-answer, or 'e' to finish the drill and jump to the current topic for editing
-(your progress up to that point will be saved).
+numbers 0–5 signify.
+
    
+
    
+At any time you can press 'q' to finish the drill early (your progress up to
+that point will be saved), 's' to skip the current item without viewing the
+answer, or 'e' to escape from the drill and jump to the current topic for
+editing (again, your progress up to that point will be saved).
+
    
+
    
+After exiting the drill session with 'e' or 'q', you can resume where you left
+off, using the command org-drill-resume. This will return you to the item
+that you were viewing when you left the session. For example, if you are shown
+an item and realise that it is poorly formulated, or contains an error, you can
+press 'e' to leave the drill, then correct the item, then press
+M-x org-drill-resume and continue where you left off.
+
    
+
    
+Note that 'drastic' edits, such as deleting or moving items, can sometimes
+cause Org-Drill to "lose its place" in the file, preventing it from
+successfully resuming the session. In that case you will need to start a new
+session.
 
    
 
 
    
@@ -719,16 +721,13 @@ Leech items can be handled in one of three ways. You can choose how Org-Drill
 handles leeches by setting the variable org-drill-leech-method to one of the
 following values:
 
    
-
    nil
    
-Leech items are tagged with the leech tag, but otherwise treated the
-same as normal items.
+
    nil
    Leech items are tagged with the leech tag, but otherwise treated the
+         same as normal items.
 
    
-
    skip
    
-Leech items are not included in drill sessions.
+
    skip
    Leech items are not included in drill sessions.
 
    
-
    warn
    
-Leech items are still included in drill sessions, but a warning
-message is printed when each leech item is presented.
+
    warn
    Leech items are still included in drill sessions, but a warning
+  message is printed when each leech item is presented.
 
    
 
    
 
@@ -762,7 +761,7 @@ settings by adding elisp code to your configuration file (.emacs).
 
    
 
 
    
-
    Appearance of items during drill sessions 
    
+
    Visual appearance of items during drill sessions 
    
 
    
 
 
@@ -828,17 +827,78 @@ session will not end until all outstanding items have been reviewed.
 
    
 
 
    
-
    Spaced repetition algorithm 
    
+
    Definition of old and overdue items 
    
 
    
 
 
 
+
    
+Org-Drill prioritises overdue items in each drill session, presenting them
+before other items are seen. Overdue items are defined in terms of how far in
+the past the item is scheduled for review. The threshold is defined in terms
+of a proportion rather than an absolute number of days. If days overdue is
+greater than
+
    
+
    +last-interval * (factor - 1)
+
    
+
+
+
    
+and is at least one day overdue, then the item is considered 'overdue'. The
+default factor is 1.2, meaning that the due date can overrun by 20% before the
+item is considered overdue.
+
    
+
    
+To change the factor that determines when items become overdue, use something
+like the following in your .emacs. Note that the value should never be less
+than 1.0.
+
    
+
+
+
+
    (setq org-drill-overdue-interval-factor 1.1)
+
    
+
+
+
+
    
+After prioritising overdue items, Org-Drill next prioritises young
+items. These are items which were recently learned (or relearned in the case of
+a failure), and which therefore have short inter-repetition intervals.
+"Recent" is defined as an inter-repetition interval less than a fixed number of
+days, rather than a number of repetitions. This ensures that more difficult
+items are reviewed more often than easier items before they stop being 'young'.
+
    
+
    
+The default definition of a young item is one with an inter-repetition interval
+of 10 days or less. To change this, use the following:
+
    
+
+
+
+
    (setq org-drill-days-before-old 7)
+
    
+
+
+
+
+
    
 
 
    
 
-
    
-
    Choice of algorithm 
    
-
    
+
    
+
    Spaced repetition algorithm 
    
+
    
+
+
+
+
+
    
+
+
    
+
    Choice of algorithm 
    
+
    
 
 
 
@@ -846,31 +906,25 @@ session will not end until all outstanding items have been reviewed.
 Org-Drill supports three different spaced repetition algorithms, all based on
 SuperMemo algorithms. These are:
 
    
-
    SM2
    
-an early algorithm, used in SuperMemo 2.0 (1988), which remains very
-popular – Anki and Mnemosyne, two of the most popular spaced repetition
-programs, use SM2. This algorithm stores an 'ease factor' for each item,
-which is modified each time you rate your recall of the item.
+
    SM2
    an early algorithm, used in SuperMemo 2.0 (1988), which remains very
+  popular – Anki and Mnemosyne, two of the most popular spaced repetition
+  programs, use SM2. This algorithm stores an 'ease factor' for each item,
+  which is modified each time you rate your recall of the item.
 
    
-
    SM5 (default)
    
-used in SuperMemo 5.0 (1989). This algorithm uses 'ease
-factors' but also uses a persistent, per-user 'matrix of optimal factors'
-which is also modified after each item repetition.
+
    SM5 (default)
    used in SuperMemo 5.0 (1989). This algorithm uses 'ease
+     factors' but also uses a persistent, per-user 'matrix of optimal factors'
+     which is also modified after each item repetition.
 
    
-
    Simple8
    
-an experimental algorithm based on the SM8 algorithm. SM8 is used
-in SuperMemo 8.0 (1998) and is almost identical to SM11 which is
-used in SuperMemo 2002. Like SM5, it uses a matrix of optimal
-factors. Simple8 differs from SM8 in that it does not adapt the
-matrix to the individual user, though it does adapt each item's
-'ease factor'.
-
+
    Simple8
    an experimental algorithm based on the SM8 algorithm. SM8 is used
+             in SuperMemo 8.0 (1998) and is almost identical to SM11 which is
+             used in SuperMemo 2002. Like SM5, it uses a matrix of optimal
+             factors. Simple8 differs from SM8 in that it does not adapt the
+             matrix to the individual user, though it does adapt each item's
+             'ease factor'.
 
    
 
    
 
-
-
    
-If you want Org-Drill to use the SM2 algorithm, put the following in your
+
    If you want Org-Drill to use the SM2 algorithm, put the following in your
 .emacs:
 
    
 
@@ -886,9 +940,9 @@ If you want Org-Drill to use the SM2 algorithm, put the following i
 
 
    
 
-
    
-
    Random variation of repetition intervals 
    
-
    
+
    
+
    Random variation of repetition intervals 
    
+
    
 
 
 
@@ -922,9 +976,9 @@ your .emacs:
 
 
    
 
-
    
-
    Adjustment for early or late review of items 
    
-
    
+
    
+
    Adjustment for early or late review of items 
    
+
    
 
 
 
@@ -951,9 +1005,9 @@ effect on the SM2 algorithm.
 
 
    
 
-
    
-
    Adjusting item difficulty globally 
    
-
    
+
    
+
    Adjusting item difficulty globally 
    
+
    
 
 
 
@@ -995,8 +1049,8 @@ To alter the learn fraction, put the following in your .emacs:
 
 
 
-
    (setq org-drill-learn-fraction 0.45)   ; change the value as desired
-
    
+
    (setq org-drill-learn-fraction 0.45)   ; change the value as desired
+
    
 
 
 
@@ -1006,9 +1060,9 @@ To alter the learn fraction, put the following in your .emacs:
 
 
    
 
-
    
-
    Per-file customisation settings 
    
-
    
+
    
+
    Per-file customisation settings 
    
+
    
 
 
 
@@ -1020,10 +1074,10 @@ special settings when running a Drill session using that file:
 
 
 
-
    # Local Variables:
-# org-drill-maximum-items-per-session:    50
-# org-drill-spaced-repetition-algorithm:  simple8
-# End:
+
    # Local Variables:
+# org-drill-maximum-items-per-session:    50
+# org-drill-spaced-repetition-algorithm:  simple8
+# End:
 
    
 
 
@@ -1069,26 +1123,26 @@ captured facts.
 
 
 
-
    (setq org-capture-templates
-       `(("u"
-         "Task: Read this URL"
+
    (setq org-capture-templates
+       `(("u"
+         "Task: Read this URL"
          entry
-         (file+headline "tasks.org" "Articles To Read")
-         ,(concat "* TODO Read article: '%:description'\nURL: %c\n\n")
-         :empty-lines 1
-         :immediate-finish t)
+         (file+headline "tasks.org" "Articles To Read")
+         ,(concat "* TODO Read article: '%:description'\nURL: %c\n\n")
+         :empty-lines 1
+         :immediate-finish t)
 
-        ("w"
-         "Capture web snippet"
+        ("w"
+         "Capture web snippet"
          entry
-         (file+headline "my-facts.org" "Inbox")
-         ,(concat "* Fact: '%:description'        :"
-                  (format "%s" org-drill-question-tag)
-                  ":\n:PROPERTIES:\n:DATE_ADDED: %u\n:SOURCE_URL: %c\n:END:\n\n%i\n%?\n")
-         :empty-lines 1
-         :immediate-finish t)
-        ;; ...other capture templates...
-    ))
+         (file+headline "my-facts.org" "Inbox")
+         ,(concat "* Fact: '%:description'        :"
+                  (format "%s" org-drill-question-tag)
+                  ":\n:PROPERTIES:\n:DATE_ADDED: %u\n:SOURCE_URL: %c\n:END:\n\n%i\n%?\n")
+         :empty-lines 1
+         :immediate-finish t)
+        ;; ...other capture templates...
+    ))
 
    
 
 
@@ -1097,14 +1151,12 @@ captured facts.
 Using these templates and org-protocol, you can set up buttons in your web
 browser to:
 
      
-
    • 
-Create a task telling you to read the URL of the currently viewed webpage
+
    • Create a task telling you to read the URL of the currently viewed webpage
 
      • 
-
    • 
-Turn a region of selected text on a webpage, into a new fact which is saved
-to whichever file and heading you nominate in the template. The fact will
-contain a timestamp, and a hyperlink back to the webpage where you created
-it.
+
    • Turn a region of selected text on a webpage, into a new fact which is saved
+  to whichever file and heading you nominate in the template. The fact will
+  contain a timestamp, and a hyperlink back to the webpage where you created
+  it.
 
      • 
 
    
 
@@ -1166,10 +1218,10 @@ something like:
 
 
 
-
    ** Fact: 'Tuberculosis - Wikipedia, the Free Encyclopedia'        :drill:
-
+
    ** Fact: 'Tuberculosis - Wikipedia, the Free Encyclopedia'        :drill:
+
 Prevention relies on screening programs and vaccination, usually with Bacillus
-Calmette-Guérin vaccine.
+Calmette-Guérin vaccine.
 
    
 
 
@@ -1196,10 +1248,10 @@ or give it different tags or properties, for example.
 
    
 
    
 
    
-
     Author: Paul Sexton
-
    
-
     Date: 2011-04-08 16:00:36 
    
-
    HTML generated by org-mode 7.4 in emacs 23
    
+
    Date: 2011-04-13 11:23:22 
    
+
    Author: Paul Sexton
    
+
    Org version 7.5 with Emacs version 23
    
+Validate XHTML 1.0
 
    
 
    
 
-- 
cgit v1.2.3