| blob | 4387161ac0a06af400be1df77ef5a3adb65beb66 |
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
264 (const :tag "All agenda files with any archive files associated with them." agenda-with-archives)
265 (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)
269 "If non-nil, prompt to save all modified buffers after a drill session
270 finishes."
275 "Which SuperMemo spaced repetition algorithm to use for scheduling items.
276 Available choices are:
277 - SM2 :: the SM2 algorithm, used in SuperMemo 2.0
278 - SM5 :: the SM5 algorithm, used in SuperMemo 5.0
279 - Simple8 :: a modified version of the SM8 algorithm. SM8 is used in
280 SuperMemo 98. The version implemented here is simplified in that while it
281 'learns' the difficulty of each item using quality grades and number of
282 failures, it does not modify the matrix of values that
283 governs how fast the inter-repetition intervals increase. A method for
284 adjusting intervals when items are reviewed early or late has been taken
285 from SM11, a later version of the algorithm, and included in Simple8."
290 "DO NOT CHANGE THE VALUE OF THIS VARIABLE.
292 Persistent matrix of optimal factors, used by the SuperMemo SM5 algorithm.
293 The matrix is saved (using the 'customize' facility) at the end of each
294 drill session.
296 Over time, values in the matrix will adapt to the individual user's
297 pace of learning."
302 "In the SM5 algorithm, the initial interval after the first
303 successful presentation of an item is always 4 days. If you wish to change
304 this, you can do so here."
309 "If true, the number of days until an item's next repetition
310 will vary slightly from the interval calculated by the SM2
311 algorithm. The variation is very small when the interval is
312 small, but scales up with the interval."
317 "If true, when the student successfully reviews an item 1 or more days
318 before or after the scheduled review date, this will affect that date of
319 the item's next scheduled review, according to the algorithm presented at
320 [[http://www.supermemo.com/english/algsm11.htm#Advanced%20repetitions]].
322 Items that were reviewed early will have their next review date brought
323 forward. Those that were reviewed late will have their next review
324 date postponed further.
326 Note that this option currently has no effect if the SM2 algorithm
327 is used."
332 "For card types 'hide1_firstmore', 'show1_lastmore' and 'show1_firstless',
333 this number determines how often the 'less favoured' situation
334 should arise. It will occur 1 in every N trials, where N is the
335 value of the variable.
337 For example, with the hide1_firstmore card type, the first piece
338 of clozed text should be hidden more often than the other
339 pieces. If this variable is set to 4 (default), the first item
340 will only be shown 25% of the time (1 in 4 trials). Similarly for
341 show1_lastmore, the last item will be shown 75% of the time, and
342 for show1_firstless, the first item would only be shown 25% of the
343 time.
345 If the value of this variable is NIL, then weighting is disabled, and
346 all weighted card types are treated as their unweighted equivalents."
351 "When in cram mode, items are considered due for review if
352 they were reviewed at least this many hours ago."
356 ;;; NEW items have never been presented in a drill session before.
357 ;;; MATURE items HAVE been presented at least once before.
358 ;;; - YOUNG mature items were scheduled no more than
359 ;;; ORG-DRILL-DAYS-BEFORE-OLD days after their last
360 ;;; repetition. These items will have been learned 'recently' and will have a
361 ;;; low repetition count.
362 ;;; - OLD mature items have intervals greater than
363 ;;; ORG-DRILL-DAYS-BEFORE-OLD.
364 ;;; - OVERDUE items are past their scheduled review date by more than
365 ;;; LAST-INTERVAL * (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) days,
366 ;;; regardless of young/old status.
369 "When an item's inter-repetition interval rises above this value in days,
370 it is no longer considered a 'young' (recently learned) item."
375 "An item is considered overdue if its scheduled review date is
376 more than (ORG-DRILL-OVERDUE-INTERVAL-FACTOR - 1) * LAST-INTERVAL
377 days in the past. For example, a value of 1.2 means an additional
378 20% of the last scheduled interval is allowed to elapse before
379 the item is overdue. A value of 1.0 means no extra time is
380 allowed at all - items are immediately considered overdue if
381 there is even one day's delay in reviewing them. This variable
382 should never be less than 1.0."
387 "Fraction between 0 and 1 that governs how quickly the spaces
388 between successive repetitions increase, for all items. The
389 default value is 0.5. Higher values make spaces increase more
390 quickly with each successful repetition. You should only change
391 this in small increments (for example 0.05-0.1) as it has an
392 exponential effect on inter-repetition spacing."
397 "Global variable that can be bound to a correct answer when an
398 item is being presented. If this variable is non-nil, the default
399 presentation function will show its value instead of the default
400 behaviour of revealing the contents of the drilled item.
402 This variable is useful for card types that compute their answers
403 -- for example, a card type that asks the student to translate a
414 "List of markers for items that are considered 'overdue', based on
417 "List of markers for mature entries whose last inter-repetition
420 "List of markers for mature entries whose last inter-repetition
428 "Are we in 'cram mode', where all items are considered due
435 ;;; Make the above settings safe as file-local variables.
465 ;;;; Utilities ================================================================
473 nil
480 "Add VAL to the end of the sequence stored in PLACE. Return the new
481 value."
485 "Randomly permute the elements of LIST (all permutations equally likely)."
486 ;; Adapted from 'shuffle-vector' in cookie1.el
488 j
489 temp
497 list)
500 "Round the floating point number FLOATNUM to FIX decimal places.
501 Example: (round-float 3.56755765 3) -> 3.568"
506 "Return a human-readable description of the key/keys to which the command
507 CMD is bound, or nil if it is not bound to a key."
514 time))
517 "Like `org-map-entries', but only drill entries are processed."
528 skip)))
557 "Nil means a last review date has not yet been stored for
558 the item.
559 Zero means it was reviewed today.
560 A positive number means it was reviewed that many days ago.
561 A negative number means the date of last review is in the future --
562 this should never happen."
570 "Like `org-drill-days-since-last-review', but return value is
571 in hours rather than days."
581 "Is MARKER, or the point, in a 'drill item'? This will return nil if
582 the point is inside a subheading of a drill item -- to handle that
583 situation use `org-part-of-drill-entry-p'."
594 "Is the current entry either the main heading of a 'drill item',
595 or a subheading within a drill item?"
597 ;; Does this heading INHERIT the drill tag
601 "Move the point to the heading which holds the :drill: tag for this
602 drill entry."
612 "Is the current entry a 'leech item'?"
616 ;; (defun org-drill-entry-due-p ()
617 ;; (cond
618 ;; (*org-drill-cram-mode*
619 ;; (let ((hours (org-drill-hours-since-last-review)))
620 ;; (and (org-drill-entry-p)
621 ;; (or (null hours)
622 ;; (>= hours org-drill-cram-hours)))))
623 ;; (t
624 ;; (let ((item-time (org-get-scheduled-time (point))))
625 ;; (and (org-drill-entry-p)
626 ;; (or (not (eql 'skip org-drill-leech-method))
627 ;; (not (org-drill-entry-leech-p)))
628 ;; (or (null item-time) ; not scheduled
629 ;; (not (minusp ; scheduled for today/in past
630 ;; (- (time-to-days (current-time))
631 ;; (time-to-days item-time))))))))))
634 "Returns:
635 - NIL if the item is not to be regarded as scheduled for review at all.
636 This is the case if it is not a drill item, or if it is a leech item
637 that we wish to skip, or if we are in cram mode and have already reviewed
638 the item within the last few hours.
639 - 0 if the item is new, or if it scheduled for review today.
640 - A negative integer - item is scheduled that many days in the future.
641 - A positive integer - item is scheduled that many days in the past."
655 nil)
663 "Returns true if entry that is scheduled DAYS-OVERDUE dasy in the past,
664 and whose last inter-repetition interval was LAST-INTERVAL, should be
665 considered 'overdue'. If the arguments are not given they are extracted
666 from the entry at point."
673 ;;(> due org-drill-days-before-overdue)
675 org-drill-overdue-interval-factor)))
691 default)))
727 default)))
729 ;;; From http://www.supermemo.com/english/ol/sm5.htm
731 "Returns a random number between 0.5 and 1.5."
744 "Random numbers in a pseudo-normal distribution with mean MEAN, range
745 MEAN-VARIATION to MEAN+VARIATION"
749 mean))
752 optimal-interval
753 days-ahead)
754 "Arguments:
755 - OPTIMAL-FACTOR: interval-factor if the item had been tested
756 exactly when it was supposed to be.
757 - OPTIMAL-INTERVAL: interval for next repetition (days) if the item had been
758 tested exactly when it was supposed to be.
759 - DAYS-AHEAD: how many days ahead of time the item was reviewed.
761 Returns an adjusted optimal factor which should be used to
762 calculate the next interval, instead of the optimal factor found
763 in the matrix."
765 (/ (+ optimal-interval
771 "Returns a list of 6 items, containing all the stored recall
772 data for the item at point:
773 - LAST-INTERVAL is the interval in days that was used to schedule the item's
774 current review date.
775 - REPEATS is the number of items the item has been successfully recalled without
776 without any failures. It is reset to 0 upon failure to recall the item.
777 - FAILURES is the total number of times the user has failed to recall the item.
778 - TOTAL-REPEATS includes both successful and unsuccessful repetitions.
779 - AVERAGE-QUALITY is the mean quality of recall of the item over
780 all its repetitions, successful and unsuccessful.
781 - EASE is a number reflecting how easy the item is to learn. Higher is easier.
782 "
796 )))
808 total-repeats meanq
809 ease)
810 "Stores the given data in the item at point."
822 ;;; SM2 Algorithm =============================================================
825 failures meanq total-repeats)
826 "Arguments:
827 - LAST-INTERVAL -- the number of days since the item was last reviewed.
828 - REPEATS -- the number of times the item has been successfully reviewed
829 - EF -- the 'easiness factor'
830 - QUALITY -- 0 to 5
832 Returns a list: (INTERVAL REPEATS EF FAILURES MEAN TOTAL-REPEATS OFMATRIX), where:
833 - INTERVAL is the number of days until the item should next be reviewed
834 - REPEATS is incremented by 1.
835 - EF is modified based on the recall quality for the item.
836 - OF-MATRIX is not modified."
840 ;; When an item is failed, its interval is reset to 0,
841 ;; but its EF is unchanged
843 org-drill-optimal-factor-matrix)
844 ;; else:
863 interval)
865 next-ef
867 org-drill-optimal-factor-matrix))))
870 ;;; SM5 Algorithm =============================================================
874 org-drill-sm5-initial-interval
875 ef))
886 org-drill-optimal-factor-matrix))))
888 of
892 failures meanq total-repeats
904 quality))
908 quality org-drill-learn-fraction))
915 last-interval n ef of-matrix)
916 delta-days)))
922 ;; "Failed" -- reset repetitions to 0,
926 ; preserved
927 ;; For a zero-based quality of 4 or 5, don't repeat
928 ;; ((and (>= quality 4)
929 ;; (not org-learn-always-reschedule))
930 ;; (list 0 (1+ n) ef failures meanq
931 ;; (1+ total-repeats) of-matrix)) ; 0 interval = unschedule
934 last-interval n ef of-matrix))
939 ef
940 failures
941 meanq
943 of-matrix)))))
945 ;;; Simple8 Algorithm =========================================================
948 "Arguments:
949 - FAILURES: integer >= 0. The total number of times the item has
950 been forgotten, ever.
952 Returns the optimal FIRST interval for an item which has previously been
953 forgotten on FAILURES occasions."
957 "Arguments:
958 - EASE: floating point number >= 1.2. Corresponds to `AF' in SM8 algorithm.
959 - REPETITION: the number of times the item has been tested.
960 1 is the first repetition (ie the second trial).
961 Returns:
962 The factor by which the last interval should be
963 multiplied to give the next interval. Corresponds to `RF' or `OF'."
967 "Returns the ease (`AF' in the SM8 algorithm) which corresponds
968 to a mean item quality of QUALITY."
976 failures meanq totaln
978 "Arguments:
979 - LAST-INTERVAL -- the number of days since the item was last reviewed.
980 - REPEATS -- the number of times the item has been successfully reviewed
981 - EASE -- the 'easiness factor'
982 - QUALITY -- 0 to 5
983 - DELTA-DAYS -- how many days overdue was the item when it was reviewed.
984 0 = reviewed on the scheduled day. +N = N days overdue.
985 -N = reviewed N days early.
987 Returns the new item data, as a list of 6 values:
988 - NEXT-INTERVAL
989 - REPEATS
990 - EASE
991 - FAILURES
992 - AVERAGE-QUALITY
993 - TOTAL-REPEATS.
994 See the documentation for `org-drill-get-item-data' for a description of these."
1001 quality))
1015 org-drill-adjust-intervals-for-early-and-late-repetitions-p
1019 repeats))
1025 ;; The item was reviewed earlier than scheduled.
1036 next-interval)
1037 repeats
1039 failures
1040 meanq
1041 totaln)))
1043 ;;; Essentially copied from `org-learn.el', but modified to
1044 ;;; optionally call the SM2 or simple8 functions.
1046 "If DAYS-AHEAD is supplied it must be a positive integer. The
1047 item will be scheduled exactly this many days into the future."
1052 ;; Entries can have weights, 1 by default. Intervals are divided by the
1053 ;; item's weight, so an item with a weight of 2 will have all intervals
1054 ;; halved, meaning you will end up reviewing it twice as often.
1055 ;; Useful for entries which randomly present any of several facts.
1060 total-repeats meanq ease)
1063 failures meanq total-repeats
1067 ease quality failures
1068 meanq total-repeats ofmatrix))
1070 ease quality failures
1071 meanq total-repeats))
1073 quality failures meanq
1074 total-repeats
1075 delta-days)))
1087 total-repeats meanq ease)
1104 "Returns an integer representing the number of days into the future
1105 that the current item would be scheduled, based on a recall quality
1106 of QUALITY."
1109 total-repeats meanq ease)
1114 failures meanq total-repeats
1118 ease quality failures
1119 meanq total-repeats
1120 org-drill-optimal-factor-matrix))
1122 ease quality failures
1123 meanq total-repeats))
1125 quality failures meanq
1126 total-repeats)))
1131 (+ last-interval
1134 next-interval))))))
1142 intervals))
1147 "Returns quality rating (0-5), or nil if the user quit."
1156 3-5 Means you have remembered the item.
1158 0 - Completely forgot.
1159 1 - Even after seeing the answer, it still took a bit to sink in.
1160 2 - After seeing the answer, you remembered it.
1161 3 - It took you awhile, but you finally remembered. (+%s days)
1162 4 - After a little bit of thought you remembered. (+%s days)
1163 5 - You remembered the item really easily. (+%s days)
1165 How well did you do? (0-5, ?=help, e=edit, t=tags, q=quit)"
1200 ;;(setq failures (if failures (string-to-number failures) 0))
1201 ;; (org-set-property "DRILL_FAILURE_COUNT"
1202 ;; (format "%d" (1+ failures)))
1215 quality))
1219 nil))))
1221 ;; (defun org-drill-hide-all-subheadings-except (heading-list)
1222 ;; "Returns a list containing the position of each immediate subheading of
1223 ;; the current topic."
1224 ;; (let ((drill-entry-level (org-current-level))
1225 ;; (drill-sections nil)
1226 ;; (drill-heading nil))
1227 ;; (org-show-subtree)
1228 ;; (save-excursion
1229 ;; (org-map-entries
1230 ;; (lambda ()
1231 ;; (when (and (not (outline-invisible-p))
1232 ;; (> (org-current-level) drill-entry-level))
1233 ;; (setq drill-heading (org-get-heading t))
1234 ;; (unless (and (= (org-current-level) (1+ drill-entry-level))
1235 ;; (member drill-heading heading-list))
1236 ;; (hide-subtree))
1237 ;; (push (point) drill-sections)))
1238 ;; "" 'tree))
1239 ;; (reverse drill-sections)))
1242 "TEST is a function taking no arguments. TEST will be called for each
1243 of the immediate subheadings of the current drill item, with the point
1244 on the relevant subheading. TEST should return nil if the subheading is
1245 to be revealed, non-nil if it is to be hidden.
1246 Returns a list containing the position of each immediate subheading of
1247 the current topic."
1320 prompt))
1325 You seem to be having a lot of trouble memorising this item.
1328 prompt)))
1334 "++:++ "
1336 prompt))
1354 "Hide the buffer region between BEG and END with an 'invisible text'
1355 visual overlay, or with the string TEXT if it is supplied."
1378 ;; This will also unhide the item's heading.
1387 ;; Don't hide org links, partly because they might contain inline
1388 ;; images which we want to keep visible
1395 "Hide the current match with a 'cloze' visual overlay."
1408 ovl 'display
1409 ;; If hint is like `X...' then display [X...]
1410 ;; otherwise display [...X]
1412 hint))))))
1424 "During the execution of BODY, the entire text of the current entry is
1425 concealed by an overlay that displays the string TEXT."
1434 "During the execution of BODY, the entire text of the current entry is
1435 concealed by an overlay that displays the overlays in REPLACEMENTS."
1444 "Make an overlay that conceals the entire text of the item, not
1445 including properties or the contents of subheadings. The overlay shows
1446 the string TEXT.
1447 If MULTI-P is non-nil, TEXT must be a list of values which are legal
1448 for the `display' text property. The text of the item will be temporarily
1449 replaced by all of these items, in the order in which they appear in
1450 the list.
1451 Note: does not actually alter the item."
1472 "Make overlays that conceal the entire text of the item, not
1473 including properties or the contents of subheadings. The overlay shows
1474 the string TEXT.
1475 Note: does not actually alter the item."
1485 p-max
1500 "Make an overlay that conceals the heading of the item. The overlay shows
1501 the string TEXT.
1502 Note: does not actually alter the item."
1514 text
1518 ;; (defun org-entry-empty-p ()
1519 ;; (zerop (length (org-drill-get-entry-text))))
1521 ;; This version is about 5x faster than the old version, above.
1533 ;;; Presentation functions ====================================================
1534 ;;
1535 ;; Each of these is called with point on topic heading. Each needs to show the
1536 ;; topic in the form of a 'question' or with some information 'hidden', as
1537 ;; appropriate for the card type. The user should then be prompted to press a
1538 ;; key. The function should then reveal either the 'answer' or the entire
1539 ;; topic, and should return t if the user chose to see the answer and rate their
1540 ;; recall, nil if they chose to quit.
1578 drill-sections))
1602 &optional
1603 force-show-first
1604 force-show-last
1605 force-hide-first)
1606 "Hides NUMBER-TO-HIDE pieces of text that are marked for cloze deletion,
1607 chosen at random.
1608 If NUMBER-TO-HIDE is negative, show only (ABS NUMBER-TO-HIDE) pieces,
1609 hiding all the rest.
1610 If FORCE-HIDE-FIRST is non-nil, force the first piece of text to be one of
1611 the hidden items.
1612 If FORCE-SHOW-FIRST is non-nil, never hide the first piece of text.
1613 If FORCE-SHOW-LAST is non-nil, never hide the last piece of text.
1614 If the number of text pieces in the item is less than
1615 NUMBER-TO-HIDE, then all text pieces will be hidden (except the first or last
1616 items if FORCE-SHOW-FIRST or FORCE-SHOW-LAST is non-nil)."
1641 to match-count
1642 collect i)))
1646 ;; Force '1' to be in the list, and to be the first item
1647 ;; in the list.
1656 ;; (dolist (pos-to-hide match-nums)
1667 ;; (loop
1668 ;; do (re-search-forward org-drill-cloze-regexp
1669 ;; item-end t pos-to-hide)
1670 ;; while (org-pos-in-regexp (match-beginning 0)
1671 ;; org-bracket-link-regexp 1))
1672 ;; (org-drill-hide-matched-cloze-text)))))
1681 "Hide the TO-HIDE'th piece of clozed text. 1 is the first piece. If
1682 TO-HIDE is negative, count backwards, so -1 means the last item, -2
1683 the second to last, etc."
1708 nil)
1728 "Hides one of the pieces of text that are marked for cloze deletion,
1729 chosen at random."
1733 "Hides two of the pieces of text that are marked for cloze deletion,
1734 chosen at random."
1738 "Hides the first piece of text that is marked for cloze deletion."
1742 "Hides the last piece of text that is marked for cloze deletion."
1746 "Commonly, hides the FIRST piece of text that is marked for
1747 cloze deletion. Uncommonly, hide one of the other pieces of text,
1748 chosen at random.
1750 The definitions of 'commonly' and 'uncommonly' are determined by
1751 the value of `org-drill-cloze-text-weight'."
1752 ;; The 'firstmore' and 'lastmore' functions used to randomly choose whether
1753 ;; to hide the 'favoured' piece of text. However even when the chance of
1754 ;; hiding it was set quite high (80%), the outcome was too unpredictable over
1755 ;; the small number of repetitions where most learning takes place for each
1756 ;; item. In other words, the actual frequency during the first 10 repetitions
1757 ;; was often very different from 80%. Hence we use modulo instead.
1760 ;; Behave as hide1cloze
1765 org-drill-cloze-text-weight))
1767 org-drill-cloze-text-weight))
1768 ;; Uncommonly, hide any item except the first
1771 ;; Commonly, hide first item
1775 "Commonly, hides all pieces except the last. Uncommonly, shows
1776 any random piece. The effect is similar to 'show1cloze' except
1777 that the last item is much less likely to be the item that is
1778 visible.
1780 The definitions of 'commonly' and 'uncommonly' are determined by
1781 the value of `org-drill-cloze-text-weight'."
1784 ;; Behave as show1cloze
1789 org-drill-cloze-text-weight))
1791 org-drill-cloze-text-weight))
1792 ;; Uncommonly, show any item except the last
1795 ;; Commonly, show the LAST item
1799 "Commonly, hides all pieces except one, where the shown piece
1800 is guaranteed NOT to be the first piece. Uncommonly, shows any
1801 random piece. The effect is similar to 'show1cloze' except that
1802 the first item is much less likely to be the item that is
1803 visible.
1805 The definitions of 'commonly' and 'uncommonly' are determined by
1806 the value of `org-drill-cloze-text-weight'."
1809 ;; Behave as show1cloze
1814 org-drill-cloze-text-weight))
1816 org-drill-cloze-text-weight))
1817 ;; Uncommonly, show the first item
1820 ;; Commonly, show any item, except the first
1824 "Similar to `org-drill-present-multicloze-hide1', but hides all
1825 the pieces of text that are marked for cloze deletion, except for one
1826 piece which is chosen at random."
1830 "Similar to `org-drill-present-multicloze-show1', but reveals two
1831 pieces rather than one."
1834 ;; (defun org-drill-present-multicloze-show1 ()
1835 ;; "Similar to `org-drill-present-multicloze-hide1', but hides all
1836 ;; the pieces of text that are marked for cloze deletion, except for one
1837 ;; piece which is chosen at random."
1838 ;; (with-hidden-comments
1839 ;; (with-hidden-cloze-hints
1840 ;; (let ((item-end nil)
1841 ;; (match-count 0)
1842 ;; (body-start (or (cdr (org-get-property-block))
1843 ;; (point))))
1844 ;; (org-drill-hide-all-subheadings-except nil)
1845 ;; (save-excursion
1846 ;; (outline-next-heading)
1847 ;; (setq item-end (point)))
1848 ;; (save-excursion
1849 ;; (goto-char body-start)
1850 ;; (while (re-search-forward org-drill-cloze-regexp item-end t)
1851 ;; (incf match-count)))
1852 ;; (when (plusp match-count)
1853 ;; (let ((match-to-hide (random* match-count)))
1854 ;; (save-excursion
1855 ;; (goto-char body-start)
1856 ;; (dotimes (n match-count)
1857 ;; (re-search-forward org-drill-cloze-regexp
1858 ;; item-end t)
1859 ;; (unless (= n match-to-hide)
1860 ;; (org-drill-hide-matched-cloze-text))))))
1861 ;; (org-display-inline-images t)
1862 ;; (org-cycle-hide-drawers 'all)
1863 ;; (prog1 (org-drill-presentation-prompt)
1864 ;; (org-drill-hide-subheadings-if 'org-drill-entry-p)
1865 ;; (org-drill-unhide-clozed-text))))))
1868 "Present the string QUESTION as the only visible content of the card.
1869 If ANSWER is supplied, set the global variable `drill-answer' to its value."
1882 "TEXTS is a list of valid values for the 'display' text property.
1883 Present these overlays, in sequence, as the only
1884 visible content of the card.
1885 If ANSWER is supplied, set the global variable `drill-answer' to its value."
1889 replacements
1898 "Present the current topic for interactive review, as in `org-drill'.
1899 Review will occur regardless of whether the topic is due for review or whether
1900 it meets the definition of a 'review topic' used by `org-drill'.
1902 Returns a quality rating from 0 to 5, or nil if the user quit, or the symbol
1903 EDIT if the user chose to exit the drill and edit the current item. Choosing
1904 the latter option leaves the drill session suspended; it can be resumed
1905 later using `org-drill-resume'.
1907 See `org-drill' for more details."
1910 ;;(unless (org-part-of-drill-entry-p)
1911 ;; (error "Point is not inside a drill entry"))
1912 ;;(unless (org-at-heading-p)
1913 ;; (org-back-to-heading))
1918 ;; fontification functions in `outline-view-change-hook' can cause big
1919 ;; slowdowns, so we temporarily bind this variable to nil here.
1946 nil)
1978 "Returns true if the current drill session has continued past its
1979 maximum duration."
1987 "Returns true if the current drill session has reached the
1988 maximum number of items."
1992 org-drill-maximum-items-per-session)))
2000 m
2002 ;; First priority is items we failed in a prior session.
2007 ;; Next priority is overdue items.
2011 ;; We use `pop', not `pop-random', because we have already
2012 ;; sorted overdue items into a random order which takes
2013 ;; number of days overdue into account.
2015 ;; Next priority is 'young' items.
2020 ;; Next priority is newly added items, and older entries.
2021 ;; We pool these into a single group.
2033 ;; After all the above are done, last priority is items
2034 ;; that were failed earlier THIS SESSION.
2039 m)))
2042 "Returns nil, t, or a list of markers representing entries that were
2043 'failed' and need to be presented again before the session ends.
2045 RESUMING-P is true if we are resuming a suspended drill session."
2063 ;; The entry is not due anymore. This could arise if the user
2064 ;; suspends a drill session, then drills an individual entry,
2065 ;; then resumes the session.
2068 nil)
2103 "%d items reviewed. Session duration %s.
2104 Recall of reviewed items:
2105 Excellent (5): %3d%% | Near miss (2): %3d%%
2106 Good (4): %3d%% | Failure (1): %3d%%
2107 Hard (3): %3d%% | Abject failure (0): %3d%%
2109 You successfully recalled %d%% of reviewed items (quality > %s)
2110 %d/%d items still await review (%s, %s, %s, %s, %s).
2111 Tomorrow, %d more items will become due for review.
2112 Session finished. Press a key to continue..."
2128 pass-percent
2129 org-drill-failure-quality
2155 ))
2166 "%s
2167 You failed %d%% of the items you reviewed during this session.
2168 %d (%d%%) of all items scanned were overdue.
2170 Are you keeping up with your items, and reviewing them
2171 when they are scheduled? If so, you may want to consider
2172 lowering the value of `org-drill-learn-fraction' slightly in
2173 order to make items appear more frequently over time."
2182 "MARKERS is a list of markers, all of which will be freed (set to
2183 point nowhere). Alternatively, MARKERS can be 't', in which case
2184 all the markers used by Org-Drill will be freed."
2193 markers))
2205 "Returns a list (STATUS DUE) where DUE is the number of days overdue,
2206 zero being due today, -1 being scheduled 1 day in the future. STATUS is
2207 one of the following values:
2208 - nil, if the item is not a drill entry, or has an empty body
2209 - :unscheduled
2210 - :future
2211 - :new
2212 - :failed
2213 - :overdue
2214 - :young
2215 - :old
2216 "
2225 nil)
2231 ;; body is empty, and this is not a card type where empty bodies are
2232 ;; meaningful, so skip it.
2233 nil)
2236 ;; ((eql -1 due)
2237 ;; :tomorrow)
2240 ;; The rest of the stati all denote 'due' items ==========================
2242 org-drill-failure-quality)
2243 ;; Mature entries that were failed last time are
2244 ;; FAILED, regardless of how young, old or overdue
2245 ;; they are.
2250 ;; Overdue status overrides young versus old
2251 ;; distinction.
2252 ;; Store marker + due, for sorting of overdue entries
2255 org-drill-days-before-old)
2259 due))))
2268 collected
2270 sym2)
2272 sym1)))))
2276 "Begin an interactive 'drill session'. The user is asked to
2277 review a series of topics (headers). Each topic is initially
2278 presented as a 'question', often with part of the topic content
2279 hidden. The user attempts to recall the hidden information or
2280 answer the question, then presses a key to reveal the answer. The
2281 user then rates his or her recall or performance on that
2282 topic. This rating information is used to reschedule the topic
2283 for future review.
2285 Org-drill proceeds by:
2287 - Finding all topics (headings) in SCOPE which have either been
2288 used and rescheduled before, or which have a tag that matches
2289 `org-drill-question-tag'.
2291 - All matching topics which are either unscheduled, or are
2292 scheduled for the current date or a date in the past, are
2293 considered to be candidates for the drill session.
2295 - If `org-drill-maximum-items-per-session' is set, a random
2296 subset of these topics is presented. Otherwise, all of the
2297 eligible topics will be presented.
2299 SCOPE determines the scope in which to search for
2300 questions. It accepts the same values as `org-drill-scope',
2301 which see.
2303 If RESUME-P is non-nil, resume a suspended drill session rather
2304 than starting a new one."
2355 (:unscheduled
2357 ;; (:tomorrow
2358 ;; (incf *org-drill-dormant-entry-count*)
2359 ;; (incf *org-drill-due-tomorrow-count*))
2360 (:future
2364 (:new
2366 (:failed
2368 (:young
2370 (:overdue
2372 (:old
2374 )))))
2375 scope)
2403 "You can continue the drill session with the command `org-drill-resume'.%s"
2418 org-drill-optimal-factor-matrix))
2422 "Run an interactive drill session in 'cram mode'. In cram mode,
2423 all drill items are considered to be due for review, unless they
2424 have been reviewed within the last `org-drill-cram-hours'
2425 hours."
2432 "Run an interactive drill session using drill items within the
2433 subtree at point."
2439 "Run an interactive drill session using drill items from all org
2440 files in the same directory as the current file."
2446 "Run a new drill session, but try to use leftover due items that
2447 were not reviewed during the last session, rather than scanning for
2448 unreviewed items. If there are no leftover items in memory, a full
2449 scan will be performed."
2467 "Resume a suspended drill session. Sessions are suspended by
2468 exiting them with the `edit' or `quit' options."
2474 ;; Current drill session is finished, but there are still
2475 ;; more items which need to be reviewed.
2477 "You have finished the drill session. However, %d items still
2478 need reviewing. Start a new drill session? "
2492 "Delete scheduling data from every drill entry in scope. This
2493 function may be useful if you want to give your collection of
2494 entries to someone else. Scope defaults to the current buffer,
2495 and is specified by the argument SCOPE, which accepts the same
2496 values as `org-drill-scope'."
2502 ;; Scope is the current buffer. This means we can use
2503 ;; `org-delete-property-globally', which is faster.
2516 org-drill-cloze-keywords
2517 nil)))
2524 ;;; Synching card collections =================================================
2531 "Copy the subtree at point to the buffer DEST. The copy will receive
2532 the tag 'imported'."
2563 ;; We've looked all the way up the path
2564 ;; Default to appending to the end of DEST
2576 "SRC and DEST are two org mode buffers containing drill items.
2577 For each drill item in DEST that shares an ID with an item in SRC,
2578 overwrite scheduling data in DEST with data taken from the item in SRC.
2579 This is intended for use when two people are sharing a set of drill items,
2580 one person has made some updates to the item set, and the other person
2581 wants to migrate to the updated set without losing their scheduling data.
2583 By default, any drill items in SRC which do not exist in DEST are
2584 copied into DEST. We attempt to place the copied item in the
2585 equivalent location in DEST to its location in SRC, by matching
2586 the heading hierarchy. However if IGNORE-NEW-ITEMS-P is non-nil,
2587 we simply ignore any items that do not exist in DEST, and do not
2588 copy them across."
2599 ;; Compile list of all IDs in the destination buffer.
2608 ;; Look through all entries in source buffer.
2618 nil)
2620 ;; This entry matches an entry in dest. Retrieve all its
2621 ;; scheduling data, then go to the matching location in dest
2622 ;; and write the data.
2625 total-repeats meanq ease)
2631 ;; go to matching entry in destination buffer
2637 total-repeats meanq ease)
2649 ;; item in SRC has ID, but no matching ID in DEST.
2650 ;; It must be a new item that does not exist in DEST.
2651 ;; Copy the entire item to the *end* of DEST.
2655 ;; Finally: there may be some items in DEST which are not in SRC, and
2656 ;; which have been scheduled by another user of DEST. Clear out the
2657 ;; scheduling info from all the unmatched items in DEST.
2665 ;;; Card types for learning languages =========================================
2667 ;;; Get spell-number.el from:
2668 ;;; http://www.emacswiki.org/emacs/spell-number.el
2671 ;;; `conjugate' card type =====================================================
2672 ;;; See spanish.org for usage
2678 ;; past tenses
2684 ;; future tenses
2686 ;; moods (backgrounds).
2692 )
2693 "Alist where each entry has the form (TENSE COLOUR), where
2694 TENSE is a string naming a tense in which verbs can be
2695 conjugated, and COLOUR is a string specifying a foreground colour
2696 which will be used by `org-drill-present-verb-conjugation' and
2697 `org-drill-show-answer-verb-conjugation' to fontify the verb and
2702 "Auxiliary function used by `org-drill-present-verb-conjugation' and
2703 `org-drill-show-answer-verb-conjugation'."
2722 :background
2732 "Present a drill entry whose card type is 'conjugate'."
2753 translation
2759 "Show the answer for a drill item whose card type is 'conjugate'.
2760 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2761 returns its return value."
2774 infinitive translation)
2779 ;;; `decline_noun' card type ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2795 ))
2799 "Auxiliary function used by `org-drill-present-noun-declension' and
2800 `org-drill-show-answer-noun-declension'."
2818 org-drill-noun-gender-alist t))
2826 "Present a drill entry whose card type is 'decline_noun'."
2848 noun noun-gender
2855 translation
2863 "Show the answer for a drill item whose card type is 'decline_noun'.
2864 RESCHEDULE-FN must be a function that calls `org-drill-reschedule' and
2865 returns its return value."
2870 noun noun-gender translation)
2875 ;;; `translate_number' card type ==============================================
2876 ;;; See spanish.org for usage
2900 num-max num-min))
2922 ;; (defun org-drill-show-answer-translate-number (reschedule-fn)
2923 ;; (let* ((language (read (org-entry-get (point) "DRILL_LANGUAGE" t)))
2924 ;; (highlight-face 'font-lock-warning-face)
2925 ;; (non-english
2926 ;; (let ((spelln-language language))
2927 ;; (propertize (spelln-integer-in-words *drilled-number*)
2928 ;; 'face highlight-face)))
2929 ;; (english
2930 ;; (let ((spelln-language 'english-gb))
2931 ;; (propertize (spelln-integer-in-words *drilled-number*)
2932 ;; 'face 'highlight-face))))
2933 ;; (with-replaced-entry-text
2934 ;; (cond
2935 ;; ((eql 'to-english *drilled-number-direction*)
2936 ;; (format "\nThe English translation of %s is:\n\n%s\n"
2937 ;; non-english english))
2938 ;; (t
2939 ;; (format "\nThe %s translation of %s is:\n\n%s\n"
2940 ;; (capitalize (format "%s" language))
2941 ;; english non-english)))
2942 ;; (funcall reschedule-fn))))
2945 ;;; `spanish_verb' card type ==================================================
2946 ;;; Not very interesting, but included to demonstrate how a presentation
2947 ;;; function can manipulate which subheading are hidden versus shown.