| blob | 5d8569d5c39244246cbe7f0c07226d8ee80d8418 |
1 ;;; -*- coding: utf-8-unix -*-
2 ;;; org-drill.el - Self-testing using spaced repetition
3 ;;;
4 ;;; Author: Paul Sexton <eeeickythump@gmail.com>
5 ;;; Version: 2.3.7
6 ;;; Repository at http://bitbucket.org/eeeickythump/org-drill/
7 ;;;
8 ;;;
9 ;;; Synopsis
10 ;;; ========
11 ;;;
12 ;;; Uses the SuperMemo spaced repetition algorithms to conduct interactive
13 ;;; "drill sessions", where the material to be remembered is presented to the
14 ;;; student in random order. The student rates his or her recall of each item,
15 ;;; and this information is used to schedule the item for later revision.
16 ;;;
17 ;;; Each drill session can be restricted to topics in the current buffer
18 ;;; (default), one or several files, all agenda files, or a subtree. A single
19 ;;; topic can also be drilled.
20 ;;;
21 ;;; Different "card types" can be defined, which present their information to
22 ;;; the student in different ways.
23 ;;;
24 ;;; See the file README.org for more detailed documentation.
35 "Options concerning interactive drill sessions in Org mode (org-drill)."
42 "drill"
43 "Tag which topics must possess in order to be identified as review topics
44 by `org-drill'."
50 30
51 "Each drill session will present at most this many topics for review.
52 Nil means unlimited."
59 20
60 "Maximum duration of a drill session, in minutes.
61 Nil means unlimited."
67 2
68 "If the quality of recall for an item is this number or lower,
69 it is regarded as an unambiguous failure, and the repetition
70 interval for the card is reset to 0 days. If the quality is higher
71 than this number, it is regarded as successfully recalled, but the
72 time interval to the next repetition will be lowered if the quality
73 was near to a fail.
75 By default this is 2, for SuperMemo-like behaviour. For
76 Mnemosyne-like behaviour, set it to 1. Other values are not
77 really sensible."
83 10
84 "What percentage of items do you consider it is 'acceptable' to
85 forget each drill session? The default is 10%. A warning message
86 is displayed at the end of the session if the percentage forgotten
87 climbs above this number."
93 15
94 "If an item is forgotten more than this many times, it is tagged
95 as a 'leech' item."
101 'skip
102 "How should 'leech items' be handled during drill sessions?
103 Possible values:
104 - nil :: Leech items are treated the same as normal items.
105 - skip :: Leech items are not included in drill sessions.
106 - warn :: Leech items are still included in drill sessions,
107 but a warning message is printed when each leech item is
108 presented."
115 "The face used to hide the contents of cloze phrases."
121 "The face used to hide the contents of cloze phrases."
127 "The face used to hide the contents of cloze phrases."
132 nil
133 "Use a special face to highlight cloze-deleted text in org mode
134 buffers?"
140 nil
141 "Conceal the contents of the main heading of each item during drill
142 sessions? You may want to enable this behaviour if item headings or tags
143 contain information that could 'give away' the answer."
149 "royal blue"
150 "Foreground colour used to display the count of remaining new items
151 during a drill session."
156 "green"
157 "Foreground colour used to display the count of remaining mature items
158 during a drill session. Mature items are due for review, but are not new."
163 "red"
164 "Foreground colour used to display the count of remaining failed items
165 during a drill session."
170 "sienna"
171 "Foreground colour used to display the count of reviewed items
172 during a drill session."
179 face org-drill-hidden-cloze-face
180 window t))
187 face default
188 window t))
192 "String which, if it occurs within a cloze expression, signifies that the
193 rest of the expression after the string is a `hint', to be displayed instead of
204 `((,org-drill-cloze-regexp
208 )))
227 org-drill-present-verb-conjugation
228 org-drill-show-answer-verb-conjugation)
230 org-drill-present-noun-declension
231 org-drill-show-answer-noun-declension)
234 "Alist associating card types with presentation functions. Each
235 entry in the alist takes the form:
237 ;;; (CARDTYPE QUESTION-FN [ANSWER-FN DRILL-EMPTY-P])
239 Where CARDTYPE is a string or nil (for default), and QUESTION-FN
240 is a function which takes no arguments and returns a boolean
241 value.
243 When supplied, ANSWER-FN is a function that takes one argument --
244 that argument is a function of no arguments, which when called,
245 prompts the user to rate their recall and performs rescheduling
246 of the drill item. ANSWER-FN is called with the point on the
247 active item's heading, just prior to displaying the item's
248 'answer'. It can therefore be used to modify the appearance of
249 the answer. ANSWER-FN must call its argument before returning.
251 When supplied, DRILL-EMPTY-P is a boolean value, default nil.
252 When non-nil, cards of this type will be presented during tests
253 even if their bodies are empty."
260 'file
261 "The scope in which to search for drill items when conducting a
262 drill session. This can be any of:
264 file The current buffer, respecting the restriction if any.
265 This is the default.
266 tree The subtree started with the entry at point
267 file-no-restriction The current buffer, without restriction
268 file-with-archives The current buffer, and any archives associated with it.
269 agenda All agenda files
270 agenda-with-archives All agenda files with any archive files associated
271 with them.
272 directory All files with the extension '.org' in the same
273 directory as the current file (includes the current
274 file if it is an .org file.)
275 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
276 "
277 ;; Note -- meanings differ slightly from the argument to org-map-entries:
278 ;; 'file' means current file/buffer, respecting any restriction
279 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
280 ;; 'directory' means all *.org files in current directory
285 list))
289 t
290 "If non-nil, prompt to save all modified buffers after a drill session
291 finishes."
297 'sm5
298 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
299 Available choices are:
300 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
301 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
302 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
303 SuperMemo 98. The version implemented here is simplified in that while it
304 'learns' the difficulty of each item using quality grades and number of
305 failures, it does not modify the matrix of values that
306 governs how fast the inter-repetition intervals increase. A method for
307 adjusting intervals when items are reviewed early or late has been taken
308 from SM11, a later version of the algorithm, and included in Simple8."
314 nil
315 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
317 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
318 The matrix is saved (using the 'customize' facility) at the end of each
319 drill session.
321 Over time, values in the matrix will adapt to the individual user's
322 pace of learning."
328 4.0
329 "In the SM5 algorithm, the initial interval after the first
330 successful presentation of an item is always 4 days. If you wish to change
331 this, you can do so here."
337 nil
338 "If true, the number of days until an item's next repetition
339 will vary slightly from the interval calculated by the SM2
340 algorithm. The variation is very small when the interval is
341 small, but scales up with the interval."
347 nil
348 "If true, when the student successfully reviews an item 1 or more days
349 before or after the scheduled review date, this will affect that date of
350 the item's next scheduled review, according to the algorithm presented at
351 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
353 Items that were reviewed early will have their next review date brought
354 forward. Those that were reviewed late will have their next review
355 date postponed further.
357 Note that this option currently has no effect if the SM2 algorithm
358 is used."
364 4
365 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
366 this number determines how often the 'less favoured' situation
367 should arise. It will occur 1 in every N trials, where N is the
368 value of the variable.
370 For example, with the hide1_firstmore card type, the first piece
371 of clozed text should be hidden more often than the other
372 pieces. If this variable is set to 4 (default), the first item
373 will only be shown 25% of the time (1 in 4 trials). Similarly for
374 show1_lastmore, the last item will be shown 75% of the time, and
375 for show1_firstless, the first item would only be shown 25% of the
376 time.
378 If the value of this variable is NIL, then weighting is disabled, and
379 all weighted card types are treated as their unweighted equivalents."
385 12
386 "When in cram mode, items are considered due for review if
387 they were reviewed at least this many hours ago."
392 ;;; NEW items have never been presented in a drill session before.
393 ;;; MATURE items HAVE been presented at least once before.
394 ;;; - YOUNG mature items were scheduled no more than
395 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
396 ;;; repetition. These items will have been learned 'recently' and will have a
397 ;;; low repetition count.
398 ;;; - OLD mature items have intervals greater than
399 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
400 ;;; - OVERDUE items are past their scheduled review date by more than
401 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
402 ;;; regardless of young/old status.
406 10
407 "When an item's inter-repetition interval rises above this value in days,
408 it is no longer considered a 'young' (recently learned) item."
414 1.2
415 "An item is considered overdue if its scheduled review date is
416 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
417 days in the past. For example, a value of 1.2 means an additional
418 20% of the last scheduled interval is allowed to elapse before
419 the item is overdue. A value of 1.0 means no extra time is
420 allowed at all - items are immediately considered overdue if
421 there is even one day's delay in reviewing them. This variable
422 should never be less than 1.0."
428 0.5
429 "Fraction between 0 and 1 that governs how quickly the spaces
430 between successive repetitions increase, for all items. The
431 default value is 0.5. Higher values make spaces increase more
432 quickly with each successful repetition. You should only change
433 this in small increments (for example 0.05-0.1) as it has an
434 exponential effect on inter-repetition spacing."
440 "Global variable that can be bound to a correct answer when an
441 item is being presented. If this variable is non-nil, the default
442 presentation function will show its value instead of the default
443 behaviour of revealing the contents of the drilled item.
445 This variable is useful for card types that compute their answers
446 -- for example, a card type that asks the student to translate a
458 "List of markers for items that are considered 'overdue', based on
461 "List of markers for mature entries whose last inter-repetition
464 "List of markers for mature entries whose last inter-repetition
472 "Are we in 'cram mode', where all items are considered due
480 ;;; Make the above settings safe as file-local variables.
512 ;;;; Utilities ================================================================
522 nil
530 "Add VAL to the end of the sequence stored in PLACE. Return the new
531 value."
536 "Randomly permute the elements of LIST (all permutations equally likely)."
537 ;; Adapted from 'shuffle-vector' in cookie1.el
539 j
540 temp
548 list)
552 "Round the floating point number FLOATNUM to FIX decimal places.
553 Example: (round-float 3.56755765 3) -> 3.568"
559 "Return a human-readable description of the key/keys to which the command
560 CMD is bound, or nil if it is not bound to a key."
568 time))
572 "Like `org-map-entries', but only drill entries are processed."
583 skip)))
616 "Nil means a last review date has not yet been stored for
617 the item.
618 Zero means it was reviewed today.
619 A positive number means it was reviewed that many days ago.
620 A negative number means the date of last review is in the future --
621 this should never happen."
630 "Like `org-drill-days-since-last-review', but return value is
631 in hours rather than days."
642 "Is MARKER, or the point, in a 'drill item'? This will return nil if
643 the point is inside a subheading of a drill item -- to handle that
644 situation use `org-part-of-drill-entry-p'."
657 "Is the current entry either the main heading of a 'drill item',
658 or a subheading within a drill item?"
660 ;; Does this heading INHERIT the drill tag
665 "Move the point to the heading which holds the :drill: tag for this
666 drill entry."
678 "Is the current entry a 'leech item'?"
683 ;; (defun org-drill-entry-due-p ()
684 ;; (cond
685 ;; (*org-drill-cram-mode*
686 ;; (let ((hours (org-drill-hours-since-last-review)))
687 ;; (and (org-drill-entry-p)
688 ;; (or (null hours)
689 ;; (>= hours org-drill-cram-hours)))))
690 ;; (t
691 ;; (let ((item-time (org-get-scheduled-time (point))))
692 ;; (and (org-drill-entry-p)
693 ;; (or (not (eql 'skip org-drill-leech-method))
694 ;; (not (org-drill-entry-leech-p)))
695 ;; (or (null item-time) ; not scheduled
696 ;; (not (minusp ; scheduled for today/in past
697 ;; (- (time-to-days (current-time))
698 ;; (time-to-days item-time))))))))))
702 "Returns:
703 - NIL if the item is not to be regarded as scheduled for review at all.
704 This is the case if it is not a drill item, or if it is a leech item
705 that we wish to skip, or if we are in cram mode and have already reviewed
706 the item within the last few hours.
707 - 0 if the item is new, or if it scheduled for review today.
708 - A negative integer - item is scheduled that many days in the future.
709 - A positive integer - item is scheduled that many days in the past."
723 nil)
732 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
733 and whose last inter-repetition interval was LAST-INTERVAL, should be
734 considered 'overdue'. If the arguments are not given they are extracted
735 from the entry at point."
742 ;;(> due org-drill-days-before-overdue)
744 org-drill-overdue-interval-factor)))
764 default)))
802 default)))
805 ;;; From http://www.supermemo.com/english/ol/sm5.htm
807 "Returns a random number between 0.5 and 1.5."
820 "Random numbers in a pseudo-normal distribution with mean MEAN, range
821 MEAN-VARIATION to MEAN+VARIATION"
825 mean))
829 optimal-interval
830 days-ahead)
831 "Arguments:
832 - OPTIMAL-FACTOR: interval-factor if the item had been tested
833 exactly when it was supposed to be.
834 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
835 tested exactly when it was supposed to be.
836 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
838 Returns an adjusted optimal factor which should be used to
839 calculate the next interval, instead of the optimal factor found
840 in the matrix."
842 (/ (+ optimal-interval
849 "Returns a list of 6 items, containing all the stored recall
850 data for the item at point:
851 - LAST-INTERVAL is the interval in days that was used to schedule the item's
852 current review date.
853 - REPEATS is the number of items the item has been successfully recalled without
854 without any failures. It is reset to 0 upon failure to recall the item.
855 - FAILURES is the total number of times the user has failed to recall the item.
856 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
857 - AVERAGE-QUALITY is the mean quality of recall of the item over
858 all its repetitions, successful and unsuccessful.
859 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
860 "
874 )))
887 total-repeats meanq
888 ease)
889 "Stores the given data in the item at point."
903 ;;; SM2 Algorithm =============================================================
907 failures meanq total-repeats)
908 "Arguments:
909 - LAST-INTERVAL -- the number of days since the item was last reviewed.
910 - REPEATS -- the number of times the item has been successfully reviewed
911 - EF -- the 'easiness factor'
912 - QUALITY -- 0 to 5
914 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
915 - INTERVAL is the number of days until the item should next be reviewed
916 - REPEATS is incremented by 1.
917 - EF is modified based on the recall quality for the item.
918 - OF-MATRIX is not modified."
922 ;; When an item is failed, its interval is reset to 0,
923 ;; but its EF is unchanged
925 org-drill-optimal-factor-matrix)
926 ;; else:
945 interval)
947 next-ef
949 org-drill-optimal-factor-matrix))))
952 ;;; SM5 Algorithm =============================================================
958 org-drill-sm5-initial-interval
959 ef))
971 org-drill-optimal-factor-matrix))))
973 of
978 failures meanq total-repeats
991 quality))
996 quality org-drill-learn-fraction))
1003 last-interval n ef of-matrix)
1004 delta-days)))
1013 ;; "Failed" -- reset repetitions to 0,
1017 ; preserved
1018 ;; For a zero-based quality of 4 or 5, don't repeat
1019 ;; ((and (>= quality 4)
1020 ;; (not org-learn-always-reschedule))
1021 ;; (list 0 (1+ n) ef failures meanq
1022 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
1025 last-interval n ef of-matrix))
1030 ef
1031 failures
1032 meanq
1034 of-matrix)))))
1037 ;;; Simple8 Algorithm =========================================================
1041 "Arguments:
1042 - FAILURES: integer >= 0. The total number of times the item has
1043 been forgotten, ever.
1045 Returns the optimal FIRST interval for an item which has previously been
1046 forgotten on FAILURES occasions."
1051 "Arguments:
1052 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
1053 - REPETITION: the number of times the item has been tested.
1054 1 is the first repetition (ie the second trial).
1055 Returns:
1056 The factor by which the last interval should be
1057 multiplied to give the next interval. Corresponds to `RF' or `OF'."
1062 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
1063 to a mean item quality of QUALITY."
1072 failures meanq totaln
1074 "Arguments:
1075 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1076 - REPEATS -- the number of times the item has been successfully reviewed
1077 - EASE -- the 'easiness factor'
1078 - QUALITY -- 0 to 5
1079 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
1080 0 = reviewed on the scheduled day. +N = N days overdue.
1081 -N = reviewed N days early.
1083 Returns the new item data, as a list of 6 values:
1084 - NEXT-INTERVAL
1085 - REPEATS
1086 - EASE
1087 - FAILURES
1088 - AVERAGE-QUALITY
1089 - TOTAL-REPEATS.
1090 See the documentation for `org-drill-get-item-data' for a description of these."
1097 quality))
1111 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1115 repeats))
1121 ;; The item was reviewed earlier than scheduled.
1132 next-interval)
1133 repeats
1135 failures
1136 meanq
1137 totaln
1138 )))
1143 ;;; Essentially copied from `org-learn.el', but modified to
1144 ;;; optionally call the SM2 or simple8 functions.
1146 "If DAYS-AHEAD is supplied it must be a positive integer. The
1147 item will be scheduled exactly this many days into the future."
1152 ;; Entries can have weights, 1 by default. Intervals are divided by the
1153 ;; item's weight, so an item with a weight of 2 will have all intervals
1154 ;; halved, meaning you will end up reviewing it twice as often.
1155 ;; Useful for entries which randomly present any of several facts.
1160 total-repeats meanq ease)
1163 failures meanq total-repeats
1167 ease quality failures
1168 meanq total-repeats ofmatrix))
1170 ease quality failures
1171 meanq total-repeats))
1173 quality failures meanq
1174 total-repeats
1175 delta-days)))
1187 total-repeats meanq ease)
1204 "Returns an integer representing the number of days into the future
1205 that the current item would be scheduled, based on a recall quality
1206 of QUALITY."
1209 total-repeats meanq ease)
1214 failures meanq total-repeats
1218 ease quality failures
1219 meanq total-repeats
1220 org-drill-optimal-factor-matrix))
1222 ease quality failures
1223 meanq total-repeats))
1225 quality failures meanq
1226 total-repeats)))
1231 (+ last-interval
1234 next-interval))))))
1242 intervals))
1247 "Returns quality rating (0-5), or nil if the user quit."
1256 3-5 Means you have remembered the item.
1258 0 - Completely forgot.
1259 1 - Even after seeing the answer, it still took a bit to sink in.
1260 2 - After seeing the answer, you remembered it.
1261 3 - It took you awhile, but you finally remembered. (+%s days)
1262 4 - After a little bit of thought you remembered. (+%s days)
1263 5 - You remembered the item really easily. (+%s days)
1265 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1300 ;;(setq failures (if failures (string-to-number failures) 0))
1301 ;; (org-set-property "DRILL_FAILURE_COUNT"
1302 ;; (format "%d" (1+ failures)))
1315 quality))
1319 nil))))
1322 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1323 ;; "Returns a list containing the position of each immediate subheading of
1324 ;; the current topic."
1325 ;; (let ((drill-entry-level (org-current-level))
1326 ;; (drill-sections nil)
1327 ;; (drill-heading nil))
1328 ;; (org-show-subtree)
1329 ;; (save-excursion
1330 ;; (org-map-entries
1331 ;; (lambda ()
1332 ;; (when (and (not (outline-invisible-p))
1333 ;; (> (org-current-level) drill-entry-level))
1334 ;; (setq drill-heading (org-get-heading t))
1335 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1336 ;; (member drill-heading heading-list))
1337 ;; (hide-subtree))
1338 ;; (push (point) drill-sections)))
1339 ;; "" 'tree))
1340 ;; (reverse drill-sections)))
1345 "TEST is a function taking no arguments. TEST will be called for each
1346 of the immediate subheadings of the current drill item, with the point
1347 on the relevant subheading. TEST should return nil if the subheading is
1348 to be revealed, non-nil if it is to be hidden.
1349 Returns a list containing the position of each immediate subheading of
1350 the current topic."
1425 prompt))
1430 You seem to be having a lot of trouble memorising this item.
1433 prompt)))
1439 "++:++ "
1441 prompt))
1461 "Hide the buffer region between BEG and END with an 'invisible text'
1462 visual overlay, or with the string TEXT if it is supplied."
1488 ;; This will also unhide the item's heading.
1498 ;; Don't hide org links, partly because they might contain inline
1499 ;; images which we want to keep visible
1507 "Hide the current match with a 'cloze' visual overlay."
1520 ovl 'display
1521 ;; If hint is like `X...' then display [X...]
1522 ;; otherwise display [...X]
1524 hint))))))
1538 "During the execution of BODY, the entire text of the current entry is
1539 concealed by an overlay that displays the string TEXT."
1549 "During the execution of BODY, the entire text of the current entry is
1550 concealed by an overlay that displays the overlays in REPLACEMENTS."
1560 "Make an overlay that conceals the entire text of the item, not
1561 including properties or the contents of subheadings. The overlay shows
1562 the string TEXT.
1563 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1564 for the `display' text property. The text of the item will be temporarily
1565 replaced by all of these items, in the order in which they appear in
1566 the list.
1567 Note: does not actually alter the item."
1590 "Make overlays that conceal the entire text of the item, not
1591 including properties or the contents of subheadings. The overlay shows
1592 the string TEXT.
1593 Note: does not actually alter the item."
1603 p-max
1620 "Make an overlay that conceals the heading of the item. The overlay shows
1621 the string TEXT.
1622 Note: does not actually alter the item."
1636 text
1640 ;; (defun org-entry-empty-p ()
1641 ;; (zerop (length (org-drill-get-entry-text))))
1643 ;; This version is about 5x faster than the old version, above.
1656 ;;; Presentation functions ====================================================
1657 ;;
1658 ;; Each of these is called with point on topic heading. Each needs to show the
1659 ;; topic in the form of a 'question' or with some information 'hidden', as
1660 ;; appropriate for the card type. The user should then be prompted to press a
1661 ;; key. The function should then reveal either the 'answer' or the entire
1662 ;; topic, and should return t if the user chose to see the answer and rate their
1663 ;; recall, nil if they chose to quit.
1703 drill-sections))
1730 &optional
1731 force-show-first
1732 force-show-last
1733 force-hide-first)
1734 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1735 chosen at random.
1736 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1737 hiding all the rest.
1738 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1739 the hidden items.
1740 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1741 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1742 If the number of text pieces in the item is less than
1743 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1744 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1769 to match-count
1770 collect i)))
1774 ;; Force '1' to be in the list, and to be the first item
1775 ;; in the list.
1784 ;; (dolist (pos-to-hide match-nums)
1795 ;; (loop
1796 ;; do (re-search-forward org-drill-cloze-regexp
1797 ;; item-end t pos-to-hide)
1798 ;; while (org-pos-in-regexp (match-beginning 0)
1799 ;; org-bracket-link-regexp 1))
1800 ;; (org-drill-hide-matched-cloze-text)))))
1810 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1811 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1812 the second to last, etc."
1837 nil)
1858 "Hides one of the pieces of text that are marked for cloze deletion,
1859 chosen at random."
1864 "Hides two of the pieces of text that are marked for cloze deletion,
1865 chosen at random."
1870 "Hides the first piece of text that is marked for cloze deletion."
1875 "Hides the last piece of text that is marked for cloze deletion."
1880 "Commonly, hides the FIRST piece of text that is marked for
1881 cloze deletion. Uncommonly, hide one of the other pieces of text,
1882 chosen at random.
1884 The definitions of 'commonly' and 'uncommonly' are determined by
1885 the value of `org-drill-cloze-text-weight'."
1886 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1887 ;; to hide the 'favoured' piece of text. However even when the chance of
1888 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1889 ;; the small number of repetitions where most learning takes place for each
1890 ;; item. In other words, the actual frequency during the first 10 repetitions
1891 ;; was often very different from 80%. Hence we use modulo instead.
1894 ;; Behave as hide1cloze
1899 org-drill-cloze-text-weight))
1901 org-drill-cloze-text-weight))
1902 ;; Uncommonly, hide any item except the first
1905 ;; Commonly, hide first item
1910 "Commonly, hides all pieces except the last. Uncommonly, shows
1911 any random piece. The effect is similar to 'show1cloze' except
1912 that the last item is much less likely to be the item that is
1913 visible.
1915 The definitions of 'commonly' and 'uncommonly' are determined by
1916 the value of `org-drill-cloze-text-weight'."
1919 ;; Behave as show1cloze
1924 org-drill-cloze-text-weight))
1926 org-drill-cloze-text-weight))
1927 ;; Uncommonly, show any item except the last
1930 ;; Commonly, show the LAST item
1935 "Commonly, hides all pieces except one, where the shown piece
1936 is guaranteed NOT to be the first piece. Uncommonly, shows any
1937 random piece. The effect is similar to 'show1cloze' except that
1938 the first item is much less likely to be the item that is
1939 visible.
1941 The definitions of 'commonly' and 'uncommonly' are determined by
1942 the value of `org-drill-cloze-text-weight'."
1945 ;; Behave as show1cloze
1950 org-drill-cloze-text-weight))
1952 org-drill-cloze-text-weight))
1953 ;; Uncommonly, show the first item
1956 ;; Commonly, show any item, except the first
1961 "Similar to `org-drill-present-multicloze-hide1', but hides all
1962 the pieces of text that are marked for cloze deletion, except for one
1963 piece which is chosen at random."
1968 "Similar to `org-drill-present-multicloze-show1', but reveals two
1969 pieces rather than one."
1973 ;; (defun org-drill-present-multicloze-show1 ()
1974 ;; "Similar to `org-drill-present-multicloze-hide1', but hides all
1975 ;; the pieces of text that are marked for cloze deletion, except for one
1976 ;; piece which is chosen at random."
1977 ;; (with-hidden-comments
1978 ;; (with-hidden-cloze-hints
1979 ;; (let ((item-end nil)
1980 ;; (match-count 0)
1981 ;; (body-start (or (cdr (org-get-property-block))
1982 ;; (point))))
1983 ;; (org-drill-hide-all-subheadings-except nil)
1984 ;; (save-excursion
1985 ;; (outline-next-heading)
1986 ;; (setq item-end (point)))
1987 ;; (save-excursion
1988 ;; (goto-char body-start)
1989 ;; (while (re-search-forward org-drill-cloze-regexp item-end t)
1990 ;; (incf match-count)))
1991 ;; (when (plusp match-count)
1992 ;; (let ((match-to-hide (random* match-count)))
1993 ;; (save-excursion
1994 ;; (goto-char body-start)
1995 ;; (dotimes (n match-count)
1996 ;; (re-search-forward org-drill-cloze-regexp
1997 ;; item-end t)
1998 ;; (unless (= n match-to-hide)
1999 ;; (org-drill-hide-matched-cloze-text))))))
2000 ;; (org-display-inline-images t)
2001 ;; (org-cycle-hide-drawers 'all)
2002 ;; (prog1 (org-drill-presentation-prompt)
2003 ;; (org-drill-hide-subheadings-if 'org-drill-entry-p)
2004 ;; (org-drill-unhide-clozed-text))))))
2008 "Present the string QUESTION as the only visible content of the card.
2009 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2023 "TEXTS is a list of valid values for the 'display' text property.
2024 Present these overlays, in sequence, as the only
2025 visible content of the card.
2026 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2030 replacements
2040 "Present the current topic for interactive review, as in `org-drill'.
2041 Review will occur regardless of whether the topic is due for review or whether
2042 it meets the definition of a 'review topic' used by `org-drill'.
2044 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
2045 EDIT if the user chose to exit the drill and edit the current item. Choosing
2046 the latter option leaves the drill session suspended; it can be resumed
2047 later using `org-drill-resume'.
2049 See `org-drill' for more details."
2052 ;;(unless (org-part-of-drill-entry-p)
2053 ;; (error "Point is not inside a drill entry"))
2054 ;;(unless (org-at-heading-p)
2055 ;; (org-back-to-heading))
2060 ;; fontification functions in `outline-view-change-hook' can cause big
2061 ;; slowdowns, so we temporarily bind this variable to nil here.
2088 nil)
2123 "Returns true if the current drill session has continued past its
2124 maximum duration."
2133 "Returns true if the current drill session has reached the
2134 maximum number of items."
2138 org-drill-maximum-items-per-session)))
2147 m
2149 ;; First priority is items we failed in a prior session.
2154 ;; Next priority is overdue items.
2158 ;; We use `pop', not `pop-random', because we have already
2159 ;; sorted overdue items into a random order which takes
2160 ;; number of days overdue into account.
2162 ;; Next priority is 'young' items.
2167 ;; Next priority is newly added items, and older entries.
2168 ;; We pool these into a single group.
2180 ;; After all the above are done, last priority is items
2181 ;; that were failed earlier THIS SESSION.
2186 m)))
2190 "Returns nil, t, or a list of markers representing entries that were
2191 'failed' and need to be presented again before the session ends.
2193 RESUMING-P is true if we are resuming a suspended drill session."
2211 ;; The entry is not due anymore. This could arise if the user
2212 ;; suspends a drill session, then drills an individual entry,
2213 ;; then resumes the session.
2216 nil)
2253 "%d items reviewed. Session duration %s.
2254 Recall of reviewed items:
2255 Excellent (5): %3d%% | Near miss (2): %3d%%
2256 Good (4): %3d%% | Failure (1): %3d%%
2257 Hard (3): %3d%% | Abject failure (0): %3d%%
2259 You successfully recalled %d%% of reviewed items (quality > %s)
2260 %d/%d items still await review (%s, %s, %s, %s, %s).
2261 Tomorrow, %d more items will become due for review.
2262 Session finished. Press a key to continue..."
2278 pass-percent
2279 org-drill-failure-quality
2305 ))
2316 "%s
2317 You failed %d%% of the items you reviewed during this session.
2318 %d (%d%%) of all items scanned were overdue.
2320 Are you keeping up with your items, and reviewing them
2321 when they are scheduled? If so, you may want to consider
2322 lowering the value of `org-drill-learn-fraction' slightly in
2323 order to make items appear more frequently over time."
2330 ))))
2335 "MARKERS is a list of markers, all of which will be freed (set to
2336 point nowhere). Alternatively, MARKERS can be 't', in which case
2337 all the markers used by Org-Drill will be freed."
2346 markers))
2358 "Returns a list (STATUS DUE) where DUE is the number of days overdue,
2359 zero being due today, -1 being scheduled 1 day in the future. STATUS is
2360 one of the following values:
2361 - nil, if the item is not a drill entry, or has an empty body
2362 - :unscheduled
2363 - :future
2364 - :new
2365 - :failed
2366 - :overdue
2367 - :young
2368 - :old
2369 "
2378 nil)
2384 ;; body is empty, and this is not a card type where empty bodies are
2385 ;; meaningful, so skip it.
2386 nil)
2389 ;; ((eql -1 due)
2390 ;; :tomorrow)
2393 ;; The rest of the stati all denote 'due' items ==========================
2395 org-drill-failure-quality)
2396 ;; Mature entries that were failed last time are
2397 ;; FAILED, regardless of how young, old or overdue
2398 ;; they are.
2403 ;; Overdue status overrides young versus old
2404 ;; distinction.
2405 ;; Store marker + due, for sorting of overdue entries
2408 org-drill-days-before-old)
2412 due))))
2421 collected
2423 sym2)
2425 sym1)))))
2429 "Begin an interactive 'drill session'. The user is asked to
2430 review a series of topics (headers). Each topic is initially
2431 presented as a 'question', often with part of the topic content
2432 hidden. The user attempts to recall the hidden information or
2433 answer the question, then presses a key to reveal the answer. The
2434 user then rates his or her recall or performance on that
2435 topic. This rating information is used to reschedule the topic
2436 for future review.
2438 Org-drill proceeds by:
2440 - Finding all topics (headings) in SCOPE which have either been
2441 used and rescheduled before, or which have a tag that matches
2442 `org-drill-question-tag'.
2444 - All matching topics which are either unscheduled, or are
2445 scheduled for the current date or a date in the past, are
2446 considered to be candidates for the drill session.
2448 - If `org-drill-maximum-items-per-session' is set, a random
2449 subset of these topics is presented. Otherwise, all of the
2450 eligible topics will be presented.
2452 SCOPE determines the scope in which to search for
2453 questions. It accepts the same values as `org-drill-scope',
2454 which see.
2456 If RESUME-P is non-nil, resume a suspended drill session rather
2457 than starting a new one."
2508 (:unscheduled
2510 ;; (:tomorrow
2511 ;; (incf *org-drill-dormant-entry-count*)
2512 ;; (incf *org-drill-due-tomorrow-count*))
2513 (:future
2517 (:new
2519 (:failed
2521 (:young
2523 (:overdue
2525 (:old
2527 )))))
2528 scope)
2556 "You can continue the drill session with the command `org-drill-resume'.%s"
2566 ))))
2572 org-drill-optimal-factor-matrix))
2576 "Run an interactive drill session in 'cram mode'. In cram mode,
2577 all drill items are considered to be due for review, unless they
2578 have been reviewed within the last `org-drill-cram-hours'
2579 hours."
2586 "Run an interactive drill session using drill items within the
2587 subtree at point."
2593 "Run an interactive drill session using drill items from all org
2594 files in the same directory as the current file."
2600 "Run a new drill session, but try to use leftover due items that
2601 were not reviewed during the last session, rather than scanning for
2602 unreviewed items. If there are no leftover items in memory, a full
2603 scan will be performed."
2621 "Resume a suspended drill session. Sessions are suspended by
2622 exiting them with the `edit' or `quit' options."
2628 ;; Current drill session is finished, but there are still
2629 ;; more items which need to be reviewed.
2631 "You have finished the drill session. However, %d items still
2632 need reviewing. Start a new drill session? "
2646 "Delete scheduling data from every drill entry in scope. This
2647 function may be useful if you want to give your collection of
2648 entries to someone else. Scope defaults to the current buffer,
2649 and is specified by the argument SCOPE, which accepts the same
2650 values as `org-drill-scope'."
2656 ;; Scope is the current buffer. This means we can use
2657 ;; `org-delete-property-globally', which is faster.
2670 org-drill-cloze-keywords
2671 nil)))
2678 ;;; Synching card collections =================================================
2685 "Copy the subtree at point to the buffer DEST. The copy will receive
2686 the tag 'imported'."
2717 ;; We've looked all the way up the path
2718 ;; Default to appending to the end of DEST
2727 )))))
2732 "SRC and DEST are two org mode buffers containing drill items.
2733 For each drill item in DEST that shares an ID with an item in SRC,
2734 overwrite scheduling data in DEST with data taken from the item in SRC.
2735 This is intended for use when two people are sharing a set of drill items,
2736 one person has made some updates to the item set, and the other person
2737 wants to migrate to the updated set without losing their scheduling data.
2739 By default, any drill items in SRC which do not exist in DEST are
2740 copied into DEST. We attempt to place the copied item in the
2741 equivalent location in DEST to its location in SRC, by matching
2742 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2743 we simply ignore any items that do not exist in DEST, and do not
2744 copy them across."
2755 ;; Compile list of all IDs in the destination buffer.
2764 ;; Look through all entries in source buffer.
2774 nil)
2776 ;; This entry matches an entry in dest. Retrieve all its
2777 ;; scheduling data, then go to the matching location in dest
2778 ;; and write the data.
2781 total-repeats meanq ease)
2787 ;; go to matching entry in destination buffer
2793 total-repeats meanq ease)
2805 ;; item in SRC has ID, but no matching ID in DEST.
2806 ;; It must be a new item that does not exist in DEST.
2807 ;; Copy the entire item to the *end* of DEST.
2811 ;; Finally: there may be some items in DEST which are not in SRC, and
2812 ;; which have been scheduled by another user of DEST. Clear out the
2813 ;; scheduling info from all the unmatched items in DEST.
2823 ;;; Card types for learning languages =========================================
2825 ;;; Get spell-number.el from:
2826 ;;; http://www.emacswiki.org/emacs/spell-number.el
2830 ;;; `conjugate' card type =====================================================
2831 ;;; See spanish.org for usage
2837 ;; past tenses
2843 ;; future tenses
2845 ;; moods (backgrounds).
2851 )
2852 "Alist where each entry has the form (TENSE COLOUR), where
2853 TENSE is a string naming a tense in which verbs can be
2854 conjugated, and COLOUR is a string specifying a foreground colour
2855 which will be used by `org-drill-present-verb-conjugation' and
2856 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2861 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2862 `org-drill-show-answer-verb-conjugation'."
2881 :background
2891 "Present a drill entry whose card type is 'conjugate'."
2912 translation
2918 "Show the answer for a drill item whose card type is 'conjugate'.
2919 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2920 returns its return value."
2933 infinitive translation)
2938 ;;; `decline_noun' card type ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2954 ))
2958 "Auxiliary function used by `org-drill-present-noun-declension' and
2959 `org-drill-show-answer-noun-declension'."
2977 org-drill-noun-gender-alist t))
2985 "Present a drill entry whose card type is 'decline_noun'."
3007 noun noun-gender
3014 translation
3022 "Show the answer for a drill item whose card type is 'decline_noun'.
3023 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3024 returns its return value."
3029 noun noun-gender translation)
3034 ;;; `translate_number' card type ==============================================
3035 ;;; See spanish.org for usage
3059 num-max num-min))
3082 ;; (defun org-drill-show-answer-translate-number (reschedule-fn)
3083 ;; (let* ((language (read (org-entry-get (point) "DRILL_LANGUAGE" t)))
3084 ;; (highlight-face 'font-lock-warning-face)
3085 ;; (non-english
3086 ;; (let ((spelln-language language))
3087 ;; (propertize (spelln-integer-in-words *drilled-number*)
3088 ;; 'face highlight-face)))
3089 ;; (english
3090 ;; (let ((spelln-language 'english-gb))
3091 ;; (propertize (spelln-integer-in-words *drilled-number*)
3092 ;; 'face 'highlight-face))))
3093 ;; (with-replaced-entry-text
3094 ;; (cond
3095 ;; ((eql 'to-english *drilled-number-direction*)
3096 ;; (format "\nThe English translation of %s is:\n\n%s\n"
3097 ;; non-english english))
3098 ;; (t
3099 ;; (format "\nThe %s translation of %s is:\n\n%s\n"
3100 ;; (capitalize (format "%s" language))
3101 ;; english non-english)))
3102 ;; (funcall reschedule-fn))))
3105 ;;; `spanish_verb' card type ==================================================
3106 ;;; Not very interesting, but included to demonstrate how a presentation
3107 ;;; function can manipulate which subheading are hidden versus shown.