Need help cloning? Visit
is a free Git and Mercurial client for Windows.
is a free Git and Mercurial client for Mac.
+;;; org-drill.el - Self-testing with org-learn
+;;; Author: Paul Sexton <firstname.lastname@example.org>
+;;; Version: 1.0
+;;; Repository at http://bitbucket.org/eeeickythump/org-drill/
+;;; Uses the spaced repetition algorithm in `org-learn' to conduct interactive
+;;; "drill sessions" where material to be remembered is presented to the
+;;; student. The student rates his or her recall of each item, and this information
+;;; is fed back to 'org-learn' to schedule later revision of the item.
+;;; Drills can include topics in one buffer, one or several files,
+;;; all agenda files, or a subtree. A single topic can also be drilled.
+;;; Different "card types" can be defined, which present their information to
+;;; the student in different ways.
+;;; Put the following in your .emacs:
+;;; (add-to-list 'load-path "/path/to/org/contrib/lisp/")
+;;; (require 'org-drill)
+;;; Tag all items you want to be asked about with a tag that matches
+;;; `org-drill-question-tag'. This is :drill: by default.
+;;; You don't need to schedule the topics initially. Within each question, the
+;;; answer can be included in the following ways:
+;;; - Question in the main body text, answer in subtopics. This is the
+;;; default. All subtopics will be shown collapsed.
+;;; - Each subtopic contains a piece of information related to the topic. One
+;;; of these will revealed at random, and the others hidden. To define a
+;;; topic of this type, give the topic a property `DRILL_CARD_TYPE' with
+;;; value `multisided'.
+;;; - Cloze deletion -- any pieces of text in the body of the card that are
+;;; surrounded with [SINGLE square brackets] will be hidden when the card is
+;;; presented to the user, and revealed once they press a key. Cloze deletion
+;;; is automatically applied to all topics.
+;;; - No explicit answer -- the user judges whether they recalled the
+;;; fact adequately.
+;;; See "questions.org" for examples.
+;;; Run a drill session with `M-x org-drill'. This will include all eligible
+;;; topics in the current buffer. `org-drill' can also be targeted at a particular
+;;; subtree or particular files or sets of files; see the documentation of that
+;;; function for details.
+;;; During the drill session, you will be presented with each item, then asked
+;;; to rate your recall of it by pressing a key between 0 and 5. At any time you
+;;; can press 'q' to finish the drill early (your progress will be saved).
+;;; - encourage org-learn to reschedule "4" and "5" items.
+;;; - nicer "cloze face" which does not hide the space preceding the cloze,
+;;; and behaves more nicely across line breaks
+;;; - hide drawers.
+;;; - org-drill-question-tag should use a tag match string, rather than a
+;;; single tag
+;;; - when finished, display a message showing how many items reviewed,
+;;; how many still pending, numbers in each recall category
+(eval-when-compile (require 'cl))
+(eval-when-compile (require 'hi-lock))
+(defgroup org-drill nil
+ "Options concerning interactive drill sessions in Org mode (org-drill)."
+ :tag "Org-Drill"
+ :group 'org-link)
+ "Tag which topics must possess in order to be identified as review topics
+ :group 'org-drill
+ :type 'string)
+ "Each drill session will present at most this many topics for review.
+Nil means unlimited."
+ :type '(choice integer (const nil)))
+ "Maximum duration of a drill session, in minutes.
+ '((t (:foreground "blue" :background "blue")))
+ "The face used to hide the contents of cloze phrases."
+ :group 'org-drill)
+ '((nil . org-drill-present-simple-card)
+ ("simple" . org-drill-present-simple-card)
+ ("multisided" . org-drill-present-multi-sided-card))
+ "Alist associating card types with presentation functions. Each entry in the
+alist takes the form (CARDTYPE . FUNCTION), where CARDTYPE is a string
+or nil, and FUNCTION is a function which takes no arguments and returns a
+ :type '(alist :key-type (choice string (const nil)) :value-type function))
+(defun shuffle-list (list)
+ "Randomly permute the elements of LIST (all permutations equally likely)."
+ ;; Adapted from 'shuffle-vector' in cookie1.el
+ (let ((i 0)
+ (len (length list)))
+ (while (< i len)
+ (setq j (+ i (random (- len i))))
+ (setq temp (nth i list))
+ (setf (nth i list) (nth j list))
+ (setf (nth j list) temp)
+ (setq i (1+ i))))
+(defun org-drill-entry-due-p ()
+ (let ((item-time (org-get-scheduled-time (point))))
+ (and (or (assoc "LEARN_DATA" (org-entry-properties nil))
+ (member org-drill-question-tag (org-get-local-tags)))
+ (or (null item-time)
+ (not (minusp ; scheduled for today/in
+ ; future
+ (- (time-to-days (current-time))
+ (time-to-days item-time))))))))
+(defun org-drill-reschedule ()
+ (let ((ch nil))
+ (while (not (memq ch '(?q ?0 ?1 ?2 ?3 ?4 ?5)))
+ (setq ch (read-char
+ (if (eq ch ??)
+ "0-2 Means you have forgotten the item.
+3-5 Means you have remembered the item.
+0 - Completely forgot.
+1 - Even after seeing the answer, it still took a bit to sink in.
+2 - After seeing the answer, you remembered it.
+3 - It took you awhile, but you finally remembered.
+4 - After a little bit of thought you remembered.
+5 - You remembered the item really easily.
+How well did you do? (0-5, ?=help, q=quit)"
+ "How well did you do? (0-5, ?=help, q=quit)"))))
+ ((and (>= ch ?0) (<= ch ?5))
+ (org-smart-reschedule (- ch 48)))
+;;; Presentation functions ====================================================
+;; Each of these is called with point on topic heading. Each needs to show the
+;; topic in the form of a 'question' or with some information 'hidden', as
+;; appropriate for the card type. The user should then be prompted to press a
+;; key. The function should then reveal either the 'answer' or the entire
+;; topic, and should return t if the user chose to see the answer and rate their
+;; recall, nil if they chose to quit.
+(defun org-drill-present-simple-card ()
+ (let ((drill-entry-level (org-current-level)))
+ (lambda ()
+ (if (> (org-current-level) drill-entry-level)
+ "" 'tree)))
+ (setq ch (read-char "Press a key to see the answer..."))
+ (not (eq ch ?q)))
+(defun org-drill-present-multi-sided-card ()
+ (let ((drill-entry-level (org-current-level))
+ (drill-sections nil))
+ (when (> (org-current-level) drill-entry-level)
+ (push (point) drill-sections)))
+ "" 'tree))
+ (when drill-sections
+ (goto-char (nth (random (length drill-sections)) drill-sections))
+ (setq ch (read-char "Press a key to see the answer..."))
+ (not (eq ch ?q))))
+(defun org-drill-entry ()
+ "Present the current topic for interactive review, as in `org-drill'.
+Review will occur regardless of whether the topic is due for review or whether
+it meets the definition of a 'review topic' used by `org-drill'.
+See `org-drill' for more details."
+ (unless (org-at-heading-p)
+ (let ((card-type (cdr (assoc "DRILL_CARD_TYPE" (org-entry-properties nil))))
+ (cont nil))
+ (org-cycle-hide-drawers 'overview)
+ (let ((presentation-fn (cdr (assoc card-type org-drill-card-type-alist))))
+ (highlight-regexp org-drill-cloze-regexp
+ (setq cont (funcall presentation-fn))
+ (unhighlight-regexp org-drill-cloze-regexp))
+ (error "Unknown card type: '%s'" card-type))))
+ ((not cont)
+ (message "Quit")
+(defun org-drill (&optional scope)
+ "Begin an interactive 'drill session'. The user is asked to
+review a series of topics (headers). Each topic is initially
+presented as a 'question', often with part of the topic content
+hidden. The user attempts to recall the hidden information or
+answer the question, then presses a key to reveal the answer. The
+user then rates his or her recall or performance on that
+topic. This rating information is used to reschedule the topic
+for future review using the `org-learn' library.
+Org-drill proceeds by:
+- Finding all topics (headings) in SCOPE which have either been
+ used and rescheduled by org-learn before (i.e. the LEARN_DATA
+ property is set), or which have a tag that matches
+- All matching topics which are either unscheduled, or are
+ scheduled for the current date or a date in the past, are
+ considered to be candidates for the drill session.
+- If `org-drill-maximum-items-per-session' is set, a random
+ subset of these topics is presented. Otherwise, all of the
+ eligible topics will be presented.
+SCOPE determines the scope in which to search for
+questions. It is passed to `org-map-entries', and can be any of:
+nil The current buffer, respecting the restriction if any.
+ This is the default.
+tree The subtree started with the entry at point
+file The current buffer, without restriction
+ The current buffer, and any archives associated with it
+agenda All agenda files
+ All agenda files with any archive files associated with them
+ (file1 file2 ...)
+ If this is a list, all files in the list will be scanned."
+ (let ((entries nil)
+ (result nil)
+ (results nil))
+ (block org-drill
+ (lambda () (if (org-drill-entry-due-p)
+ (push (point-marker) entries)))
+ "" scope)
+ ((null entries)
+ (message "I did not find any pending drill items."))
+ (let ((start-time (float-time (current-time))))
+ (dolist (m (if (and org-drill-maximum-items-per-session
+ (> (length entries)
+ (subseq (shuffle-list entries) 0
+ (shuffle-list entries)))
+ (switch-to-buffer (marker-buffer m))
+ (goto-char (marker-position m))
+ (setq result (org-drill-entry))
+ ((null result)
+ (message "Quit")
+ (return-from org-drill nil))
+ ((and org-drill-maximum-duration
+ (> (- (float-time (current-time)) start-time)
+ (* org-drill-maximum-duration 60)))
+ (message "This drill session has reached its maximum duration.")
+ (return-from org-drill nil)))))
+ (message "Drill session finished!")
+# -*- mode: org; coding: utf-8 -*-
+# example of card definitions for use with org-drill.
+* Spanish questions
+# Simple cards. When each card is presented, all subheadings are collapsed.
+*** Greeting 1 :drill:
+Translate into Spanish:
+What is your name? (formal)
+¿Cómo se llama usted?
+*** Greeting 2 :drill:
+What is your name? (informal)
+¿Cómo te llamas?
+# Examples of 'multisided' cards. The user will randomly be presented either
+# with the Spanish word, or the English word, and asked to recall the
+# appropriate translation.
+*** Noun :drill:
+ :DRILL_CARD_TYPE: multisided
+Translate this word.
+** Grammar rules
+# Simple cards -- the question and answer are produced purely using cloze
+# deletion, without the need to hide any subtopics.
+*** Rule :drill:
+To make the plural of an adjective ending in [a stressed vowel or a consonant
+other than -z], add /-es/.
+To form an adverb from an adjective, add [-mente] to the [feminine] (gender)
+form of the adjective.