Allow specifying field values from org-mode properties (#22)
* Allow specifying field values from org-mode properties * Update documentation and fine-tune the diff * Refactor, fix indentation, and other minor fixes Renamed all-fields to named-fields since the heading and content before first subheading can also be a field. --------- Co-authored-by: Renat Galimov <renat@Renats-MacBook-Pro.local> Co-authored-by: orgtre <orgtre@posteo.net>
This commit is contained in:
Renat Galimov
GitHub
parent
87394670a2
commit
ab7b33b48c
2 changed files with 113 additions and 92 deletions
17
README.org
17
README.org
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
anki-editor is an [[https://www.gnu.org/software/emacs/emacs.html][Emacs]] minor mode for making [[https://apps.ankiweb.net][Anki]] cards with [[https://orgmode.org][Org Mode]].
|
||||
|
||||
This repository is a fork of [[https://github.com/louietan/anki-editor][louietan/anki-editor]]. By now there are quite a few differences and extensions compared to the original:
|
||||
This repository is a fork of [[https://github.com/louietan/anki-editor][louietan/anki-editor]]. By now there are quite a few differences and extensions compared to the original:
|
||||
- The develop branch of the original has been merged into the master branch; see the unreleased section of [[https://github.com/orgtre/anki-editor/blob/master/Changelog.org][Changelog.org]] for a list of the new features that come with this.
|
||||
- Almost all outstanding pull requests to the original have been integrated; [[https://github.com/orgtre/anki-editor/issues/10][this issue]] tracks the two exceptions.
|
||||
- A more flexible note structure, outlined [[https://github.com/eyeinsky/org-anki/issues/48#issuecomment-1216625730][here]], has been introduced.
|
||||
|
|
@ -20,7 +20,7 @@ Other than Emacs you need [[https://apps.ankiweb.net][Anki]], its [[https://gith
|
|||
|
||||
*** Using package.el
|
||||
|
||||
If you're using the built-in =package.el= package manager, first manually download this repository and then type the following in Emacs:
|
||||
If you're using the built-in =package.el= package manager, first manually download this repository and then type the following in Emacs:
|
||||
|
||||
: M-x package-install-file [RET] "path/to/anki-editor.el" [RET]
|
||||
|
||||
|
|
@ -84,6 +84,19 @@ If you're using [[https://github.com/radian-software/straight.el][straight.el]]
|
|||
This works for all note types, just make the first 2 fields absent and
|
||||
~anki-editor~ will use note heading as first field and the text below the heading as second field.
|
||||
|
||||
,* You can extract a field value from an org-property
|
||||
:PROPERTIES:
|
||||
:ANKI_NOTE_TYPE: Basic
|
||||
:ANKI_FIELD_FRONT: Can one define an anki-field inside an org-mode property?
|
||||
:ANKI_PREPEND_HEADING: nil
|
||||
:END:
|
||||
|
||||
Yes. In this example, =anki-editor= will use the =ANKI_FIELD_FRONT= property value as
|
||||
a front side of the Anki card and the body of the card as its back.
|
||||
|
||||
,** Front
|
||||
Notice that property fields will override subheading fields.
|
||||
This block will be skipped
|
||||
#+END_SRC
|
||||
|
||||
- Anki deck is provided by ~ANKI_DECK~ property. This property is
|
||||
|
|
|
|||
188
anki-editor.el
188
anki-editor.el
|
|
@ -442,6 +442,8 @@ The implementation is borrowed and simplified from ox-html."
|
|||
(defconst anki-editor-prop-deck "ANKI_DECK")
|
||||
(defconst anki-editor-prop-format "ANKI_FORMAT")
|
||||
(defconst anki-editor-prop-prepend-heading "ANKI_PREPEND_HEADING")
|
||||
(defconst anki-editor-prop-field-prefix "ANKI_FIELD_"
|
||||
"Anki fields with names got from an org-node property.")
|
||||
(defconst anki-editor-prop-tags "ANKI_TAGS")
|
||||
(defconst anki-editor-prop-tags-plus (concat anki-editor-prop-tags "+"))
|
||||
(defconst anki-editor-prop-failure-reason "ANKI_FAILURE_REASON")
|
||||
|
|
@ -806,6 +808,14 @@ Return a list of cons of (FIELD-NAME . FIELD-CONTENT)."
|
|||
do (org-forward-heading-same-level nil t)
|
||||
until (= last-pt (point)))))
|
||||
|
||||
(defun anki-editor--property-fields (fields)
|
||||
"Extract Anki FIELDS from entry properties."
|
||||
(cl-loop for field in fields
|
||||
for property = (concat anki-editor-prop-field-prefix (upcase field))
|
||||
for property-value = (org-entry-get-with-inheritance property)
|
||||
when property-value
|
||||
collect (cons field property-value)))
|
||||
|
||||
(defun anki-editor--note-contents-before-subheading ()
|
||||
"Get content between heading at point and next sub/heading.
|
||||
|
||||
|
|
@ -857,97 +867,95 @@ When the `subheading-fields' don't match the `note-type's fields,
|
|||
map missing fields to the `heading' and/or `content-before-subheading'.
|
||||
Return a list of cons of (FIELD-NAME . FIELD-CONTENT)."
|
||||
(anki-editor--with-collection-data-updated
|
||||
(let* ((fields-matching (cl-intersection
|
||||
(alist-get note-type
|
||||
anki-editor--model-fields
|
||||
nil nil #'string=)
|
||||
(mapcar #'car subheading-fields)
|
||||
:test #'string=))
|
||||
(fields-missing (cl-set-difference
|
||||
(alist-get note-type
|
||||
anki-editor--model-fields
|
||||
nil nil #'string=)
|
||||
(mapcar #'car subheading-fields)
|
||||
:test #'string=))
|
||||
(fields-extra (cl-set-difference
|
||||
(mapcar #'car subheading-fields)
|
||||
(alist-get note-type
|
||||
anki-editor--model-fields
|
||||
nil nil #'string=)
|
||||
:test #'string=))
|
||||
(fields (cl-loop for f in fields-matching
|
||||
collect (cons f (alist-get
|
||||
f subheading-fields
|
||||
nil nil #'string=))))
|
||||
(heading-format anki-editor-prepend-heading-format))
|
||||
(cond ((equal 0 (length fields-missing))
|
||||
(when (< 0 (length fields-extra))
|
||||
(user-error "Failed to map all subheadings to a field")))
|
||||
((equal 1 (length fields-missing))
|
||||
(if (equal 0 (length fields-extra))
|
||||
(if (equal "" (string-trim content-before-subheading))
|
||||
(push (cons (car fields-missing) heading)
|
||||
fields)
|
||||
(if prepend-heading
|
||||
(push (cons (car fields-missing)
|
||||
(concat
|
||||
(format heading-format heading)
|
||||
content-before-subheading))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
content-before-subheading)
|
||||
fields)))
|
||||
(if (equal "" (string-trim content-before-subheading))
|
||||
(push (cons (car fields-missing)
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields level))
|
||||
fields)
|
||||
(if prepend-heading
|
||||
(push (cons (car fields-missing)
|
||||
(concat
|
||||
(format heading-format heading)
|
||||
content-before-subheading
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields
|
||||
level)))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
(concat content-before-subheading
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields
|
||||
level)))
|
||||
fields)))))
|
||||
((equal 2 (length fields-missing))
|
||||
(if (equal 0 (length fields-extra))
|
||||
(progn
|
||||
(push (cons (nth 1 fields-missing)
|
||||
content-before-subheading)
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
heading)
|
||||
fields))
|
||||
(if (equal "" (string-trim content-before-subheading))
|
||||
(progn
|
||||
(push (cons (nth 1 fields-missing)
|
||||
(let* ((model-fields (alist-get
|
||||
note-type anki-editor--model-fields
|
||||
nil nil #'string=))
|
||||
(property-fields (anki-editor--property-fields model-fields))
|
||||
(named-fields (seq-uniq (append subheading-fields property-fields)
|
||||
(lambda (left right)
|
||||
(string= (car left) (car right)))))
|
||||
(fields-matching (cl-intersection
|
||||
model-fields (mapcar #'car named-fields)
|
||||
:test #'string=))
|
||||
(fields-missing (cl-set-difference
|
||||
model-fields (mapcar #'car named-fields)
|
||||
:test #'string=))
|
||||
(fields-extra (cl-set-difference
|
||||
(mapcar #'car named-fields) model-fields
|
||||
:test #'string=))
|
||||
(fields (cl-loop for f in fields-matching
|
||||
collect (cons f (alist-get
|
||||
f named-fields
|
||||
nil nil #'string=))))
|
||||
(heading-format anki-editor-prepend-heading-format))
|
||||
(cond ((equal 0 (length fields-missing))
|
||||
(when (< 0 (length fields-extra))
|
||||
(user-error "Failed to map all named fields")))
|
||||
((equal 1 (length fields-missing))
|
||||
(if (equal 0 (length fields-extra))
|
||||
(if (equal "" (string-trim content-before-subheading))
|
||||
(push (cons (car fields-missing) heading)
|
||||
fields)
|
||||
(if prepend-heading
|
||||
(push (cons (car fields-missing)
|
||||
(concat
|
||||
(format heading-format heading)
|
||||
content-before-subheading))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
content-before-subheading)
|
||||
fields)))
|
||||
(if (equal "" (string-trim content-before-subheading))
|
||||
(push (cons (car fields-missing)
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields level))
|
||||
fields)
|
||||
(if prepend-heading
|
||||
(push (cons (car fields-missing)
|
||||
(concat
|
||||
(format heading-format heading)
|
||||
content-before-subheading
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields level))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
heading)
|
||||
fields))
|
||||
(progn
|
||||
(push (cons (nth 1 fields-missing)
|
||||
(concat content-before-subheading
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields level)))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
heading)
|
||||
fields)))))
|
||||
((< 2 (length fields-missing))
|
||||
(user-error (concat "Cannot map note fields: "
|
||||
"more than two fields missing"))))
|
||||
fields)))
|
||||
fields-extra subheading-fields
|
||||
level)))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
(concat content-before-subheading
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields
|
||||
level)))
|
||||
fields)))))
|
||||
((equal 2 (length fields-missing))
|
||||
(if (equal 0 (length fields-extra))
|
||||
(progn
|
||||
(push (cons (nth 1 fields-missing)
|
||||
content-before-subheading)
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
heading)
|
||||
fields))
|
||||
(if (equal "" (string-trim content-before-subheading))
|
||||
(progn
|
||||
(push (cons (nth 1 fields-missing)
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields level))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
heading)
|
||||
fields))
|
||||
(progn
|
||||
(push (cons (nth 1 fields-missing)
|
||||
(concat content-before-subheading
|
||||
(anki-editor--concat-fields
|
||||
fields-extra subheading-fields level)))
|
||||
fields)
|
||||
(push (cons (car fields-missing)
|
||||
heading)
|
||||
fields)))))
|
||||
((< 2 (length fields-missing))
|
||||
(user-error (concat "Cannot map note fields: "
|
||||
"more than two fields missing"))))
|
||||
fields)))
|
||||
|
||||
(defun anki-editor--concat-fields (field-names field-alist level)
|
||||
"Concat field names and content of fields in list `field-names'."
|
||||
|
|
|
|||
Loading…
Reference in a new issue