| blob | b0223597ab93412ff97a6f5f3e13b2958e480bca |
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.5
6 ;; Repository at http://bitbucket.org/eeeickythump/org-drill/
7 ;;
8 ;; This file is not part of GNU Emacs.
9 ;;
10 ;; Synopsis
11 ;; ========
12 ;;
13 ;; Uses the SuperMemo spaced repetition algorithms to conduct interactive
14 ;; "drill sessions", where the material to be remembered is presented to the
15 ;; student in random order. The student rates his or her recall of each item,
16 ;; and this information is used to schedule the item for later revision.
17 ;;
18 ;; Each drill session can be restricted to topics in the current buffer
19 ;; (default), one or several files, all agenda files, or a subtree. A single
20 ;; topic can also be drilled.
21 ;;
22 ;; Different "card types" can be defined, which present their information to
23 ;; the student in different ways.
24 ;;
25 ;; See the file README.org in the repository for more detailed documentation.
35 "Options concerning interactive drill sessions in Org mode (org-drill)."
41 "drill"
42 "Tag which topics must possess in order to be identified as review topics
43 by `org-drill'."
49 30
50 "Each drill session will present at most this many topics for review.
51 Nil means unlimited."
57 20
58 "Maximum duration of a drill session, in minutes.
59 Nil means unlimited."
65 2
66 "If the quality of recall for an item is this number or lower,
67 it is regarded as an unambiguous failure, and the repetition
68 interval for the card is reset to 0 days. If the quality is higher
69 than this number, it is regarded as successfully recalled, but the
70 time interval to the next repetition will be lowered if the quality
71 was near to a fail.
73 By default this is 2, for SuperMemo-like behaviour. For
74 Mnemosyne-like behaviour, set it to 1. Other values are not
75 really sensible."
81 10
82 "What percentage of items do you consider it is 'acceptable' to
83 forget each drill session? The default is 10%. A warning message
84 is displayed at the end of the session if the percentage forgotten
85 climbs above this number."
91 15
92 "If an item is forgotten more than this many times, it is tagged
93 as a 'leech' item."
99 'skip
100 "How should 'leech items' be handled during drill sessions?
101 Possible values:
102 - nil :: Leech items are treated the same as normal items.
103 - skip :: Leech items are not included in drill sessions.
104 - warn :: Leech items are still included in drill sessions,
105 but a warning message is printed when each leech item is
106 presented."
113 "The face used to hide the contents of cloze phrases."
119 "The face used to hide the contents of cloze phrases."
125 "The face used to hide the contents of cloze phrases."
130 nil
131 "Use a special face to highlight cloze-deleted text in org mode
132 buffers?"
138 nil
139 "Conceal the contents of the main heading of each item during drill
140 sessions? You may want to enable this behaviour if item headings or tags
141 contain information that could 'give away' the answer."
147 "royal blue"
148 "Foreground colour used to display the count of remaining new items
149 during a drill session."
154 "green"
155 "Foreground colour used to display the count of remaining mature items
156 during a drill session. Mature items are due for review, but are not new."
161 "red"
162 "Foreground colour used to display the count of remaining failed items
163 during a drill session."
168 "sienna"
169 "Foreground colour used to display the count of reviewed items
170 during a drill session."
177 face org-drill-hidden-cloze-face
178 window t))
185 face default
186 window t))
190 ;; ver 1 "[^][]\\(\\[[^][][^]]*\\]\\)"
191 ;; ver 2 "\\(\\[.*?\\]\\|^[^[[:cntrl:]]*?\\]\\|\\[.*?$\\)"
192 ;; ver 3! "\\(\\[.*?\\]\\|\\[.*?[[:cntrl:]]+.*?\\]\\)"
197 `((,org-drill-cloze-regexp
201 )))
220 org-drill-show-answer-verb-conjugation)
223 org-drill-show-answer-translate-number))
224 "Alist associating card types with presentation functions. Each entry in the
225 alist takes one of two forms:
226 1. (CARDTYPE . QUESTION-FN), where CARDTYPE is a string or nil (for default),
227 and QUESTION-FN is a function which takes no arguments and returns a boolean
228 value.
229 2. (CARDTYPE QUESTION-FN ANSWER-FN), where ANSWER-FN is a function that takes
230 one argument -- the argument is a function that itself takes no arguments.
231 ANSWER-FN is called with the point on the active item's
232 heading, just prior to displaying the item's 'answer'. It can therefore be
233 used to modify the appearance of the answer. ANSWER-FN must call its argument
234 before returning. (Its argument is a function that prompts the user and
235 performs rescheduling)."
241 'file
242 "The scope in which to search for drill items when conducting a
243 drill session. This can be any of:
245 file The current buffer, respecting the restriction if any.
246 This is the default.
247 tree The subtree started with the entry at point
248 file-no-restriction The current buffer, without restriction
249 file-with-archives The current buffer, and any archives associated with it.
250 agenda All agenda files
251 agenda-with-archives All agenda files with any archive files associated
252 with them.
253 directory All files with the extension '.org' in the same
254 directory as the current file (includes the current
255 file if it is an .org file.)
256 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
257 "
258 ;; Note -- meanings differ slightly from the argument to org-map-entries:
259 ;; 'file' means current file/buffer, respecting any restriction
260 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
261 ;; 'directory' means all *.org files in current directory
266 list))
270 t
271 "If non-nil, prompt to save all modified buffers after a drill session
272 finishes."
278 'sm5
279 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
280 Available choices are:
281 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
282 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
283 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
284 SuperMemo 98. The version implemented here is simplified in that while it
285 'learns' the difficulty of each item using quality grades and number of
286 failures, it does not modify the matrix of values that
287 governs how fast the inter-repetition intervals increase. A method for
288 adjusting intervals when items are reviewed early or late has been taken
289 from SM11, a later version of the algorithm, and included in Simple8."
295 nil
296 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
298 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
299 The matrix is saved (using the 'customize' facility) at the end of each
300 drill session.
302 Over time, values in the matrix will adapt to the individual user's
303 pace of learning."
309 4.0
310 "In the SM5 algorithm, the initial interval after the first
311 successful presentation of an item is always 4 days. If you wish to change
312 this, you can do so here."
318 nil
319 "If true, the number of days until an item's next repetition
320 will vary slightly from the interval calculated by the SM2
321 algorithm. The variation is very small when the interval is
322 small, but scales up with the interval."
328 nil
329 "If true, when the student successfully reviews an item 1 or more days
330 before or after the scheduled review date, this will affect that date of
331 the item's next scheduled review, according to the algorithm presented at
332 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
334 Items that were reviewed early will have their next review date brought
335 forward. Those that were reviewed late will have their next review
336 date postponed further.
338 Note that this option currently has no effect if the SM2 algorithm
339 is used."
345 4
346 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
347 this number determines how often the 'less favoured' situation
348 should arise. It will occur 1 in every N trials, where N is the
349 value of the variable.
351 For example, with the hide1_firstmore card type, the first piece
352 of clozed text should be hidden more often than the other
353 pieces. If this variable is set to 4 (default), the first item
354 will only be shown 25% of the time (1 in 4 trials). Similarly for
355 show1_lastmore, the last item will be shown 75% of the time, and
356 for show1_firstless, the first item would only be shown 25% of the
357 time.
359 If the value of this variable is NIL, then weighting is disabled, and
360 all weighted card types are treated as their unweighted equivalents."
366 12
367 "When in cram mode, items are considered due for review if
368 they were reviewed at least this many hours ago."
373 ;;; NEW items have never been presented in a drill session before.
374 ;;; MATURE items HAVE been presented at least once before.
375 ;;; - YOUNG mature items were scheduled no more than
376 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
377 ;;; repetition. These items will have been learned 'recently' and will have a
378 ;;; low repetition count.
379 ;;; - OLD mature items have intervals greater than
380 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
381 ;;; - OVERDUE items are past their scheduled review date by more than
382 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
383 ;;; regardless of young/old status.
387 10
388 "When an item's inter-repetition interval rises above this value in days,
389 it is no longer considered a 'young' (recently learned) item."
395 1.2
396 "An item is considered overdue if its scheduled review date is
397 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
398 days in the past. For example, a value of 1.2 means an additional
399 20% of the last scheduled interval is allowed to elapse before
400 the item is overdue. A value of 1.0 means no extra time is
401 allowed at all - items are immediately considered overdue if
402 there is even one day's delay in reviewing them. This variable
403 should never be less than 1.0."
409 0.5
410 "Fraction between 0 and 1 that governs how quickly the spaces
411 between successive repetitions increase, for all items. The
412 default value is 0.5. Higher values make spaces increase more
413 quickly with each successful repetition. You should only change
414 this in small increments (for example 0.05-0.1) as it has an
415 exponential effect on inter-repetition spacing."
428 "List of markers for items that are considered 'overdue', based on
431 "List of markers for mature entries whose last inter-repetition
434 "List of markers for mature entries whose last inter-repetition
442 "Are we in 'cram mode', where all items are considered due
450 ;;; Make the above settings safe as file-local variables.
482 ;;;; Utilities ================================================================
492 nil
500 "Add VAL to the end of the sequence stored in PLACE. Return the new
501 value."
506 "Randomly permute the elements of LIST (all permutations equally likely)."
507 ;; Adapted from 'shuffle-vector' in cookie1.el
509 j
510 temp
518 list)
522 "Round the floating point number FLOATNUM to FIX decimal places.
523 Example: (round-float 3.56755765 3) -> 3.568"
529 "Return a human-readable description of the key/keys to which the command
530 CMD is bound, or nil if it is not bound to a key."
538 time))
542 "Like `org-map-entries', but only drill entries are processed."
553 skip)))
586 "Nil means a last review date has not yet been stored for
587 the item.
588 Zero means it was reviewed today.
589 A positive number means it was reviewed that many days ago.
590 A negative number means the date of last review is in the future --
591 this should never happen."
600 "Like `org-drill-days-since-last-review', but return value is
601 in hours rather than days."
612 "Is MARKER, or the point, in a 'drill item'? This will return nil if
613 the point is inside a subheading of a drill item -- to handle that
614 situation use `org-part-of-drill-entry-p'."
627 "Is the current entry either the main heading of a 'drill item',
628 or a subheading within a drill item?"
630 ;; Does this heading INHERIT the drill tag
635 "Move the point to the heading which holds the :drill: tag for this
636 drill entry."
648 "Is the current entry a 'leech item'?"
653 ;; (defun org-drill-entry-due-p ()
654 ;; (cond
655 ;; (*org-drill-cram-mode*
656 ;; (let ((hours (org-drill-hours-since-last-review)))
657 ;; (and (org-drill-entry-p)
658 ;; (or (null hours)
659 ;; (>= hours org-drill-cram-hours)))))
660 ;; (t
661 ;; (let ((item-time (org-get-scheduled-time (point))))
662 ;; (and (org-drill-entry-p)
663 ;; (or (not (eql 'skip org-drill-leech-method))
664 ;; (not (org-drill-entry-leech-p)))
665 ;; (or (null item-time) ; not scheduled
666 ;; (not (minusp ; scheduled for today/in past
667 ;; (- (time-to-days (current-time))
668 ;; (time-to-days item-time))))))))))
672 "Returns:
673 - NIL if the item is not to be regarded as scheduled for review at all.
674 This is the case if it is not a drill item, or if it is a leech item
675 that we wish to skip, or if we are in cram mode and have already reviewed
676 the item within the last few hours.
677 - 0 if the item is new, or if it scheduled for review today.
678 - A negative integer - item is scheduled that many days in the future.
679 - A positive integer - item is scheduled that many days in the past."
693 nil)
702 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
703 and whose last inter-repetition interval was LAST-INTERVAL, should be
704 considered 'overdue'. If the arguments are not given they are extracted
705 from the entry at point."
712 ;;(> due org-drill-days-before-overdue)
714 org-drill-overdue-interval-factor)))
734 default)))
772 default)))
775 ;;; From http://www.supermemo.com/english/ol/sm5.htm
777 "Returns a random number between 0.5 and 1.5."
790 "Random numbers in a pseudo-normal distribution with mean MEAN, range
791 MEAN-VARIATION to MEAN+VARIATION"
795 mean))
799 optimal-interval
800 days-ahead)
801 "Arguments:
802 - OPTIMAL-FACTOR: interval-factor if the item had been tested
803 exactly when it was supposed to be.
804 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
805 tested exactly when it was supposed to be.
806 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
808 Returns an adjusted optimal factor which should be used to
809 calculate the next interval, instead of the optimal factor found
810 in the matrix."
812 (/ (+ optimal-interval
819 "Returns a list of 6 items, containing all the stored recall
820 data for the item at point:
821 - LAST-INTERVAL is the interval in days that was used to schedule the item's
822 current review date.
823 - REPEATS is the number of items the item has been successfully recalled without
824 without any failures. It is reset to 0 upon failure to recall the item.
825 - FAILURES is the total number of times the user has failed to recall the item.
826 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
827 - AVERAGE-QUALITY is the mean quality of recall of the item over
828 all its repetitions, successful and unsuccessful.
829 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
830 "
844 )))
857 total-repeats meanq
858 ease)
859 "Stores the given data in the item at point."
873 ;;; SM2 Algorithm =============================================================
877 failures meanq total-repeats)
878 "Arguments:
879 - LAST-INTERVAL -- the number of days since the item was last reviewed.
880 - REPEATS -- the number of times the item has been successfully reviewed
881 - EF -- the 'easiness factor'
882 - QUALITY -- 0 to 5
884 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
885 - INTERVAL is the number of days until the item should next be reviewed
886 - REPEATS is incremented by 1.
887 - EF is modified based on the recall quality for the item.
888 - OF-MATRIX is not modified."
892 ;; When an item is failed, its interval is reset to 0,
893 ;; but its EF is unchanged
895 org-drill-optimal-factor-matrix)
896 ;; else:
915 interval)
917 next-ef
919 org-drill-optimal-factor-matrix))))
922 ;;; SM5 Algorithm =============================================================
928 org-drill-sm5-initial-interval
929 ef))
941 org-drill-optimal-factor-matrix))))
943 of
948 failures meanq total-repeats
961 quality))
966 quality org-drill-learn-fraction))
973 last-interval n ef of-matrix)
974 delta-days)))
983 ;; "Failed" -- reset repetitions to 0,
987 ; preserved
988 ;; For a zero-based quality of 4 or 5, don't repeat
989 ;; ((and (>= quality 4)
990 ;; (not org-learn-always-reschedule))
991 ;; (list 0 (1+ n) ef failures meanq
992 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
995 last-interval n ef of-matrix))
1000 ef
1001 failures
1002 meanq
1004 of-matrix)))))
1007 ;;; Simple8 Algorithm =========================================================
1011 "Arguments:
1012 - FAILURES: integer >= 0. The total number of times the item has
1013 been forgotten, ever.
1015 Returns the optimal FIRST interval for an item which has previously been
1016 forgotten on FAILURES occasions."
1021 "Arguments:
1022 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
1023 - REPETITION: the number of times the item has been tested.
1024 1 is the first repetition (ie the second trial).
1025 Returns:
1026 The factor by which the last interval should be
1027 multiplied to give the next interval. Corresponds to `RF' or `OF'."
1032 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
1033 to a mean item quality of QUALITY."
1042 failures meanq totaln
1044 "Arguments:
1045 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1046 - REPEATS -- the number of times the item has been successfully reviewed
1047 - EASE -- the 'easiness factor'
1048 - QUALITY -- 0 to 5
1049 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
1050 0 = reviewed on the scheduled day. +N = N days overdue.
1051 -N = reviewed N days early.
1053 Returns the new item data, as a list of 6 values:
1054 - NEXT-INTERVAL
1055 - REPEATS
1056 - EASE
1057 - FAILURES
1058 - AVERAGE-QUALITY
1059 - TOTAL-REPEATS.
1060 See the documentation for `org-drill-get-item-data' for a description of these."
1067 quality))
1081 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1085 repeats))
1091 ;; The item was reviewed earlier than scheduled.
1102 next-interval)
1103 repeats
1105 failures
1106 meanq
1107 totaln
1108 )))
1113 ;;; Essentially copied from `org-learn.el', but modified to
1114 ;;; optionally call the SM2 or simple8 functions.
1116 "If DAYS-AHEAD is supplied it must be a positive integer. The
1117 item will be scheduled exactly this many days into the future."
1122 ;; Entries can have weights, 1 by default. Intervals are divided by the
1123 ;; item's weight, so an item with a weight of 2 will have all intervals
1124 ;; halved, meaning you will end up reviewing it twice as often.
1125 ;; Useful for entries which randomly present any of several facts.
1130 total-repeats meanq ease)
1133 failures meanq total-repeats
1137 ease quality failures
1138 meanq total-repeats ofmatrix))
1140 ease quality failures
1141 meanq total-repeats))
1143 quality failures meanq
1144 total-repeats
1145 delta-days)))
1157 total-repeats meanq ease)
1174 "Returns an integer representing the number of days into the future
1175 that the current item would be scheduled, based on a recall quality
1176 of QUALITY."
1179 total-repeats meanq ease)
1184 failures meanq total-repeats
1188 ease quality failures
1189 meanq total-repeats
1190 org-drill-optimal-factor-matrix))
1192 ease quality failures
1193 meanq total-repeats))
1195 quality failures meanq
1196 total-repeats)))
1201 (+ last-interval
1204 next-interval))))))
1212 intervals))
1217 "Returns quality rating (0-5), or nil if the user quit."
1226 3-5 Means you have remembered the item.
1228 0 - Completely forgot.
1229 1 - Even after seeing the answer, it still took a bit to sink in.
1230 2 - After seeing the answer, you remembered it.
1231 3 - It took you awhile, but you finally remembered. (+%s days)
1232 4 - After a little bit of thought you remembered. (+%s days)
1233 5 - You remembered the item really easily. (+%s days)
1235 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1269 ;;(setq failures (if failures (string-to-number failures) 0))
1270 ;; (org-set-property "DRILL_FAILURE_COUNT"
1271 ;; (format "%d" (1+ failures)))
1284 quality))
1288 nil))))
1291 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1292 ;; "Returns a list containing the position of each immediate subheading of
1293 ;; the current topic."
1294 ;; (let ((drill-entry-level (org-current-level))
1295 ;; (drill-sections nil)
1296 ;; (drill-heading nil))
1297 ;; (org-show-subtree)
1298 ;; (save-excursion
1299 ;; (org-map-entries
1300 ;; (lambda ()
1301 ;; (when (and (not (outline-invisible-p))
1302 ;; (> (org-current-level) drill-entry-level))
1303 ;; (setq drill-heading (org-get-heading t))
1304 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1305 ;; (member drill-heading heading-list))
1306 ;; (hide-subtree))
1307 ;; (push (point) drill-sections)))
1308 ;; "" 'tree))
1309 ;; (reverse drill-sections)))
1314 "TEST is a function taking no arguments. TEST will be called for each
1315 of the immediate subheadings of the current drill item, with the point
1316 on the relevant subheading. TEST should return nil if the subheading is
1317 to be revealed, non-nil if it is to be hidden.
1318 Returns a list containing the position of each immediate subheading of
1319 the current topic."
1390 prompt))
1395 You seem to be having a lot of trouble memorising this item.
1398 prompt)))
1404 "++:++ "
1406 prompt))
1426 "Hide the buffer region between BEG and END with an 'invisible text'
1427 visual overlay, or with the string TEXT if it is supplied."
1453 ;; This will also unhide the item's heading.
1463 ;; Don't hide org links, partly because they might contain inline
1464 ;; images which we want to keep visible
1472 "Hide the current match with a 'cloze' visual overlay."
1482 ovl 'display
1483 ;; If hint is like `X...' then display [X...]
1484 ;; otherwise display [...X]
1486 hint))))))
1500 "During the execution of BODY, the entire text of the current entry is
1501 concealed by an overlay that displays the string TEXT."
1511 "Make an overlay that conceals the entire text of the item, not
1512 including properties or the contents of subheadings. The overlay shows
1513 the string TEXT.
1514 Note: does not actually alter the item."
1541 "Make an overlay that conceals the heading of the item. The overlay shows
1542 the string TEXT.
1543 Note: does not actually alter the item."
1557 text
1566 ;;; Presentation functions ====================================================
1568 ;; Each of these is called with point on topic heading. Each needs to show the
1569 ;; topic in the form of a 'question' or with some information 'hidden', as
1570 ;; appropriate for the card type. The user should then be prompted to press a
1571 ;; key. The function should then reveal either the 'answer' or the entire
1572 ;; topic, and should return t if the user chose to see the answer and rate their
1573 ;; recall, nil if they chose to quit.
1601 drill-sections))
1626 &optional
1627 force-show-first
1628 force-show-last
1629 force-hide-first)
1630 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1631 chosen at random.
1632 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1633 hiding all the rest.
1634 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1635 the hidden items.
1636 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1637 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1638 If the number of text pieces in the item is less than
1639 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1640 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1665 to match-count
1666 collect i)))
1670 ;; Force '1' to be in the list, and to be the first item
1671 ;; in the list.
1680 ;; (dolist (pos-to-hide match-nums)
1691 ;; (loop
1692 ;; do (re-search-forward org-drill-cloze-regexp
1693 ;; item-end t pos-to-hide)
1694 ;; while (org-pos-in-regexp (match-beginning 0)
1695 ;; org-bracket-link-regexp 1))
1696 ;; (org-drill-hide-matched-cloze-text)))))
1705 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1706 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1707 the second to last, etc."
1732 nil)
1752 "Hides one of the pieces of text that are marked for cloze deletion,
1753 chosen at random."
1758 "Hides two of the pieces of text that are marked for cloze deletion,
1759 chosen at random."
1764 "Hides the first piece of text that is marked for cloze deletion."
1769 "Hides the last piece of text that is marked for cloze deletion."
1774 "Commonly, hides the FIRST piece of text that is marked for
1775 cloze deletion. Uncommonly, hide one of the other pieces of text,
1776 chosen at random.
1778 The definitions of 'commonly' and 'uncommonly' are determined by
1779 the value of `org-drill-cloze-text-weight'."
1780 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1781 ;; to hide the 'favoured' piece of text. However even when the chance of
1782 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1783 ;; the small number of repetitions where most learning takes place for each
1784 ;; item. In other words, the actual frequency during the first 10 repetitions
1785 ;; was often very different from 80%. Hence we use modulo instead.
1788 ;; Behave as hide1cloze
1793 org-drill-cloze-text-weight))
1795 org-drill-cloze-text-weight))
1796 ;; Uncommonly, hide any item except the first
1799 ;; Commonly, hide first item
1804 "Commonly, hides all pieces except the last. Uncommonly, shows
1805 any random piece. The effect is similar to 'show1cloze' except
1806 that the last item is much less likely to be the item that is
1807 visible.
1809 The definitions of 'commonly' and 'uncommonly' are determined by
1810 the value of `org-drill-cloze-text-weight'."
1813 ;; Behave as show1cloze
1818 org-drill-cloze-text-weight))
1820 org-drill-cloze-text-weight))
1821 ;; Uncommonly, show any item except the last
1824 ;; Commonly, show the LAST item
1829 "Commonly, hides all pieces except one, where the shown piece
1830 is guaranteed NOT to be the first piece. Uncommonly, shows any
1831 random piece. The effect is similar to 'show1cloze' except that
1832 the first item is much less likely to be the item that is
1833 visible.
1835 The definitions of 'commonly' and 'uncommonly' are determined by
1836 the value of `org-drill-cloze-text-weight'."
1839 ;; Behave as show1cloze
1844 org-drill-cloze-text-weight))
1846 org-drill-cloze-text-weight))
1847 ;; Uncommonly, show the first item
1850 ;; Commonly, show any item, except the first
1855 "Similar to `org-drill-present-multicloze-hide1', but hides all
1856 the pieces of text that are marked for cloze deletion, except for one
1857 piece which is chosen at random."
1862 "Similar to `org-drill-present-multicloze-show1', but reveals two
1863 pieces rather than one."
1867 ;; (defun org-drill-present-multicloze-show1 ()
1868 ;; "Similar to `org-drill-present-multicloze-hide1', but hides all
1869 ;; the pieces of text that are marked for cloze deletion, except for one
1870 ;; piece which is chosen at random."
1871 ;; (with-hidden-comments
1872 ;; (with-hidden-cloze-hints
1873 ;; (let ((item-end nil)
1874 ;; (match-count 0)
1875 ;; (body-start (or (cdr (org-get-property-block))
1876 ;; (point))))
1877 ;; (org-drill-hide-all-subheadings-except nil)
1878 ;; (save-excursion
1879 ;; (outline-next-heading)
1880 ;; (setq item-end (point)))
1881 ;; (save-excursion
1882 ;; (goto-char body-start)
1883 ;; (while (re-search-forward org-drill-cloze-regexp item-end t)
1884 ;; (incf match-count)))
1885 ;; (when (plusp match-count)
1886 ;; (let ((match-to-hide (random* match-count)))
1887 ;; (save-excursion
1888 ;; (goto-char body-start)
1889 ;; (dotimes (n match-count)
1890 ;; (re-search-forward org-drill-cloze-regexp
1891 ;; item-end t)
1892 ;; (unless (= n match-to-hide)
1893 ;; (org-drill-hide-matched-cloze-text))))))
1894 ;; (org-display-inline-images t)
1895 ;; (org-cycle-hide-drawers 'all)
1896 ;; (prog1 (org-drill-presentation-prompt)
1897 ;; (org-drill-hide-subheadings-if 'org-drill-entry-p)
1898 ;; (org-drill-unhide-clozed-text))))))
1902 "Present the string QUESTION as the only visible content of the card."
1905 question
1912 ;;; The following macro is necessary because `org-save-outline-visibility'
1913 ;;; currently discards the value returned by its body and returns a garbage
1914 ;;; value instead. (as at org mode v 7.5)
1917 "Store the current visibility state of the org buffer, and restore it
1918 after executing BODY. Return the value of the last expression
1919 in BODY."
1930 "Present the current topic for interactive review, as in `org-drill'.
1931 Review will occur regardless of whether the topic is due for review or whether
1932 it meets the definition of a 'review topic' used by `org-drill'.
1934 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
1935 EDIT if the user chose to exit the drill and edit the current item. Choosing
1936 the latter option leaves the drill session suspended; it can be resumed
1937 later using `org-drill-resume'.
1939 See `org-drill' for more details."
1942 ;;(unless (org-part-of-drill-entry-p)
1943 ;; (error "Point is not inside a drill entry"))
1944 ;;(unless (org-at-heading-p)
1945 ;; (org-back-to-heading))
1971 nil)
2004 "Returns true if the current drill session has continued past its
2005 maximum duration."
2013 "Returns true if the current drill session has reached the
2014 maximum number of items."
2017 org-drill-maximum-items-per-session)))
2026 m
2028 ;; First priority is items we failed in a prior session.
2033 ;; Next priority is overdue items.
2037 ;; We use `pop', not `pop-random', because we have already
2038 ;; sorted overdue items into a random order which takes
2039 ;; number of days overdue into account.
2041 ;; Next priority is 'young' items.
2046 ;; Next priority is newly added items, and older entries.
2047 ;; We pool these into a single group.
2059 ;; After all the above are done, last priority is items
2060 ;; that were failed earlier THIS SESSION.
2065 m)))
2069 "Returns nil, t, or a list of markers representing entries that were
2070 'failed' and need to be presented again before the session ends.
2072 RESUMING-P is true if we are resuming a suspended drill session."
2090 ;; The entry is not due anymore. This could arise if the user
2091 ;; suspends a drill session, then drills an individual entry,
2092 ;; then resumes the session.
2095 nil)
2129 "%d items reviewed. Session duration %s.
2130 Recall of reviewed items:
2131 Excellent (5): %3d%% | Near miss (2): %3d%%
2132 Good (4): %3d%% | Failure (1): %3d%%
2133 Hard (3): %3d%% | Abject failure (0): %3d%%
2135 You successfully recalled %d%% of reviewed items (quality > %s)
2136 %d/%d items still await review (%s, %s, %s, %s, %s).
2137 Tomorrow, %d more items will become due for review.
2138 Session finished. Press a key to continue..."
2154 pass-percent
2155 org-drill-failure-quality
2181 ))
2192 "%s
2193 You failed %d%% of the items you reviewed during this session.
2194 %d (%d%%) of all items scanned were overdue.
2196 Are you keeping up with your items, and reviewing them
2197 when they are scheduled? If so, you may want to consider
2198 lowering the value of `org-drill-learn-fraction' slightly in
2199 order to make items appear more frequently over time."
2206 ))))
2211 "MARKERS is a list of markers, all of which will be freed (set to
2212 point nowhere). Alternatively, MARKERS can be 't', in which case
2213 all the markers used by Org-Drill will be freed."
2222 markers))
2234 "Returns a list (STATUS DUE) where DUE is the number of days overdue,
2235 zero being due today, -1 being scheduled 1 day in the future. STATUS is
2236 one of the following values:
2237 - nil, if the item is not a drill entry, or has an empty body
2238 - :unscheduled
2239 - :future
2240 - :new
2241 - :failed
2242 - :overdue
2243 - :young
2244 - :old
2245 "
2254 nil)
2259 ;; ((eql -1 due)
2260 ;; :tomorrow)
2263 ;; The rest of the stati all denote 'due' items ==========================
2265 org-drill-failure-quality)
2266 ;; Mature entries that were failed last time are
2267 ;; FAILED, regardless of how young, old or overdue
2268 ;; they are.
2273 ;; Overdue status overrides young versus old
2274 ;; distinction.
2275 ;; Store marker + due, for sorting of overdue entries
2278 org-drill-days-before-old)
2282 due))))
2291 collected
2293 sym2)
2295 sym1)))))
2299 "Begin an interactive 'drill session'. The user is asked to
2300 review a series of topics (headers). Each topic is initially
2301 presented as a 'question', often with part of the topic content
2302 hidden. The user attempts to recall the hidden information or
2303 answer the question, then presses a key to reveal the answer. The
2304 user then rates his or her recall or performance on that
2305 topic. This rating information is used to reschedule the topic
2306 for future review.
2308 Org-drill proceeds by:
2310 - Finding all topics (headings) in SCOPE which have either been
2311 used and rescheduled before, or which have a tag that matches
2312 `org-drill-question-tag'.
2314 - All matching topics which are either unscheduled, or are
2315 scheduled for the current date or a date in the past, are
2316 considered to be candidates for the drill session.
2318 - If `org-drill-maximum-items-per-session' is set, a random
2319 subset of these topics is presented. Otherwise, all of the
2320 eligible topics will be presented.
2322 SCOPE determines the scope in which to search for
2323 questions. It accepts the same values as `org-drill-scope',
2324 which see.
2326 If RESUME-P is non-nil, resume a suspended drill session rather
2327 than starting a new one."
2378 (:unscheduled
2380 ;; (:tomorrow
2381 ;; (incf *org-drill-dormant-entry-count*)
2382 ;; (incf *org-drill-due-tomorrow-count*))
2383 (:future
2387 (:new
2389 (:failed
2391 (:young
2393 (:overdue
2395 (:old
2397 scope)
2398 ;; (let ((due (org-drill-entry-days-overdue))
2399 ;; (last-int (org-drill-entry-last-interval 1)))
2400 ;; (cond
2401 ;; ((org-drill-entry-empty-p)
2402 ;; nil) ; skip -- item body is empty
2403 ;; ((or (null due) ; unscheduled - usually a skipped leech
2404 ;; (minusp due)) ; scheduled in the future
2405 ;; (incf *org-drill-dormant-entry-count*)
2406 ;; (if (eq -1 due)
2407 ;; (incf *org-drill-due-tomorrow-count*)))
2408 ;; ((org-drill-entry-new-p)
2409 ;; (push (point-marker) *org-drill-new-entries*))
2410 ;; ((<= (org-drill-entry-last-quality 9999)
2411 ;; org-drill-failure-quality)
2412 ;; ;; Mature entries that were failed last time are
2413 ;; ;; FAILED, regardless of how young, old or overdue
2414 ;; ;; they are.
2415 ;; (push (point-marker) *org-drill-failed-entries*))
2416 ;; ((org-drill-entry-overdue-p due last-int)
2417 ;; ;; Overdue status overrides young versus old
2418 ;; ;; distinction.
2419 ;; ;; Store marker + due, for sorting of overdue entries
2420 ;; (push (cons (point-marker) due) overdue-data))
2421 ;; ((<= (org-drill-entry-last-interval 9999)
2422 ;; org-drill-days-before-old)
2423 ;; ;; Item is 'young'.
2424 ;; (push (point-marker)
2425 ;; *org-drill-young-mature-entries*))
2426 ;; (t
2427 ;; (push (point-marker)
2428 ;; *org-drill-old-mature-entries*))))
2429 ;; Order 'overdue' items so that the most overdue will tend to
2430 ;; come up for review first, while keeping exact order random
2454 "You can continue the drill session with the command `org-drill-resume'.%s"
2464 ))))
2470 org-drill-optimal-factor-matrix))
2474 "Run an interactive drill session in 'cram mode'. In cram mode,
2475 all drill items are considered to be due for review, unless they
2476 have been reviewed within the last `org-drill-cram-hours'
2477 hours."
2484 "Run an interactive drill session using drill items within the
2485 subtree at point."
2491 "Run an interactive drill session using drill items from all org
2492 files in the same directory as the current file."
2498 "Run a new drill session, but try to use leftover due items that
2499 were not reviewed during the last session, rather than scanning for
2500 unreviewed items. If there are no leftover items in memory, a full
2501 scan will be performed."
2518 "Resume a suspended drill session. Sessions are suspended by
2519 exiting them with the `edit' or `quit' options."
2525 ;; Current drill session is finished, but there are still
2526 ;; more items which need to be reviewed.
2528 "You have finished the drill session. However, %d items still
2529 need reviewing. Start a new drill session? "
2543 "Delete scheduling data from every drill entry in scope. This
2544 function may be useful if you want to give your collection of
2545 entries to someone else. Scope defaults to the current buffer,
2546 and is specified by the argument SCOPE, which accepts the same
2547 values as `org-drill-scope'."
2553 ;; Scope is the current buffer. This means we can use
2554 ;; `org-delete-property-globally', which is faster.
2567 org-drill-cloze-keywords
2568 nil)))
2575 ;;; Synching card collections =================================================
2582 "Copy the subtree at point to the buffer DEST. The copy will receive
2583 the tag 'imported'."
2614 ;; We've looked all the way up the path
2615 ;; Default to appending to the end of DEST
2624 )))))
2629 "SRC and DEST are two org mode buffers containing drill items.
2630 For each drill item in DEST that shares an ID with an item in SRC,
2631 overwrite scheduling data in DEST with data taken from the item in SRC.
2632 This is intended for use when two people are sharing a set of drill items,
2633 one person has made some updates to the item set, and the other person
2634 wants to migrate to the updated set without losing their scheduling data.
2636 By default, any drill items in SRC which do not exist in DEST are
2637 copied into DEST. We attempt to place the copied item in the
2638 equivalent location in DEST to its location in SRC, by matching
2639 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2640 we simply ignore any items that do not exist in DEST, and do not
2641 copy them across."
2652 ;; Compile list of all IDs in the destination buffer.
2661 ;; Look through all entries in source buffer.
2671 nil)
2673 ;; This entry matches an entry in dest. Retrieve all its
2674 ;; scheduling data, then go to the matching location in dest
2675 ;; and write the data.
2678 total-repeats meanq ease)
2684 ;; go to matching entry in destination buffer
2690 total-repeats meanq ease)
2702 ;; item in SRC has ID, but no matching ID in DEST.
2703 ;; It must be a new item that does not exist in DEST.
2704 ;; Copy the entire item to the *end* of DEST.
2708 ;; Finally: there may be some items in DEST which are not in SRC, and
2709 ;; which have been scheduled by another user of DEST. Clear out the
2710 ;; scheduling info from all the unmatched items in DEST.
2720 ;;; Card types for learning languages =========================================
2722 ;;; Get spell-number.el from:
2723 ;;; http://www.emacswiki.org/emacs/spell-number.el
2727 ;;; `conjugate' card type =====================================================
2728 ;;; See spanish.org for usage
2734 ;; past tenses
2740 ;; future tenses
2742 "Alist where each entry has the form (TENSE COLOUR), where
2743 TENSE is a string naming a tense in which verbs can be
2744 conjugated, and COLOUR is a string specifying a foreground colour
2745 which will be used by `org-drill-present-verb-conjugation' and
2746 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2751 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2752 `org-drill-show-answer-verb-conjugation'."
2776 "Present a drill entry whose card type is 'conjugate'."
2783 infinitive tense))
2787 translation
2789 tense))))))
2793 "Show the answer for a drill item whose card type is 'conjugate'.
2794 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2795 returns its return value."
2801 infinitive translation)
2805 ;;; `translate_number' card type ==============================================
2806 ;;; See spanish.org for usage
2826 num-max num-min))
2861 non-english english))
2865 english non-english)))
2869 ;;; `spanish_verb' card type ==================================================
2870 ;;; Not very interesting, but included to demonstrate how a presentation
2871 ;;; function can manipulate which subheading are hidden versus shown.