| blob | 12c7dba4bf5fe650ab6d32ee1318376525f3c036 |
1 ;; -*- coding: utf-8-unix -*-
2 ;;; org-drill.el - Self-testing using spaced repetition
3 ;;;
4 ;;; Copyright (C) 2010-2015 Paul Sexton
5 ;;;
6 ;;; Author: Paul Sexton <eeeickythump@gmail.com>
7 ;;; Version: 2.4.7
8 ;;; Keywords: flashcards, memory, learning, memorization
9 ;;; Repository at http://bitbucket.org/eeeickythump/org-drill/
10 ;;;
11 ;;; This file is not part of GNU Emacs.
12 ;;;
13 ;;; This program is free software; you can redistribute it and/or modify
14 ;;; it under the terms of the GNU General Public License as published by
15 ;;; the Free Software Foundation, either version 3 of the License, or
16 ;;; (at your option) any later version.
17 ;;;
18 ;;; This program is distaributed in the hope that it will be useful,
19 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;;; GNU General Public License for more details.
22 ;;;
23 ;;; You should have received a copy of the GNU General Public License
24 ;;; along with this program. If not, see <http://www.gnu.org/licenses/>.
25 ;;;
26 ;;;
27 ;;; Synopsis
28 ;;; ========
29 ;;;
30 ;;; Uses the SuperMemo spaced repetition algorithms to conduct interactive
31 ;;; "drill sessions", where the material to be remembered is presented to the
32 ;;; student in random order. The student rates his or her recall of each item,
33 ;;; and this information is used to schedule the item for later revision.
34 ;;;
35 ;;; Each drill session can be restricted to topics in the current buffer
36 ;;; (default), one or several files, all agenda files, or a subtree. A single
37 ;;; topic can also be drilled.
38 ;;;
39 ;;; Different "card types" can be defined, which present their information to
40 ;;; the student in different ways.
41 ;;;
42 ;;; See the file README.org for more detailed documentation.
56 "Options concerning interactive drill sessions in Org mode (org-drill)."
63 "drill"
64 "Tag which topics must possess in order to be identified as review topics
65 by `org-drill'."
71 30
72 "Each drill session will present at most this many topics for review.
73 Nil means unlimited."
80 20
81 "Maximum duration of a drill session, in minutes.
82 Nil means unlimited."
88 2
89 "If the quality of recall for an item is this number or lower,
90 it is regarded as an unambiguous failure, and the repetition
91 interval for the card is reset to 0 days. If the quality is higher
92 than this number, it is regarded as successfully recalled, but the
93 time interval to the next repetition will be lowered if the quality
94 was near to a fail.
96 By default this is 2, for SuperMemo-like behaviour. For
97 Mnemosyne-like behaviour, set it to 1. Other values are not
98 really sensible."
104 10
105 "What percentage of items do you consider it is 'acceptable' to
106 forget each drill session? The default is 10%. A warning message
107 is displayed at the end of the session if the percentage forgotten
108 climbs above this number."
114 15
115 "If an item is forgotten more than this many times, it is tagged
116 as a 'leech' item."
122 'skip
123 "How should 'leech items' be handled during drill sessions?
124 Possible values:
125 - nil :: Leech items are treated the same as normal items.
126 - skip :: Leech items are not included in drill sessions.
127 - warn :: Leech items are still included in drill sessions,
128 but a warning message is printed when each leech item is
129 presented."
136 "The face used to hide the contents of cloze phrases."
142 "The face used to hide the contents of cloze phrases."
148 "The face used to hide the contents of cloze phrases."
153 nil
154 "Use a special face to highlight cloze-deleted text in org mode
155 buffers?"
161 nil
162 "Conceal the contents of the main heading of each item during drill
163 sessions? You may want to enable this behaviour if item headings or tags
164 contain information that could 'give away' the answer."
170 "royal blue"
171 "Foreground colour used to display the count of remaining new items
172 during a drill session."
177 "green"
178 "Foreground colour used to display the count of remaining mature items
179 during a drill session. Mature items are due for review, but are not new."
184 "red"
185 "Foreground colour used to display the count of remaining failed items
186 during a drill session."
191 "sienna"
192 "Foreground colour used to display the count of reviewed items
193 during a drill session."
198 "["
199 "String used within org buffers to delimit cloze deletions."
204 "]"
205 "String used within org buffers to delimit cloze deletions."
212 org-drill-left-cloze-delimiter
213 org-drill-right-cloze-delimiter)
214 face org-drill-hidden-cloze-face
215 window t))
222 face default
223 window t))
229 "String which, if it occurs within a cloze expression, signifies that the
230 rest of the expression after the string is a `hint', to be displayed instead of
247 )))
257 ;; Variables defining what keys can be pressed during drill sessions to quit the
258 ;; session, edit the item, etc.
262 "If this character is pressed during a drill session, suspend the session
267 "If this character is pressed during a drill session, skip to the next
270 "If this character is pressed during a drill session, edit the tags for
290 org-drill-present-verb-conjugation
291 org-drill-show-answer-verb-conjugation)
293 org-drill-present-noun-declension
294 org-drill-show-answer-noun-declension)
297 "Alist associating card types with presentation functions. Each
298 entry in the alist takes the form:
300 ;;; (CARDTYPE QUESTION-FN [ANSWER-FN DRILL-EMPTY-P])
302 Where CARDTYPE is a string or nil (for default), and QUESTION-FN
303 is a function which takes no arguments and returns a boolean
304 value.
306 When supplied, ANSWER-FN is a function that takes one argument --
307 that argument is a function of no arguments, which when called,
308 prompts the user to rate their recall and performs rescheduling
309 of the drill item. ANSWER-FN is called with the point on the
310 active item's heading, just prior to displaying the item's
311 'answer'. It can therefore be used to modify the appearance of
312 the answer. ANSWER-FN must call its argument before returning.
314 When supplied, DRILL-EMPTY-P is a boolean value, default nil.
315 When non-nil, cards of this type will be presented during tests
316 even if their bodies are empty."
323 'file
324 "The scope in which to search for drill items when conducting a
325 drill session. This can be any of:
327 file The current buffer, respecting the restriction if any.
328 This is the default.
329 tree The subtree started with the entry at point
330 file-no-restriction The current buffer, without restriction
331 file-with-archives The current buffer, and any archives associated with it.
332 agenda All agenda files
333 agenda-with-archives All agenda files with any archive files associated
334 with them.
335 directory All files with the extension '.org' in the same
336 directory as the current file (includes the current
337 file if it is an .org file.)
338 (FILE1 FILE2 ...) If this is a list, all files in the list will be scanned.
339 "
340 ;; Note -- meanings differ slightly from the argument to org-map-entries:
341 ;; 'file' means current file/buffer, respecting any restriction
342 ;; 'file-no-restriction' means current file/buffer, ignoring restrictions
343 ;; 'directory' means all *.org files in current directory
350 (const :tag "All agenda files with any archive files associated with them." agenda-with-archives)
351 (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)
356 nil
357 "If non-nil, a string specifying a tags/property/TODO query. During
358 drill sessions, only items that match this query will be considered."
364 t
365 "If non-nil, prompt to save all modified buffers after a drill session
366 finishes."
372 'sm5
373 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
374 Available choices are:
375 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
376 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
377 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
378 SuperMemo 98. The version implemented here is simplified in that while it
379 'learns' the difficulty of each item using quality grades and number of
380 failures, it does not modify the matrix of values that
381 governs how fast the inter-repetition intervals increase. A method for
382 adjusting intervals when items are reviewed early or late has been taken
383 from SM11, a later version of the algorithm, and included in Simple8."
389 nil
390 "Obsolete and will be removed in future. The SM5 optimal factor
391 matrix data is now stored in the variable
392 `org-drill-sm5-optimal-factor-matrix'."
398 nil
399 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
401 Persistent matrix of optimal factors, used by the SuperMemo SM5
402 algorithm. The matrix is saved at the end of each drill session.
404 Over time, values in the matrix will adapt to the individual user's
418 org-drill-optimal-factor-matrix)))
424 4.0
425 "In the SM5 algorithm, the initial interval after the first
426 successful presentation of an item is always 4 days. If you wish to change
427 this, you can do so here."
433 nil
434 "If true, the number of days until an item's next repetition
435 will vary slightly from the interval calculated by the SM2
436 algorithm. The variation is very small when the interval is
437 small, but scales up with the interval."
443 nil
444 "If true, when the student successfully reviews an item 1 or more days
445 before or after the scheduled review date, this will affect that date of
446 the item's next scheduled review, according to the algorithm presented at
447 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
449 Items that were reviewed early will have their next review date brought
450 forward. Those that were reviewed late will have their next review
451 date postponed further.
453 Note that this option currently has no effect if the SM2 algorithm
454 is used."
460 4
461 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
462 this number determines how often the 'less favoured' situation
463 should arise. It will occur 1 in every N trials, where N is the
464 value of the variable.
466 For example, with the hide1_firstmore card type, the first piece
467 of clozed text should be hidden more often than the other
468 pieces. If this variable is set to 4 (default), the first item
469 will only be shown 25% of the time (1 in 4 trials). Similarly for
470 show1_lastmore, the last item will be shown 75% of the time, and
471 for show1_firstless, the first item would only be shown 25% of the
472 time.
474 If the value of this variable is NIL, then weighting is disabled, and
475 all weighted card types are treated as their unweighted equivalents."
481 12
482 "When in cram mode, items are considered due for review if
483 they were reviewed at least this many hours ago."
488 ;;; NEW items have never been presented in a drill session before.
489 ;;; MATURE items HAVE been presented at least once before.
490 ;;; - YOUNG mature items were scheduled no more than
491 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
492 ;;; repetition. These items will have been learned 'recently' and will have a
493 ;;; low repetition count.
494 ;;; - OLD mature items have intervals greater than
495 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
496 ;;; - OVERDUE items are past their scheduled review date by more than
497 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
498 ;;; regardless of young/old status.
502 10
503 "When an item's inter-repetition interval rises above this value in days,
504 it is no longer considered a 'young' (recently learned) item."
510 1.2
511 "An item is considered overdue if its scheduled review date is
512 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
513 days in the past. For example, a value of 1.2 means an additional
514 20% of the last scheduled interval is allowed to elapse before
515 the item is overdue. A value of 1.0 means no extra time is
516 allowed at all - items are immediately considered overdue if
517 there is even one day's delay in reviewing them. This variable
518 should never be less than 1.0."
524 0.5
525 "Fraction between 0 and 1 that governs how quickly the spaces
526 between successive repetitions increase, for all items. The
527 default value is 0.5. Higher values make spaces increase more
528 quickly with each successful repetition. You should only change
529 this in small increments (for example 0.05-0.1) as it has an
530 exponential effect on inter-repetition spacing."
536 "Global variable that can be bound to a correct answer when an
537 item is being presented. If this variable is non-nil, the default
538 presentation function will show its value instead of the default
539 behaviour of revealing the contents of the drilled item.
541 This variable is useful for card types that compute their answers
542 -- for example, a card type that asks the student to translate a
554 "List of markers for items that are considered 'overdue', based on
557 "List of markers for mature entries whose last inter-repetition
560 "List of markers for mature entries whose last inter-repetition
568 "Are we in 'cram mode', where all items are considered due
575 "If non-nil, entries more than 90 days overdue are regarded as 'lapsed'.
576 This means that when the item is eventually re-tested it will be
577 treated as 'failed' (quality 2) for rescheduling purposes,
581 ;;; Make the above settings safe as file-local variables.
617 ;;;; Utilities ================================================================
627 nil
635 "Add VAL to the end of the sequence stored in PLACE. Return the new
636 value."
641 "Randomly permute the elements of LIST (all permutations equally likely)."
642 ;; Adapted from 'shuffle-vector' in cookie1.el
644 j
645 temp
653 list)
657 "Round the floating point number FLOATNUM to FIX decimal places.
658 Example: (round-float 3.56755765 3) -> 3.568"
664 "Return a human-readable description of the key/keys to which the command
665 CMD is bound, or nil if it is not bound to a key."
673 time))
679 time))
683 "Like `org-map-entries', but only drill entries are processed."
699 skip)))
732 "Nil means a last review date has not yet been stored for
733 the item.
734 Zero means it was reviewed today.
735 A positive number means it was reviewed that many days ago.
736 A negative number means the date of last review is in the future --
737 this should never happen."
746 "Like `org-drill-days-since-last-review', but return value is
747 in hours rather than days."
758 "Is MARKER, or the point, in a 'drill item'? This will return nil if
759 the point is inside a subheading of a drill item -- to handle that
760 situation use `org-part-of-drill-entry-p'."
773 "Is the current entry either the main heading of a 'drill item',
774 or a subheading within a drill item?"
776 ;; Does this heading INHERIT the drill tag
781 "Move the point to the heading which holds the :drill: tag for this
782 drill entry."
794 "Is the current entry a 'leech item'?"
799 ;; (defun org-drill-entry-due-p ()
800 ;; (cond
801 ;; (*org-drill-cram-mode*
802 ;; (let ((hours (org-drill-hours-since-last-review)))
803 ;; (and (org-drill-entry-p)
804 ;; (or (null hours)
805 ;; (>= hours org-drill-cram-hours)))))
806 ;; (t
807 ;; (let ((item-time (org-get-scheduled-time (point))))
808 ;; (and (org-drill-entry-p)
809 ;; (or (not (eql 'skip org-drill-leech-method))
810 ;; (not (org-drill-entry-leech-p)))
811 ;; (or (null item-time) ; not scheduled
812 ;; (not (minusp ; scheduled for today/in past
813 ;; (- (time-to-days (current-time))
814 ;; (time-to-days item-time))))))))))
818 "Returns:
819 - NIL if the item is not to be regarded as scheduled for review at all.
820 This is the case if it is not a drill item, or if it is a leech item
821 that we wish to skip, or if we are in cram mode and have already reviewed
822 the item within the last few hours.
823 - 0 if the item is new, or if it scheduled for review today.
824 - A negative integer - item is scheduled that many days in the future.
825 - A positive integer - item is scheduled that many days in the past."
839 nil)
848 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
849 and whose last inter-repetition interval was LAST-INTERVAL, should be
850 considered 'overdue'. If the arguments are not given they are extracted
851 from the entry at point."
858 ;;(> due org-drill-days-before-overdue)
860 org-drill-overdue-interval-factor)))
880 default)))
918 default)))
921 ;;; From http://www.supermemo.com/english/ol/sm5.htm
923 "Returns a random number between 0.5 and 1.5."
936 "Random numbers in a pseudo-normal distribution with mean MEAN, range
937 MEAN-VARIATION to MEAN+VARIATION"
941 mean))
945 optimal-interval
946 days-ahead)
947 "Arguments:
948 - OPTIMAL-FACTOR: interval-factor if the item had been tested
949 exactly when it was supposed to be.
950 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
951 tested exactly when it was supposed to be.
952 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
954 Returns an adjusted optimal factor which should be used to
955 calculate the next interval, instead of the optimal factor found
956 in the matrix."
958 (/ (+ optimal-interval
965 "Returns a list of 6 items, containing all the stored recall
966 data for the item at point:
967 - LAST-INTERVAL is the interval in days that was used to schedule the item's
968 current review date.
969 - REPEATS is the number of items the item has been successfully recalled without
970 without any failures. It is reset to 0 upon failure to recall the item.
971 - FAILURES is the total number of times the user has failed to recall the item.
972 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
973 - AVERAGE-QUALITY is the mean quality of recall of the item over
974 all its repetitions, successful and unsuccessful.
975 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
976 "
990 )))
1003 total-repeats meanq
1004 ease)
1005 "Stores the given data in the item at point."
1019 ;;; SM2 Algorithm =============================================================
1023 failures meanq total-repeats)
1024 "Arguments:
1025 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1026 - REPEATS -- the number of times the item has been successfully reviewed
1027 - EF -- the 'easiness factor'
1028 - QUALITY -- 0 to 5
1030 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
1031 - INTERVAL is the number of days until the item should next be reviewed
1032 - REPEATS is incremented by 1.
1033 - EF is modified based on the recall quality for the item.
1034 - OF-MATRIX is not modified."
1038 ;; When an item is failed, its interval is reset to 0,
1039 ;; but its EF is unchanged
1041 org-drill-sm5-optimal-factor-matrix)
1042 ;; else:
1061 interval)
1063 next-ef
1065 org-drill-sm5-optimal-factor-matrix))))
1068 ;;; SM5 Algorithm =============================================================
1074 org-drill-sm5-initial-interval
1075 ef))
1087 org-drill-sm5-optimal-factor-matrix))))
1089 of
1094 failures meanq total-repeats
1107 quality))
1112 quality org-drill-learn-fraction))
1119 last-interval n ef of-matrix)
1120 delta-days)))
1129 ;; "Failed" -- reset repetitions to 0,
1133 ; preserved
1134 ;; For a zero-based quality of 4 or 5, don't repeat
1135 ;; ((and (>= quality 4)
1136 ;; (not org-learn-always-reschedule))
1137 ;; (list 0 (1+ n) ef failures meanq
1138 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
1141 last-interval n ef of-matrix))
1146 ef
1147 failures
1148 meanq
1150 of-matrix)))))
1153 ;;; Simple8 Algorithm =========================================================
1157 "Arguments:
1158 - FAILURES: integer >= 0. The total number of times the item has
1159 been forgotten, ever.
1161 Returns the optimal FIRST interval for an item which has previously been
1162 forgotten on FAILURES occasions."
1167 "Arguments:
1168 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
1169 - REPETITION: the number of times the item has been tested.
1170 1 is the first repetition (ie the second trial).
1171 Returns:
1172 The factor by which the last interval should be
1173 multiplied to give the next interval. Corresponds to `RF' or `OF'."
1178 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
1179 to a mean item quality of QUALITY."
1188 failures meanq totaln
1190 "Arguments:
1191 - LAST-INTERVAL -- the number of days since the item was last reviewed.
1192 - REPEATS -- the number of times the item has been successfully reviewed
1193 - EASE -- the 'easiness factor'
1194 - QUALITY -- 0 to 5
1195 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
1196 0 = reviewed on the scheduled day. +N = N days overdue.
1197 -N = reviewed N days early.
1199 Returns the new item data, as a list of 6 values:
1200 - NEXT-INTERVAL
1201 - REPEATS
1202 - EASE
1203 - FAILURES
1204 - AVERAGE-QUALITY
1205 - TOTAL-REPEATS.
1206 See the documentation for `org-drill-get-item-data' for a description of these."
1213 quality))
1227 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1231 repeats))
1237 ;; The item was reviewed earlier than scheduled.
1248 next-interval)
1249 repeats
1251 failures
1252 meanq
1253 totaln
1254 )))
1259 ;;; Essentially copied from `org-learn.el', but modified to
1260 ;;; optionally call the SM2 or simple8 functions.
1262 "If DAYS-AHEAD is supplied it must be a positive integer. The
1263 item will be scheduled exactly this many days into the future."
1268 ;; Entries can have weights, 1 by default. Intervals are divided by the
1269 ;; item's weight, so an item with a weight of 2 will have all intervals
1270 ;; halved, meaning you will end up reviewing it twice as often.
1271 ;; Useful for entries which randomly present any of several facts.
1276 total-repeats meanq ease)
1279 failures meanq total-repeats
1283 ease quality failures
1284 meanq total-repeats ofmatrix))
1286 ease quality failures
1287 meanq total-repeats))
1289 quality failures meanq
1290 total-repeats
1291 delta-days)))
1303 total-repeats meanq ease)
1320 "Returns an integer representing the number of days into the future
1321 that the current item would be scheduled, based on a recall quality
1322 of QUALITY."
1325 total-repeats meanq ease)
1330 failures meanq total-repeats
1334 ease quality failures
1335 meanq total-repeats
1336 org-drill-sm5-optimal-factor-matrix))
1338 ease quality failures
1339 meanq total-repeats))
1341 quality failures meanq
1342 total-repeats)))
1347 (+ last-interval
1350 next-interval))))))
1358 intervals))
1363 "Returns quality rating (0-5), or nil if the user quit."
1368 org-drill--help-key
1369 org-drill--edit-key
1370 org-drill--tags-key
1371 org-drill--quit-key)))
1374 org-drill--edit-key
1380 3-5 Means you have remembered the item.
1382 0 - Completely forgot.
1383 1 - Even after seeing the answer, it still took a bit to sink in.
1384 2 - After seeing the answer, you remembered it.
1385 3 - It took you awhile, but you finally remembered. (+%s days)
1386 4 - After a little bit of thought you remembered. (+%s days)
1387 5 - You remembered the item really easily. (+%s days)
1389 How well did you do? %s"
1393 key-prompt)
1426 ;;(setq failures (if failures (string-to-number failures) 0))
1427 ;; (org-set-property "DRILL_FAILURE_COUNT"
1428 ;; (format "%d" (1+ failures)))
1441 quality))
1445 nil))))
1448 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1449 ;; "Returns a list containing the position of each immediate subheading of
1450 ;; the current topic."
1451 ;; (let ((drill-entry-level (org-current-level))
1452 ;; (drill-sections nil)
1453 ;; (drill-heading nil))
1454 ;; (org-show-subtree)
1455 ;; (save-excursion
1456 ;; (org-map-entries
1457 ;; (lambda ()
1458 ;; (when (and (not (org-invisible-p))
1459 ;; (> (org-current-level) drill-entry-level))
1460 ;; (setq drill-heading (org-get-heading t))
1461 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1462 ;; (member drill-heading heading-list))
1463 ;; (hide-subtree))
1464 ;; (push (point) drill-sections)))
1465 ;; "" 'tree))
1466 ;; (reverse drill-sections)))
1471 "TEST is a function taking no arguments. TEST will be called for each
1472 of the immediate subheadings of the current drill item, with the point
1473 on the relevant subheading. TEST should return nil if the subheading is
1474 to be revealed, non-nil if it is to be hidden.
1475 Returns a list containing the position of each immediate subheading of
1476 the current topic."
1515 org-drill--edit-key
1516 org-drill--tags-key
1517 org-drill--skip-key
1518 org-drill--quit-key))))
1555 prompt))
1560 You seem to be having a lot of trouble memorising this item.
1563 prompt)))
1569 "++:++ "
1571 prompt))
1591 "Hide the buffer region between BEG and END with an 'invisible text'
1592 visual overlay, or with the string TEXT if it is supplied."
1619 ;; This will also unhide the item's heading.
1629 ;; Don't hide:
1630 ;; - org links, partly because they might contain inline
1631 ;; images which we want to keep visible.
1632 ;; - LaTeX math fragments
1633 ;; - the contents of SRC blocks
1643 "Hide the current match with a 'cloze' visual overlay."
1657 ovl 'display
1658 ;; If hint is like `X...' then display [X...]
1659 ;; otherwise display [...X]
1661 hint))))))
1675 "During the execution of BODY, the entire text of the current entry is
1676 concealed by an overlay that displays the string TEXT."
1686 "During the execution of BODY, the entire text of the current entry is
1687 concealed by an overlay that displays the overlays in REPLACEMENTS."
1697 "Make an overlay that conceals the entire text of the item, not
1698 including properties or the contents of subheadings. The overlay shows
1699 the string TEXT.
1700 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1701 for the `display' text property. The text of the item will be temporarily
1702 replaced by all of these items, in the order in which they appear in
1703 the list.
1704 Note: does not actually alter the item."
1728 "Make overlays that conceal the entire text of the item, not
1729 including properties or the contents of subheadings. The overlay shows
1730 the string TEXT.
1731 Note: does not actually alter the item."
1741 p-max
1759 "Make an overlay that conceals the heading of the item. The overlay shows
1760 the string TEXT.
1761 Note: does not actually alter the item."
1775 text
1779 ;; (defun org-entry-empty-p ()
1780 ;; (zerop (length (org-drill-get-entry-text))))
1782 ;; This version is about 5x faster than the old version, above.
1797 ;;; Presentation functions ====================================================
1798 ;;
1799 ;; Each of these is called with point on topic heading. Each needs to show the
1800 ;; topic in the form of a 'question' or with some information 'hidden', as
1801 ;; appropriate for the card type. The user should then be prompted to press a
1802 ;; key. The function should then reveal either the 'answer' or the entire
1803 ;; topic, and should return t if the user chose to see the answer and rate their
1804 ;; recall, nil if they chose to quit.
1854 drill-sections))
1883 &optional
1884 force-show-first
1885 force-show-last
1886 force-hide-first)
1887 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1888 chosen at random.
1889 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1890 hiding all the rest.
1891 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1892 the hidden items.
1893 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1894 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1895 If the number of text pieces in the item is less than
1896 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1897 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1923 to match-count
1924 collect i)))
1928 ;; Force '1' to be in the list, and to be the first item
1929 ;; in the list.
1938 ;; (dolist (pos-to-hide match-nums)
1950 ;; (loop
1951 ;; do (re-search-forward org-drill-cloze-regexp
1952 ;; item-end t pos-to-hide)
1953 ;; while (org-pos-in-regexp (match-beginning 0)
1954 ;; org-bracket-link-regexp 1))
1955 ;; (org-drill-hide-matched-cloze-text)))))
1966 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1967 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1968 the second to last, etc."
1994 nil)
2001 ;; Don't consider this a cloze region if it is part of an
2002 ;; org link, or if it occurs inside a LaTeX math
2003 ;; fragment
2020 "Hides one of the pieces of text that are marked for cloze deletion,
2021 chosen at random."
2026 "Hides two of the pieces of text that are marked for cloze deletion,
2027 chosen at random."
2032 "Hides the first piece of text that is marked for cloze deletion."
2037 "Hides the last piece of text that is marked for cloze deletion."
2042 "Commonly, hides the FIRST piece of text that is marked for
2043 cloze deletion. Uncommonly, hide one of the other pieces of text,
2044 chosen at random.
2046 The definitions of 'commonly' and 'uncommonly' are determined by
2047 the value of `org-drill-cloze-text-weight'."
2048 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
2049 ;; to hide the 'favoured' piece of text. However even when the chance of
2050 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
2051 ;; the small number of repetitions where most learning takes place for each
2052 ;; item. In other words, the actual frequency during the first 10 repetitions
2053 ;; was often very different from 80%. Hence we use modulo instead.
2056 ;; Behave as hide1cloze
2061 org-drill-cloze-text-weight))
2063 org-drill-cloze-text-weight))
2064 ;; Uncommonly, hide any item except the first
2067 ;; Commonly, hide first item
2072 "Commonly, hides all pieces except the last. Uncommonly, shows
2073 any random piece. The effect is similar to 'show1cloze' except
2074 that the last item is much less likely to be the item that is
2075 visible.
2077 The definitions of 'commonly' and 'uncommonly' are determined by
2078 the value of `org-drill-cloze-text-weight'."
2081 ;; Behave as show1cloze
2086 org-drill-cloze-text-weight))
2088 org-drill-cloze-text-weight))
2089 ;; Uncommonly, show any item except the last
2092 ;; Commonly, show the LAST item
2097 "Commonly, hides all pieces except one, where the shown piece
2098 is guaranteed NOT to be the first piece. Uncommonly, shows any
2099 random piece. The effect is similar to 'show1cloze' except that
2100 the first item is much less likely to be the item that is
2101 visible.
2103 The definitions of 'commonly' and 'uncommonly' are determined by
2104 the value of `org-drill-cloze-text-weight'."
2107 ;; Behave as show1cloze
2112 org-drill-cloze-text-weight))
2114 org-drill-cloze-text-weight))
2115 ;; Uncommonly, show the first item
2118 ;; Commonly, show any item, except the first
2123 "Similar to `org-drill-present-multicloze-hide1', but hides all
2124 the pieces of text that are marked for cloze deletion, except for one
2125 piece which is chosen at random."
2130 "Similar to `org-drill-present-multicloze-show1', but reveals two
2131 pieces rather than one."
2136 "Present the string QUESTION as the only visible content of the card.
2137 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2151 "TEXTS is a list of valid values for the 'display' text property.
2152 Present these overlays, in sequence, as the only
2153 visible content of the card.
2154 If ANSWER is supplied, set the global variable `drill-answer' to its value."
2158 replacements
2168 "Present the current topic for interactive review, as in `org-drill'.
2169 Review will occur regardless of whether the topic is due for review or whether
2170 it meets the definition of a 'review topic' used by `org-drill'.
2172 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
2173 EDIT if the user chose to exit the drill and edit the current item. Choosing
2174 the latter option leaves the drill session suspended; it can be resumed
2175 later using `org-drill-resume'.
2177 See `org-drill' for more details."
2180 ;;(unless (org-part-of-drill-entry-p)
2181 ;; (error "Point is not inside a drill entry"))
2182 ;;(unless (org-at-heading-p)
2183 ;; (org-back-to-heading))
2188 ;; fontification functions in `outline-view-change-hook' can cause big
2189 ;; slowdowns, so we temporarily bind this variable to nil here.
2217 nil)
2253 "Returns true if the current drill session has continued past its
2254 maximum duration."
2263 "Returns true if the current drill session has reached the
2264 maximum number of items."
2268 org-drill-maximum-items-per-session)))
2277 m
2279 ;; First priority is items we failed in a prior session.
2284 ;; Next priority is overdue items.
2288 ;; We use `pop', not `pop-random', because we have already
2289 ;; sorted overdue items into a random order which takes
2290 ;; number of days overdue into account.
2292 ;; Next priority is 'young' items.
2297 ;; Next priority is newly added items, and older entries.
2298 ;; We pool these into a single group.
2310 ;; After all the above are done, last priority is items
2311 ;; that were failed earlier THIS SESSION.
2316 m)))
2320 "Returns nil, t, or a list of markers representing entries that were
2321 'failed' and need to be presented again before the session ends.
2323 RESUMING-P is true if we are resuming a suspended drill session."
2341 ;; The entry is not due anymore. This could arise if the user
2342 ;; suspends a drill session, then drills an individual entry,
2343 ;; then resumes the session.
2346 nil)
2383 "%d items reviewed. Session duration %s.
2384 Recall of reviewed items:
2385 Excellent (5): %3d%% | Near miss (2): %3d%%
2386 Good (4): %3d%% | Failure (1): %3d%%
2387 Hard (3): %3d%% | Abject failure (0): %3d%%
2389 You successfully recalled %d%% of reviewed items (quality > %s)
2390 %d/%d items still await review (%s, %s, %s, %s, %s).
2391 Tomorrow, %d more items will become due for review.
2392 Session finished. Press a key to continue..."
2408 pass-percent
2409 org-drill-failure-quality
2435 ))
2446 "%s
2447 You failed %d%% of the items you reviewed during this session.
2448 %d (%d%%) of all items scanned were overdue.
2450 Are you keeping up with your items, and reviewing them
2451 when they are scheduled? If so, you may want to consider
2452 lowering the value of `org-drill-learn-fraction' slightly in
2453 order to make items appear more frequently over time."
2460 ))))
2465 "MARKERS is a list of markers, all of which will be freed (set to
2466 point nowhere). Alternatively, MARKERS can be 't', in which case
2467 all the markers used by Org-Drill will be freed."
2476 markers))
2480 ;;; overdue-data is a list of entries, each entry has the form (POS DUE AGE)
2481 ;;; where POS is a marker pointing to the start of the entry, and
2482 ;;; DUE is a number indicating how many days ago the entry was due.
2483 ;;; AGE is the number of days elapsed since item creation (nil if unknown).
2484 ;;; if age > lapse threshold (default 90), sort by age (oldest first)
2485 ;;; if age < lapse threshold, sort by due (biggest first)
2492 overdue-data))
2513 "If USE-LAST-INTERVAL-P is non-nil, and DATE_ADDED is missing, use the
2514 value of DRILL_LAST_INTERVAL instead (as the item's age must be at least
2515 that many days)."
2527 "Returns a list (STATUS DUE AGE) where DUE is the number of days overdue,
2528 zero being due today, -1 being scheduled 1 day in the future.
2529 AGE is the number of days elapsed since the item was created (nil if unknown).
2530 STATUS is one of the following values:
2531 - nil, if the item is not a drill entry, or has an empty body
2532 - :unscheduled
2533 - :future
2534 - :new
2535 - :failed
2536 - :overdue
2537 - :young
2538 - :old
2539 "
2549 nil)
2555 ;; body is empty, and this is not a card type where empty bodies are
2556 ;; meaningful, so skip it.
2557 nil)
2560 ;; ((eql -1 due)
2561 ;; :tomorrow)
2564 ;; The rest of the stati all denote 'due' items ==========================
2566 org-drill-failure-quality)
2567 ;; Mature entries that were failed last time are
2568 ;; FAILED, regardless of how young, old or overdue
2569 ;; they are.
2574 ;; Overdue status overrides young versus old
2575 ;; distinction.
2576 ;; Store marker + due, for sorting of overdue entries
2579 org-drill-days-before-old)
2583 due age))))
2592 collected
2594 sym2)
2596 sym1)))))
2621 (:unscheduled
2623 ;; (:tomorrow
2624 ;; (incf *org-drill-dormant-entry-count*)
2625 ;; (incf *org-drill-due-tomorrow-count*))
2626 (:future
2630 (:new
2632 (:failed
2634 (:young
2636 (:overdue
2638 (:old
2640 )))))
2644 "Begin an interactive 'drill session'. The user is asked to
2645 review a series of topics (headers). Each topic is initially
2646 presented as a 'question', often with part of the topic content
2647 hidden. The user attempts to recall the hidden information or
2648 answer the question, then presses a key to reveal the answer. The
2649 user then rates his or her recall or performance on that
2650 topic. This rating information is used to reschedule the topic
2651 for future review.
2653 Org-drill proceeds by:
2655 - Finding all topics (headings) in SCOPE which have either been
2656 used and rescheduled before, or which have a tag that matches
2657 `org-drill-question-tag'.
2659 - All matching topics which are either unscheduled, or are
2660 scheduled for the current date or a date in the past, are
2661 considered to be candidates for the drill session.
2663 - If `org-drill-maximum-items-per-session' is set, a random
2664 subset of these topics is presented. Otherwise, all of the
2665 eligible topics will be presented.
2667 SCOPE determines the scope in which to search for
2668 questions. It accepts the same values as `org-drill-scope',
2669 which see.
2671 DRILL-MATCH, if supplied, is a string specifying a tags/property/
2672 todo query. Only items matching the query will be considered.
2673 It accepts the same values as `org-drill-match', which see.
2675 If RESUME-P is non-nil, resume a suspended drill session rather
2676 than starting a new one."
2679 ;; Check org version. Org 7.9.3f introduced a backwards-incompatible change
2680 ;; to the arguments accepted by `org-schedule'. At the time of writing there
2681 ;; are still lots of people using versions of org older than this.
2686 (format "Warning: org-drill requires org mode 7.9.3f or newer. Scheduling of failed cards will not
2687 work correctly with older versions of org mode. Your org mode version (%s) appears to be older than
2716 'org-map-drill-entry-function
2717 scope drill-match)
2745 "You can continue the drill session with the command `org-drill-resume'.%s"
2755 ))))
2763 "Run an interactive drill session in 'cram mode'. In cram mode,
2764 all drill items are considered to be due for review, unless they
2765 have been reviewed within the last `org-drill-cram-hours'
2766 hours."
2773 "Run an interactive drill session using drill items within the
2774 subtree at point."
2780 "Run an interactive drill session using drill items from all org
2781 files in the same directory as the current file."
2787 "Run a new drill session, but try to use leftover due items that
2788 were not reviewed during the last session, rather than scanning for
2789 unreviewed items. If there are no leftover items in memory, a full
2790 scan will be performed."
2808 "Resume a suspended drill session. Sessions are suspended by
2809 exiting them with the `edit' or `quit' options."
2815 ;; Current drill session is finished, but there are still
2816 ;; more items which need to be reviewed.
2818 "You have finished the drill session. However, %d items still
2819 need reviewing. Start a new drill session? "
2827 "Make the current item due for revision, and set its last interval to 0.
2828 Makes the item behave as if it has been failed, without actually recording a
2829 failure. This command can be used to 'reset' repetitions for an item."
2841 "Delete scheduling data from every drill entry in scope. This
2842 function may be useful if you want to give your collection of
2843 entries to someone else. Scope defaults to the current buffer,
2844 and is specified by the argument SCOPE, which accepts the same
2845 values as `org-drill-scope'."
2851 ;; Scope is the current buffer. This means we can use
2852 ;; `org-delete-property-globally', which is faster.
2862 ;; Compute local versions of the regexp for cloze deletions, in case
2863 ;; the left and right delimiters are redefined locally.
2871 ;; Can't add to org-mode-hook, because local variables won't have been loaded
2872 ;; yet.
2874 ;; (defun org-drill-add-cloze-fontification ()
2875 ;; (when (eql major-mode 'org-mode)
2876 ;; ;; Compute local versions of the regexp for cloze deletions, in case
2877 ;; ;; the left and right delimiters are redefined locally.
2878 ;; (setq-local org-drill-cloze-regexp (org-drill--compute-cloze-regexp))
2879 ;; (setq-local org-drill-cloze-keywords (org-drill--compute-cloze-keywords))
2880 ;; (when org-drill-use-visible-cloze-face-p
2881 ;; (font-lock-add-keywords nil ;'org-mode
2882 ;; org-drill-cloze-keywords
2883 ;; nil))))
2885 ;; XXX
2886 ;; (add-hook 'hack-local-variables-hook
2887 ;; 'org-drill-add-cloze-fontification)
2888 ;;
2889 ;; (org-drill-add-cloze-fontification)
2892 ;;; Synching card collections =================================================
2899 "Copy the subtree at point to the buffer DEST. The copy will receive
2900 the tag 'imported'."
2931 ;; We've looked all the way up the path
2932 ;; Default to appending to the end of DEST
2941 )))))
2946 "SRC and DEST are two org mode buffers containing drill items.
2947 For each drill item in DEST that shares an ID with an item in SRC,
2948 overwrite scheduling data in DEST with data taken from the item in SRC.
2949 This is intended for use when two people are sharing a set of drill items,
2950 one person has made some updates to the item set, and the other person
2951 wants to migrate to the updated set without losing their scheduling data.
2953 By default, any drill items in SRC which do not exist in DEST are
2954 copied into DEST. We attempt to place the copied item in the
2955 equivalent location in DEST to its location in SRC, by matching
2956 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2957 we simply ignore any items that do not exist in DEST, and do not
2958 copy them across."
2969 ;; Compile list of all IDs in the destination buffer.
2978 ;; Look through all entries in source buffer.
2988 nil)
2990 ;; This entry matches an entry in dest. Retrieve all its
2991 ;; scheduling data, then go to the matching location in dest
2992 ;; and write the data.
2995 total-repeats meanq ease)
3001 ;; go to matching entry in destination buffer
3007 total-repeats meanq ease)
3019 ;; item in SRC has ID, but no matching ID in DEST.
3020 ;; It must be a new item that does not exist in DEST.
3021 ;; Copy the entire item to the *end* of DEST.
3025 ;; Finally: there may be some items in DEST which are not in SRC, and
3026 ;; which have been scheduled by another user of DEST. Clear out the
3027 ;; scheduling info from all the unmatched items in DEST.
3037 ;;; Card types for learning languages =========================================
3039 ;;; Get spell-number.el from:
3040 ;;; http://www.emacswiki.org/emacs/spell-number.el
3044 ;;; `conjugate' card type =====================================================
3045 ;;; See spanish.org for usage
3051 ;; past tenses
3057 ;; future tenses
3059 ;; moods (backgrounds).
3065 )
3066 "Alist where each entry has the form (TENSE COLOUR), where
3067 TENSE is a string naming a tense in which verbs can be
3068 conjugated, and COLOUR is a string specifying a foreground colour
3069 which will be used by `org-drill-present-verb-conjugation' and
3070 `org-drill-show-answer-verb-conjugation' to fontify the verb and
3075 "Auxiliary function used by `org-drill-present-verb-conjugation' and
3076 `org-drill-show-answer-verb-conjugation'."
3095 :background
3105 "Present a drill entry whose card type is 'conjugate'."
3126 translation
3132 "Show the answer for a drill item whose card type is 'conjugate'.
3133 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3134 returns its return value."
3147 infinitive translation)
3152 ;;; `decline_noun' card type ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3168 ))
3172 "Auxiliary function used by `org-drill-present-noun-declension' and
3173 `org-drill-show-answer-noun-declension'."
3191 org-drill-noun-gender-alist t))
3199 "Present a drill entry whose card type is 'decline_noun'."
3221 noun noun-gender
3228 translation
3236 "Show the answer for a drill item whose card type is 'decline_noun'.
3237 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
3238 returns its return value."
3243 noun noun-gender translation)
3248 ;;; `translate_number' card type ==============================================
3249 ;;; See spanish.org for usage
3273 num-max num-min))
3296 ;; (defun org-drill-show-answer-translate-number (reschedule-fn)
3297 ;; (let* ((language (read (org-entry-get (point) "DRILL_LANGUAGE" t)))
3298 ;; (highlight-face 'font-lock-warning-face)
3299 ;; (non-english
3300 ;; (let ((spelln-language language))
3301 ;; (propertize (spelln-integer-in-words *drilled-number*)
3302 ;; 'face highlight-face)))
3303 ;; (english
3304 ;; (let ((spelln-language 'english-gb))
3305 ;; (propertize (spelln-integer-in-words *drilled-number*)
3306 ;; 'face 'highlight-face))))
3307 ;; (with-replaced-entry-text
3308 ;; (cond
3309 ;; ((eql 'to-english *drilled-number-direction*)
3310 ;; (format "\nThe English translation of %s is:\n\n%s\n"
3311 ;; non-english english))
3312 ;; (t
3313 ;; (format "\nThe %s translation of %s is:\n\n%s\n"
3314 ;; (capitalize (format "%s" language))
3315 ;; english non-english)))
3316 ;; (funcall reschedule-fn))))
3319 ;;; `spanish_verb' card type ==================================================
3320 ;;; Not very interesting, but included to demonstrate how a presentation
3321 ;;; function can manipulate which subheading are hidden versus shown.