branch: elpa/gnosis
commit 358c9d2baaa2cd76c123fb748694d391466d6fe1
Author: Thanos Apollo <[email protected]>
Commit: Thanos Apollo <[email protected]>
[packaging] Update commentary for intended workflow.
---
gnosis.el | 39 ++++++++++++++++++++++++++++-----------
1 file changed, 28 insertions(+), 11 deletions(-)
diff --git a/gnosis.el b/gnosis.el
index 4e6234424e..42eaa200e2 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -25,15 +25,32 @@
;;; Commentary:
-;; Gnosis is a spaced repetition system-like that enhances memory
-;; retention through active recall. It employs a Q&A format, where each
-;; gnosis consists of a question, answer, and explanation.
-
-;; Gnosis algorithm is highly adjustable, allowing users to set specific
-;; values not just for thema decks but for tags as well. Gnosis'
-;; adjustability allows users to fine-tune settings not only for entire
-;; thema collections but also for specific tagged topics, thereby creating
-;; a personalized learning environment for each topic.
+;; Gnosis is a learning tool that integrates a note-taking system with
+;; spaced repetition and self-testing. It works together with
+;; org-gnosis, which provides a Zettelkasten-style note-taking system
+;; where notes (nodes) are org files indexed in an SQLite database.
+;;
+;; The intended workflow is:
+;;
+;; 1. Write notes on a topic using `org-gnosis-find'.
+;; 2. Create themata (flashcard-like questions) related to the topic
+;; using `gnosis-add-thema'.
+;; 3. Link themata to note topics by inserting org-gnosis links in
+;; the keimenon (question text) or parathema (extra context) using
+;; `org-gnosis-insert'.
+;; 4. Review themata with spaced repetition via `gnosis-review', or
+;; review all themata linked to a specific topic via
+;; `gnosis-review-topic'.
+;;
+;; Gnosis and org-gnosis maintain separate SQLite databases. The
+;; gnosis database stores themata, decks, review history, and links
+;; from themata to org-gnosis nodes. The org-gnosis database stores
+;; nodes, tags, and links between nodes.
+;;
+;; The spaced repetition algorithm is highly adjustable, allowing
+;; users to set specific values not just for thema decks but for tags
+;; as well, creating a personalized learning environment for each
+;; topic.
;;; Code:
@@ -839,8 +856,8 @@ If SUSPENDED-P, return suspended themata as well."
If DUE is t, return only due themata."
(let ((themata (gnosis-select 'id 'themata `(= deck-id ,(or deck-id
(gnosis--get-deck-id)))
- t)))
- (if (or due nil)
+ t)))
+ (if due
(cl-loop for thema in themata
when (and (not (gnosis-suspended-p thema))
(gnosis-review-is-due-p thema))
