ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

org-drill: Add auto pronounce feature 

* contrib/lisp/org-drill.el (org-drill-entry,
  org-drill-entry-before-hook, org-drill-entry-after-hook): Add two
  hooks around `org-drill-entry'.
(org-drill-auto-pronounce):
(org-drill-pronounce-command,org-drill-pronounce-command-args): New
functions.
(org-drill-pronounce-word): New function.
(org-drill-hide-subheadings-if): Fix issue in Org 9.2 version.
This commit is contained in:
stardiviner 2019-01-27 10:43:37 +08:00 committed by Nicolas Goaziou
parent 70c90c2cb5
commit d6130e5129
1 changed files with 64 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
contrib/lisp/org-drill.el
View File

@ -269,6 +269,9 @@ item.")
(defvar org-drill--tags-key ?t (defvar org-drill--tags-key ?t
"If this character is pressed during a drill session, edit the tags for "If this character is pressed during a drill session, edit the tags for
the current item.") the current item.")
(defvar org-drill--pronounce-key ?p
"If this character is pressed during a drill session, pronounce for
the current item.")
(defcustom org-drill-card-type-alist (defcustom org-drill-card-type-alist
@ -531,6 +534,34 @@ exponential effect on inter-repetition spacing."
:group 'org-drill :group 'org-drill
:type 'float) :type 'float)
(defcustom org-drill-entry-before-hook nil
"A hook to run functions when every org-drill entry."
:group 'org-drill
:type 'hook)
(defcustom org-drill-entry-after-hook nil
"A hook to run functions when every org-drill entry."
:group 'org-drill
:type 'hook)
(defcustom org-drill-auto-pronounce t
"Auto pronounce org-drill word if non-nil."
:group 'org-drill
:type 'boolean
:safe #'booleanp)
(defcustom org-drill-pronounce-command (executable-find "espeak")
"Org-drill pronounce command."
:group 'org-drill
:type 'string)
(defcustom org-drill-pronounce-command-args
(if (string= org-drill-pronounce-command "/usr/bin/espeak")
"-v en")
"Org-drill pronounce command arguments."
:group 'org-drill
:type 'string)
(defvar drill-answer nil (defvar drill-answer nil
"Global variable that can be bound to a correct answer when an "Global variable that can be bound to a correct answer when an
@ -1364,15 +1395,16 @@ of QUALITY."
(let ((ch nil) (let ((ch nil)
(input nil) (input nil)
(next-review-dates (org-drill-hypothetical-next-review-dates)) (next-review-dates (org-drill-hypothetical-next-review-dates))
(key-prompt (format "(0-5, %c=help, %c=edit, %c=tags, %c=quit)" (key-prompt (format "(0-5, %c=help, %c=pronounce, %c=edit, %c=tags, %c=quit)"
org-drill--help-key org-drill--help-key
org-drill--pronounce-key
org-drill--edit-key org-drill--edit-key
org-drill--tags-key org-drill--tags-key
org-drill--quit-key))) org-drill--quit-key)))
(save-excursion (save-excursion
(while (not (memq ch (list org-drill--quit-key (while (not (memq ch (list org-drill--quit-key
org-drill--edit-key org-drill--edit-key
7 ; C-g 7 ; C-g
?0 ?1 ?2 ?3 ?4 ?5))) ?0 ?1 ?2 ?3 ?4 ?5)))
(setq input (read-key-sequence (setq input (read-key-sequence
(if (eq ch org-drill--help-key) (if (eq ch org-drill--help-key)
@ -1391,7 +1423,9 @@ How well did you do? %s"
(round (nth 4 next-review-dates)) (round (nth 4 next-review-dates))
(round (nth 5 next-review-dates)) (round (nth 5 next-review-dates))
key-prompt) key-prompt)
(format "How well did you do? %s" key-prompt)))) (format "How well did you do? %s" key-prompt))
(when (eq ch org-drill--pronounce-key)
(org-drill-pronounce-word))))
(cond (cond
((stringp input) ((stringp input)
(setq ch (elt input 0))) (setq ch (elt input 0)))
@ -1486,7 +1520,7 @@ the current topic."
(funcall test)) (funcall test))
(hide-subtree)) (hide-subtree))
(push (point) drill-sections))) (push (point) drill-sections)))
"" 'tree)) nil 'tree))
(reverse drill-sections))) (reverse drill-sections)))
@ -1511,7 +1545,8 @@ the current topic."
(first fmt-and-args) (first fmt-and-args)
(rest fmt-and-args)) (rest fmt-and-args))
(format (concat "Press key for answer, " (format (concat "Press key for answer, "
"%c=edit, %c=tags, %c=skip, %c=quit.") "%c=pronounce, %c=edit, %c=tags, %c=skip, %c=quit.")
org-drill--pronounce-key
org-drill--edit-key org-drill--edit-key
org-drill--tags-key org-drill--tags-key
org-drill--skip-key org-drill--skip-key
@ -1561,19 +1596,21 @@ You seem to be having a lot of trouble memorising this item.
Consider reformulating the item to make it easier to remember.\n" Consider reformulating the item to make it easier to remember.\n"
'face '(:foreground "red")) 'face '(:foreground "red"))
prompt))) prompt)))
(while (memq ch '(nil org-drill--tags-key)) (while (memq ch '(nil org-drill--tags-key org-drill--pronounce-key))
(setq ch nil) (setq ch nil)
(while (not (input-pending-p)) (while (not (input-pending-p))
(let ((elapsed (time-subtract (current-time) item-start-time))) (let ((elapsed (time-subtract (current-time) item-start-time)))
(message (concat (if (>= (time-to-seconds elapsed) (* 60 60)) (message (concat (if (>= (time-to-seconds elapsed) (* 60 60))
"++:++ " "++:++ "
(format-time-string "%M:%S " elapsed)) (format-time-string "%M:%S " elapsed))
prompt)) prompt))
(sit-for 1))) (sit-for 1)))
(setq input (read-key-sequence nil)) (setq input (read-key-sequence nil))
(if (stringp input) (setq ch (elt input 0))) (if (stringp input) (setq ch (elt input 0)))
(if (eql ch org-drill--tags-key) (if (eql ch org-drill--tags-key)
(org-set-tags-command))) (org-set-tags-command))
(when (eq ch org-drill--pronounce-key)
(org-drill-pronounce-word)))
(case ch (case ch
(org-drill--quit-key nil) (org-drill--quit-key nil)
(org-drill--edit-key 'edit) (org-drill--edit-key 'edit)
@ -2163,6 +2200,16 @@ If ANSWER is supplied, set the global variable `drill-answer' to its value."
(prog1 (org-drill-presentation-prompt) (prog1 (org-drill-presentation-prompt)
(org-drill-hide-subheadings-if 'org-drill-entry-p))))) (org-drill-hide-subheadings-if 'org-drill-entry-p)))))
(defun org-drill-pronounce-word ()
"Pronounce word after querying."
(interactive)
(start-process-shell-command
"org-drill pronounce"
nil
(concat org-drill-pronounce-command
" " org-drill-pronounce-command-args " "
(shell-quote-argument
(substring-no-properties (org-get-heading t t t t))))))
(defun org-drill-entry () (defun org-drill-entry ()
"Present the current topic for interactive review, as in `org-drill'. "Present the current topic for interactive review, as in `org-drill'.
@ -2202,6 +2249,8 @@ See `org-drill' for more details."
'org-drill-present-default-answer) 'org-drill-present-default-answer)
present-empty-cards (third presentation-fn) present-empty-cards (third presentation-fn)
presentation-fn (first presentation-fn))) presentation-fn (first presentation-fn)))
(when org-drill-auto-pronounce (org-drill-pronounce-word))
(run-hook-with-args 'org-drill-entry-before-hook)
(prog1 (prog1
(cond (cond
((null presentation-fn) ((null presentation-fn)
@ -2223,7 +2272,8 @@ See `org-drill' for more details."
(save-excursion (save-excursion
(funcall answer-fn (funcall answer-fn
(lambda () (org-drill-reschedule)))))))) (lambda () (org-drill-reschedule))))))))
(org-remove-latex-fragment-image-overlays))))))) (run-hook-with-args 'org-drill-entry-after-hook)
(org-remove-latex-fragment-image-overlays)))))))
(defun org-drill-entries-pending-p () (defun org-drill-entries-pending-p ()