Skip to content
Emacs minor mode for making Anki cards with Org
Branch: master
Clone or download
kevinjfoley and louietan Use emacs base64 sha1 (#38)
Use built-in functions for SHA1 hasing and base64 encoding
Latest commit 115ce2e Dec 31, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Changelog.org
README.org Release Jul 29, 2018
anki-editor.el Use emacs base64 sha1 (#38) Dec 31, 2018
demo.gif Release 0.3 Jun 10, 2018
examples.org
fix-notes-0.3.el

README.org

http://melpa.org/packages/anki-editor-badge.svg

anki-editor – Emacs minor mode for making Anki cards with Org

Since I’m not a native English speaker, feel free to correct me if there were any ambiguity or grammatical mistakes ;-)

Installation

Requirements

  • anki-connect, an Anki add-on required by this package to interact with Anki.
  • curl

If you have MELPA in your package-archives, just M-x package-install RET anki-editor RET, or install it manually by downloading and visiting anki-editor.el in your emacs buffer, and M-x package-install-from-buffer RET.

Usage

The Layout of Notes

Now you can compose Anki notes in Org syntax, e.g. lists, code examples, tables, embedded latex, when being submitted to Anki, they will be converted to HTML by Org-mode’s HTML backend with specific markers (e.g. latex) translated to Anki style.

The structure of a note is as follow, which is inspired by org-drill. More examples can be found in examples.org.

* Idiom                                                        :vocab:idioms:
  :PROPERTIES:
  :ANKI_DECK: English
  :ANKI_NOTE_TYPE: Basic (and reversed card)
  :ANKI_TAGS: languages european_languages
  :END:
** Front
   (it's) raining cats and dogs
** Back
   it's raining very hard
  • An Anki note is an Org entry with ANKI_NOTE_TYPE property
  • Anki tags can be set in two ways
    1. With “ANKI_TAGS” property, multiple tags are seperated with space
    2. With Org tags [fn:1], this could be turned off if you would like to keep Org tags separated from Anki tags
  • Other necessary information (e.g. deck, note type) of a note is put in the property drawer of the entry
    • As the value of ANKI_DECK is retrieved with inheritance, you don’t have to set it per note, instead, you could create a deck entry with this property set and put note entries under it, or set it per file by #+PROPERTY: ANKI_DECK YourDeck
  • Child entries of a note entry are fields

Commands

CommandBrief Description
anki-editor-push-notesPush notes to Anki. Additional arguments can be used to restrict the range of notes.
anki-editor-retry-failure-notesSame as above, except that it only pushes notes that have ANKI_FAILURE_REASON.
anki-editor-insert-noteInsert a note entry like M-RET, interactively.
anki-editor-cloze-regionCreate a cloze deletion from region.
anki-editor-export-subtree-to-htmlExport the subtree at point to HTML.
anki-editor-convert-region-to-htmlConvert and replace region to HTML.

Functions

NameDescription
anki-editor-map-note-entriesSimple wrapper that calls org-map-entries.
anki-editor-note-at-pointConstruct an alist representing a note from current entry.

Variables

NameDefault ValueDescription
anki-editor-anki-connect-listening-address“127.0.0.1”The network address AnkiConnect is listening.
anki-editor-anki-connect-listening-port“8765”The port number AnkiConnect is listening.
anki-editor-break-consecutive-braces-in-latexnilIf non-nil, consecutive `}’ will be automatically separated by spaces to prevent early-closing of cloze.
anki-editor-create-decksnilIf non-nil, creates deck before creating a note.
anki-editor-ignored-org-tags’(“export” “noexport”)A list of Org tags that are ignored when constructing notes form entries.
anki-editor-org-tags-as-anki-tagstIf nil, tags of entries wont’t be counted as Anki tags.
anki-editor-protected-tags’(“marked” “leech”)A list of tags that won’t be deleted from Anki even though they’re absent in Org entries.

Limitations

Tags between Anki and Org

Because the set of characters allowed in tags is different between Anki and Org, you have to make sure that tags from Anki are compatible with Org and tags in Org could be recognized by Anki.

Working with Anki add-ons

This package may not work well when you are using certain Anki add-ons especially those who extend the builtin Anki note editor to automatically fill note field content (e.g. Add note id).

Demo

./demo.gif

[fn:1] It should be noted that Org only allows letters, numbers, _ and @ in a tag but Anki allows more, so you may have to edit you Anki tags before they can be used in Org without any surprise.

You can’t perform that action at this time.