| blob | 98642cbf08f772b23a11e45d1af7010dac52510e |
1 ;;; org-drill.el - Self-testing using spaced repetition
2 ;;;
3 ;;; Author: Paul Sexton <eeeickythump@gmail.com>
4 ;;; Version: 2.3
5 ;;; Repository at http://bitbucket.org/eeeickythump/org-drill/
6 ;;;
7 ;;;
8 ;;; Synopsis
9 ;;; ========
10 ;;;
11 ;;; Uses the SuperMemo spaced repetition algorithms to conduct interactive
12 ;;; "drill sessions", where the material to be remembered is presented to the
13 ;;; student in random order. The student rates his or her recall of each item,
14 ;;; and this information is used to schedule the item for later revision.
15 ;;;
16 ;;; Each drill session can be restricted to topics in the current buffer
17 ;;; (default), one or several files, all agenda files, or a subtree. A single
18 ;;; topic can also be drilled.
19 ;;;
20 ;;; Different "card types" can be defined, which present their information to
21 ;;; the student in different ways.
22 ;;;
23 ;;; See the file README.org for more detailed documentation.
34 "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."
58 20
59 "Maximum duration of a drill session, in minutes.
60 Nil means unlimited."
66 2
67 "If the quality of recall for an item is this number or lower,
68 it is regarded as an unambiguous failure, and the repetition
69 interval for the card is reset to 0 days. If the quality is higher
70 than this number, it is regarded as successfully recalled, but the
71 time interval to the next repetition will be lowered if the quality
72 was near to a fail.
74 By default this is 2, for SuperMemo-like behaviour. For
75 Mnemosyne-like behaviour, set it to 1. Other values are not
76 really sensible."
82 10
83 "What percentage of items do you consider it is 'acceptable' to
84 forget each drill session? The default is 10%. A warning message
85 is displayed at the end of the session if the percentage forgotten
86 climbs above this number."
92 15
93 "If an item is forgotten more than this many times, it is tagged
94 as a 'leech' item."
100 'skip
101 "How should 'leech items' be handled during drill sessions?
102 Possible values:
103 - nil :: Leech items are treated the same as normal items.
104 - skip :: Leech items are not included in drill sessions.
105 - warn :: Leech items are still included in drill sessions,
106 but a warning message is printed when each leech item is
107 presented."
114 "The face used to hide the contents of cloze phrases."
120 "The face used to hide the contents of cloze phrases."
126 "The face used to hide the contents of cloze phrases."
131 nil
132 "Use a special face to highlight cloze-deleted text in org mode
133 buffers?"
139 nil
140 "Conceal the contents of the main heading of each item during drill
141 sessions? You may want to enable this behaviour if item headings or tags
142 contain information that could 'give away' the answer."
148 "royal blue"
149 "Foreground colour used to display the count of remaining new items
150 during a drill session."
155 "green"
156 "Foreground colour used to display the count of remaining mature items
157 during a drill session. Mature items are due for review, but are not new."
162 "red"
163 "Foreground colour used to display the count of remaining failed items
164 during a drill session."
169 "sienna"
170 "Foreground colour used to display the count of reviewed items
171 during a drill session."
178 face org-drill-hidden-cloze-face
179 window t))
186 face default
187 window t))
191 ;; ver 1 "[^][]\\(\\[[^][][^]]*\\]\\)"
192 ;; ver 2 "\\(\\[.*?\\]\\|^[^[[:cntrl:]]*?\\]\\|\\[.*?$\\)"
193 ;; ver 3! "\\(\\[.*?\\]\\|\\[.*?[[:cntrl:]]+.*?\\]\\)"
198 `((,org-drill-cloze-regexp
202 )))
215 org-drill-show-answer-verb-conjugation)
218 org-drill-show-answer-translate-number))
219 "Alist associating card types with presentation functions. Each entry in the
220 alist takes one of two forms:
221 1. (CARDTYPE . QUESTION-FN), where CARDTYPE is a string or nil (for default),
222 and QUESTION-FN is a function which takes no arguments and returns a boolean
223 value.
224 2. (CARDTYPE QUESTION-FN ANSWER-FN), where ANSWER-FN is a function that takes
225 one argument -- the argument is a function that itself takes no arguments.
226 ANSWER-FN is called with the point on the active item's
227 heading, just prior to displaying the item's 'answer'. It can therefore be
228 used to modify the appearance of the answer. ANSWER-FN must call its argument
229 before returning. (Its argument is a function that prompts the user and
230 performs rescheduling)."
236 'sm5
237 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
238 Available choices are:
239 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
240 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
241 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
242 SuperMemo 98. The version implemented here is simplified in that while it
243 'learns' the difficulty of each item using quality grades and number of
244 failures, it does not modify the matrix of values that
245 governs how fast the inter-repetition intervals increase. A method for
246 adjusting intervals when items are reviewed early or late has been taken
247 from SM11, a later version of the algorithm, and included in Simple8."
254 nil
255 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
257 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
258 The matrix is saved (using the 'customize' facility) at the end of each
259 drill session.
261 Over time, values in the matrix will adapt to the individual user's
262 pace of learning."
268 nil
269 "If true, the number of days until an item's next repetition
270 will vary slightly from the interval calculated by the SM2
271 algorithm. The variation is very small when the interval is
272 small, but scales up with the interval."
278 nil
279 "If true, when the student successfully reviews an item 1 or more days
280 before or after the scheduled review date, this will affect that date of
281 the item's next scheduled review, according to the algorithm presented at
282 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
284 Items that were reviewed early will have their next review date brought
285 forward. Those that were reviewed late will have their next review
286 date postponed further.
288 Note that this option currently has no effect if the SM2 algorithm
289 is used."
295 12
296 "When in cram mode, items are considered due for review if
297 they were reviewed at least this many hours ago."
302 ;;; NEW items have never been presented in a drill session before.
303 ;;; MATURE items HAVE been presented at least once before.
304 ;;; - YOUNG mature items were scheduled no more than
305 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
306 ;;; repetition. These items will have been learned 'recently' and will have a
307 ;;; low repetition count.
308 ;;; - OLD mature items have intervals greater than
309 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
310 ;;; - OVERDUE items are past their scheduled review date by more than
311 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
312 ;;; regardless of young/old status.
316 10
317 "When an item's inter-repetition interval rises above this value in days,
318 it is no longer considered a 'young' (recently learned) item."
324 1.2
325 "An item is considered overdue if its scheduled review date is
326 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
327 days in the past. For example, a value of 1.2 means an additional
328 20% of the last scheduled interval is allowed to elapse before
329 the item is overdue. A value of 1.0 means no extra time is
330 allowed at all - items are immediately considered overdue if
331 there is even one day's delay in reviewing them. This variable
332 should never be less than 1.0."
338 0.5
339 "Fraction between 0 and 1 that governs how quickly the spaces
340 between successive repetitions increase, for all items. The
341 default value is 0.5. Higher values make spaces increase more
342 quickly with each successful repetition. You should only change
343 this in small increments (for example 0.05-0.1) as it has an
344 exponential effect on inter-repetition spacing."
358 "List of markers for items that are considered 'overdue', based on
361 "List of markers for mature entries whose last inter-repetition
364 "List of markers for mature entries whose last inter-repetition
372 "Are we in 'cram mode', where all items are considered due
380 ;;; Make the above settings safe as file-local variables.
406 ;;;; Utilities ================================================================
416 nil
424 "Add VAL to the end of the sequence stored in PLACE. Return the new
425 value."
430 "Randomly permute the elements of LIST (all permutations equally likely)."
431 ;; Adapted from 'shuffle-vector' in cookie1.el
433 j
434 temp
442 list)
446 "Round the floating point number FLOATNUM to FIX decimal places.
447 Example: (round-float 3.56755765 3) -> 3.568"
454 time))
458 "Like `org-map-entries', but only drill entries are processed."
493 "Nil means a last review date has not yet been stored for
494 the item.
495 Zero means it was reviewed today.
496 A positive number means it was reviewed that many days ago.
497 A negative number means the date of last review is in the future --
498 this should never happen."
507 "Like `org-drill-days-since-last-review', but return value is
508 in hours rather than days."
519 "Is MARKER, or the point, in a 'drill item'? This will return nil if
520 the point is inside a subheading of a drill item -- to handle that
521 situation use `org-part-of-drill-entry-p'."
534 "Is the current entry either the main heading of a 'drill item',
535 or a subheading within a drill item?"
537 ;; Does this heading INHERIT the drill tag
542 "Move the point to the heading which holds the :drill: tag for this
543 drill entry."
555 "Is the current entry a 'leech item'?"
560 ;; (defun org-drill-entry-due-p ()
561 ;; (cond
562 ;; (*org-drill-cram-mode*
563 ;; (let ((hours (org-drill-hours-since-last-review)))
564 ;; (and (org-drill-entry-p)
565 ;; (or (null hours)
566 ;; (>= hours org-drill-cram-hours)))))
567 ;; (t
568 ;; (let ((item-time (org-get-scheduled-time (point))))
569 ;; (and (org-drill-entry-p)
570 ;; (or (not (eql 'skip org-drill-leech-method))
571 ;; (not (org-drill-entry-leech-p)))
572 ;; (or (null item-time) ; not scheduled
573 ;; (not (minusp ; scheduled for today/in past
574 ;; (- (time-to-days (current-time))
575 ;; (time-to-days item-time))))))))))
579 "Returns:
580 - NIL if the item is not to be regarded as scheduled for review at all.
581 This is the case if it is not a drill item, or if it is a leech item
582 that we wish to skip, or if we are in cram mode and have already reviewed
583 the item within the last few hours.
584 - 0 if the item is new, or if it scheduled for review today.
585 - A negative integer - item is scheduled that many days in the future.
586 - A positive integer - item is scheduled that many days in the past."
600 nil)
609 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
610 and whose last inter-repetition interval was LAST-INTERVAL, should be
611 considered 'overdue'. If the arguments are not given they are extracted
612 from the entry at point."
619 ;;(> due org-drill-days-before-overdue)
621 org-drill-overdue-interval-factor)))
641 default)))
679 default)))
682 ;;; From http://www.supermemo.com/english/ol/sm5.htm
684 "Returns a random number between 0.5 and 1.5."
697 "Random numbers in a pseudo-normal distribution with mean MEAN, range
698 MEAN-VARIATION to MEAN+VARIATION"
702 mean))
706 optimal-interval
707 days-ahead)
708 "Arguments:
709 - OPTIMAL-FACTOR: interval-factor if the item had been tested
710 exactly when it was supposed to be.
711 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
712 tested exactly when it was supposed to be.
713 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
715 Returns an adjusted optimal factor which should be used to
716 calculate the next interval, instead of the optimal factor found
717 in the matrix."
719 (/ (+ optimal-interval
726 "Returns a list of 6 items, containing all the stored recall
727 data for the item at point:
728 - LAST-INTERVAL is the interval in days that was used to schedule the item's
729 current review date.
730 - REPEATS is the number of items the item has been successfully recalled without
731 without any failures. It is reset to 0 upon failure to recall the item.
732 - FAILURES is the total number of times the user has failed to recall the item.
733 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
734 - AVERAGE-QUALITY is the mean quality of recall of the item over
735 all its repetitions, successful and unsuccessful.
736 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
737 "
751 )))
764 total-repeats meanq
765 ease)
766 "Stores the given data in the item at point."
780 ;;; SM2 Algorithm =============================================================
784 failures meanq total-repeats)
785 "Arguments:
786 - LAST-INTERVAL -- the number of days since the item was last reviewed.
787 - REPEATS -- the number of times the item has been successfully reviewed
788 - EF -- the 'easiness factor'
789 - QUALITY -- 0 to 5
791 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
792 - INTERVAL is the number of days until the item should next be reviewed
793 - REPEATS is incremented by 1.
794 - EF is modified based on the recall quality for the item.
795 - OF-MATRIX is not modified."
799 ;; When an item is failed, its interval is reset to 0,
800 ;; but its EF is unchanged
802 org-drill-optimal-factor-matrix)
803 ;; else:
822 interval)
824 next-ef
826 org-drill-optimal-factor-matrix))))
829 ;;; SM5 Algorithm =============================================================
834 org-drill-optimal-factor-matrix))))
836 of
841 failures meanq total-repeats
854 quality))
859 quality org-drill-learn-fraction))
866 last-interval n ef of-matrix)
867 delta-days)))
876 ;; "Failed" -- reset repetitions to 0,
880 ; preserved
881 ;; For a zero-based quality of 4 or 5, don't repeat
882 ;; ((and (>= quality 4)
883 ;; (not org-learn-always-reschedule))
884 ;; (list 0 (1+ n) ef failures meanq
885 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
888 last-interval n ef of-matrix))
893 ef
894 failures
895 meanq
897 of-matrix)))))
900 ;;; Simple8 Algorithm =========================================================
904 "Arguments:
905 - FAILURES: integer >= 0. The total number of times the item has
906 been forgotten, ever.
908 Returns the optimal FIRST interval for an item which has previously been
909 forgotten on FAILURES occasions."
914 "Arguments:
915 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
916 - REPETITION: the number of times the item has been tested.
917 1 is the first repetition (ie the second trial).
918 Returns:
919 The factor by which the last interval should be
920 multiplied to give the next interval. Corresponds to `RF' or `OF'."
925 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
926 to a mean item quality of QUALITY."
935 failures meanq totaln
937 "Arguments:
938 - LAST-INTERVAL -- the number of days since the item was last reviewed.
939 - REPEATS -- the number of times the item has been successfully reviewed
940 - EASE -- the 'easiness factor'
941 - QUALITY -- 0 to 5
942 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
943 0 = reviewed on the scheduled day. +N = N days overdue.
944 -N = reviewed N days early.
946 Returns the new item data, as a list of 6 values:
947 - NEXT-INTERVAL
948 - REPEATS
949 - EASE
950 - FAILURES
951 - AVERAGE-QUALITY
952 - TOTAL-REPEATS.
953 See the documentation for `org-drill-get-item-data' for a description of these."
960 quality))
974 org-drill-adjust-intervals-for-early-and-late-repetitions-p
978 repeats))
984 ;; The item was reviewed earlier than scheduled.
995 next-interval)
996 repeats
998 failures
999 meanq
1000 totaln
1001 )))
1006 ;;; Essentially copied from `org-learn.el', but modified to
1007 ;;; optionally call the SM2 or simple8 functions.
1009 "If DAYS-AHEAD is supplied it must be a positive integer. The
1010 item will be scheduled exactly this many days into the future."
1015 ;; Entries can have weights, 1 by default. Intervals are divided by the
1016 ;; item's weight, so an item with a weight of 2 will have all intervals
1017 ;; halved, meaning you will end up reviewing it twice as often.
1018 ;; Useful for entries which randomly present any of several facts.
1023 total-repeats meanq ease)
1026 failures meanq total-repeats
1030 ease quality failures
1031 meanq total-repeats ofmatrix))
1033 ease quality failures
1034 meanq total-repeats))
1036 quality failures meanq
1037 total-repeats
1038 delta-days)))
1043 total-repeats meanq ease)
1064 "Returns an integer representing the number of days into the future
1065 that the current item would be scheduled, based on a recall quality
1066 of QUALITY."
1069 total-repeats meanq ease)
1074 failures meanq total-repeats
1078 ease quality failures
1079 meanq total-repeats
1080 org-drill-optimal-factor-matrix))
1082 ease quality failures
1083 meanq total-repeats))
1085 quality failures meanq
1086 total-repeats)))
1093 next-interval))))))
1101 intervals))
1106 "Returns quality rating (0-5), or nil if the user quit."
1115 3-5 Means you have remembered the item.
1117 0 - Completely forgot.
1118 1 - Even after seeing the answer, it still took a bit to sink in.
1119 2 - After seeing the answer, you remembered it.
1120 3 - It took you awhile, but you finally remembered. (+%s days)
1121 4 - After a little bit of thought you remembered. (+%s days)
1122 5 - You remembered the item really easily. (+%s days)
1124 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1158 ;;(setq failures (if failures (string-to-number failures) 0))
1159 ;; (org-set-property "DRILL_FAILURE_COUNT"
1160 ;; (format "%d" (1+ failures)))
1173 quality))
1177 nil))))
1180 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1181 ;; "Returns a list containing the position of each immediate subheading of
1182 ;; the current topic."
1183 ;; (let ((drill-entry-level (org-current-level))
1184 ;; (drill-sections nil)
1185 ;; (drill-heading nil))
1186 ;; (org-show-subtree)
1187 ;; (save-excursion
1188 ;; (org-map-entries
1189 ;; (lambda ()
1190 ;; (when (and (not (outline-invisible-p))
1191 ;; (> (org-current-level) drill-entry-level))
1192 ;; (setq drill-heading (org-get-heading t))
1193 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1194 ;; (member drill-heading heading-list))
1195 ;; (hide-subtree))
1196 ;; (push (point) drill-sections)))
1197 ;; "" 'tree))
1198 ;; (reverse drill-sections)))
1203 "TEST is a function taking no arguments. TEST will be called for each
1204 of the immediate subheadings of the current drill item, with the point
1205 on the relevant subheading. TEST should return nil if the subheading is
1206 to be revealed, non-nil if it is to be hidden.
1207 Returns a list containing the position of each immediate subheading of
1208 the current topic."
1277 prompt))
1282 You seem to be having a lot of trouble memorising this item.
1285 prompt)))
1291 "++:++ "
1293 prompt))
1313 "Hide the buffer region between BEG and END with an 'invisible text'
1314 visual overlay, or with the string TEXT if it is supplied."
1340 ;; This will also unhide the item's heading.
1350 ;; Don't hide org links, partly because they might contain inline
1351 ;; images which we want to keep visible
1358 "Hide the current match with a 'cloze' visual overlay."
1368 ovl 'display
1369 ;; If hint is like `X...' then display [X...]
1370 ;; otherwise display [...X]
1372 hint))))))
1385 "During the execution of BODY, the entire text of the current entry is
1386 concealed by an overlay that displays the string TEXT."
1396 "Make an overlay that conceals the entire text of the item, not
1397 including properties or the contents of subheadings. The overlay shows
1398 the string TEXT.
1399 Note: does not actually alter the item."
1426 "Make an overlay that conceals the heading of the item. The overlay shows
1427 the string TEXT.
1428 Note: does not actually alter the item."
1442 text
1451 ;;; Presentation functions ====================================================
1453 ;; Each of these is called with point on topic heading. Each needs to show the
1454 ;; topic in the form of a 'question' or with some information 'hidden', as
1455 ;; appropriate for the card type. The user should then be prompted to press a
1456 ;; key. The function should then reveal either the 'answer' or the entire
1457 ;; topic, and should return t if the user chose to see the answer and rate their
1458 ;; recall, nil if they chose to quit.
1486 drill-sections))
1511 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1512 chosen at random."
1529 collect i))
1535 item-end t pos-to-hide)
1545 "Hides one of the pieces of text that are marked for cloze deletion,
1546 chosen at random."
1551 "Hides two of the pieces of text that are marked for cloze deletion,
1552 chosen at random."
1556 ;; (defun org-drill-present-multicloze-hide1 ()
1557 ;; "Hides one of the pieces of text that are marked for cloze deletion,
1558 ;; chosen at random."
1559 ;; (with-hidden-comments
1560 ;; (let ((item-end nil)
1561 ;; (match-count 0)
1562 ;; (body-start (or (cdr (org-get-property-block))
1563 ;; (point))))
1564 ;; (org-drill-hide-all-subheadings-except nil)
1565 ;; (save-excursion
1566 ;; (outline-next-heading)
1567 ;; (setq item-end (point)))
1568 ;; (save-excursion
1569 ;; (goto-char body-start)
1570 ;; (while (re-search-forward org-drill-cloze-regexp item-end t)
1571 ;; (incf match-count)))
1572 ;; (when (plusp match-count)
1573 ;; (save-excursion
1574 ;; (goto-char body-start)
1575 ;; (re-search-forward org-drill-cloze-regexp
1576 ;; item-end t (1+ (random match-count)))
1577 ;; (org-drill-hide-matched-cloze-text)))
1578 ;; (org-display-inline-images t)
1579 ;; (org-cycle-hide-drawers 'all)
1580 ;; (prog1 (org-drill-presentation-prompt)
1581 ;; (org-drill-hide-subheadings-if 'org-drill-entry-p)
1582 ;; (org-drill-unhide-clozed-text)))))
1586 "Similar to `org-drill-present-multicloze-hide1', but hides all
1587 the pieces of text that are marked for cloze deletion, except for one
1588 piece which is chosen at random."
1609 item-end t)
1620 "Present the string QUESTION as the only visible content of the card."
1623 question
1630 ;;; The following macro is necessary because `org-save-outline-visibility'
1631 ;;; currently discards the value returned by its body and returns a garbage
1632 ;;; value instead. (as at org mode v 7.5)
1635 "Store the current visibility state of the org buffer, and restore it
1636 after executing BODY. Return the value of the last expression
1637 in BODY."
1648 "Present the current topic for interactive review, as in `org-drill'.
1649 Review will occur regardless of whether the topic is due for review or whether
1650 it meets the definition of a 'review topic' used by `org-drill'.
1652 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
1653 EDIT if the user chose to exit the drill and edit the current item. Choosing
1654 the latter option leaves the drill session suspended; it can be resumed
1655 later using `org-drill-resume'.
1657 See `org-drill' for more details."
1660 ;;(unless (org-part-of-drill-entry-p)
1661 ;; (error "Point is not inside a drill entry"))
1662 ;;(unless (org-at-heading-p)
1663 ;; (org-back-to-heading))
1687 nil)
1720 "Returns true if the current drill session has continued past its
1721 maximum duration."
1729 "Returns true if the current drill session has reached the
1730 maximum number of items."
1733 org-drill-maximum-items-per-session)))
1742 m
1744 ;; First priority is items we failed in a prior session.
1750 ;; Next priority is overdue items.
1754 ;; We use `pop', not `pop-random', because we have already
1755 ;; sorted overdue items into a random order which takes
1756 ;; number of days overdue into account.
1759 ;; Next priority is 'young' items.
1765 ;; Next priority is newly added items, and older entries.
1766 ;; We pool these into a single group.
1780 ;; After all the above are done, last priority is items
1781 ;; that were failed earlier THIS SESSION.
1787 m)))
1791 "Returns nil, t, or a list of markers representing entries that were
1792 'failed' and need to be presented again before the session ends.
1794 RESUMING-P is true if we are resuming a suspended drill session."
1842 "%d items reviewed. Session duration %s.
1843 %d/%d items awaiting review (%s, %s, %s, %s, %s).
1845 Recall of reviewed items:
1846 Excellent (5): %3d%% | Near miss (2): %3d%%
1847 Good (4): %3d%% | Failure (1): %3d%%
1848 Hard (3): %3d%% | Abject failure (0): %3d%%
1850 You successfully recalled %d%% of reviewed items (quality > %s)
1851 Tomorrow, %d more items will become due for review.
1852 Session finished. Press a key to continue..."
1892 pass-percent
1893 org-drill-failure-quality
1895 ))
1905 "%s
1906 You failed %d%% of the items you reviewed during this session.
1907 %d (%d%%) of all items scanned were overdue.
1909 Are you keeping up with your items, and reviewing them
1910 when they are scheduled? If so, you may want to consider
1911 lowering the value of `org-drill-learn-fraction' slightly in
1912 order to make items appear more frequently over time."
1919 ))))
1942 "Begin an interactive 'drill session'. The user is asked to
1943 review a series of topics (headers). Each topic is initially
1944 presented as a 'question', often with part of the topic content
1945 hidden. The user attempts to recall the hidden information or
1946 answer the question, then presses a key to reveal the answer. The
1947 user then rates his or her recall or performance on that
1948 topic. This rating information is used to reschedule the topic
1949 for future review.
1951 Org-drill proceeds by:
1953 - Finding all topics (headings) in SCOPE which have either been
1954 used and rescheduled before, or which have a tag that matches
1955 `org-drill-question-tag'.
1957 - All matching topics which are either unscheduled, or are
1958 scheduled for the current date or a date in the past, are
1959 considered to be candidates for the drill session.
1961 - If `org-drill-maximum-items-per-session' is set, a random
1962 subset of these topics is presented. Otherwise, all of the
1963 eligible topics will be presented.
1965 SCOPE determines the scope in which to search for
1966 questions. It is passed to `org-map-entries', and can be any of:
1968 nil The current buffer, respecting the restriction if any.
1969 This is the default.
1970 tree The subtree started with the entry at point
1971 file The current buffer, without restriction
1972 file-with-archives
1973 The current buffer, and any archives associated with it
1974 agenda All agenda files
1975 agenda-with-archives
1976 All agenda files with any archive files associated with them
1977 (file1 file2 ...)
1978 If this is a list, all files in the list will be scanned.
1980 If RESUME-P is non-nil, resume a suspended drill session rather
1981 than starting a new one."
2044 org-drill-failure-quality)
2045 ;; Mature entries that were failed last time are
2046 ;; FAILED, regardless of how young, old or overdue
2047 ;; they are.
2050 ;; Overdue status overrides young versus old
2051 ;; distinction.
2052 ;; Store marker + due, for sorting of overdue entries
2055 org-drill-days-before-old)
2056 ;; Item is 'young'.
2062 scope)
2063 ;; Order 'overdue' items so that the most overdue will tend to
2064 ;; come up for review first, while keeping exact order random
2092 ))))
2099 org-drill-optimal-factor-matrix))
2103 "Run an interactive drill session in 'cram mode'. In cram mode,
2104 all drill items are considered to be due for review, unless they
2105 have been reviewed within the last `org-drill-cram-hours'
2106 hours."
2113 "Run an interactive drill session using drill items within the
2114 subtree at point."
2120 "Resume a suspended drill session. Sessions are suspended by
2121 exiting them with the `edit' option."
2133 "Delete scheduling data from every drill entry in scope. This
2134 function may be useful if you want to give your collection of
2135 entries to someone else. Scope defaults to the current buffer,
2136 and is specified by the argument SCOPE, which accepts the same
2137 values as `org-drill'."
2143 ;; Scope is the current buffer. This means we can use
2144 ;; `org-delete-property-globally', which is faster.
2158 org-drill-cloze-keywords
2159 nil))))
2162 ;;; Synching card collections =================================================
2169 "Copy the subtree at point to the buffer DEST. The copy will receive
2170 the tag 'imported'."
2201 ;; We've looked all the way up the path
2202 ;; Default to appending to the end of DEST
2211 )))))
2216 "SRC and DEST are two org mode buffers containing drill items.
2217 For each drill item in DEST that shares an ID with an item in SRC,
2218 overwrite scheduling data in DEST with data taken from the item in SRC.
2219 This is intended for use when two people are sharing a set of drill items,
2220 one person has made some updates to the item set, and the other person
2221 wants to migrate to the updated set without losing their scheduling data."
2222 ;; In future could look at what to do if we find an item in SRC whose ID
2223 ;; is not present in DEST -- copy the whole item to DEST?
2224 ;; org-copy-subtree --> org-paste-subtree
2225 ;; could try to put it "near" the closest marker
2236 ;; Compile list of all IDs in the destination buffer.
2244 ;; Look through all entries in source buffer.
2254 nil)
2256 ;; This entry matches an entry in dest. Retrieve all its
2257 ;; scheduling data, then go to the matching location in dest
2258 ;; and write the data.
2261 total-repeats meanq ease)
2267 ;; go to matching entry in destination buffer
2273 total-repeats meanq ease)
2280 ;; item in SRC has ID, but no matching ID in DEST.
2281 ;; It must be a new item that does not exist in DEST.
2282 ;; Copy the entire item to the *end* of DEST.
2287 ;;; Card types for learning languages =========================================
2289 ;;; Get spell-number.el from:
2290 ;;; http://www.emacswiki.org/emacs/spell-number.el
2294 ;;; `conjugate' card type =====================================================
2295 ;;; See spanish.org for usage
2301 ;; past tenses
2307 ;; future tenses
2309 "Alist where each entry has the form (TENSE COLOUR), where
2310 TENSE is a string naming a tense in which verbs can be
2311 conjugated, and COLOUR is a string specifying a foreground colour
2312 which will be used by `org-drill-present-verb-conjugation' and
2313 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2318 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2319 `org-drill-show-answer-verb-conjugation'."
2341 "Present a drill entry whose card type is 'conjugate'."
2348 infinitive tense))
2351 translation tense))))))
2355 "Show the answer for a drill item whose card type is 'conjugate'.
2356 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2357 returns its return value."
2363 infinitive translation)
2367 ;;; `translate_number' card type ==============================================
2368 ;;; See spanish.org for usage
2388 num-max num-min))
2423 non-english english))
2427 english non-english)))
2431 ;;; `spanish_verb' card type ==================================================
2432 ;;; Not very interesting, but included to demonstrate how a presentation
2433 ;;; function can manipulate which subheading are hidden versus shown.