| blob | 81012e1d1bcb09a8e0095059e7fa2c395a5ae015 |
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.4.5
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.
37 "Options concerning interactive drill sessions in Org mode (org-drill)."
44 "drill"
45 "Tag which topics must possess in order to be identified as review topics
46 by `org-drill'."
52 30
53 "Each drill session will present at most this many topics for review.
54 Nil means unlimited."
61 20
62 "Maximum duration of a drill session, in minutes.
63 Nil means unlimited."
69 2
70 "If the quality of recall for an item is this number or lower,
71 it is regarded as an unambiguous failure, and the repetition
72 interval for the card is reset to 0 days. If the quality is higher
73 than this number, it is regarded as successfully recalled, but the
74 time interval to the next repetition will be lowered if the quality
75 was near to a fail.
77 By default this is 2, for SuperMemo-like behaviour. For
78 Mnemosyne-like behaviour, set it to 1. Other values are not
79 really sensible."
85 10
86 "What percentage of items do you consider it is 'acceptable' to
87 forget each drill session? The default is 10%. A warning message
88 is displayed at the end of the session if the percentage forgotten
89 climbs above this number."
95 15
96 "If an item is forgotten more than this many times, it is tagged
97 as a 'leech' item."
103 'skip
104 "How should 'leech items' be handled during drill sessions?
105 Possible values:
106 - nil :: Leech items are treated the same as normal items.
107 - skip :: Leech items are not included in drill sessions.
108 - warn :: Leech items are still included in drill sessions,
109 but a warning message is printed when each leech item is
110 presented."
117 "The face used to hide the contents of cloze phrases."
123 "The face used to hide the contents of cloze phrases."
129 "The face used to hide the contents of cloze phrases."
134 nil
135 "Use a special face to highlight cloze-deleted text in org mode
136 buffers?"
142 nil
143 "Conceal the contents of the main heading of each item during drill
144 sessions? You may want to enable this behaviour if item headings or tags
145 contain information that could 'give away' the answer."
151 "royal blue"
152 "Foreground colour used to display the count of remaining new items
153 during a drill session."
158 "green"
159 "Foreground colour used to display the count of remaining mature items
160 during a drill session. Mature items are due for review, but are not new."
165 "red"
166 "Foreground colour used to display the count of remaining failed items
167 during a drill session."
172 "sienna"
173 "Foreground colour used to display the count of reviewed items
174 during a drill session."
179 "["
180 "String used within org buffers to delimit cloze deletions."
185 "]"
186 "String used within org buffers to delimit cloze deletions."
193 org-drill-left-cloze-delimiter
194 org-drill-right-cloze-delimiter)
195 face org-drill-hidden-cloze-face
196 window t))
203 face default
204 window t))
208 "String which, if it occurs within a cloze expression, signifies that the
209 rest of the expression after the string is a `hint', to be displayed instead of
226 )))
252 org-drill-present-verb-conjugation
253 org-drill-show-answer-verb-conjugation)
255 org-drill-present-noun-declension
256 org-drill-show-answer-noun-declension)
259 "Alist associating card types with presentation functions. Each
260 entry in the alist takes the form:
262 ;;; (CARDTYPE QUESTION-FN [ANSWER-FN DRILL-EMPTY-P])
264 Where CARDTYPE is a string or nil (for default), and QUESTION-FN
265 is a function which takes no arguments and returns a boolean
266 value.
268 When supplied, ANSWER-FN is a function that takes one argument --
269 that argument is a function of no arguments, which when called,
270 prompts the user to rate their recall and performs rescheduling
271 of the drill item. ANSWER-FN is called with the point on the
272 active item's heading, just prior to displaying the item's
273 'answer'. It can therefore be used to modify the appearance of
274 the answer. ANSWER-FN must call its argument before returning.
276 When supplied, DRILL-EMPTY-P is a boolean value, default nil.
277 When non-nil, cards of this type will be presented during tests
278 even if their bodies are empty."
285 'file
286 "The scope in which to search for drill items when conducting a
287 drill session. This can be any of:
289 file The current buffer, respecting the restriction if any.
290 This is the default.
291 tree The subtree started with the entry at point
292 file-no-restriction The current buffer, without restriction
293 file-with-archives The current buffer, and any archives associated with it.
294 agenda All agenda files
295 agenda-with-archives All agenda files with any archive files associated
296 with them.
297 directory All files with the extension '.org' in the same
298 directory as the current file (includes the current
299 file if it is an .org file.)
300 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
301 "
302 ;; Note -- meanings differ slightly from the argument to org-map-entries:
303 ;; 'file' means current file/buffer, respecting any restriction
304 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
305 ;; 'directory' means all *.org files in current directory
312 (const :tag "All agenda files with any archive files associated with them." agenda-with-archives)
313 (const :tag "All files with the extension '.org' in the same directory as the current file (includes the current file if it is an .org file.)" directory)
318 nil
319 "If non-nil, a string specifying a tags/property/TODO query. During
320 drill sessions, only items that match this query will be considered."
326 t
327 "If non-nil, prompt to save all modified buffers after a drill session
328 finishes."
334 'sm5
335 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
336 Available choices are:
337 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
338 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
339 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
340 SuperMemo 98. The version implemented here is simplified in that while it
341 'learns' the difficulty of each item using quality grades and number of
342 failures, it does not modify the matrix of values that
343 governs how fast the inter-repetition intervals increase. A method for
344 adjusting intervals when items are reviewed early or late has been taken
345 from SM11, a later version of the algorithm, and included in Simple8."
351 nil
352 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
354 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
355 The matrix is saved (using the 'customize' facility) at the end of each
356 drill session.
358 Over time, values in the matrix will adapt to the individual user's
359 pace of learning."
365 4.0
366 "In the SM5 algorithm, the initial interval after the first
367 successful presentation of an item is always 4 days. If you wish to change
368 this, you can do so here."
374 nil
375 "If true, the number of days until an item's next repetition
376 will vary slightly from the interval calculated by the SM2
377 algorithm. The variation is very small when the interval is
378 small, but scales up with the interval."
384 nil
385 "If true, when the student successfully reviews an item 1 or more days
386 before or after the scheduled review date, this will affect that date of
387 the item's next scheduled review, according to the algorithm presented at
388 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
390 Items that were reviewed early will have their next review date brought
391 forward. Those that were reviewed late will have their next review
392 date postponed further.
394 Note that this option currently has no effect if the SM2 algorithm
395 is used."
401 4
402 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
403 this number determines how often the 'less favoured' situation
404 should arise. It will occur 1 in every N trials, where N is the
405 value of the variable.
407 For example, with the hide1_firstmore card type, the first piece
408 of clozed text should be hidden more often than the other
409 pieces. If this variable is set to 4 (default), the first item
410 will only be shown 25% of the time (1 in 4 trials). Similarly for
411 show1_lastmore, the last item will be shown 75% of the time, and
412 for show1_firstless, the first item would only be shown 25% of the
413 time.
415 If the value of this variable is NIL, then weighting is disabled, and
416 all weighted card types are treated as their unweighted equivalents."
422 12
423 "When in cram mode, items are considered due for review if
424 they were reviewed at least this many hours ago."
429 ;;; NEW items have never been presented in a drill session before.
430 ;;; MATURE items HAVE been presented at least once before.
431 ;;; - YOUNG mature items were scheduled no more than
432 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
433 ;;; repetition. These items will have been learned 'recently' and will have a
434 ;;; low repetition count.
435 ;;; - OLD mature items have intervals greater than
436 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
437 ;;; - OVERDUE items are past their scheduled review date by more than
438 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
439 ;;; regardless of young/old status.
443 10
444 "When an item's inter-repetition interval rises above this value in days,
445 it is no longer considered a 'young' (recently learned) item."
451 1.2
452 "An item is considered overdue if its scheduled review date is
453 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
454 days in the past. For example, a value of 1.2 means an additional
455 20% of the last scheduled interval is allowed to elapse before
456 the item is overdue. A value of 1.0 means no extra time is
457 allowed at all - items are immediately considered overdue if
458 there is even one day's delay in reviewing them. This variable
459 should never be less than 1.0."
465 0.5
466 "Fraction between 0 and 1 that governs how quickly the spaces
467 between successive repetitions increase, for all items. The
468 default value is 0.5. Higher values make spaces increase more
469 quickly with each successful repetition. You should only change
470 this in small increments (for example 0.05-0.1) as it has an
471 exponential effect on inter-repetition spacing."
477 "Global variable that can be bound to a correct answer when an
478 item is being presented. If this variable is non-nil, the default
479 presentation function will show its value instead of the default
480 behaviour of revealing the contents of the drilled item.
482 This variable is useful for card types that compute their answers
483 -- for example, a card type that asks the student to translate a
495 "List of markers for items that are considered 'overdue', based on
498 "List of markers for mature entries whose last inter-repetition
501 "List of markers for mature entries whose last inter-repetition
509 "Are we in 'cram mode', where all items are considered due
516 "If non-nil, entries more than 90 days overdue are regarded as 'lapsed'.
517 This means that when the item is eventually re-tested it will be
518 treated as 'failed' (quality 2) for rescheduling purposes,
522 ;;; Make the above settings safe as file-local variables.
558 ;;;; Utilities ================================================================
568 nil
576 "Add VAL to the end of the sequence stored in PLACE. Return the new
577 value."
582 "Randomly permute the elements of LIST (all permutations equally likely)."
583 ;; Adapted from 'shuffle-vector' in cookie1.el
585 j
586 temp
594 list)
598 "Round the floating point number FLOATNUM to FIX decimal places.
599 Example: (round-float 3.56755765 3) -> 3.568"
605 "Return a human-readable description of the key/keys to which the command
606 CMD is bound, or nil if it is not bound to a key."
614 time))
620 time))
624 "Like `org-map-entries', but only drill entries are processed."
640 skip)))
673 "Nil means a last review date has not yet been stored for
674 the item.
675 Zero means it was reviewed today.
676 A positive number means it was reviewed that many days ago.
677 A negative number means the date of last review is in the future --
678 this should never happen."
687 "Like `org-drill-days-since-last-review', but return value is
688 in hours rather than days."
699 "Is MARKER, or the point, in a 'drill item'? This will return nil if
700 the point is inside a subheading of a drill item -- to handle that
701 situation use `org-part-of-drill-entry-p'."
714 "Is the current entry either the main heading of a 'drill item',
715 or a subheading within a drill item?"
717 ;; Does this heading INHERIT the drill tag
722 "Move the point to the heading which holds the :drill: tag for this
723 drill entry."
735 "Is the current entry a 'leech item'?"
740 ;; (defun org-drill-entry-due-p ()
741 ;; (cond
742 ;; (*org-drill-cram-mode*
743 ;; (let ((hours (org-drill-hours-since-last-review)))
744 ;; (and (org-drill-entry-p)
745 ;; (or (null hours)
746 ;; (>= hours org-drill-cram-hours)))))
747 ;; (t
748 ;; (let ((item-time (org-get-scheduled-time (point))))
749 ;; (and (org-drill-entry-p)
750 ;; (or (not (eql 'skip org-drill-leech-method))
751 ;; (not (org-drill-entry-leech-p)))
752 ;; (or (null item-time) ; not scheduled
753 ;; (not (minusp ; scheduled for today/in past
754 ;; (- (time-to-days (current-time))
755 ;; (time-to-days item-time))))))))))
759 "Returns:
760 - NIL if the item is not to be regarded as scheduled for review at all.
761 This is the case if it is not a drill item, or if it is a leech item
762 that we wish to skip, or if we are in cram mode and have already reviewed
763 the item within the last few hours.
764 - 0 if the item is new, or if it scheduled for review today.
765 - A negative integer - item is scheduled that many days in the future.
766 - A positive integer - item is scheduled that many days in the past."
780 nil)
789 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
790 and whose last inter-repetition interval was LAST-INTERVAL, should be
791 considered 'overdue'. If the arguments are not given they are extracted
792 from the entry at point."
799 ;;(> due org-drill-days-before-overdue)
801 org-drill-overdue-interval-factor)))
821 default)))
859 default)))
862 ;;; From http://www.supermemo.com/english/ol/sm5.htm
864 "Returns a random number between 0.5 and 1.5."
877 "Random numbers in a pseudo-normal distribution with mean MEAN, range
878 MEAN-VARIATION to MEAN+VARIATION"
882 mean))
886 optimal-interval
887 days-ahead)
888 "Arguments:
889 - OPTIMAL-FACTOR: interval-factor if the item had been tested
890 exactly when it was supposed to be.
891 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
892 tested exactly when it was supposed to be.
893 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
895 Returns an adjusted optimal factor which should be used to
896 calculate the next interval, instead of the optimal factor found
897 in the matrix."
899 (/ (+ optimal-interval
906 "Returns a list of 6 items, containing all the stored recall
907 data for the item at point:
908 - LAST-INTERVAL is the interval in days that was used to schedule the item's
909 current review date.
910 - REPEATS is the number of items the item has been successfully recalled without
911 without any failures. It is reset to 0 upon failure to recall the item.
912 - FAILURES is the total number of times the user has failed to recall the item.
913 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
914 - AVERAGE-QUALITY is the mean quality of recall of the item over
915 all its repetitions, successful and unsuccessful.
916 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
917 "
931 )))
944 total-repeats meanq
945 ease)
946 "Stores the given data in the item at point."
960 ;;; SM2 Algorithm =============================================================
964 failures meanq total-repeats)
965 "Arguments:
966 - LAST-INTERVAL -- the number of days since the item was last reviewed.
967 - REPEATS -- the number of times the item has been successfully reviewed
968 - EF -- the 'easiness factor'
969 - QUALITY -- 0 to 5
971 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
972 - INTERVAL is the number of days until the item should next be reviewed
973 - REPEATS is incremented by 1.
974 - EF is modified based on the recall quality for the item.
975 - OF-MATRIX is not modified."
979 ;; When an item is failed, its interval is reset to 0,
980 ;; but its EF is unchanged
982 org-drill-optimal-factor-matrix)
983 ;; else:
1002 interval)
1004 next-ef
1006 org-drill-optimal-factor-matrix))))
1009 ;;; SM5 Algorithm =============================================================
1015 org-drill-sm5-initial-interval
1016 ef))
1028 org-drill-optimal-factor-matrix))))
1030 of
1035 failures meanq total-repeats
1048 quality))
1053 quality org-drill-learn-fraction))
1060 last-interval n ef of-matrix)
1061 delta-days)))
1070 ;; "Failed" -- reset repetitions to 0,
1074 ; preserved
1075 ;; For a zero-based quality of 4 or 5, don't repeat
1076 ;; ((and (>= quality 4)
1077 ;; (not org-learn-always-reschedule))
1078 ;; (list 0 (1+ n) ef failures meanq
1079 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
1082 last-interval n ef of-matrix))
1087 ef
1088 failures
1089 meanq
1091 of-matrix)))))
1094 ;;; Simple8 Algorithm =========================================================
1098 "Arguments:
1099 - FAILURES: integer >= 0. The total number of times the item has
1100 been forgotten, ever.
1102 Returns the optimal FIRST interval for an item which has previously been
1103 forgotten on FAILURES occasions."
1108 "Arguments:
1109 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
1110 - REPETITION: the number of times the item has been tested.
1111 1 is the first repetition (ie the second trial).
1112 Returns:
1113 The factor by which the last interval should be
1114 multiplied to give the next interval. Corresponds to `RF' or `OF'."
1119 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
1120 to a mean item quality of QUALITY."
1129 failures meanq totaln
1131 "Arguments:
1132 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1133 - REPEATS -- the number of times the item has been successfully reviewed
1134 - EASE -- the 'easiness factor'
1135 - QUALITY -- 0 to 5
1136 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
1137 0 = reviewed on the scheduled day. +N = N days overdue.
1138 -N = reviewed N days early.
1140 Returns the new item data, as a list of 6 values:
1141 - NEXT-INTERVAL
1142 - REPEATS
1143 - EASE
1144 - FAILURES
1145 - AVERAGE-QUALITY
1146 - TOTAL-REPEATS.
1147 See the documentation for `org-drill-get-item-data' for a description of these."
1154 quality))
1168 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1172 repeats))
1178 ;; The item was reviewed earlier than scheduled.
1189 next-interval)
1190 repeats
1192 failures
1193 meanq
1194 totaln
1195 )))
1200 ;;; Essentially copied from `org-learn.el', but modified to
1201 ;;; optionally call the SM2 or simple8 functions.
1203 "If DAYS-AHEAD is supplied it must be a positive integer. The
1204 item will be scheduled exactly this many days into the future."
1209 ;; Entries can have weights, 1 by default. Intervals are divided by the
1210 ;; item's weight, so an item with a weight of 2 will have all intervals
1211 ;; halved, meaning you will end up reviewing it twice as often.
1212 ;; Useful for entries which randomly present any of several facts.
1217 total-repeats meanq ease)
1220 failures meanq total-repeats
1224 ease quality failures
1225 meanq total-repeats ofmatrix))
1227 ease quality failures
1228 meanq total-repeats))
1230 quality failures meanq
1231 total-repeats
1232 delta-days)))
1244 total-repeats meanq ease)
1261 "Returns an integer representing the number of days into the future
1262 that the current item would be scheduled, based on a recall quality
1263 of QUALITY."
1266 total-repeats meanq ease)
1271 failures meanq total-repeats
1275 ease quality failures
1276 meanq total-repeats
1277 org-drill-optimal-factor-matrix))
1279 ease quality failures
1280 meanq total-repeats))
1282 quality failures meanq
1283 total-repeats)))
1288 (+ last-interval
1291 next-interval))))))
1299 intervals))
1304 "Returns quality rating (0-5), or nil if the user quit."
1313 3-5 Means you have remembered the item.
1315 0 - Completely forgot.
1316 1 - Even after seeing the answer, it still took a bit to sink in.
1317 2 - After seeing the answer, you remembered it.
1318 3 - It took you awhile, but you finally remembered. (+%s days)
1319 4 - After a little bit of thought you remembered. (+%s days)
1320 5 - You remembered the item really easily. (+%s days)
1322 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1358 ;;(setq failures (if failures (string-to-number failures) 0))
1359 ;; (org-set-property "DRILL_FAILURE_COUNT"
1360 ;; (format "%d" (1+ failures)))
1373 quality))
1377 nil))))
1380 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1381 ;; "Returns a list containing the position of each immediate subheading of
1382 ;; the current topic."
1383 ;; (let ((drill-entry-level (org-current-level))
1384 ;; (drill-sections nil)
1385 ;; (drill-heading nil))
1386 ;; (org-show-subtree)
1387 ;; (save-excursion
1388 ;; (org-map-entries
1389 ;; (lambda ()
1390 ;; (when (and (not (outline-invisible-p))
1391 ;; (> (org-current-level) drill-entry-level))
1392 ;; (setq drill-heading (org-get-heading t))
1393 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1394 ;; (member drill-heading heading-list))
1395 ;; (hide-subtree))
1396 ;; (push (point) drill-sections)))
1397 ;; "" 'tree))
1398 ;; (reverse drill-sections)))
1403 "TEST is a function taking no arguments. TEST will be called for each
1404 of the immediate subheadings of the current drill item, with the point
1405 on the relevant subheading. TEST should return nil if the subheading is
1406 to be revealed, non-nil if it is to be hidden.
1407 Returns a list containing the position of each immediate subheading of
1408 the current topic."
1483 prompt))
1488 You seem to be having a lot of trouble memorising this item.
1491 prompt)))
1497 "++:++ "
1499 prompt))
1519 "Hide the buffer region between BEG and END with an 'invisible text'
1520 visual overlay, or with the string TEXT if it is supplied."
1547 ;; This will also unhide the item's heading.
1557 ;; Don't hide:
1558 ;; - org links, partly because they might contain inline
1559 ;; images which we want to keep visible.
1560 ;; - LaTeX math fragments
1561 ;; - the contents of SRC blocks
1571 "Hide the current match with a 'cloze' visual overlay."
1585 ovl 'display
1586 ;; If hint is like `X...' then display [X...]
1587 ;; otherwise display [...X]
1589 hint))))))
1603 "During the execution of BODY, the entire text of the current entry is
1604 concealed by an overlay that displays the string TEXT."
1614 "During the execution of BODY, the entire text of the current entry is
1615 concealed by an overlay that displays the overlays in REPLACEMENTS."
1625 "Make an overlay that conceals the entire text of the item, not
1626 including properties or the contents of subheadings. The overlay shows
1627 the string TEXT.
1628 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1629 for the `display' text property. The text of the item will be temporarily
1630 replaced by all of these items, in the order in which they appear in
1631 the list.
1632 Note: does not actually alter the item."
1656 "Make overlays that conceal the entire text of the item, not
1657 including properties or the contents of subheadings. The overlay shows
1658 the string TEXT.
1659 Note: does not actually alter the item."
1669 p-max
1687 "Make an overlay that conceals the heading of the item. The overlay shows
1688 the string TEXT.
1689 Note: does not actually alter the item."
1703 text
1707 ;; (defun org-entry-empty-p ()
1708 ;; (zerop (length (org-drill-get-entry-text))))
1710 ;; This version is about 5x faster than the old version, above.
1725 ;;; Presentation functions ====================================================
1726 ;;
1727 ;; Each of these is called with point on topic heading. Each needs to show the
1728 ;; topic in the form of a 'question' or with some information 'hidden', as
1729 ;; appropriate for the card type. The user should then be prompted to press a
1730 ;; key. The function should then reveal either the 'answer' or the entire
1731 ;; topic, and should return t if the user chose to see the answer and rate their
1732 ;; recall, nil if they chose to quit.
1782 drill-sections))
1811 &optional
1812 force-show-first
1813 force-show-last
1814 force-hide-first)
1815 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1816 chosen at random.
1817 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1818 hiding all the rest.
1819 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1820 the hidden items.
1821 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1822 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1823 If the number of text pieces in the item is less than
1824 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1825 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1851 to match-count
1852 collect i)))
1856 ;; Force '1' to be in the list, and to be the first item
1857 ;; in the list.
1866 ;; (dolist (pos-to-hide match-nums)
1878 ;; (loop
1879 ;; do (re-search-forward org-drill-cloze-regexp
1880 ;; item-end t pos-to-hide)
1881 ;; while (org-pos-in-regexp (match-beginning 0)
1882 ;; org-bracket-link-regexp 1))
1883 ;; (org-drill-hide-matched-cloze-text)))))
1894 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1895 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1896 the second to last, etc."
1922 nil)
1929 ;; Don't consider this a cloze region if it is part of an
1930 ;; org link, or if it occurs inside a LaTeX math
1931 ;; fragment
1948 "Hides one of the pieces of text that are marked for cloze deletion,
1949 chosen at random."
1954 "Hides two of the pieces of text that are marked for cloze deletion,
1955 chosen at random."
1960 "Hides the first piece of text that is marked for cloze deletion."
1965 "Hides the last piece of text that is marked for cloze deletion."
1970 "Commonly, hides the FIRST piece of text that is marked for
1971 cloze deletion. Uncommonly, hide one of the other pieces of text,
1972 chosen at random.
1974 The definitions of 'commonly' and 'uncommonly' are determined by
1975 the value of `org-drill-cloze-text-weight'."
1976 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1977 ;; to hide the 'favoured' piece of text. However even when the chance of
1978 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1979 ;; the small number of repetitions where most learning takes place for each
1980 ;; item. In other words, the actual frequency during the first 10 repetitions
1981 ;; was often very different from 80%. Hence we use modulo instead.
1984 ;; Behave as hide1cloze
1989 org-drill-cloze-text-weight))
1991 org-drill-cloze-text-weight))
1992 ;; Uncommonly, hide any item except the first
1995 ;; Commonly, hide first item
2000 "Commonly, hides all pieces except the last. Uncommonly, shows
2001 any random piece. The effect is similar to 'show1cloze' except
2002 that the last item is much less likely to be the item that is
2003 visible.
2005 The definitions of 'commonly' and 'uncommonly' are determined by
2006 the value of `org-drill-cloze-text-weight'."
2009 ;; Behave as show1cloze
2014 org-drill-cloze-text-weight))
2016 org-drill-cloze-text-weight))
2017 ;; Uncommonly, show any item except the last
2020 ;; Commonly, show the LAST item
2025 "Commonly, hides all pieces except one, where the shown piece
2026 is guaranteed NOT to be the first piece. Uncommonly, shows any
2027 random piece. The effect is similar to 'show1cloze' except that
2028 the first item is much less likely to be the item that is
2029 visible.
2031 The definitions of 'commonly' and 'uncommonly' are determined by
2032 the value of `org-drill-cloze-text-weight'."
2035 ;; Behave as show1cloze
2040 org-drill-cloze-text-weight))
2042 org-drill-cloze-text-weight))
2043 ;; Uncommonly, show the first item
2046 ;; Commonly, show any item, except the first
2051 "Similar to `org-drill-present-multicloze-hide1', but hides all
2052 the pieces of text that are marked for cloze deletion, except for one
2053 piece which is chosen at random."
2058 "Similar to `org-drill-present-multicloze-show1', but reveals two
2059 pieces rather than one."
2064 "Present the string QUESTION as the only visible content of the card.
2065 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2079 "TEXTS is a list of valid values for the 'display' text property.
2080 Present these overlays, in sequence, as the only
2081 visible content of the card.
2082 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2086 replacements
2096 "Present the current topic for interactive review, as in `org-drill'.
2097 Review will occur regardless of whether the topic is due for review or whether
2098 it meets the definition of a 'review topic' used by `org-drill'.
2100 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
2101 EDIT if the user chose to exit the drill and edit the current item. Choosing
2102 the latter option leaves the drill session suspended; it can be resumed
2103 later using `org-drill-resume'.
2105 See `org-drill' for more details."
2108 ;;(unless (org-part-of-drill-entry-p)
2109 ;; (error "Point is not inside a drill entry"))
2110 ;;(unless (org-at-heading-p)
2111 ;; (org-back-to-heading))
2116 ;; fontification functions in `outline-view-change-hook' can cause big
2117 ;; slowdowns, so we temporarily bind this variable to nil here.
2145 nil)
2181 "Returns true if the current drill session has continued past its
2182 maximum duration."
2191 "Returns true if the current drill session has reached the
2192 maximum number of items."
2196 org-drill-maximum-items-per-session)))
2205 m
2207 ;; First priority is items we failed in a prior session.
2212 ;; Next priority is overdue items.
2216 ;; We use `pop', not `pop-random', because we have already
2217 ;; sorted overdue items into a random order which takes
2218 ;; number of days overdue into account.
2220 ;; Next priority is 'young' items.
2225 ;; Next priority is newly added items, and older entries.
2226 ;; We pool these into a single group.
2238 ;; After all the above are done, last priority is items
2239 ;; that were failed earlier THIS SESSION.
2244 m)))
2248 "Returns nil, t, or a list of markers representing entries that were
2249 'failed' and need to be presented again before the session ends.
2251 RESUMING-P is true if we are resuming a suspended drill session."
2269 ;; The entry is not due anymore. This could arise if the user
2270 ;; suspends a drill session, then drills an individual entry,
2271 ;; then resumes the session.
2274 nil)
2311 "%d items reviewed. Session duration %s.
2312 Recall of reviewed items:
2313 Excellent (5): %3d%% | Near miss (2): %3d%%
2314 Good (4): %3d%% | Failure (1): %3d%%
2315 Hard (3): %3d%% | Abject failure (0): %3d%%
2317 You successfully recalled %d%% of reviewed items (quality > %s)
2318 %d/%d items still await review (%s, %s, %s, %s, %s).
2319 Tomorrow, %d more items will become due for review.
2320 Session finished. Press a key to continue..."
2336 pass-percent
2337 org-drill-failure-quality
2363 ))
2374 "%s
2375 You failed %d%% of the items you reviewed during this session.
2376 %d (%d%%) of all items scanned were overdue.
2378 Are you keeping up with your items, and reviewing them
2379 when they are scheduled? If so, you may want to consider
2380 lowering the value of `org-drill-learn-fraction' slightly in
2381 order to make items appear more frequently over time."
2388 ))))
2393 "MARKERS is a list of markers, all of which will be freed (set to
2394 point nowhere). Alternatively, MARKERS can be 't', in which case
2395 all the markers used by Org-Drill will be freed."
2404 markers))
2408 ;;; overdue-data is a list of entries, each entry has the form (POS DUE AGE)
2409 ;;; where POS is a marker pointing to the start of the entry, and
2410 ;;; DUE is a number indicating how many days ago the entry was due.
2411 ;;; AGE is the number of days elapsed since item creation (nil if unknown).
2412 ;;; if age > lapse threshold (default 90), sort by age (oldest first)
2413 ;;; if age < lapse threshold, sort by due (biggest first)
2420 overdue-data))
2441 "If USE-LAST-INTERVAL-P is non-nil, and DATE_ADDED is missing, use the
2442 value of DRILL_LAST_INTERVAL instead (as the item's age must be at least
2443 that many days)."
2455 "Returns a list (STATUS DUE AGE) where DUE is the number of days overdue,
2456 zero being due today, -1 being scheduled 1 day in the future.
2457 AGE is the number of days elapsed since the item was created (nil if unknown).
2458 STATUS is one of the following values:
2459 - nil, if the item is not a drill entry, or has an empty body
2460 - :unscheduled
2461 - :future
2462 - :new
2463 - :failed
2464 - :overdue
2465 - :young
2466 - :old
2467 "
2477 nil)
2483 ;; body is empty, and this is not a card type where empty bodies are
2484 ;; meaningful, so skip it.
2485 nil)
2488 ;; ((eql -1 due)
2489 ;; :tomorrow)
2492 ;; The rest of the stati all denote 'due' items ==========================
2494 org-drill-failure-quality)
2495 ;; Mature entries that were failed last time are
2496 ;; FAILED, regardless of how young, old or overdue
2497 ;; they are.
2502 ;; Overdue status overrides young versus old
2503 ;; distinction.
2504 ;; Store marker + due, for sorting of overdue entries
2507 org-drill-days-before-old)
2511 due age))))
2520 collected
2522 sym2)
2524 sym1)))))
2528 "Begin an interactive 'drill session'. The user is asked to
2529 review a series of topics (headers). Each topic is initially
2530 presented as a 'question', often with part of the topic content
2531 hidden. The user attempts to recall the hidden information or
2532 answer the question, then presses a key to reveal the answer. The
2533 user then rates his or her recall or performance on that
2534 topic. This rating information is used to reschedule the topic
2535 for future review.
2537 Org-drill proceeds by:
2539 - Finding all topics (headings) in SCOPE which have either been
2540 used and rescheduled before, or which have a tag that matches
2541 `org-drill-question-tag'.
2543 - All matching topics which are either unscheduled, or are
2544 scheduled for the current date or a date in the past, are
2545 considered to be candidates for the drill session.
2547 - If `org-drill-maximum-items-per-session' is set, a random
2548 subset of these topics is presented. Otherwise, all of the
2549 eligible topics will be presented.
2551 SCOPE determines the scope in which to search for
2552 questions. It accepts the same values as `org-drill-scope',
2553 which see.
2555 DRILL-MATCH, if supplied, is a string specifying a tags/property/
2556 todo query. Only items matching the query will be considered.
2557 It accepts the same values as `org-drill-match', which see.
2559 If RESUME-P is non-nil, resume a suspended drill session rather
2560 than starting a new one."
2563 ;; Check org version. Org 7.9.3f introduced a backwards-incompatible change
2564 ;; to the arguments accepted by `org-schedule'. At the time of writing there
2565 ;; are still lots of people using versions of org older than this.
2570 (format "Warning: org-drill requires org mode 7.9.3f or newer. Scheduling of failed cards will not
2571 work correctly with older versions of org mode. Your org mode version (%s) appears to be older than
2622 (:unscheduled
2624 ;; (:tomorrow
2625 ;; (incf *org-drill-dormant-entry-count*)
2626 ;; (incf *org-drill-due-tomorrow-count*))
2627 (:future
2631 (:new
2633 (:failed
2635 (:young
2637 (:overdue
2639 (:old
2641 )))))
2642 scope drill-match)
2670 "You can continue the drill session with the command `org-drill-resume'.%s"
2680 ))))
2686 org-drill-optimal-factor-matrix))
2690 "Run an interactive drill session in 'cram mode'. In cram mode,
2691 all drill items are considered to be due for review, unless they
2692 have been reviewed within the last `org-drill-cram-hours'
2693 hours."
2700 "Run an interactive drill session using drill items within the
2701 subtree at point."
2707 "Run an interactive drill session using drill items from all org
2708 files in the same directory as the current file."
2714 "Run a new drill session, but try to use leftover due items that
2715 were not reviewed during the last session, rather than scanning for
2716 unreviewed items. If there are no leftover items in memory, a full
2717 scan will be performed."
2735 "Resume a suspended drill session. Sessions are suspended by
2736 exiting them with the `edit' or `quit' options."
2742 ;; Current drill session is finished, but there are still
2743 ;; more items which need to be reviewed.
2745 "You have finished the drill session. However, %d items still
2746 need reviewing. Start a new drill session? "
2754 "Make the current item due for revision, and set its last interval to 0.
2755 Makes the item behave as if it has been failed, without actually recording a
2756 failure. This command can be used to 'reset' repetitions for an item."
2768 "Delete scheduling data from every drill entry in scope. This
2769 function may be useful if you want to give your collection of
2770 entries to someone else. Scope defaults to the current buffer,
2771 and is specified by the argument SCOPE, which accepts the same
2772 values as `org-drill-scope'."
2778 ;; Scope is the current buffer. This means we can use
2779 ;; `org-delete-property-globally', which is faster.
2789 ;; Compute local versions of the regexp for cloze deletions, in case
2790 ;; the left and right delimiters are redefined locally.
2799 ;; Can't add to org-mode-hook, because local variables won't have been loaded
2800 ;; yet.
2802 ;; (defun org-drill-add-cloze-fontification ()
2803 ;; (when (eql major-mode 'org-mode)
2804 ;; ;; Compute local versions of the regexp for cloze deletions, in case
2805 ;; ;; the left and right delimiters are redefined locally.
2806 ;; (setq-local org-drill-cloze-regexp (org-drill--compute-cloze-regexp))
2807 ;; (setq-local org-drill-cloze-keywords (org-drill--compute-cloze-keywords))
2808 ;; (when org-drill-use-visible-cloze-face-p
2809 ;; (font-lock-add-keywords nil ;'org-mode
2810 ;; org-drill-cloze-keywords
2811 ;; nil))))
2813 ;; XXX
2814 ;; (add-hook 'hack-local-variables-hook
2815 ;; 'org-drill-add-cloze-fontification)
2816 ;;
2817 ;; (org-drill-add-cloze-fontification)
2820 ;;; Synching card collections =================================================
2827 "Copy the subtree at point to the buffer DEST. The copy will receive
2828 the tag 'imported'."
2859 ;; We've looked all the way up the path
2860 ;; Default to appending to the end of DEST
2869 )))))
2874 "SRC and DEST are two org mode buffers containing drill items.
2875 For each drill item in DEST that shares an ID with an item in SRC,
2876 overwrite scheduling data in DEST with data taken from the item in SRC.
2877 This is intended for use when two people are sharing a set of drill items,
2878 one person has made some updates to the item set, and the other person
2879 wants to migrate to the updated set without losing their scheduling data.
2881 By default, any drill items in SRC which do not exist in DEST are
2882 copied into DEST. We attempt to place the copied item in the
2883 equivalent location in DEST to its location in SRC, by matching
2884 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2885 we simply ignore any items that do not exist in DEST, and do not
2886 copy them across."
2897 ;; Compile list of all IDs in the destination buffer.
2906 ;; Look through all entries in source buffer.
2916 nil)
2918 ;; This entry matches an entry in dest. Retrieve all its
2919 ;; scheduling data, then go to the matching location in dest
2920 ;; and write the data.
2923 total-repeats meanq ease)
2929 ;; go to matching entry in destination buffer
2935 total-repeats meanq ease)
2947 ;; item in SRC has ID, but no matching ID in DEST.
2948 ;; It must be a new item that does not exist in DEST.
2949 ;; Copy the entire item to the *end* of DEST.
2953 ;; Finally: there may be some items in DEST which are not in SRC, and
2954 ;; which have been scheduled by another user of DEST. Clear out the
2955 ;; scheduling info from all the unmatched items in DEST.
2965 ;;; Card types for learning languages =========================================
2967 ;;; Get spell-number.el from:
2968 ;;; http://www.emacswiki.org/emacs/spell-number.el
2972 ;;; `conjugate' card type =====================================================
2973 ;;; See spanish.org for usage
2979 ;; past tenses
2985 ;; future tenses
2987 ;; moods (backgrounds).
2993 )
2994 "Alist where each entry has the form (TENSE COLOUR), where
2995 TENSE is a string naming a tense in which verbs can be
2996 conjugated, and COLOUR is a string specifying a foreground colour
2997 which will be used by `org-drill-present-verb-conjugation' and
2998 `org-drill-show-answer-verb-conjugation' to fontify the verb and
3003 "Auxiliary function used by `org-drill-present-verb-conjugation' and
3004 `org-drill-show-answer-verb-conjugation'."
3023 :background
3033 "Present a drill entry whose card type is 'conjugate'."
3054 translation
3060 "Show the answer for a drill item whose card type is 'conjugate'.
3061 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3062 returns its return value."
3075 infinitive translation)
3080 ;;; `decline_noun' card type ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3096 ))
3100 "Auxiliary function used by `org-drill-present-noun-declension' and
3101 `org-drill-show-answer-noun-declension'."
3119 org-drill-noun-gender-alist t))
3127 "Present a drill entry whose card type is 'decline_noun'."
3149 noun noun-gender
3156 translation
3164 "Show the answer for a drill item whose card type is 'decline_noun'.
3165 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3166 returns its return value."
3171 noun noun-gender translation)
3176 ;;; `translate_number' card type ==============================================
3177 ;;; See spanish.org for usage
3201 num-max num-min))
3224 ;; (defun org-drill-show-answer-translate-number (reschedule-fn)
3225 ;; (let* ((language (read (org-entry-get (point) "DRILL_LANGUAGE" t)))
3226 ;; (highlight-face 'font-lock-warning-face)
3227 ;; (non-english
3228 ;; (let ((spelln-language language))
3229 ;; (propertize (spelln-integer-in-words *drilled-number*)
3230 ;; 'face highlight-face)))
3231 ;; (english
3232 ;; (let ((spelln-language 'english-gb))
3233 ;; (propertize (spelln-integer-in-words *drilled-number*)
3234 ;; 'face 'highlight-face))))
3235 ;; (with-replaced-entry-text
3236 ;; (cond
3237 ;; ((eql 'to-english *drilled-number-direction*)
3238 ;; (format "\nThe English translation of %s is:\n\n%s\n"
3239 ;; non-english english))
3240 ;; (t
3241 ;; (format "\nThe %s translation of %s is:\n\n%s\n"
3242 ;; (capitalize (format "%s" language))
3243 ;; english non-english)))
3244 ;; (funcall reschedule-fn))))
3247 ;;; `spanish_verb' card type ==================================================
3248 ;;; Not very interesting, but included to demonstrate how a presentation
3249 ;;; function can manipulate which subheading are hidden versus shown.