elisp/anki-editor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add doc strings.

Browse source
This commit is contained in:
louie 2018-01-07 10:48:23 +08:00
parent e489e729e2
commit 196800efaa
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
anki-editor.el
View file

@ -35,6 +35,7 @@
;; Commands ;; Commands
(defun anki-editor-submit () (defun anki-editor-submit ()
"Send notes in current buffer to Anki."
(interactive) (interactive)
(let* ((tree (org-element-parse-buffer)) (let* ((tree (org-element-parse-buffer))
(note-headings (anki-editor--get-note-headings tree)) (note-headings (anki-editor--get-note-headings tree))
@ -53,6 +54,8 @@
(message (format "Submitted %d notes, %d successful, %d failed." total (- total failed) failed)))))))) (message (format "Submitted %d notes, %d successful, %d failed." total (- total failed) failed))))))))
(defun anki-editor-insert-deck (&optional prefix) (defun anki-editor-insert-deck (&optional prefix)
"Insert a deck heading with the same level as current heading.
With prefix, only insert the deck name."
(interactive "P") (interactive "P")
(message "Fetching decks...") (message "Fetching decks...")
(anki-editor--anki-connect-invoke (anki-editor--anki-connect-invoke
@ -64,6 +67,10 @@
(unless prefix (anki-editor--set-tags-fix anki-editor-deck-tag))))) (unless prefix (anki-editor--set-tags-fix anki-editor-deck-tag)))))
(defun anki-editor-insert-note () (defun anki-editor-insert-note ()
"Insert a note heading with the same level as current heading.
The inserted heading will be structured with the property drawer
and subheadings that correspond to the fields of the selected
note type."
(interactive) (interactive)
(message "Fetching note types...") (message "Fetching note types...")
(anki-editor--anki-connect-invoke (anki-editor--anki-connect-invoke
@ -93,6 +100,7 @@
(newline-and-indent))))))) (newline-and-indent)))))))
(defun anki-editor-export-heading-contents-to-html () (defun anki-editor-export-heading-contents-to-html ()
"Export the contents of the heading at point to HTML."
(interactive) (interactive)
(let ((tree (org-element-at-point)) (let ((tree (org-element-at-point))
contents) contents)
@ -113,6 +121,7 @@
(,(kbd "C-c a e") . ,#'anki-editor-export-heading-contents-to-html))) (,(kbd "C-c a e") . ,#'anki-editor-export-heading-contents-to-html)))
(defun anki-editor-setup-default-keybindings () (defun anki-editor-setup-default-keybindings ()
"Set up the default keybindings."
(interactive) (interactive)
(dolist (map anki-editor--key-map) (dolist (map anki-editor--key-map)
(local-set-key (car map) (cdr map))) (local-set-key (car map) (cdr map)))