| blob | 2ffc201940cc45ec3e99499443964e2b8288bada |
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.6
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 ;; ver 1 "[^][]\\(\\[[^][][^]]*\\]\\)"
193 ;; ver 2 "\\(\\[.*?\\]\\|^[^[[:cntrl:]]*?\\]\\|\\[.*?$\\)"
194 ;; ver 3! "\\(\\[.*?\\]\\|\\[.*?[[:cntrl:]]+.*?\\]\\)"
199 `((,org-drill-cloze-regexp
203 )))
222 org-drill-show-answer-verb-conjugation)
225 org-drill-show-answer-translate-number))
226 "Alist associating card types with presentation functions. Each entry in the
227 alist takes one of two forms:
228 1. (CARDTYPE . QUESTION-FN), where CARDTYPE is a string or nil (for default),
229 and QUESTION-FN is a function which takes no arguments and returns a boolean
230 value.
231 2. (CARDTYPE QUESTION-FN ANSWER-FN), where ANSWER-FN is a function that takes
232 one argument -- the argument is a function that itself takes no arguments.
233 ANSWER-FN is called with the point on the active item's
234 heading, just prior to displaying the item's 'answer'. It can therefore be
235 used to modify the appearance of the answer. ANSWER-FN must call its argument
236 before returning. (Its argument is a function that prompts the user and
237 performs rescheduling)."
243 'file
244 "The scope in which to search for drill items when conducting a
245 drill session. This can be any of:
247 file The current buffer, respecting the restriction if any.
248 This is the default.
249 tree The subtree started with the entry at point
250 file-no-restriction The current buffer, without restriction
251 file-with-archives The current buffer, and any archives associated with it.
252 agenda All agenda files
253 agenda-with-archives All agenda files with any archive files associated
254 with them.
255 directory All files with the extension '.org' in the same
256 directory as the current file (includes the current
257 file if it is an .org file.)
258 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
259 "
260 ;; Note -- meanings differ slightly from the argument to org-map-entries:
261 ;; 'file' means current file/buffer, respecting any restriction
262 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
263 ;; 'directory' means all *.org files in current directory
268 list))
272 t
273 "If non-nil, prompt to save all modified buffers after a drill session
274 finishes."
280 'sm5
281 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
282 Available choices are:
283 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
284 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
285 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
286 SuperMemo 98. The version implemented here is simplified in that while it
287 'learns' the difficulty of each item using quality grades and number of
288 failures, it does not modify the matrix of values that
289 governs how fast the inter-repetition intervals increase. A method for
290 adjusting intervals when items are reviewed early or late has been taken
291 from SM11, a later version of the algorithm, and included in Simple8."
297 nil
298 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
300 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
301 The matrix is saved (using the 'customize' facility) at the end of each
302 drill session.
304 Over time, values in the matrix will adapt to the individual user's
305 pace of learning."
311 4.0
312 "In the SM5 algorithm, the initial interval after the first
313 successful presentation of an item is always 4 days. If you wish to change
314 this, you can do so here."
320 nil
321 "If true, the number of days until an item's next repetition
322 will vary slightly from the interval calculated by the SM2
323 algorithm. The variation is very small when the interval is
324 small, but scales up with the interval."
330 nil
331 "If true, when the student successfully reviews an item 1 or more days
332 before or after the scheduled review date, this will affect that date of
333 the item's next scheduled review, according to the algorithm presented at
334 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
336 Items that were reviewed early will have their next review date brought
337 forward. Those that were reviewed late will have their next review
338 date postponed further.
340 Note that this option currently has no effect if the SM2 algorithm
341 is used."
347 4
348 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
349 this number determines how often the 'less favoured' situation
350 should arise. It will occur 1 in every N trials, where N is the
351 value of the variable.
353 For example, with the hide1_firstmore card type, the first piece
354 of clozed text should be hidden more often than the other
355 pieces. If this variable is set to 4 (default), the first item
356 will only be shown 25% of the time (1 in 4 trials). Similarly for
357 show1_lastmore, the last item will be shown 75% of the time, and
358 for show1_firstless, the first item would only be shown 25% of the
359 time.
361 If the value of this variable is NIL, then weighting is disabled, and
362 all weighted card types are treated as their unweighted equivalents."
368 12
369 "When in cram mode, items are considered due for review if
370 they were reviewed at least this many hours ago."
375 ;;; NEW items have never been presented in a drill session before.
376 ;;; MATURE items HAVE been presented at least once before.
377 ;;; - YOUNG mature items were scheduled no more than
378 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
379 ;;; repetition. These items will have been learned 'recently' and will have a
380 ;;; low repetition count.
381 ;;; - OLD mature items have intervals greater than
382 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
383 ;;; - OVERDUE items are past their scheduled review date by more than
384 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
385 ;;; regardless of young/old status.
389 10
390 "When an item's inter-repetition interval rises above this value in days,
391 it is no longer considered a 'young' (recently learned) item."
397 1.2
398 "An item is considered overdue if its scheduled review date is
399 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
400 days in the past. For example, a value of 1.2 means an additional
401 20% of the last scheduled interval is allowed to elapse before
402 the item is overdue. A value of 1.0 means no extra time is
403 allowed at all - items are immediately considered overdue if
404 there is even one day's delay in reviewing them. This variable
405 should never be less than 1.0."
411 0.5
412 "Fraction between 0 and 1 that governs how quickly the spaces
413 between successive repetitions increase, for all items. The
414 default value is 0.5. Higher values make spaces increase more
415 quickly with each successful repetition. You should only change
416 this in small increments (for example 0.05-0.1) as it has an
417 exponential effect on inter-repetition spacing."
430 "List of markers for items that are considered 'overdue', based on
433 "List of markers for mature entries whose last inter-repetition
436 "List of markers for mature entries whose last inter-repetition
444 "Are we in 'cram mode', where all items are considered due
452 ;;; Make the above settings safe as file-local variables.
484 ;;;; Utilities ================================================================
494 nil
502 "Add VAL to the end of the sequence stored in PLACE. Return the new
503 value."
508 "Randomly permute the elements of LIST (all permutations equally likely)."
509 ;; Adapted from 'shuffle-vector' in cookie1.el
511 j
512 temp
520 list)
524 "Round the floating point number FLOATNUM to FIX decimal places.
525 Example: (round-float 3.56755765 3) -> 3.568"
531 "Return a human-readable description of the key/keys to which the command
532 CMD is bound, or nil if it is not bound to a key."
540 time))
544 "Like `org-map-entries', but only drill entries are processed."
555 skip)))
588 "Nil means a last review date has not yet been stored for
589 the item.
590 Zero means it was reviewed today.
591 A positive number means it was reviewed that many days ago.
592 A negative number means the date of last review is in the future --
593 this should never happen."
602 "Like `org-drill-days-since-last-review', but return value is
603 in hours rather than days."
614 "Is MARKER, or the point, in a 'drill item'? This will return nil if
615 the point is inside a subheading of a drill item -- to handle that
616 situation use `org-part-of-drill-entry-p'."
629 "Is the current entry either the main heading of a 'drill item',
630 or a subheading within a drill item?"
632 ;; Does this heading INHERIT the drill tag
637 "Move the point to the heading which holds the :drill: tag for this
638 drill entry."
650 "Is the current entry a 'leech item'?"
655 ;; (defun org-drill-entry-due-p ()
656 ;; (cond
657 ;; (*org-drill-cram-mode*
658 ;; (let ((hours (org-drill-hours-since-last-review)))
659 ;; (and (org-drill-entry-p)
660 ;; (or (null hours)
661 ;; (>= hours org-drill-cram-hours)))))
662 ;; (t
663 ;; (let ((item-time (org-get-scheduled-time (point))))
664 ;; (and (org-drill-entry-p)
665 ;; (or (not (eql 'skip org-drill-leech-method))
666 ;; (not (org-drill-entry-leech-p)))
667 ;; (or (null item-time) ; not scheduled
668 ;; (not (minusp ; scheduled for today/in past
669 ;; (- (time-to-days (current-time))
670 ;; (time-to-days item-time))))))))))
674 "Returns:
675 - NIL if the item is not to be regarded as scheduled for review at all.
676 This is the case if it is not a drill item, or if it is a leech item
677 that we wish to skip, or if we are in cram mode and have already reviewed
678 the item within the last few hours.
679 - 0 if the item is new, or if it scheduled for review today.
680 - A negative integer - item is scheduled that many days in the future.
681 - A positive integer - item is scheduled that many days in the past."
695 nil)
704 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
705 and whose last inter-repetition interval was LAST-INTERVAL, should be
706 considered 'overdue'. If the arguments are not given they are extracted
707 from the entry at point."
714 ;;(> due org-drill-days-before-overdue)
716 org-drill-overdue-interval-factor)))
736 default)))
774 default)))
777 ;;; From http://www.supermemo.com/english/ol/sm5.htm
779 "Returns a random number between 0.5 and 1.5."
792 "Random numbers in a pseudo-normal distribution with mean MEAN, range
793 MEAN-VARIATION to MEAN+VARIATION"
797 mean))
801 optimal-interval
802 days-ahead)
803 "Arguments:
804 - OPTIMAL-FACTOR: interval-factor if the item had been tested
805 exactly when it was supposed to be.
806 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
807 tested exactly when it was supposed to be.
808 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
810 Returns an adjusted optimal factor which should be used to
811 calculate the next interval, instead of the optimal factor found
812 in the matrix."
814 (/ (+ optimal-interval
821 "Returns a list of 6 items, containing all the stored recall
822 data for the item at point:
823 - LAST-INTERVAL is the interval in days that was used to schedule the item's
824 current review date.
825 - REPEATS is the number of items the item has been successfully recalled without
826 without any failures. It is reset to 0 upon failure to recall the item.
827 - FAILURES is the total number of times the user has failed to recall the item.
828 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
829 - AVERAGE-QUALITY is the mean quality of recall of the item over
830 all its repetitions, successful and unsuccessful.
831 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
832 "
846 )))
859 total-repeats meanq
860 ease)
861 "Stores the given data in the item at point."
875 ;;; SM2 Algorithm =============================================================
879 failures meanq total-repeats)
880 "Arguments:
881 - LAST-INTERVAL -- the number of days since the item was last reviewed.
882 - REPEATS -- the number of times the item has been successfully reviewed
883 - EF -- the 'easiness factor'
884 - QUALITY -- 0 to 5
886 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
887 - INTERVAL is the number of days until the item should next be reviewed
888 - REPEATS is incremented by 1.
889 - EF is modified based on the recall quality for the item.
890 - OF-MATRIX is not modified."
894 ;; When an item is failed, its interval is reset to 0,
895 ;; but its EF is unchanged
897 org-drill-optimal-factor-matrix)
898 ;; else:
917 interval)
919 next-ef
921 org-drill-optimal-factor-matrix))))
924 ;;; SM5 Algorithm =============================================================
930 org-drill-sm5-initial-interval
931 ef))
943 org-drill-optimal-factor-matrix))))
945 of
950 failures meanq total-repeats
963 quality))
968 quality org-drill-learn-fraction))
975 last-interval n ef of-matrix)
976 delta-days)))
985 ;; "Failed" -- reset repetitions to 0,
989 ; preserved
990 ;; For a zero-based quality of 4 or 5, don't repeat
991 ;; ((and (>= quality 4)
992 ;; (not org-learn-always-reschedule))
993 ;; (list 0 (1+ n) ef failures meanq
994 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
997 last-interval n ef of-matrix))
1002 ef
1003 failures
1004 meanq
1006 of-matrix)))))
1009 ;;; Simple8 Algorithm =========================================================
1013 "Arguments:
1014 - FAILURES: integer >= 0. The total number of times the item has
1015 been forgotten, ever.
1017 Returns the optimal FIRST interval for an item which has previously been
1018 forgotten on FAILURES occasions."
1023 "Arguments:
1024 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
1025 - REPETITION: the number of times the item has been tested.
1026 1 is the first repetition (ie the second trial).
1027 Returns:
1028 The factor by which the last interval should be
1029 multiplied to give the next interval. Corresponds to `RF' or `OF'."
1034 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
1035 to a mean item quality of QUALITY."
1044 failures meanq totaln
1046 "Arguments:
1047 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1048 - REPEATS -- the number of times the item has been successfully reviewed
1049 - EASE -- the 'easiness factor'
1050 - QUALITY -- 0 to 5
1051 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
1052 0 = reviewed on the scheduled day. +N = N days overdue.
1053 -N = reviewed N days early.
1055 Returns the new item data, as a list of 6 values:
1056 - NEXT-INTERVAL
1057 - REPEATS
1058 - EASE
1059 - FAILURES
1060 - AVERAGE-QUALITY
1061 - TOTAL-REPEATS.
1062 See the documentation for `org-drill-get-item-data' for a description of these."
1069 quality))
1083 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1087 repeats))
1093 ;; The item was reviewed earlier than scheduled.
1104 next-interval)
1105 repeats
1107 failures
1108 meanq
1109 totaln
1110 )))
1115 ;;; Essentially copied from `org-learn.el', but modified to
1116 ;;; optionally call the SM2 or simple8 functions.
1118 "If DAYS-AHEAD is supplied it must be a positive integer. The
1119 item will be scheduled exactly this many days into the future."
1124 ;; Entries can have weights, 1 by default. Intervals are divided by the
1125 ;; item's weight, so an item with a weight of 2 will have all intervals
1126 ;; halved, meaning you will end up reviewing it twice as often.
1127 ;; Useful for entries which randomly present any of several facts.
1132 total-repeats meanq ease)
1135 failures meanq total-repeats
1139 ease quality failures
1140 meanq total-repeats ofmatrix))
1142 ease quality failures
1143 meanq total-repeats))
1145 quality failures meanq
1146 total-repeats
1147 delta-days)))
1159 total-repeats meanq ease)
1176 "Returns an integer representing the number of days into the future
1177 that the current item would be scheduled, based on a recall quality
1178 of QUALITY."
1181 total-repeats meanq ease)
1186 failures meanq total-repeats
1190 ease quality failures
1191 meanq total-repeats
1192 org-drill-optimal-factor-matrix))
1194 ease quality failures
1195 meanq total-repeats))
1197 quality failures meanq
1198 total-repeats)))
1203 (+ last-interval
1206 next-interval))))))
1214 intervals))
1219 "Returns quality rating (0-5), or nil if the user quit."
1228 3-5 Means you have remembered the item.
1230 0 - Completely forgot.
1231 1 - Even after seeing the answer, it still took a bit to sink in.
1232 2 - After seeing the answer, you remembered it.
1233 3 - It took you awhile, but you finally remembered. (+%s days)
1234 4 - After a little bit of thought you remembered. (+%s days)
1235 5 - You remembered the item really easily. (+%s days)
1237 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1271 ;;(setq failures (if failures (string-to-number failures) 0))
1272 ;; (org-set-property "DRILL_FAILURE_COUNT"
1273 ;; (format "%d" (1+ failures)))
1286 quality))
1290 nil))))
1293 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1294 ;; "Returns a list containing the position of each immediate subheading of
1295 ;; the current topic."
1296 ;; (let ((drill-entry-level (org-current-level))
1297 ;; (drill-sections nil)
1298 ;; (drill-heading nil))
1299 ;; (org-show-subtree)
1300 ;; (save-excursion
1301 ;; (org-map-entries
1302 ;; (lambda ()
1303 ;; (when (and (not (outline-invisible-p))
1304 ;; (> (org-current-level) drill-entry-level))
1305 ;; (setq drill-heading (org-get-heading t))
1306 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1307 ;; (member drill-heading heading-list))
1308 ;; (hide-subtree))
1309 ;; (push (point) drill-sections)))
1310 ;; "" 'tree))
1311 ;; (reverse drill-sections)))
1316 "TEST is a function taking no arguments. TEST will be called for each
1317 of the immediate subheadings of the current drill item, with the point
1318 on the relevant subheading. TEST should return nil if the subheading is
1319 to be revealed, non-nil if it is to be hidden.
1320 Returns a list containing the position of each immediate subheading of
1321 the current topic."
1392 prompt))
1397 You seem to be having a lot of trouble memorising this item.
1400 prompt)))
1406 "++:++ "
1408 prompt))
1428 "Hide the buffer region between BEG and END with an 'invisible text'
1429 visual overlay, or with the string TEXT if it is supplied."
1455 ;; This will also unhide the item's heading.
1465 ;; Don't hide org links, partly because they might contain inline
1466 ;; images which we want to keep visible
1474 "Hide the current match with a 'cloze' visual overlay."
1484 ovl 'display
1485 ;; If hint is like `X...' then display [X...]
1486 ;; otherwise display [...X]
1488 hint))))))
1502 "During the execution of BODY, the entire text of the current entry is
1503 concealed by an overlay that displays the string TEXT."
1513 "During the execution of BODY, the entire text of the current entry is
1514 concealed by an overlay that displays the overlays in REPLACEMENTS."
1524 "Make an overlay that conceals the entire text of the item, not
1525 including properties or the contents of subheadings. The overlay shows
1526 the string TEXT.
1527 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1528 for the `display' text property. The text of the item will be temporarily
1529 replaced by all of these items, in the order in which they appear in
1530 the list.
1531 Note: does not actually alter the item."
1554 "Make overlays that conceal the entire text of the item, not
1555 including properties or the contents of subheadings. The overlay shows
1556 the string TEXT.
1557 Note: does not actually alter the item."
1567 p-max
1584 "Make an overlay that conceals the heading of the item. The overlay shows
1585 the string TEXT.
1586 Note: does not actually alter the item."
1600 text
1609 ;;; Presentation functions ====================================================
1611 ;; Each of these is called with point on topic heading. Each needs to show the
1612 ;; topic in the form of a 'question' or with some information 'hidden', as
1613 ;; appropriate for the card type. The user should then be prompted to press a
1614 ;; key. The function should then reveal either the 'answer' or the entire
1615 ;; topic, and should return t if the user chose to see the answer and rate their
1616 ;; recall, nil if they chose to quit.
1647 drill-sections))
1674 &optional
1675 force-show-first
1676 force-show-last
1677 force-hide-first)
1678 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1679 chosen at random.
1680 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1681 hiding all the rest.
1682 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1683 the hidden items.
1684 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1685 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1686 If the number of text pieces in the item is less than
1687 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1688 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1713 to match-count
1714 collect i)))
1718 ;; Force '1' to be in the list, and to be the first item
1719 ;; in the list.
1728 ;; (dolist (pos-to-hide match-nums)
1739 ;; (loop
1740 ;; do (re-search-forward org-drill-cloze-regexp
1741 ;; item-end t pos-to-hide)
1742 ;; while (org-pos-in-regexp (match-beginning 0)
1743 ;; org-bracket-link-regexp 1))
1744 ;; (org-drill-hide-matched-cloze-text)))))
1754 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1755 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1756 the second to last, etc."
1781 nil)
1802 "Hides one of the pieces of text that are marked for cloze deletion,
1803 chosen at random."
1808 "Hides two of the pieces of text that are marked for cloze deletion,
1809 chosen at random."
1814 "Hides the first piece of text that is marked for cloze deletion."
1819 "Hides the last piece of text that is marked for cloze deletion."
1824 "Commonly, hides the FIRST piece of text that is marked for
1825 cloze deletion. Uncommonly, hide one of the other pieces of text,
1826 chosen at random.
1828 The definitions of 'commonly' and 'uncommonly' are determined by
1829 the value of `org-drill-cloze-text-weight'."
1830 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1831 ;; to hide the 'favoured' piece of text. However even when the chance of
1832 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1833 ;; the small number of repetitions where most learning takes place for each
1834 ;; item. In other words, the actual frequency during the first 10 repetitions
1835 ;; was often very different from 80%. Hence we use modulo instead.
1838 ;; Behave as hide1cloze
1843 org-drill-cloze-text-weight))
1845 org-drill-cloze-text-weight))
1846 ;; Uncommonly, hide any item except the first
1849 ;; Commonly, hide first item
1854 "Commonly, hides all pieces except the last. Uncommonly, shows
1855 any random piece. The effect is similar to 'show1cloze' except
1856 that the last item is much less likely to be the item that is
1857 visible.
1859 The definitions of 'commonly' and 'uncommonly' are determined by
1860 the value of `org-drill-cloze-text-weight'."
1863 ;; Behave as show1cloze
1868 org-drill-cloze-text-weight))
1870 org-drill-cloze-text-weight))
1871 ;; Uncommonly, show any item except the last
1874 ;; Commonly, show the LAST item
1879 "Commonly, hides all pieces except one, where the shown piece
1880 is guaranteed NOT to be the first piece. Uncommonly, shows any
1881 random piece. The effect is similar to 'show1cloze' except that
1882 the first item is much less likely to be the item that is
1883 visible.
1885 The definitions of 'commonly' and 'uncommonly' are determined by
1886 the value of `org-drill-cloze-text-weight'."
1889 ;; Behave as show1cloze
1894 org-drill-cloze-text-weight))
1896 org-drill-cloze-text-weight))
1897 ;; Uncommonly, show the first item
1900 ;; Commonly, show any item, except the first
1905 "Similar to `org-drill-present-multicloze-hide1', but hides all
1906 the pieces of text that are marked for cloze deletion, except for one
1907 piece which is chosen at random."
1912 "Similar to `org-drill-present-multicloze-show1', but reveals two
1913 pieces rather than one."
1917 ;; (defun org-drill-present-multicloze-show1 ()
1918 ;; "Similar to `org-drill-present-multicloze-hide1', but hides all
1919 ;; the pieces of text that are marked for cloze deletion, except for one
1920 ;; piece which is chosen at random."
1921 ;; (with-hidden-comments
1922 ;; (with-hidden-cloze-hints
1923 ;; (let ((item-end nil)
1924 ;; (match-count 0)
1925 ;; (body-start (or (cdr (org-get-property-block))
1926 ;; (point))))
1927 ;; (org-drill-hide-all-subheadings-except nil)
1928 ;; (save-excursion
1929 ;; (outline-next-heading)
1930 ;; (setq item-end (point)))
1931 ;; (save-excursion
1932 ;; (goto-char body-start)
1933 ;; (while (re-search-forward org-drill-cloze-regexp item-end t)
1934 ;; (incf match-count)))
1935 ;; (when (plusp match-count)
1936 ;; (let ((match-to-hide (random* match-count)))
1937 ;; (save-excursion
1938 ;; (goto-char body-start)
1939 ;; (dotimes (n match-count)
1940 ;; (re-search-forward org-drill-cloze-regexp
1941 ;; item-end t)
1942 ;; (unless (= n match-to-hide)
1943 ;; (org-drill-hide-matched-cloze-text))))))
1944 ;; (org-display-inline-images t)
1945 ;; (org-cycle-hide-drawers 'all)
1946 ;; (prog1 (org-drill-presentation-prompt)
1947 ;; (org-drill-hide-subheadings-if 'org-drill-entry-p)
1948 ;; (org-drill-unhide-clozed-text))))))
1952 "Present the string QUESTION as the only visible content of the card."
1955 question
1965 "TEXTS is a list of valid values for the 'display' text property.
1966 Present these overlays, in sequence, as the only
1967 visible content of the card."
1970 replacements
1980 "Present the current topic for interactive review, as in `org-drill'.
1981 Review will occur regardless of whether the topic is due for review or whether
1982 it meets the definition of a 'review topic' used by `org-drill'.
1984 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
1985 EDIT if the user chose to exit the drill and edit the current item. Choosing
1986 the latter option leaves the drill session suspended; it can be resumed
1987 later using `org-drill-resume'.
1989 See `org-drill' for more details."
1992 ;;(unless (org-part-of-drill-entry-p)
1993 ;; (error "Point is not inside a drill entry"))
1994 ;;(unless (org-at-heading-p)
1995 ;; (org-back-to-heading))
1999 ;; fontification functions in `outline-view-change-hook' can cause big
2000 ;; slowdowns, so we temporarily bind this variable to nil here.
2024 nil)
2057 "Returns true if the current drill session has continued past its
2058 maximum duration."
2066 "Returns true if the current drill session has reached the
2067 maximum number of items."
2070 org-drill-maximum-items-per-session)))
2079 m
2081 ;; First priority is items we failed in a prior session.
2086 ;; Next priority is overdue items.
2090 ;; We use `pop', not `pop-random', because we have already
2091 ;; sorted overdue items into a random order which takes
2092 ;; number of days overdue into account.
2094 ;; Next priority is 'young' items.
2099 ;; Next priority is newly added items, and older entries.
2100 ;; We pool these into a single group.
2112 ;; After all the above are done, last priority is items
2113 ;; that were failed earlier THIS SESSION.
2118 m)))
2122 "Returns nil, t, or a list of markers representing entries that were
2123 'failed' and need to be presented again before the session ends.
2125 RESUMING-P is true if we are resuming a suspended drill session."
2143 ;; The entry is not due anymore. This could arise if the user
2144 ;; suspends a drill session, then drills an individual entry,
2145 ;; then resumes the session.
2148 nil)
2182 "%d items reviewed. Session duration %s.
2183 Recall of reviewed items:
2184 Excellent (5): %3d%% | Near miss (2): %3d%%
2185 Good (4): %3d%% | Failure (1): %3d%%
2186 Hard (3): %3d%% | Abject failure (0): %3d%%
2188 You successfully recalled %d%% of reviewed items (quality > %s)
2189 %d/%d items still await review (%s, %s, %s, %s, %s).
2190 Tomorrow, %d more items will become due for review.
2191 Session finished. Press a key to continue..."
2207 pass-percent
2208 org-drill-failure-quality
2234 ))
2245 "%s
2246 You failed %d%% of the items you reviewed during this session.
2247 %d (%d%%) of all items scanned were overdue.
2249 Are you keeping up with your items, and reviewing them
2250 when they are scheduled? If so, you may want to consider
2251 lowering the value of `org-drill-learn-fraction' slightly in
2252 order to make items appear more frequently over time."
2259 ))))
2264 "MARKERS is a list of markers, all of which will be freed (set to
2265 point nowhere). Alternatively, MARKERS can be 't', in which case
2266 all the markers used by Org-Drill will be freed."
2275 markers))
2287 "Returns a list (STATUS DUE) where DUE is the number of days overdue,
2288 zero being due today, -1 being scheduled 1 day in the future. STATUS is
2289 one of the following values:
2290 - nil, if the item is not a drill entry, or has an empty body
2291 - :unscheduled
2292 - :future
2293 - :new
2294 - :failed
2295 - :overdue
2296 - :young
2297 - :old
2298 "
2307 nil)
2312 ;; ((eql -1 due)
2313 ;; :tomorrow)
2316 ;; The rest of the stati all denote 'due' items ==========================
2318 org-drill-failure-quality)
2319 ;; Mature entries that were failed last time are
2320 ;; FAILED, regardless of how young, old or overdue
2321 ;; they are.
2326 ;; Overdue status overrides young versus old
2327 ;; distinction.
2328 ;; Store marker + due, for sorting of overdue entries
2331 org-drill-days-before-old)
2335 due))))
2344 collected
2346 sym2)
2348 sym1)))))
2352 "Begin an interactive 'drill session'. The user is asked to
2353 review a series of topics (headers). Each topic is initially
2354 presented as a 'question', often with part of the topic content
2355 hidden. The user attempts to recall the hidden information or
2356 answer the question, then presses a key to reveal the answer. The
2357 user then rates his or her recall or performance on that
2358 topic. This rating information is used to reschedule the topic
2359 for future review.
2361 Org-drill proceeds by:
2363 - Finding all topics (headings) in SCOPE which have either been
2364 used and rescheduled before, or which have a tag that matches
2365 `org-drill-question-tag'.
2367 - All matching topics which are either unscheduled, or are
2368 scheduled for the current date or a date in the past, are
2369 considered to be candidates for the drill session.
2371 - If `org-drill-maximum-items-per-session' is set, a random
2372 subset of these topics is presented. Otherwise, all of the
2373 eligible topics will be presented.
2375 SCOPE determines the scope in which to search for
2376 questions. It accepts the same values as `org-drill-scope',
2377 which see.
2379 If RESUME-P is non-nil, resume a suspended drill session rather
2380 than starting a new one."
2431 (:unscheduled
2433 ;; (:tomorrow
2434 ;; (incf *org-drill-dormant-entry-count*)
2435 ;; (incf *org-drill-due-tomorrow-count*))
2436 (:future
2440 (:new
2442 (:failed
2444 (:young
2446 (:overdue
2448 (:old
2450 scope)
2451 ;; (let ((due (org-drill-entry-days-overdue))
2452 ;; (last-int (org-drill-entry-last-interval 1)))
2453 ;; (cond
2454 ;; ((org-drill-entry-empty-p)
2455 ;; nil) ; skip -- item body is empty
2456 ;; ((or (null due) ; unscheduled - usually a skipped leech
2457 ;; (minusp due)) ; scheduled in the future
2458 ;; (incf *org-drill-dormant-entry-count*)
2459 ;; (if (eq -1 due)
2460 ;; (incf *org-drill-due-tomorrow-count*)))
2461 ;; ((org-drill-entry-new-p)
2462 ;; (push (point-marker) *org-drill-new-entries*))
2463 ;; ((<= (org-drill-entry-last-quality 9999)
2464 ;; org-drill-failure-quality)
2465 ;; ;; Mature entries that were failed last time are
2466 ;; ;; FAILED, regardless of how young, old or overdue
2467 ;; ;; they are.
2468 ;; (push (point-marker) *org-drill-failed-entries*))
2469 ;; ((org-drill-entry-overdue-p due last-int)
2470 ;; ;; Overdue status overrides young versus old
2471 ;; ;; distinction.
2472 ;; ;; Store marker + due, for sorting of overdue entries
2473 ;; (push (cons (point-marker) due) overdue-data))
2474 ;; ((<= (org-drill-entry-last-interval 9999)
2475 ;; org-drill-days-before-old)
2476 ;; ;; Item is 'young'.
2477 ;; (push (point-marker)
2478 ;; *org-drill-young-mature-entries*))
2479 ;; (t
2480 ;; (push (point-marker)
2481 ;; *org-drill-old-mature-entries*))))
2482 ;; Order 'overdue' items so that the most overdue will tend to
2483 ;; come up for review first, while keeping exact order random
2509 "You can continue the drill session with the command `org-drill-resume'.%s"
2519 ))))
2525 org-drill-optimal-factor-matrix))
2529 "Run an interactive drill session in 'cram mode'. In cram mode,
2530 all drill items are considered to be due for review, unless they
2531 have been reviewed within the last `org-drill-cram-hours'
2532 hours."
2539 "Run an interactive drill session using drill items within the
2540 subtree at point."
2546 "Run an interactive drill session using drill items from all org
2547 files in the same directory as the current file."
2553 "Run a new drill session, but try to use leftover due items that
2554 were not reviewed during the last session, rather than scanning for
2555 unreviewed items. If there are no leftover items in memory, a full
2556 scan will be performed."
2573 "Resume a suspended drill session. Sessions are suspended by
2574 exiting them with the `edit' or `quit' options."
2580 ;; Current drill session is finished, but there are still
2581 ;; more items which need to be reviewed.
2583 "You have finished the drill session. However, %d items still
2584 need reviewing. Start a new drill session? "
2598 "Delete scheduling data from every drill entry in scope. This
2599 function may be useful if you want to give your collection of
2600 entries to someone else. Scope defaults to the current buffer,
2601 and is specified by the argument SCOPE, which accepts the same
2602 values as `org-drill-scope'."
2608 ;; Scope is the current buffer. This means we can use
2609 ;; `org-delete-property-globally', which is faster.
2622 org-drill-cloze-keywords
2623 nil)))
2630 ;;; Synching card collections =================================================
2637 "Copy the subtree at point to the buffer DEST. The copy will receive
2638 the tag 'imported'."
2669 ;; We've looked all the way up the path
2670 ;; Default to appending to the end of DEST
2679 )))))
2684 "SRC and DEST are two org mode buffers containing drill items.
2685 For each drill item in DEST that shares an ID with an item in SRC,
2686 overwrite scheduling data in DEST with data taken from the item in SRC.
2687 This is intended for use when two people are sharing a set of drill items,
2688 one person has made some updates to the item set, and the other person
2689 wants to migrate to the updated set without losing their scheduling data.
2691 By default, any drill items in SRC which do not exist in DEST are
2692 copied into DEST. We attempt to place the copied item in the
2693 equivalent location in DEST to its location in SRC, by matching
2694 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2695 we simply ignore any items that do not exist in DEST, and do not
2696 copy them across."
2707 ;; Compile list of all IDs in the destination buffer.
2716 ;; Look through all entries in source buffer.
2726 nil)
2728 ;; This entry matches an entry in dest. Retrieve all its
2729 ;; scheduling data, then go to the matching location in dest
2730 ;; and write the data.
2733 total-repeats meanq ease)
2739 ;; go to matching entry in destination buffer
2745 total-repeats meanq ease)
2757 ;; item in SRC has ID, but no matching ID in DEST.
2758 ;; It must be a new item that does not exist in DEST.
2759 ;; Copy the entire item to the *end* of DEST.
2763 ;; Finally: there may be some items in DEST which are not in SRC, and
2764 ;; which have been scheduled by another user of DEST. Clear out the
2765 ;; scheduling info from all the unmatched items in DEST.
2775 ;;; Card types for learning languages =========================================
2777 ;;; Get spell-number.el from:
2778 ;;; http://www.emacswiki.org/emacs/spell-number.el
2782 ;;; `conjugate' card type =====================================================
2783 ;;; See spanish.org for usage
2789 ;; past tenses
2795 ;; future tenses
2797 ;; moods (backgrounds).
2803 )
2804 "Alist where each entry has the form (TENSE COLOUR), where
2805 TENSE is a string naming a tense in which verbs can be
2806 conjugated, and COLOUR is a string specifying a foreground colour
2807 which will be used by `org-drill-present-verb-conjugation' and
2808 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2813 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2814 `org-drill-show-answer-verb-conjugation'."
2833 :background
2843 "Present a drill entry whose card type is 'conjugate'."
2864 translation
2870 "Show the answer for a drill item whose card type is 'conjugate'.
2871 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2872 returns its return value."
2885 infinitive translation)
2889 ;;; `translate_number' card type ==============================================
2890 ;;; See spanish.org for usage
2910 num-max num-min))
2945 non-english english))
2949 english non-english)))
2953 ;;; `spanish_verb' card type ==================================================
2954 ;;; Not very interesting, but included to demonstrate how a presentation
2955 ;;; function can manipulate which subheading are hidden versus shown.