| blob | 5bf6dd4901e8ab1aa29d9434f6a77081bdc3fdda |
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.7
6 ;; Repository at http://bitbucket.org/eeeickythump/org-drill/
7 ;;
8 ;; This file is not part of GNU Emacs.
9 ;;
10 ;; This program is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 3, or (at your option)
13 ;; any later version.
14 ;;
15 ;; This program is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19 ;;
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary and synopsis:
24 ;;;
25 ;; Uses the SuperMemo spaced repetition algorithms to conduct interactive
26 ;; "drill sessions", where the material to be remembered is presented to the
27 ;; student in random order. The student rates his or her recall of each item,
28 ;; and this information is used to schedule the item for later revision.
29 ;;
30 ;; Each drill session can be restricted to topics in the current buffer
31 ;; (default), one or several files, all agenda files, or a subtree. A single
32 ;; topic can also be drilled.
33 ;;
34 ;; Different "card types" can be defined, which present their information to
35 ;; the student in different ways.
36 ;;
37 ;; See the file README.org for more detailed documentation.
38 ;;
39 ;;; Code:
48 "Options concerning interactive drill sessions in Org mode (org-drill)."
53 "Tag which topics must possess in order to be identified as review topics
54 by `org-drill'."
59 "Each drill session will present at most this many topics for review.
60 Nil means unlimited."
65 "Maximum duration of a drill session, in minutes.
66 Nil means unlimited."
71 "If the quality of recall for an item is this number or lower,
72 it is regarded as an unambiguous failure, and the repetition
73 interval for the card is reset to 0 days. If the quality is higher
74 than this number, it is regarded as successfully recalled, but the
75 time interval to the next repetition will be lowered if the quality
76 was near to a fail.
78 By default this is 2, for SuperMemo-like behaviour. For
79 Mnemosyne-like behaviour, set it to 1. Other values are not
80 really sensible."
85 "What percentage of items do you consider it is 'acceptable' to
86 forget each drill session? The default is 10%. A warning message
87 is displayed at the end of the session if the percentage forgotten
88 climbs above this number."
93 "If an item is forgotten more than this many times, it is tagged
94 as a 'leech' item."
99 "How should 'leech items' be handled during drill sessions?
100 Possible values:
101 - nil :: Leech items are treated the same as normal items.
102 - skip :: Leech items are not included in drill sessions.
103 - warn :: Leech items are still included in drill sessions,
104 but a warning message is printed when each leech item is
105 presented."
111 "The face used to hide the contents of cloze phrases."
116 "The face used to hide the contents of cloze phrases."
121 "The face used to hide the contents of cloze phrases."
125 "Use a special face to highlight cloze-deleted text in org mode
126 buffers?"
131 "Conceal the contents of the main heading of each item during drill
132 sessions? You may want to enable this behaviour if item headings or tags
133 contain information that could 'give away' the answer."
138 "Foreground colour used to display the count of remaining new items
139 during a drill session."
144 "Foreground colour used to display the count of remaining mature items
145 during a drill session. Mature items are due for review, but are not new."
150 "Foreground colour used to display the count of remaining failed items
151 during a drill session."
156 "Foreground colour used to display the count of reviewed items
157 during a drill session."
163 face org-drill-hidden-cloze-face
164 window t))
171 face default
172 window t))
175 "String which, if it occurs within a cloze expression, signifies that the
176 rest of the expression after the string is a `hint', to be displayed instead of
185 `((,org-drill-cloze-regexp
206 org-drill-present-verb-conjugation
207 org-drill-show-answer-verb-conjugation)
209 org-drill-present-noun-declension
210 org-drill-show-answer-noun-declension)
213 "Alist associating card types with presentation functions. Each
214 entry in the alist takes the form:
216 ;;; (CARDTYPE QUESTION-FN [ANSWER-FN DRILL-EMPTY-P])
218 Where CARDTYPE is a string or nil (for default), and QUESTION-FN
219 is a function which takes no arguments and returns a boolean
220 value.
222 When supplied, ANSWER-FN is a function that takes one argument --
223 that argument is a function of no arguments, which when called,
224 prompts the user to rate their recall and performs rescheduling
225 of the drill item. ANSWER-FN is called with the point on the
226 active item's heading, just prior to displaying the item's
227 'answer'. It can therefore be used to modify the appearance of
228 the answer. ANSWER-FN must call its argument before returning.
230 When supplied, DRILL-EMPTY-P is a boolean value, default nil.
231 When non-nil, cards of this type will be presented during tests
232 even if their bodies are empty."
238 "The scope in which to search for drill items when conducting a
239 drill session. This can be any of:
241 file The current buffer, respecting the restriction if any.
242 This is the default.
243 tree The subtree started with the entry at point
244 file-no-restriction The current buffer, without restriction
245 file-with-archives The current buffer, and any archives associated with it.
246 agenda All agenda files
247 agenda-with-archives All agenda files with any archive files associated
248 with them.
249 directory All files with the extension '.org' in the same
250 directory as the current file (includes the current
251 file if it is an .org file.)
252 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
253 "
254 ;; Note -- meanings differ slightly from the argument to org-map-entries:
255 ;; 'file' means current file/buffer, respecting any restriction
256 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
257 ;; 'directory' means all *.org files in current directory
262 list))
265 "If non-nil, prompt to save all modified buffers after a drill session
266 finishes."
271 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
272 Available choices are:
273 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
274 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
275 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
276 SuperMemo 98. The version implemented here is simplified in that while it
277 'learns' the difficulty of each item using quality grades and number of
278 failures, it does not modify the matrix of values that
279 governs how fast the inter-repetition intervals increase. A method for
280 adjusting intervals when items are reviewed early or late has been taken
281 from SM11, a later version of the algorithm, and included in Simple8."
286 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
288 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
289 The matrix is saved (using the 'customize' facility) at the end of each
290 drill session.
292 Over time, values in the matrix will adapt to the individual user's
293 pace of learning."
298 "In the SM5 algorithm, the initial interval after the first
299 successful presentation of an item is always 4 days. If you wish to change
300 this, you can do so here."
305 "If true, the number of days until an item's next repetition
306 will vary slightly from the interval calculated by the SM2
307 algorithm. The variation is very small when the interval is
308 small, but scales up with the interval."
313 "If true, when the student successfully reviews an item 1 or more days
314 before or after the scheduled review date, this will affect that date of
315 the item's next scheduled review, according to the algorithm presented at
316 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
318 Items that were reviewed early will have their next review date brought
319 forward. Those that were reviewed late will have their next review
320 date postponed further.
322 Note that this option currently has no effect if the SM2 algorithm
323 is used."
328 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
329 this number determines how often the 'less favoured' situation
330 should arise. It will occur 1 in every N trials, where N is the
331 value of the variable.
333 For example, with the hide1_firstmore card type, the first piece
334 of clozed text should be hidden more often than the other
335 pieces. If this variable is set to 4 (default), the first item
336 will only be shown 25% of the time (1 in 4 trials). Similarly for
337 show1_lastmore, the last item will be shown 75% of the time, and
338 for show1_firstless, the first item would only be shown 25% of the
339 time.
341 If the value of this variable is NIL, then weighting is disabled, and
342 all weighted card types are treated as their unweighted equivalents."
347 "When in cram mode, items are considered due for review if
348 they were reviewed at least this many hours ago."
352 ;;; NEW items have never been presented in a drill session before.
353 ;;; MATURE items HAVE been presented at least once before.
354 ;;; - YOUNG mature items were scheduled no more than
355 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
356 ;;; repetition. These items will have been learned 'recently' and will have a
357 ;;; low repetition count.
358 ;;; - OLD mature items have intervals greater than
359 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
360 ;;; - OVERDUE items are past their scheduled review date by more than
361 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
362 ;;; regardless of young/old status.
365 "When an item's inter-repetition interval rises above this value in days,
366 it is no longer considered a 'young' (recently learned) item."
371 "An item is considered overdue if its scheduled review date is
372 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
373 days in the past. For example, a value of 1.2 means an additional
374 20% of the last scheduled interval is allowed to elapse before
375 the item is overdue. A value of 1.0 means no extra time is
376 allowed at all - items are immediately considered overdue if
377 there is even one day's delay in reviewing them. This variable
378 should never be less than 1.0."
383 "Fraction between 0 and 1 that governs how quickly the spaces
384 between successive repetitions increase, for all items. The
385 default value is 0.5. Higher values make spaces increase more
386 quickly with each successful repetition. You should only change
387 this in small increments (for example 0.05-0.1) as it has an
388 exponential effect on inter-repetition spacing."
393 "Global variable that can be bound to a correct answer when an
394 item is being presented. If this variable is non-nil, the default
395 presentation function will show its value instead of the default
396 behaviour of revealing the contents of the drilled item.
398 This variable is useful for card types that compute their answers
399 -- for example, a card type that asks the student to translate a
410 "List of markers for items that are considered 'overdue', based on
413 "List of markers for mature entries whose last inter-repetition
416 "List of markers for mature entries whose last inter-repetition
424 "Are we in 'cram mode', where all items are considered due
431 ;;; Make the above settings safe as file-local variables.
461 ;;;; Utilities ================================================================
469 nil
476 "Add VAL to the end of the sequence stored in PLACE. Return the new
477 value."
481 "Randomly permute the elements of LIST (all permutations equally likely)."
482 ;; Adapted from 'shuffle-vector' in cookie1.el
484 j
485 temp
493 list)
496 "Round the floating point number FLOATNUM to FIX decimal places.
497 Example: (round-float 3.56755765 3) -> 3.568"
502 "Return a human-readable description of the key/keys to which the command
503 CMD is bound, or nil if it is not bound to a key."
510 time))
513 "Like `org-map-entries', but only drill entries are processed."
524 skip)))
553 "Nil means a last review date has not yet been stored for
554 the item.
555 Zero means it was reviewed today.
556 A positive number means it was reviewed that many days ago.
557 A negative number means the date of last review is in the future --
558 this should never happen."
566 "Like `org-drill-days-since-last-review', but return value is
567 in hours rather than days."
577 "Is MARKER, or the point, in a 'drill item'? This will return nil if
578 the point is inside a subheading of a drill item -- to handle that
579 situation use `org-part-of-drill-entry-p'."
590 "Is the current entry either the main heading of a 'drill item',
591 or a subheading within a drill item?"
593 ;; Does this heading INHERIT the drill tag
597 "Move the point to the heading which holds the :drill: tag for this
598 drill entry."
608 "Is the current entry a 'leech item'?"
612 ;; (defun org-drill-entry-due-p ()
613 ;; (cond
614 ;; (*org-drill-cram-mode*
615 ;; (let ((hours (org-drill-hours-since-last-review)))
616 ;; (and (org-drill-entry-p)
617 ;; (or (null hours)
618 ;; (>= hours org-drill-cram-hours)))))
619 ;; (t
620 ;; (let ((item-time (org-get-scheduled-time (point))))
621 ;; (and (org-drill-entry-p)
622 ;; (or (not (eql 'skip org-drill-leech-method))
623 ;; (not (org-drill-entry-leech-p)))
624 ;; (or (null item-time) ; not scheduled
625 ;; (not (minusp ; scheduled for today/in past
626 ;; (- (time-to-days (current-time))
627 ;; (time-to-days item-time))))))))))
630 "Returns:
631 - NIL if the item is not to be regarded as scheduled for review at all.
632 This is the case if it is not a drill item, or if it is a leech item
633 that we wish to skip, or if we are in cram mode and have already reviewed
634 the item within the last few hours.
635 - 0 if the item is new, or if it scheduled for review today.
636 - A negative integer - item is scheduled that many days in the future.
637 - A positive integer - item is scheduled that many days in the past."
651 nil)
659 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
660 and whose last inter-repetition interval was LAST-INTERVAL, should be
661 considered 'overdue'. If the arguments are not given they are extracted
662 from the entry at point."
669 ;;(> due org-drill-days-before-overdue)
671 org-drill-overdue-interval-factor)))
687 default)))
723 default)))
725 ;;; From http://www.supermemo.com/english/ol/sm5.htm
727 "Returns a random number between 0.5 and 1.5."
740 "Random numbers in a pseudo-normal distribution with mean MEAN, range
741 MEAN-VARIATION to MEAN+VARIATION"
745 mean))
748 optimal-interval
749 days-ahead)
750 "Arguments:
751 - OPTIMAL-FACTOR: interval-factor if the item had been tested
752 exactly when it was supposed to be.
753 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
754 tested exactly when it was supposed to be.
755 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
757 Returns an adjusted optimal factor which should be used to
758 calculate the next interval, instead of the optimal factor found
759 in the matrix."
761 (/ (+ optimal-interval
767 "Returns a list of 6 items, containing all the stored recall
768 data for the item at point:
769 - LAST-INTERVAL is the interval in days that was used to schedule the item's
770 current review date.
771 - REPEATS is the number of items the item has been successfully recalled without
772 without any failures. It is reset to 0 upon failure to recall the item.
773 - FAILURES is the total number of times the user has failed to recall the item.
774 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
775 - AVERAGE-QUALITY is the mean quality of recall of the item over
776 all its repetitions, successful and unsuccessful.
777 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
778 "
792 )))
804 total-repeats meanq
805 ease)
806 "Stores the given data in the item at point."
818 ;;; SM2 Algorithm =============================================================
821 failures meanq total-repeats)
822 "Arguments:
823 - LAST-INTERVAL -- the number of days since the item was last reviewed.
824 - REPEATS -- the number of times the item has been successfully reviewed
825 - EF -- the 'easiness factor'
826 - QUALITY -- 0 to 5
828 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
829 - INTERVAL is the number of days until the item should next be reviewed
830 - REPEATS is incremented by 1.
831 - EF is modified based on the recall quality for the item.
832 - OF-MATRIX is not modified."
836 ;; When an item is failed, its interval is reset to 0,
837 ;; but its EF is unchanged
839 org-drill-optimal-factor-matrix)
840 ;; else:
859 interval)
861 next-ef
863 org-drill-optimal-factor-matrix))))
866 ;;; SM5 Algorithm =============================================================
870 org-drill-sm5-initial-interval
871 ef))
882 org-drill-optimal-factor-matrix))))
884 of
888 failures meanq total-repeats
900 quality))
904 quality org-drill-learn-fraction))
911 last-interval n ef of-matrix)
912 delta-days)))
918 ;; "Failed" -- reset repetitions to 0,
922 ; preserved
923 ;; For a zero-based quality of 4 or 5, don't repeat
924 ;; ((and (>= quality 4)
925 ;; (not org-learn-always-reschedule))
926 ;; (list 0 (1+ n) ef failures meanq
927 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
930 last-interval n ef of-matrix))
935 ef
936 failures
937 meanq
939 of-matrix)))))
941 ;;; Simple8 Algorithm =========================================================
944 "Arguments:
945 - FAILURES: integer >= 0. The total number of times the item has
946 been forgotten, ever.
948 Returns the optimal FIRST interval for an item which has previously been
949 forgotten on FAILURES occasions."
953 "Arguments:
954 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
955 - REPETITION: the number of times the item has been tested.
956 1 is the first repetition (ie the second trial).
957 Returns:
958 The factor by which the last interval should be
959 multiplied to give the next interval. Corresponds to `RF' or `OF'."
963 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
964 to a mean item quality of QUALITY."
972 failures meanq totaln
974 "Arguments:
975 - LAST-INTERVAL -- the number of days since the item was last reviewed.
976 - REPEATS -- the number of times the item has been successfully reviewed
977 - EASE -- the 'easiness factor'
978 - QUALITY -- 0 to 5
979 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
980 0 = reviewed on the scheduled day. +N = N days overdue.
981 -N = reviewed N days early.
983 Returns the new item data, as a list of 6 values:
984 - NEXT-INTERVAL
985 - REPEATS
986 - EASE
987 - FAILURES
988 - AVERAGE-QUALITY
989 - TOTAL-REPEATS.
990 See the documentation for `org-drill-get-item-data' for a description of these."
997 quality))
1011 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1015 repeats))
1021 ;; The item was reviewed earlier than scheduled.
1032 next-interval)
1033 repeats
1035 failures
1036 meanq
1037 totaln)))
1039 ;;; Essentially copied from `org-learn.el', but modified to
1040 ;;; optionally call the SM2 or simple8 functions.
1042 "If DAYS-AHEAD is supplied it must be a positive integer. The
1043 item will be scheduled exactly this many days into the future."
1048 ;; Entries can have weights, 1 by default. Intervals are divided by the
1049 ;; item's weight, so an item with a weight of 2 will have all intervals
1050 ;; halved, meaning you will end up reviewing it twice as often.
1051 ;; Useful for entries which randomly present any of several facts.
1056 total-repeats meanq ease)
1059 failures meanq total-repeats
1063 ease quality failures
1064 meanq total-repeats ofmatrix))
1066 ease quality failures
1067 meanq total-repeats))
1069 quality failures meanq
1070 total-repeats
1071 delta-days)))
1083 total-repeats meanq ease)
1100 "Returns an integer representing the number of days into the future
1101 that the current item would be scheduled, based on a recall quality
1102 of QUALITY."
1105 total-repeats meanq ease)
1110 failures meanq total-repeats
1114 ease quality failures
1115 meanq total-repeats
1116 org-drill-optimal-factor-matrix))
1118 ease quality failures
1119 meanq total-repeats))
1121 quality failures meanq
1122 total-repeats)))
1127 (+ last-interval
1130 next-interval))))))
1138 intervals))
1143 "Returns quality rating (0-5), or nil if the user quit."
1152 3-5 Means you have remembered the item.
1154 0 - Completely forgot.
1155 1 - Even after seeing the answer, it still took a bit to sink in.
1156 2 - After seeing the answer, you remembered it.
1157 3 - It took you awhile, but you finally remembered. (+%s days)
1158 4 - After a little bit of thought you remembered. (+%s days)
1159 5 - You remembered the item really easily. (+%s days)
1161 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1196 ;;(setq failures (if failures (string-to-number failures) 0))
1197 ;; (org-set-property "DRILL_FAILURE_COUNT"
1198 ;; (format "%d" (1+ failures)))
1211 quality))
1215 nil))))
1217 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1218 ;; "Returns a list containing the position of each immediate subheading of
1219 ;; the current topic."
1220 ;; (let ((drill-entry-level (org-current-level))
1221 ;; (drill-sections nil)
1222 ;; (drill-heading nil))
1223 ;; (org-show-subtree)
1224 ;; (save-excursion
1225 ;; (org-map-entries
1226 ;; (lambda ()
1227 ;; (when (and (not (outline-invisible-p))
1228 ;; (> (org-current-level) drill-entry-level))
1229 ;; (setq drill-heading (org-get-heading t))
1230 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1231 ;; (member drill-heading heading-list))
1232 ;; (hide-subtree))
1233 ;; (push (point) drill-sections)))
1234 ;; "" 'tree))
1235 ;; (reverse drill-sections)))
1238 "TEST is a function taking no arguments. TEST will be called for each
1239 of the immediate subheadings of the current drill item, with the point
1240 on the relevant subheading. TEST should return nil if the subheading is
1241 to be revealed, non-nil if it is to be hidden.
1242 Returns a list containing the position of each immediate subheading of
1243 the current topic."
1316 prompt))
1321 You seem to be having a lot of trouble memorising this item.
1324 prompt)))
1330 "++:++ "
1332 prompt))
1350 "Hide the buffer region between BEG and END with an 'invisible text'
1351 visual overlay, or with the string TEXT if it is supplied."
1374 ;; This will also unhide the item's heading.
1383 ;; Don't hide org links, partly because they might contain inline
1384 ;; images which we want to keep visible
1391 "Hide the current match with a 'cloze' visual overlay."
1404 ovl 'display
1405 ;; If hint is like `X...' then display [X...]
1406 ;; otherwise display [...X]
1408 hint))))))
1420 "During the execution of BODY, the entire text of the current entry is
1421 concealed by an overlay that displays the string TEXT."
1430 "During the execution of BODY, the entire text of the current entry is
1431 concealed by an overlay that displays the overlays in REPLACEMENTS."
1440 "Make an overlay that conceals the entire text of the item, not
1441 including properties or the contents of subheadings. The overlay shows
1442 the string TEXT.
1443 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1444 for the `display' text property. The text of the item will be temporarily
1445 replaced by all of these items, in the order in which they appear in
1446 the list.
1447 Note: does not actually alter the item."
1468 "Make overlays that conceal the entire text of the item, not
1469 including properties or the contents of subheadings. The overlay shows
1470 the string TEXT.
1471 Note: does not actually alter the item."
1481 p-max
1496 "Make an overlay that conceals the heading of the item. The overlay shows
1497 the string TEXT.
1498 Note: does not actually alter the item."
1510 text
1514 ;; (defun org-entry-empty-p ()
1515 ;; (zerop (length (org-drill-get-entry-text))))
1517 ;; This version is about 5x faster than the old version, above.
1529 ;;; Presentation functions ====================================================
1530 ;;
1531 ;; Each of these is called with point on topic heading. Each needs to show the
1532 ;; topic in the form of a 'question' or with some information 'hidden', as
1533 ;; appropriate for the card type. The user should then be prompted to press a
1534 ;; key. The function should then reveal either the 'answer' or the entire
1535 ;; topic, and should return t if the user chose to see the answer and rate their
1536 ;; recall, nil if they chose to quit.
1574 drill-sections))
1598 &optional
1599 force-show-first
1600 force-show-last
1601 force-hide-first)
1602 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1603 chosen at random.
1604 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1605 hiding all the rest.
1606 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1607 the hidden items.
1608 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1609 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1610 If the number of text pieces in the item is less than
1611 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1612 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1637 to match-count
1638 collect i)))
1642 ;; Force '1' to be in the list, and to be the first item
1643 ;; in the list.
1652 ;; (dolist (pos-to-hide match-nums)
1663 ;; (loop
1664 ;; do (re-search-forward org-drill-cloze-regexp
1665 ;; item-end t pos-to-hide)
1666 ;; while (org-pos-in-regexp (match-beginning 0)
1667 ;; org-bracket-link-regexp 1))
1668 ;; (org-drill-hide-matched-cloze-text)))))
1677 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1678 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1679 the second to last, etc."
1704 nil)
1724 "Hides one of the pieces of text that are marked for cloze deletion,
1725 chosen at random."
1729 "Hides two of the pieces of text that are marked for cloze deletion,
1730 chosen at random."
1734 "Hides the first piece of text that is marked for cloze deletion."
1738 "Hides the last piece of text that is marked for cloze deletion."
1742 "Commonly, hides the FIRST piece of text that is marked for
1743 cloze deletion. Uncommonly, hide one of the other pieces of text,
1744 chosen at random.
1746 The definitions of 'commonly' and 'uncommonly' are determined by
1747 the value of `org-drill-cloze-text-weight'."
1748 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1749 ;; to hide the 'favoured' piece of text. However even when the chance of
1750 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1751 ;; the small number of repetitions where most learning takes place for each
1752 ;; item. In other words, the actual frequency during the first 10 repetitions
1753 ;; was often very different from 80%. Hence we use modulo instead.
1756 ;; Behave as hide1cloze
1761 org-drill-cloze-text-weight))
1763 org-drill-cloze-text-weight))
1764 ;; Uncommonly, hide any item except the first
1767 ;; Commonly, hide first item
1771 "Commonly, hides all pieces except the last. Uncommonly, shows
1772 any random piece. The effect is similar to 'show1cloze' except
1773 that the last item is much less likely to be the item that is
1774 visible.
1776 The definitions of 'commonly' and 'uncommonly' are determined by
1777 the value of `org-drill-cloze-text-weight'."
1780 ;; Behave as show1cloze
1785 org-drill-cloze-text-weight))
1787 org-drill-cloze-text-weight))
1788 ;; Uncommonly, show any item except the last
1791 ;; Commonly, show the LAST item
1795 "Commonly, hides all pieces except one, where the shown piece
1796 is guaranteed NOT to be the first piece. Uncommonly, shows any
1797 random piece. The effect is similar to 'show1cloze' except that
1798 the first item is much less likely to be the item that is
1799 visible.
1801 The definitions of 'commonly' and 'uncommonly' are determined by
1802 the value of `org-drill-cloze-text-weight'."
1805 ;; Behave as show1cloze
1810 org-drill-cloze-text-weight))
1812 org-drill-cloze-text-weight))
1813 ;; Uncommonly, show the first item
1816 ;; Commonly, show any item, except the first
1820 "Similar to `org-drill-present-multicloze-hide1', but hides all
1821 the pieces of text that are marked for cloze deletion, except for one
1822 piece which is chosen at random."
1826 "Similar to `org-drill-present-multicloze-show1', but reveals two
1827 pieces rather than one."
1830 ;; (defun org-drill-present-multicloze-show1 ()
1831 ;; "Similar to `org-drill-present-multicloze-hide1', but hides all
1832 ;; the pieces of text that are marked for cloze deletion, except for one
1833 ;; piece which is chosen at random."
1834 ;; (with-hidden-comments
1835 ;; (with-hidden-cloze-hints
1836 ;; (let ((item-end nil)
1837 ;; (match-count 0)
1838 ;; (body-start (or (cdr (org-get-property-block))
1839 ;; (point))))
1840 ;; (org-drill-hide-all-subheadings-except nil)
1841 ;; (save-excursion
1842 ;; (outline-next-heading)
1843 ;; (setq item-end (point)))
1844 ;; (save-excursion
1845 ;; (goto-char body-start)
1846 ;; (while (re-search-forward org-drill-cloze-regexp item-end t)
1847 ;; (incf match-count)))
1848 ;; (when (plusp match-count)
1849 ;; (let ((match-to-hide (random* match-count)))
1850 ;; (save-excursion
1851 ;; (goto-char body-start)
1852 ;; (dotimes (n match-count)
1853 ;; (re-search-forward org-drill-cloze-regexp
1854 ;; item-end t)
1855 ;; (unless (= n match-to-hide)
1856 ;; (org-drill-hide-matched-cloze-text))))))
1857 ;; (org-display-inline-images t)
1858 ;; (org-cycle-hide-drawers 'all)
1859 ;; (prog1 (org-drill-presentation-prompt)
1860 ;; (org-drill-hide-subheadings-if 'org-drill-entry-p)
1861 ;; (org-drill-unhide-clozed-text))))))
1864 "Present the string QUESTION as the only visible content of the card.
1865 If ANSWER is supplied, set the global variable `drill-answer' to its value."
1878 "TEXTS is a list of valid values for the 'display' text property.
1879 Present these overlays, in sequence, as the only
1880 visible content of the card.
1881 If ANSWER is supplied, set the global variable `drill-answer' to its value."
1885 replacements
1894 "Present the current topic for interactive review, as in `org-drill'.
1895 Review will occur regardless of whether the topic is due for review or whether
1896 it meets the definition of a 'review topic' used by `org-drill'.
1898 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
1899 EDIT if the user chose to exit the drill and edit the current item. Choosing
1900 the latter option leaves the drill session suspended; it can be resumed
1901 later using `org-drill-resume'.
1903 See `org-drill' for more details."
1906 ;;(unless (org-part-of-drill-entry-p)
1907 ;; (error "Point is not inside a drill entry"))
1908 ;;(unless (org-at-heading-p)
1909 ;; (org-back-to-heading))
1914 ;; fontification functions in `outline-view-change-hook' can cause big
1915 ;; slowdowns, so we temporarily bind this variable to nil here.
1942 nil)
1974 "Returns true if the current drill session has continued past its
1975 maximum duration."
1983 "Returns true if the current drill session has reached the
1984 maximum number of items."
1988 org-drill-maximum-items-per-session)))
1996 m
1998 ;; First priority is items we failed in a prior session.
2003 ;; Next priority is overdue items.
2007 ;; We use `pop', not `pop-random', because we have already
2008 ;; sorted overdue items into a random order which takes
2009 ;; number of days overdue into account.
2011 ;; Next priority is 'young' items.
2016 ;; Next priority is newly added items, and older entries.
2017 ;; We pool these into a single group.
2029 ;; After all the above are done, last priority is items
2030 ;; that were failed earlier THIS SESSION.
2035 m)))
2038 "Returns nil, t, or a list of markers representing entries that were
2039 'failed' and need to be presented again before the session ends.
2041 RESUMING-P is true if we are resuming a suspended drill session."
2059 ;; The entry is not due anymore. This could arise if the user
2060 ;; suspends a drill session, then drills an individual entry,
2061 ;; then resumes the session.
2064 nil)
2099 "%d items reviewed. Session duration %s.
2100 Recall of reviewed items:
2101 Excellent (5): %3d%% | Near miss (2): %3d%%
2102 Good (4): %3d%% | Failure (1): %3d%%
2103 Hard (3): %3d%% | Abject failure (0): %3d%%
2105 You successfully recalled %d%% of reviewed items (quality > %s)
2106 %d/%d items still await review (%s, %s, %s, %s, %s).
2107 Tomorrow, %d more items will become due for review.
2108 Session finished. Press a key to continue..."
2124 pass-percent
2125 org-drill-failure-quality
2151 ))
2162 "%s
2163 You failed %d%% of the items you reviewed during this session.
2164 %d (%d%%) of all items scanned were overdue.
2166 Are you keeping up with your items, and reviewing them
2167 when they are scheduled? If so, you may want to consider
2168 lowering the value of `org-drill-learn-fraction' slightly in
2169 order to make items appear more frequently over time."
2178 "MARKERS is a list of markers, all of which will be freed (set to
2179 point nowhere). Alternatively, MARKERS can be 't', in which case
2180 all the markers used by Org-Drill will be freed."
2189 markers))
2201 "Returns a list (STATUS DUE) where DUE is the number of days overdue,
2202 zero being due today, -1 being scheduled 1 day in the future. STATUS is
2203 one of the following values:
2204 - nil, if the item is not a drill entry, or has an empty body
2205 - :unscheduled
2206 - :future
2207 - :new
2208 - :failed
2209 - :overdue
2210 - :young
2211 - :old
2212 "
2221 nil)
2227 ;; body is empty, and this is not a card type where empty bodies are
2228 ;; meaningful, so skip it.
2229 nil)
2232 ;; ((eql -1 due)
2233 ;; :tomorrow)
2236 ;; The rest of the stati all denote 'due' items ==========================
2238 org-drill-failure-quality)
2239 ;; Mature entries that were failed last time are
2240 ;; FAILED, regardless of how young, old or overdue
2241 ;; they are.
2246 ;; Overdue status overrides young versus old
2247 ;; distinction.
2248 ;; Store marker + due, for sorting of overdue entries
2251 org-drill-days-before-old)
2255 due))))
2264 collected
2266 sym2)
2268 sym1)))))
2272 "Begin an interactive 'drill session'. The user is asked to
2273 review a series of topics (headers). Each topic is initially
2274 presented as a 'question', often with part of the topic content
2275 hidden. The user attempts to recall the hidden information or
2276 answer the question, then presses a key to reveal the answer. The
2277 user then rates his or her recall or performance on that
2278 topic. This rating information is used to reschedule the topic
2279 for future review.
2281 Org-drill proceeds by:
2283 - Finding all topics (headings) in SCOPE which have either been
2284 used and rescheduled before, or which have a tag that matches
2285 `org-drill-question-tag'.
2287 - All matching topics which are either unscheduled, or are
2288 scheduled for the current date or a date in the past, are
2289 considered to be candidates for the drill session.
2291 - If `org-drill-maximum-items-per-session' is set, a random
2292 subset of these topics is presented. Otherwise, all of the
2293 eligible topics will be presented.
2295 SCOPE determines the scope in which to search for
2296 questions. It accepts the same values as `org-drill-scope',
2297 which see.
2299 If RESUME-P is non-nil, resume a suspended drill session rather
2300 than starting a new one."
2351 (:unscheduled
2353 ;; (:tomorrow
2354 ;; (incf *org-drill-dormant-entry-count*)
2355 ;; (incf *org-drill-due-tomorrow-count*))
2356 (:future
2360 (:new
2362 (:failed
2364 (:young
2366 (:overdue
2368 (:old
2370 )))))
2371 scope)
2399 "You can continue the drill session with the command `org-drill-resume'.%s"
2414 org-drill-optimal-factor-matrix))
2418 "Run an interactive drill session in 'cram mode'. In cram mode,
2419 all drill items are considered to be due for review, unless they
2420 have been reviewed within the last `org-drill-cram-hours'
2421 hours."
2428 "Run an interactive drill session using drill items within the
2429 subtree at point."
2435 "Run an interactive drill session using drill items from all org
2436 files in the same directory as the current file."
2442 "Run a new drill session, but try to use leftover due items that
2443 were not reviewed during the last session, rather than scanning for
2444 unreviewed items. If there are no leftover items in memory, a full
2445 scan will be performed."
2463 "Resume a suspended drill session. Sessions are suspended by
2464 exiting them with the `edit' or `quit' options."
2470 ;; Current drill session is finished, but there are still
2471 ;; more items which need to be reviewed.
2473 "You have finished the drill session. However, %d items still
2474 need reviewing. Start a new drill session? "
2488 "Delete scheduling data from every drill entry in scope. This
2489 function may be useful if you want to give your collection of
2490 entries to someone else. Scope defaults to the current buffer,
2491 and is specified by the argument SCOPE, which accepts the same
2492 values as `org-drill-scope'."
2498 ;; Scope is the current buffer. This means we can use
2499 ;; `org-delete-property-globally', which is faster.
2512 org-drill-cloze-keywords
2513 nil)))
2520 ;;; Synching card collections =================================================
2527 "Copy the subtree at point to the buffer DEST. The copy will receive
2528 the tag 'imported'."
2559 ;; We've looked all the way up the path
2560 ;; Default to appending to the end of DEST
2572 "SRC and DEST are two org mode buffers containing drill items.
2573 For each drill item in DEST that shares an ID with an item in SRC,
2574 overwrite scheduling data in DEST with data taken from the item in SRC.
2575 This is intended for use when two people are sharing a set of drill items,
2576 one person has made some updates to the item set, and the other person
2577 wants to migrate to the updated set without losing their scheduling data.
2579 By default, any drill items in SRC which do not exist in DEST are
2580 copied into DEST. We attempt to place the copied item in the
2581 equivalent location in DEST to its location in SRC, by matching
2582 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2583 we simply ignore any items that do not exist in DEST, and do not
2584 copy them across."
2595 ;; Compile list of all IDs in the destination buffer.
2604 ;; Look through all entries in source buffer.
2614 nil)
2616 ;; This entry matches an entry in dest. Retrieve all its
2617 ;; scheduling data, then go to the matching location in dest
2618 ;; and write the data.
2621 total-repeats meanq ease)
2627 ;; go to matching entry in destination buffer
2633 total-repeats meanq ease)
2645 ;; item in SRC has ID, but no matching ID in DEST.
2646 ;; It must be a new item that does not exist in DEST.
2647 ;; Copy the entire item to the *end* of DEST.
2651 ;; Finally: there may be some items in DEST which are not in SRC, and
2652 ;; which have been scheduled by another user of DEST. Clear out the
2653 ;; scheduling info from all the unmatched items in DEST.
2661 ;;; Card types for learning languages =========================================
2663 ;;; Get spell-number.el from:
2664 ;;; http://www.emacswiki.org/emacs/spell-number.el
2667 ;;; `conjugate' card type =====================================================
2668 ;;; See spanish.org for usage
2674 ;; past tenses
2680 ;; future tenses
2682 ;; moods (backgrounds).
2688 )
2689 "Alist where each entry has the form (TENSE COLOUR), where
2690 TENSE is a string naming a tense in which verbs can be
2691 conjugated, and COLOUR is a string specifying a foreground colour
2692 which will be used by `org-drill-present-verb-conjugation' and
2693 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2698 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2699 `org-drill-show-answer-verb-conjugation'."
2718 :background
2728 "Present a drill entry whose card type is 'conjugate'."
2749 translation
2755 "Show the answer for a drill item whose card type is 'conjugate'.
2756 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2757 returns its return value."
2770 infinitive translation)
2775 ;;; `decline_noun' card type ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2791 ))
2795 "Auxiliary function used by `org-drill-present-noun-declension' and
2796 `org-drill-show-answer-noun-declension'."
2814 org-drill-noun-gender-alist t))
2822 "Present a drill entry whose card type is 'decline_noun'."
2844 noun noun-gender
2851 translation
2859 "Show the answer for a drill item whose card type is 'decline_noun'.
2860 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2861 returns its return value."
2866 noun noun-gender translation)
2871 ;;; `translate_number' card type ==============================================
2872 ;;; See spanish.org for usage
2896 num-max num-min))
2918 ;; (defun org-drill-show-answer-translate-number (reschedule-fn)
2919 ;; (let* ((language (read (org-entry-get (point) "DRILL_LANGUAGE" t)))
2920 ;; (highlight-face 'font-lock-warning-face)
2921 ;; (non-english
2922 ;; (let ((spelln-language language))
2923 ;; (propertize (spelln-integer-in-words *drilled-number*)
2924 ;; 'face highlight-face)))
2925 ;; (english
2926 ;; (let ((spelln-language 'english-gb))
2927 ;; (propertize (spelln-integer-in-words *drilled-number*)
2928 ;; 'face 'highlight-face))))
2929 ;; (with-replaced-entry-text
2930 ;; (cond
2931 ;; ((eql 'to-english *drilled-number-direction*)
2932 ;; (format "\nThe English translation of %s is:\n\n%s\n"
2933 ;; non-english english))
2934 ;; (t
2935 ;; (format "\nThe %s translation of %s is:\n\n%s\n"
2936 ;; (capitalize (format "%s" language))
2937 ;; english non-english)))
2938 ;; (funcall reschedule-fn))))
2941 ;;; `spanish_verb' card type ==================================================
2942 ;;; Not very interesting, but included to demonstrate how a presentation
2943 ;;; function can manipulate which subheading are hidden versus shown.