| blob | a1422ebe9a9168d5e77c255563f768ecb24eabc2 |
1 ;;; -*- coding: utf-8-unix -*-
2 ;;; org-drill.el - Self-testing using spaced repetition
3 ;;;
4 ;;; Author: Paul Sexton <eeeickythump@gmail.com>
5 ;;; Version: 2.4.3
6 ;;; Repository at http://bitbucket.org/eeeickythump/org-drill/
7 ;;;
8 ;;;
9 ;;; Synopsis
10 ;;; ========
11 ;;;
12 ;;; Uses the SuperMemo spaced repetition algorithms to conduct interactive
13 ;;; "drill sessions", where the material to be remembered is presented to the
14 ;;; student in random order. The student rates his or her recall of each item,
15 ;;; and this information is used to schedule the item for later revision.
16 ;;;
17 ;;; Each drill session can be restricted to topics in the current buffer
18 ;;; (default), one or several files, all agenda files, or a subtree. A single
19 ;;; topic can also be drilled.
20 ;;;
21 ;;; Different "card types" can be defined, which present their information to
22 ;;; the student in different ways.
23 ;;;
24 ;;; See the file README.org for more detailed documentation.
37 "Options concerning interactive drill sessions in Org mode (org-drill)."
44 "drill"
45 "Tag which topics must possess in order to be identified as review topics
46 by `org-drill'."
52 30
53 "Each drill session will present at most this many topics for review.
54 Nil means unlimited."
61 20
62 "Maximum duration of a drill session, in minutes.
63 Nil means unlimited."
69 2
70 "If the quality of recall for an item is this number or lower,
71 it is regarded as an unambiguous failure, and the repetition
72 interval for the card is reset to 0 days. If the quality is higher
73 than this number, it is regarded as successfully recalled, but the
74 time interval to the next repetition will be lowered if the quality
75 was near to a fail.
77 By default this is 2, for SuperMemo-like behaviour. For
78 Mnemosyne-like behaviour, set it to 1. Other values are not
79 really sensible."
85 10
86 "What percentage of items do you consider it is 'acceptable' to
87 forget each drill session? The default is 10%. A warning message
88 is displayed at the end of the session if the percentage forgotten
89 climbs above this number."
95 15
96 "If an item is forgotten more than this many times, it is tagged
97 as a 'leech' item."
103 'skip
104 "How should 'leech items' be handled during drill sessions?
105 Possible values:
106 - nil :: Leech items are treated the same as normal items.
107 - skip :: Leech items are not included in drill sessions.
108 - warn :: Leech items are still included in drill sessions,
109 but a warning message is printed when each leech item is
110 presented."
117 "The face used to hide the contents of cloze phrases."
123 "The face used to hide the contents of cloze phrases."
129 "The face used to hide the contents of cloze phrases."
134 nil
135 "Use a special face to highlight cloze-deleted text in org mode
136 buffers?"
142 nil
143 "Conceal the contents of the main heading of each item during drill
144 sessions? You may want to enable this behaviour if item headings or tags
145 contain information that could 'give away' the answer."
151 "royal blue"
152 "Foreground colour used to display the count of remaining new items
153 during a drill session."
158 "green"
159 "Foreground colour used to display the count of remaining mature items
160 during a drill session. Mature items are due for review, but are not new."
165 "red"
166 "Foreground colour used to display the count of remaining failed items
167 during a drill session."
172 "sienna"
173 "Foreground colour used to display the count of reviewed items
174 during a drill session."
179 "["
180 "String used within org buffers to delimit cloze deletions."
185 "]"
186 "String used within org buffers to delimit cloze deletions."
193 org-drill-left-cloze-delimiter
194 org-drill-right-cloze-delimiter)
195 face org-drill-hidden-cloze-face
196 window t))
203 face default
204 window t))
208 "String which, if it occurs within a cloze expression, signifies that the
209 rest of the expression after the string is a `hint', to be displayed instead of
226 )))
252 org-drill-present-verb-conjugation
253 org-drill-show-answer-verb-conjugation)
255 org-drill-present-noun-declension
256 org-drill-show-answer-noun-declension)
259 "Alist associating card types with presentation functions. Each
260 entry in the alist takes the form:
262 ;;; (CARDTYPE QUESTION-FN [ANSWER-FN DRILL-EMPTY-P])
264 Where CARDTYPE is a string or nil (for default), and QUESTION-FN
265 is a function which takes no arguments and returns a boolean
266 value.
268 When supplied, ANSWER-FN is a function that takes one argument --
269 that argument is a function of no arguments, which when called,
270 prompts the user to rate their recall and performs rescheduling
271 of the drill item. ANSWER-FN is called with the point on the
272 active item's heading, just prior to displaying the item's
273 'answer'. It can therefore be used to modify the appearance of
274 the answer. ANSWER-FN must call its argument before returning.
276 When supplied, DRILL-EMPTY-P is a boolean value, default nil.
277 When non-nil, cards of this type will be presented during tests
278 even if their bodies are empty."
285 'file
286 "The scope in which to search for drill items when conducting a
287 drill session. This can be any of:
289 file The current buffer, respecting the restriction if any.
290 This is the default.
291 tree The subtree started with the entry at point
292 file-no-restriction The current buffer, without restriction
293 file-with-archives The current buffer, and any archives associated with it.
294 agenda All agenda files
295 agenda-with-archives All agenda files with any archive files associated
296 with them.
297 directory All files with the extension '.org' in the same
298 directory as the current file (includes the current
299 file if it is an .org file.)
300 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
301 "
302 ;; Note -- meanings differ slightly from the argument to org-map-entries:
303 ;; 'file' means current file/buffer, respecting any restriction
304 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
305 ;; 'directory' means all *.org files in current directory
312 (const :tag "All agenda files with any archive files associated with them." agenda-with-archives)
313 (const :tag "All files with the extension '.org' in the same directory as the current file (includes the current file if it is an .org file.)" directory)
318 nil
319 "If non-nil, a string specifying a tags/property/TODO query. During
320 drill sessions, only items that match this query will be considered."
326 t
327 "If non-nil, prompt to save all modified buffers after a drill session
328 finishes."
334 'sm5
335 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
336 Available choices are:
337 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
338 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
339 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
340 SuperMemo 98. The version implemented here is simplified in that while it
341 'learns' the difficulty of each item using quality grades and number of
342 failures, it does not modify the matrix of values that
343 governs how fast the inter-repetition intervals increase. A method for
344 adjusting intervals when items are reviewed early or late has been taken
345 from SM11, a later version of the algorithm, and included in Simple8."
351 nil
352 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
354 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
355 The matrix is saved (using the 'customize' facility) at the end of each
356 drill session.
358 Over time, values in the matrix will adapt to the individual user's
359 pace of learning."
365 4.0
366 "In the SM5 algorithm, the initial interval after the first
367 successful presentation of an item is always 4 days. If you wish to change
368 this, you can do so here."
374 nil
375 "If true, the number of days until an item's next repetition
376 will vary slightly from the interval calculated by the SM2
377 algorithm. The variation is very small when the interval is
378 small, but scales up with the interval."
384 nil
385 "If true, when the student successfully reviews an item 1 or more days
386 before or after the scheduled review date, this will affect that date of
387 the item's next scheduled review, according to the algorithm presented at
388 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
390 Items that were reviewed early will have their next review date brought
391 forward. Those that were reviewed late will have their next review
392 date postponed further.
394 Note that this option currently has no effect if the SM2 algorithm
395 is used."
401 4
402 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
403 this number determines how often the 'less favoured' situation
404 should arise. It will occur 1 in every N trials, where N is the
405 value of the variable.
407 For example, with the hide1_firstmore card type, the first piece
408 of clozed text should be hidden more often than the other
409 pieces. If this variable is set to 4 (default), the first item
410 will only be shown 25% of the time (1 in 4 trials). Similarly for
411 show1_lastmore, the last item will be shown 75% of the time, and
412 for show1_firstless, the first item would only be shown 25% of the
413 time.
415 If the value of this variable is NIL, then weighting is disabled, and
416 all weighted card types are treated as their unweighted equivalents."
422 12
423 "When in cram mode, items are considered due for review if
424 they were reviewed at least this many hours ago."
429 ;;; NEW items have never been presented in a drill session before.
430 ;;; MATURE items HAVE been presented at least once before.
431 ;;; - YOUNG mature items were scheduled no more than
432 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
433 ;;; repetition. These items will have been learned 'recently' and will have a
434 ;;; low repetition count.
435 ;;; - OLD mature items have intervals greater than
436 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
437 ;;; - OVERDUE items are past their scheduled review date by more than
438 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
439 ;;; regardless of young/old status.
443 10
444 "When an item's inter-repetition interval rises above this value in days,
445 it is no longer considered a 'young' (recently learned) item."
451 1.2
452 "An item is considered overdue if its scheduled review date is
453 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
454 days in the past. For example, a value of 1.2 means an additional
455 20% of the last scheduled interval is allowed to elapse before
456 the item is overdue. A value of 1.0 means no extra time is
457 allowed at all - items are immediately considered overdue if
458 there is even one day's delay in reviewing them. This variable
459 should never be less than 1.0."
465 0.5
466 "Fraction between 0 and 1 that governs how quickly the spaces
467 between successive repetitions increase, for all items. The
468 default value is 0.5. Higher values make spaces increase more
469 quickly with each successful repetition. You should only change
470 this in small increments (for example 0.05-0.1) as it has an
471 exponential effect on inter-repetition spacing."
477 "Global variable that can be bound to a correct answer when an
478 item is being presented. If this variable is non-nil, the default
479 presentation function will show its value instead of the default
480 behaviour of revealing the contents of the drilled item.
482 This variable is useful for card types that compute their answers
483 -- for example, a card type that asks the student to translate a
495 "List of markers for items that are considered 'overdue', based on
498 "List of markers for mature entries whose last inter-repetition
501 "List of markers for mature entries whose last inter-repetition
509 "Are we in 'cram mode', where all items are considered due
517 ;;; Make the above settings safe as file-local variables.
553 ;;;; Utilities ================================================================
563 nil
571 "Add VAL to the end of the sequence stored in PLACE. Return the new
572 value."
577 "Randomly permute the elements of LIST (all permutations equally likely)."
578 ;; Adapted from 'shuffle-vector' in cookie1.el
580 j
581 temp
589 list)
593 "Round the floating point number FLOATNUM to FIX decimal places.
594 Example: (round-float 3.56755765 3) -> 3.568"
600 "Return a human-readable description of the key/keys to which the command
601 CMD is bound, or nil if it is not bound to a key."
609 time))
615 time))
619 "Like `org-map-entries', but only drill entries are processed."
635 skip)))
668 "Nil means a last review date has not yet been stored for
669 the item.
670 Zero means it was reviewed today.
671 A positive number means it was reviewed that many days ago.
672 A negative number means the date of last review is in the future --
673 this should never happen."
682 "Like `org-drill-days-since-last-review', but return value is
683 in hours rather than days."
694 "Is MARKER, or the point, in a 'drill item'? This will return nil if
695 the point is inside a subheading of a drill item -- to handle that
696 situation use `org-part-of-drill-entry-p'."
709 "Is the current entry either the main heading of a 'drill item',
710 or a subheading within a drill item?"
712 ;; Does this heading INHERIT the drill tag
717 "Move the point to the heading which holds the :drill: tag for this
718 drill entry."
730 "Is the current entry a 'leech item'?"
735 ;; (defun org-drill-entry-due-p ()
736 ;; (cond
737 ;; (*org-drill-cram-mode*
738 ;; (let ((hours (org-drill-hours-since-last-review)))
739 ;; (and (org-drill-entry-p)
740 ;; (or (null hours)
741 ;; (>= hours org-drill-cram-hours)))))
742 ;; (t
743 ;; (let ((item-time (org-get-scheduled-time (point))))
744 ;; (and (org-drill-entry-p)
745 ;; (or (not (eql 'skip org-drill-leech-method))
746 ;; (not (org-drill-entry-leech-p)))
747 ;; (or (null item-time) ; not scheduled
748 ;; (not (minusp ; scheduled for today/in past
749 ;; (- (time-to-days (current-time))
750 ;; (time-to-days item-time))))))))))
754 "Returns:
755 - NIL if the item is not to be regarded as scheduled for review at all.
756 This is the case if it is not a drill item, or if it is a leech item
757 that we wish to skip, or if we are in cram mode and have already reviewed
758 the item within the last few hours.
759 - 0 if the item is new, or if it scheduled for review today.
760 - A negative integer - item is scheduled that many days in the future.
761 - A positive integer - item is scheduled that many days in the past."
775 nil)
784 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
785 and whose last inter-repetition interval was LAST-INTERVAL, should be
786 considered 'overdue'. If the arguments are not given they are extracted
787 from the entry at point."
794 ;;(> due org-drill-days-before-overdue)
796 org-drill-overdue-interval-factor)))
816 default)))
854 default)))
857 ;;; From http://www.supermemo.com/english/ol/sm5.htm
859 "Returns a random number between 0.5 and 1.5."
872 "Random numbers in a pseudo-normal distribution with mean MEAN, range
873 MEAN-VARIATION to MEAN+VARIATION"
877 mean))
881 optimal-interval
882 days-ahead)
883 "Arguments:
884 - OPTIMAL-FACTOR: interval-factor if the item had been tested
885 exactly when it was supposed to be.
886 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
887 tested exactly when it was supposed to be.
888 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
890 Returns an adjusted optimal factor which should be used to
891 calculate the next interval, instead of the optimal factor found
892 in the matrix."
894 (/ (+ optimal-interval
901 "Returns a list of 6 items, containing all the stored recall
902 data for the item at point:
903 - LAST-INTERVAL is the interval in days that was used to schedule the item's
904 current review date.
905 - REPEATS is the number of items the item has been successfully recalled without
906 without any failures. It is reset to 0 upon failure to recall the item.
907 - FAILURES is the total number of times the user has failed to recall the item.
908 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
909 - AVERAGE-QUALITY is the mean quality of recall of the item over
910 all its repetitions, successful and unsuccessful.
911 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
912 "
926 )))
939 total-repeats meanq
940 ease)
941 "Stores the given data in the item at point."
955 ;;; SM2 Algorithm =============================================================
959 failures meanq total-repeats)
960 "Arguments:
961 - LAST-INTERVAL -- the number of days since the item was last reviewed.
962 - REPEATS -- the number of times the item has been successfully reviewed
963 - EF -- the 'easiness factor'
964 - QUALITY -- 0 to 5
966 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
967 - INTERVAL is the number of days until the item should next be reviewed
968 - REPEATS is incremented by 1.
969 - EF is modified based on the recall quality for the item.
970 - OF-MATRIX is not modified."
974 ;; When an item is failed, its interval is reset to 0,
975 ;; but its EF is unchanged
977 org-drill-optimal-factor-matrix)
978 ;; else:
997 interval)
999 next-ef
1001 org-drill-optimal-factor-matrix))))
1004 ;;; SM5 Algorithm =============================================================
1010 org-drill-sm5-initial-interval
1011 ef))
1023 org-drill-optimal-factor-matrix))))
1025 of
1030 failures meanq total-repeats
1043 quality))
1048 quality org-drill-learn-fraction))
1055 last-interval n ef of-matrix)
1056 delta-days)))
1065 ;; "Failed" -- reset repetitions to 0,
1069 ; preserved
1070 ;; For a zero-based quality of 4 or 5, don't repeat
1071 ;; ((and (>= quality 4)
1072 ;; (not org-learn-always-reschedule))
1073 ;; (list 0 (1+ n) ef failures meanq
1074 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
1077 last-interval n ef of-matrix))
1082 ef
1083 failures
1084 meanq
1086 of-matrix)))))
1089 ;;; Simple8 Algorithm =========================================================
1093 "Arguments:
1094 - FAILURES: integer >= 0. The total number of times the item has
1095 been forgotten, ever.
1097 Returns the optimal FIRST interval for an item which has previously been
1098 forgotten on FAILURES occasions."
1103 "Arguments:
1104 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
1105 - REPETITION: the number of times the item has been tested.
1106 1 is the first repetition (ie the second trial).
1107 Returns:
1108 The factor by which the last interval should be
1109 multiplied to give the next interval. Corresponds to `RF' or `OF'."
1114 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
1115 to a mean item quality of QUALITY."
1124 failures meanq totaln
1126 "Arguments:
1127 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1128 - REPEATS -- the number of times the item has been successfully reviewed
1129 - EASE -- the 'easiness factor'
1130 - QUALITY -- 0 to 5
1131 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
1132 0 = reviewed on the scheduled day. +N = N days overdue.
1133 -N = reviewed N days early.
1135 Returns the new item data, as a list of 6 values:
1136 - NEXT-INTERVAL
1137 - REPEATS
1138 - EASE
1139 - FAILURES
1140 - AVERAGE-QUALITY
1141 - TOTAL-REPEATS.
1142 See the documentation for `org-drill-get-item-data' for a description of these."
1149 quality))
1163 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1167 repeats))
1173 ;; The item was reviewed earlier than scheduled.
1184 next-interval)
1185 repeats
1187 failures
1188 meanq
1189 totaln
1190 )))
1195 ;;; Essentially copied from `org-learn.el', but modified to
1196 ;;; optionally call the SM2 or simple8 functions.
1198 "If DAYS-AHEAD is supplied it must be a positive integer. The
1199 item will be scheduled exactly this many days into the future."
1204 ;; Entries can have weights, 1 by default. Intervals are divided by the
1205 ;; item's weight, so an item with a weight of 2 will have all intervals
1206 ;; halved, meaning you will end up reviewing it twice as often.
1207 ;; Useful for entries which randomly present any of several facts.
1212 total-repeats meanq ease)
1215 failures meanq total-repeats
1219 ease quality failures
1220 meanq total-repeats ofmatrix))
1222 ease quality failures
1223 meanq total-repeats))
1225 quality failures meanq
1226 total-repeats
1227 delta-days)))
1239 total-repeats meanq ease)
1256 "Returns an integer representing the number of days into the future
1257 that the current item would be scheduled, based on a recall quality
1258 of QUALITY."
1261 total-repeats meanq ease)
1266 failures meanq total-repeats
1270 ease quality failures
1271 meanq total-repeats
1272 org-drill-optimal-factor-matrix))
1274 ease quality failures
1275 meanq total-repeats))
1277 quality failures meanq
1278 total-repeats)))
1283 (+ last-interval
1286 next-interval))))))
1294 intervals))
1299 "Returns quality rating (0-5), or nil if the user quit."
1308 3-5 Means you have remembered the item.
1310 0 - Completely forgot.
1311 1 - Even after seeing the answer, it still took a bit to sink in.
1312 2 - After seeing the answer, you remembered it.
1313 3 - It took you awhile, but you finally remembered. (+%s days)
1314 4 - After a little bit of thought you remembered. (+%s days)
1315 5 - You remembered the item really easily. (+%s days)
1317 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1353 ;;(setq failures (if failures (string-to-number failures) 0))
1354 ;; (org-set-property "DRILL_FAILURE_COUNT"
1355 ;; (format "%d" (1+ failures)))
1368 quality))
1372 nil))))
1375 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1376 ;; "Returns a list containing the position of each immediate subheading of
1377 ;; the current topic."
1378 ;; (let ((drill-entry-level (org-current-level))
1379 ;; (drill-sections nil)
1380 ;; (drill-heading nil))
1381 ;; (org-show-subtree)
1382 ;; (save-excursion
1383 ;; (org-map-entries
1384 ;; (lambda ()
1385 ;; (when (and (not (outline-invisible-p))
1386 ;; (> (org-current-level) drill-entry-level))
1387 ;; (setq drill-heading (org-get-heading t))
1388 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1389 ;; (member drill-heading heading-list))
1390 ;; (hide-subtree))
1391 ;; (push (point) drill-sections)))
1392 ;; "" 'tree))
1393 ;; (reverse drill-sections)))
1398 "TEST is a function taking no arguments. TEST will be called for each
1399 of the immediate subheadings of the current drill item, with the point
1400 on the relevant subheading. TEST should return nil if the subheading is
1401 to be revealed, non-nil if it is to be hidden.
1402 Returns a list containing the position of each immediate subheading of
1403 the current topic."
1478 prompt))
1483 You seem to be having a lot of trouble memorising this item.
1486 prompt)))
1492 "++:++ "
1494 prompt))
1514 "Hide the buffer region between BEG and END with an 'invisible text'
1515 visual overlay, or with the string TEXT if it is supplied."
1542 ;; This will also unhide the item's heading.
1552 ;; Don't hide:
1553 ;; - org links, partly because they might contain inline
1554 ;; images which we want to keep visible.
1555 ;; - LaTeX math fragments
1556 ;; - the contents of SRC blocks
1566 "Hide the current match with a 'cloze' visual overlay."
1580 ovl 'display
1581 ;; If hint is like `X...' then display [X...]
1582 ;; otherwise display [...X]
1584 hint))))))
1598 "During the execution of BODY, the entire text of the current entry is
1599 concealed by an overlay that displays the string TEXT."
1609 "During the execution of BODY, the entire text of the current entry is
1610 concealed by an overlay that displays the overlays in REPLACEMENTS."
1620 "Make an overlay that conceals the entire text of the item, not
1621 including properties or the contents of subheadings. The overlay shows
1622 the string TEXT.
1623 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1624 for the `display' text property. The text of the item will be temporarily
1625 replaced by all of these items, in the order in which they appear in
1626 the list.
1627 Note: does not actually alter the item."
1651 "Make overlays that conceal the entire text of the item, not
1652 including properties or the contents of subheadings. The overlay shows
1653 the string TEXT.
1654 Note: does not actually alter the item."
1664 p-max
1682 "Make an overlay that conceals the heading of the item. The overlay shows
1683 the string TEXT.
1684 Note: does not actually alter the item."
1698 text
1702 ;; (defun org-entry-empty-p ()
1703 ;; (zerop (length (org-drill-get-entry-text))))
1705 ;; This version is about 5x faster than the old version, above.
1718 ;;; Presentation functions ====================================================
1719 ;;
1720 ;; Each of these is called with point on topic heading. Each needs to show the
1721 ;; topic in the form of a 'question' or with some information 'hidden', as
1722 ;; appropriate for the card type. The user should then be prompted to press a
1723 ;; key. The function should then reveal either the 'answer' or the entire
1724 ;; topic, and should return t if the user chose to see the answer and rate their
1725 ;; recall, nil if they chose to quit.
1775 drill-sections))
1804 &optional
1805 force-show-first
1806 force-show-last
1807 force-hide-first)
1808 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1809 chosen at random.
1810 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1811 hiding all the rest.
1812 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1813 the hidden items.
1814 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1815 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1816 If the number of text pieces in the item is less than
1817 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1818 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1844 to match-count
1845 collect i)))
1849 ;; Force '1' to be in the list, and to be the first item
1850 ;; in the list.
1859 ;; (dolist (pos-to-hide match-nums)
1871 ;; (loop
1872 ;; do (re-search-forward org-drill-cloze-regexp
1873 ;; item-end t pos-to-hide)
1874 ;; while (org-pos-in-regexp (match-beginning 0)
1875 ;; org-bracket-link-regexp 1))
1876 ;; (org-drill-hide-matched-cloze-text)))))
1887 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1888 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1889 the second to last, etc."
1915 nil)
1922 ;; Don't consider this a cloze region if it is part of an
1923 ;; org link, or if it occurs inside a LaTeX math
1924 ;; fragment
1941 "Hides one of the pieces of text that are marked for cloze deletion,
1942 chosen at random."
1947 "Hides two of the pieces of text that are marked for cloze deletion,
1948 chosen at random."
1953 "Hides the first piece of text that is marked for cloze deletion."
1958 "Hides the last piece of text that is marked for cloze deletion."
1963 "Commonly, hides the FIRST piece of text that is marked for
1964 cloze deletion. Uncommonly, hide one of the other pieces of text,
1965 chosen at random.
1967 The definitions of 'commonly' and 'uncommonly' are determined by
1968 the value of `org-drill-cloze-text-weight'."
1969 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1970 ;; to hide the 'favoured' piece of text. However even when the chance of
1971 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1972 ;; the small number of repetitions where most learning takes place for each
1973 ;; item. In other words, the actual frequency during the first 10 repetitions
1974 ;; was often very different from 80%. Hence we use modulo instead.
1977 ;; Behave as hide1cloze
1982 org-drill-cloze-text-weight))
1984 org-drill-cloze-text-weight))
1985 ;; Uncommonly, hide any item except the first
1988 ;; Commonly, hide first item
1993 "Commonly, hides all pieces except the last. Uncommonly, shows
1994 any random piece. The effect is similar to 'show1cloze' except
1995 that the last item is much less likely to be the item that is
1996 visible.
1998 The definitions of 'commonly' and 'uncommonly' are determined by
1999 the value of `org-drill-cloze-text-weight'."
2002 ;; Behave as show1cloze
2007 org-drill-cloze-text-weight))
2009 org-drill-cloze-text-weight))
2010 ;; Uncommonly, show any item except the last
2013 ;; Commonly, show the LAST item
2018 "Commonly, hides all pieces except one, where the shown piece
2019 is guaranteed NOT to be the first piece. Uncommonly, shows any
2020 random piece. The effect is similar to 'show1cloze' except that
2021 the first item is much less likely to be the item that is
2022 visible.
2024 The definitions of 'commonly' and 'uncommonly' are determined by
2025 the value of `org-drill-cloze-text-weight'."
2028 ;; Behave as show1cloze
2033 org-drill-cloze-text-weight))
2035 org-drill-cloze-text-weight))
2036 ;; Uncommonly, show the first item
2039 ;; Commonly, show any item, except the first
2044 "Similar to `org-drill-present-multicloze-hide1', but hides all
2045 the pieces of text that are marked for cloze deletion, except for one
2046 piece which is chosen at random."
2051 "Similar to `org-drill-present-multicloze-show1', but reveals two
2052 pieces rather than one."
2057 "Present the string QUESTION as the only visible content of the card.
2058 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2072 "TEXTS is a list of valid values for the 'display' text property.
2073 Present these overlays, in sequence, as the only
2074 visible content of the card.
2075 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2079 replacements
2089 "Present the current topic for interactive review, as in `org-drill'.
2090 Review will occur regardless of whether the topic is due for review or whether
2091 it meets the definition of a 'review topic' used by `org-drill'.
2093 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
2094 EDIT if the user chose to exit the drill and edit the current item. Choosing
2095 the latter option leaves the drill session suspended; it can be resumed
2096 later using `org-drill-resume'.
2098 See `org-drill' for more details."
2101 ;;(unless (org-part-of-drill-entry-p)
2102 ;; (error "Point is not inside a drill entry"))
2103 ;;(unless (org-at-heading-p)
2104 ;; (org-back-to-heading))
2109 ;; fontification functions in `outline-view-change-hook' can cause big
2110 ;; slowdowns, so we temporarily bind this variable to nil here.
2138 nil)
2174 "Returns true if the current drill session has continued past its
2175 maximum duration."
2184 "Returns true if the current drill session has reached the
2185 maximum number of items."
2189 org-drill-maximum-items-per-session)))
2198 m
2200 ;; First priority is items we failed in a prior session.
2205 ;; Next priority is overdue items.
2209 ;; We use `pop', not `pop-random', because we have already
2210 ;; sorted overdue items into a random order which takes
2211 ;; number of days overdue into account.
2213 ;; Next priority is 'young' items.
2218 ;; Next priority is newly added items, and older entries.
2219 ;; We pool these into a single group.
2231 ;; After all the above are done, last priority is items
2232 ;; that were failed earlier THIS SESSION.
2237 m)))
2241 "Returns nil, t, or a list of markers representing entries that were
2242 'failed' and need to be presented again before the session ends.
2244 RESUMING-P is true if we are resuming a suspended drill session."
2262 ;; The entry is not due anymore. This could arise if the user
2263 ;; suspends a drill session, then drills an individual entry,
2264 ;; then resumes the session.
2267 nil)
2304 "%d items reviewed. Session duration %s.
2305 Recall of reviewed items:
2306 Excellent (5): %3d%% | Near miss (2): %3d%%
2307 Good (4): %3d%% | Failure (1): %3d%%
2308 Hard (3): %3d%% | Abject failure (0): %3d%%
2310 You successfully recalled %d%% of reviewed items (quality > %s)
2311 %d/%d items still await review (%s, %s, %s, %s, %s).
2312 Tomorrow, %d more items will become due for review.
2313 Session finished. Press a key to continue..."
2329 pass-percent
2330 org-drill-failure-quality
2356 ))
2367 "%s
2368 You failed %d%% of the items you reviewed during this session.
2369 %d (%d%%) of all items scanned were overdue.
2371 Are you keeping up with your items, and reviewing them
2372 when they are scheduled? If so, you may want to consider
2373 lowering the value of `org-drill-learn-fraction' slightly in
2374 order to make items appear more frequently over time."
2381 ))))
2386 "MARKERS is a list of markers, all of which will be freed (set to
2387 point nowhere). Alternatively, MARKERS can be 't', in which case
2388 all the markers used by Org-Drill will be freed."
2397 markers))
2401 ;;; overdue-data is a list of entries, each entry has the form (POS DUE AGE)
2402 ;;; where POS is a marker pointing to the start of the entry, and
2403 ;;; DUE is a number indicating how many days ago the entry was due.
2404 ;;; AGE is the number of days elapsed since item creation (nil if unknown).
2405 ;;; if age > 60, sort by age (oldest first)
2406 ;;; if age < 60, sort by due (biggest first)
2408 ;;; if (age a) <= 60 and (age b) <= 60, sort by due
2409 ;;; else sort by age
2414 overdue-data))
2434 "If USE-LAST-INTERVAL-P is non-nil, and DATE_ADDED is missing, use the
2435 value of DRILL_LAST_INTERVAL instead (as the item's age must be at least
2436 that many days)."
2448 "Returns a list (STATUS DUE AGE) where DUE is the number of days overdue,
2449 zero being due today, -1 being scheduled 1 day in the future.
2450 AGE is the number of days elapsed since the item was created (nil if unknown).
2451 STATUS is one of the following values:
2452 - nil, if the item is not a drill entry, or has an empty body
2453 - :unscheduled
2454 - :future
2455 - :new
2456 - :failed
2457 - :overdue
2458 - :young
2459 - :old
2460 "
2470 nil)
2476 ;; body is empty, and this is not a card type where empty bodies are
2477 ;; meaningful, so skip it.
2478 nil)
2481 ;; ((eql -1 due)
2482 ;; :tomorrow)
2485 ;; The rest of the stati all denote 'due' items ==========================
2487 org-drill-failure-quality)
2488 ;; Mature entries that were failed last time are
2489 ;; FAILED, regardless of how young, old or overdue
2490 ;; they are.
2495 ;; Overdue status overrides young versus old
2496 ;; distinction.
2497 ;; Store marker + due, for sorting of overdue entries
2500 org-drill-days-before-old)
2504 due age))))
2513 collected
2515 sym2)
2517 sym1)))))
2521 "Begin an interactive 'drill session'. The user is asked to
2522 review a series of topics (headers). Each topic is initially
2523 presented as a 'question', often with part of the topic content
2524 hidden. The user attempts to recall the hidden information or
2525 answer the question, then presses a key to reveal the answer. The
2526 user then rates his or her recall or performance on that
2527 topic. This rating information is used to reschedule the topic
2528 for future review.
2530 Org-drill proceeds by:
2532 - Finding all topics (headings) in SCOPE which have either been
2533 used and rescheduled before, or which have a tag that matches
2534 `org-drill-question-tag'.
2536 - All matching topics which are either unscheduled, or are
2537 scheduled for the current date or a date in the past, are
2538 considered to be candidates for the drill session.
2540 - If `org-drill-maximum-items-per-session' is set, a random
2541 subset of these topics is presented. Otherwise, all of the
2542 eligible topics will be presented.
2544 SCOPE determines the scope in which to search for
2545 questions. It accepts the same values as `org-drill-scope',
2546 which see.
2548 DRILL-MATCH, if supplied, is a string specifying a tags/property/
2549 todo query. Only items matching the query will be considered.
2550 It accepts the same values as `org-drill-match', which see.
2552 If RESUME-P is non-nil, resume a suspended drill session rather
2553 than starting a new one."
2556 ;; Check org version. Org 7.9.3f introduced a backwards-incompatible change
2557 ;; to the arguments accepted by `org-schedule'. At the time of writing there
2558 ;; are still lots of people using versions of org older than this.
2563 (format "Warning: org-drill requires org mode 7.9.3f or newer. Scheduling of failed cards will not
2564 work correctly with older versions of org mode. Your org mode version (%s) appears to be older than
2615 (:unscheduled
2617 ;; (:tomorrow
2618 ;; (incf *org-drill-dormant-entry-count*)
2619 ;; (incf *org-drill-due-tomorrow-count*))
2620 (:future
2624 (:new
2626 (:failed
2628 (:young
2630 (:overdue
2632 (:old
2634 )))))
2635 scope drill-match)
2663 "You can continue the drill session with the command `org-drill-resume'.%s"
2673 ))))
2679 org-drill-optimal-factor-matrix))
2683 "Run an interactive drill session in 'cram mode'. In cram mode,
2684 all drill items are considered to be due for review, unless they
2685 have been reviewed within the last `org-drill-cram-hours'
2686 hours."
2693 "Run an interactive drill session using drill items within the
2694 subtree at point."
2700 "Run an interactive drill session using drill items from all org
2701 files in the same directory as the current file."
2707 "Run a new drill session, but try to use leftover due items that
2708 were not reviewed during the last session, rather than scanning for
2709 unreviewed items. If there are no leftover items in memory, a full
2710 scan will be performed."
2728 "Resume a suspended drill session. Sessions are suspended by
2729 exiting them with the `edit' or `quit' options."
2735 ;; Current drill session is finished, but there are still
2736 ;; more items which need to be reviewed.
2738 "You have finished the drill session. However, %d items still
2739 need reviewing. Start a new drill session? "
2747 "Make the current item due for revision, and set its last interval to 0.
2748 Makes the item behave as if it has been failed, without actually recording a
2749 failure. This command can be used to 'reset' repetitions for an item."
2761 "Delete scheduling data from every drill entry in scope. This
2762 function may be useful if you want to give your collection of
2763 entries to someone else. Scope defaults to the current buffer,
2764 and is specified by the argument SCOPE, which accepts the same
2765 values as `org-drill-scope'."
2771 ;; Scope is the current buffer. This means we can use
2772 ;; `org-delete-property-globally', which is faster.
2782 ;; Compute local versions of the regexp for cloze deletions, in case
2783 ;; the left and right delimiters are redefined locally.
2792 ;; Can't add to org-mode-hook, because local variables won't have been loaded
2793 ;; yet.
2795 ;; (defun org-drill-add-cloze-fontification ()
2796 ;; (when (eql major-mode 'org-mode)
2797 ;; ;; Compute local versions of the regexp for cloze deletions, in case
2798 ;; ;; the left and right delimiters are redefined locally.
2799 ;; (setq-local org-drill-cloze-regexp (org-drill--compute-cloze-regexp))
2800 ;; (setq-local org-drill-cloze-keywords (org-drill--compute-cloze-keywords))
2801 ;; (when org-drill-use-visible-cloze-face-p
2802 ;; (font-lock-add-keywords nil ;'org-mode
2803 ;; org-drill-cloze-keywords
2804 ;; nil))))
2806 ;; XXX
2807 ;; (add-hook 'hack-local-variables-hook
2808 ;; 'org-drill-add-cloze-fontification)
2809 ;;
2810 ;; (org-drill-add-cloze-fontification)
2813 ;;; Synching card collections =================================================
2820 "Copy the subtree at point to the buffer DEST. The copy will receive
2821 the tag 'imported'."
2852 ;; We've looked all the way up the path
2853 ;; Default to appending to the end of DEST
2862 )))))
2867 "SRC and DEST are two org mode buffers containing drill items.
2868 For each drill item in DEST that shares an ID with an item in SRC,
2869 overwrite scheduling data in DEST with data taken from the item in SRC.
2870 This is intended for use when two people are sharing a set of drill items,
2871 one person has made some updates to the item set, and the other person
2872 wants to migrate to the updated set without losing their scheduling data.
2874 By default, any drill items in SRC which do not exist in DEST are
2875 copied into DEST. We attempt to place the copied item in the
2876 equivalent location in DEST to its location in SRC, by matching
2877 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2878 we simply ignore any items that do not exist in DEST, and do not
2879 copy them across."
2890 ;; Compile list of all IDs in the destination buffer.
2899 ;; Look through all entries in source buffer.
2909 nil)
2911 ;; This entry matches an entry in dest. Retrieve all its
2912 ;; scheduling data, then go to the matching location in dest
2913 ;; and write the data.
2916 total-repeats meanq ease)
2922 ;; go to matching entry in destination buffer
2928 total-repeats meanq ease)
2940 ;; item in SRC has ID, but no matching ID in DEST.
2941 ;; It must be a new item that does not exist in DEST.
2942 ;; Copy the entire item to the *end* of DEST.
2946 ;; Finally: there may be some items in DEST which are not in SRC, and
2947 ;; which have been scheduled by another user of DEST. Clear out the
2948 ;; scheduling info from all the unmatched items in DEST.
2958 ;;; Card types for learning languages =========================================
2960 ;;; Get spell-number.el from:
2961 ;;; http://www.emacswiki.org/emacs/spell-number.el
2965 ;;; `conjugate' card type =====================================================
2966 ;;; See spanish.org for usage
2972 ;; past tenses
2978 ;; future tenses
2980 ;; moods (backgrounds).
2986 )
2987 "Alist where each entry has the form (TENSE COLOUR), where
2988 TENSE is a string naming a tense in which verbs can be
2989 conjugated, and COLOUR is a string specifying a foreground colour
2990 which will be used by `org-drill-present-verb-conjugation' and
2991 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2996 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2997 `org-drill-show-answer-verb-conjugation'."
3016 :background
3026 "Present a drill entry whose card type is 'conjugate'."
3047 translation
3053 "Show the answer for a drill item whose card type is 'conjugate'.
3054 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3055 returns its return value."
3068 infinitive translation)
3073 ;;; `decline_noun' card type ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3089 ))
3093 "Auxiliary function used by `org-drill-present-noun-declension' and
3094 `org-drill-show-answer-noun-declension'."
3112 org-drill-noun-gender-alist t))
3120 "Present a drill entry whose card type is 'decline_noun'."
3142 noun noun-gender
3149 translation
3157 "Show the answer for a drill item whose card type is 'decline_noun'.
3158 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3159 returns its return value."
3164 noun noun-gender translation)
3169 ;;; `translate_number' card type ==============================================
3170 ;;; See spanish.org for usage
3194 num-max num-min))
3217 ;; (defun org-drill-show-answer-translate-number (reschedule-fn)
3218 ;; (let* ((language (read (org-entry-get (point) "DRILL_LANGUAGE" t)))
3219 ;; (highlight-face 'font-lock-warning-face)
3220 ;; (non-english
3221 ;; (let ((spelln-language language))
3222 ;; (propertize (spelln-integer-in-words *drilled-number*)
3223 ;; 'face highlight-face)))
3224 ;; (english
3225 ;; (let ((spelln-language 'english-gb))
3226 ;; (propertize (spelln-integer-in-words *drilled-number*)
3227 ;; 'face 'highlight-face))))
3228 ;; (with-replaced-entry-text
3229 ;; (cond
3230 ;; ((eql 'to-english *drilled-number-direction*)
3231 ;; (format "\nThe English translation of %s is:\n\n%s\n"
3232 ;; non-english english))
3233 ;; (t
3234 ;; (format "\nThe %s translation of %s is:\n\n%s\n"
3235 ;; (capitalize (format "%s" language))
3236 ;; english non-english)))
3237 ;; (funcall reschedule-fn))))
3240 ;;; `spanish_verb' card type ==================================================
3241 ;;; Not very interesting, but included to demonstrate how a presentation
3242 ;;; function can manipulate which subheading are hidden versus shown.