summaryrefslogtreecommitdiff
path: root/doc/gnosis.info
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-02-22 15:47:41 +0200
committerThanos Apollo <[email protected]>2024-02-22 15:47:41 +0200
commit6ee271486b9a2c1467434bf6c23cb804f905a0f2 (patch)
tree497141f3bd0f5ae33c3eee4b74145d0c06356fc6 /doc/gnosis.info
parentf226d964d3393a3f7c3e52c43ab8cfe27929e5c5 (diff)
parenta48cbbd2e2334e12f03056334a0e0bb77e85e5b2 (diff)
Release version 0.1.9: Merge branch '0.1.9-dev'0.1.9
- Rework UI for adding question
Diffstat (limited to 'doc/gnosis.info')
-rw-r--r--doc/gnosis.info106
1 files changed, 58 insertions, 48 deletions
diff --git a/doc/gnosis.info b/doc/gnosis.info
index 5176ec6..5e5f7c5 100644
--- a/doc/gnosis.info
+++ b/doc/gnosis.info
@@ -15,7 +15,7 @@ Gnosis (γνῶσις), pronounced "noh-sis", _meaning knowledge in Greek_, is
a spaced repetition system implementation for note taking and self
testing.
-This manual is written for Gnosis version 0.1.8, released on 2023-02-21.
+This manual is written for Gnosis version 0.1.9, released on 2023-02-22.
• Official manual: <https://thanosapollo.org/user-manual/gnosis>
• Git repositories:
@@ -43,9 +43,9 @@ Installation
Note Types
* Cloze::
+* MCQ (Multiple Choice Question)::
* Basic Type::
* Double::
-* MCQ (Multiple Choice Question)::
* y-or-n::
Customization
@@ -135,12 +135,13 @@ File: gnosis.info, Node: Adding notes, Next: Note Types, Prev: Installation,
3 Adding notes
**************
-Creating notes for gnosis can be done interactively with: ‘M-x
-gnosis-add-note’
+Creating notes for gnosis can be done interactively with:
+
+ ‘M-x gnosis-add-note’
When it comes to adding images, you can select images that are inside
-‘gnosis-images-dir’. See more customization for *note Image Size: Image
-size.
+‘gnosis-images-dir’. For adjusting image size, refer to *note Image
+Size: Image size.

File: gnosis.info, Node: Note Types, Next: Customization, Prev: Adding notes, Up: Top
@@ -151,13 +152,13 @@ File: gnosis.info, Node: Note Types, Next: Customization, Prev: Adding notes,
* Menu:
* Cloze::
+* MCQ (Multiple Choice Question)::
* Basic Type::
* Double::
-* MCQ (Multiple Choice Question)::
* y-or-n::

-File: gnosis.info, Node: Cloze, Next: Basic Type, Up: Note Types
+File: gnosis.info, Node: Cloze, Next: MCQ (Multiple Choice Question), Up: Note Types
4.1 Cloze
=========
@@ -185,9 +186,30 @@ selecting ‘Cloze’, the question should be formatted like this:
*UNIQUE* word (or a unique combination of words) in given note.

-File: gnosis.info, Node: Basic Type, Next: Double, Prev: Cloze, Up: Note Types
+File: gnosis.info, Node: MCQ (Multiple Choice Question), Next: Basic Type, Prev: Cloze, Up: Note Types
+
+4.2 MCQ (Multiple Choice Question)
+==================================
+
+A MCQ note type, as the name suggests, is a multiple choice question.
+
+ First you will be prompted to input the question ‘stem’ field.
+
+ Afterwards you will be prompted to enter the choices, each ‘-’
+indicates a choice, the choice inside ‘{}’ will be marked as the correct
+one.
+
+ Example of options:
+ • Option 1
+
+ • Option 2
+
+ • {Correct choice}
+
+
+File: gnosis.info, Node: Basic Type, Next: Double, Prev: MCQ (Multiple Choice Question), Up: Note Types
-4.2 Basic Type
+4.3 Basic Type
==============
Basic note type is a simple question/answer note, where the user first
@@ -195,9 +217,9 @@ sees a "main" part, which is usually a question, and he is prompted to
input the answer.

-File: gnosis.info, Node: Double, Next: MCQ (Multiple Choice Question), Prev: Basic Type, Up: Note Types
+File: gnosis.info, Node: Double, Next: y-or-n, Prev: Basic Type, Up: Note Types
-4.3 Double
+4.4 Double
==========
Double note type, is essentially a note that generates 2 basic notes.
@@ -207,20 +229,7 @@ The second one reverses question/answer.
notes for a foreign language.

-File: gnosis.info, Node: MCQ (Multiple Choice Question), Next: y-or-n, Prev: Double, Up: Note Types
-
-4.4 MCQ (Multiple Choice Question)
-==================================
-
-MCQ note type, consists of a "stem" part that is displayed, and
-"options" for the user to select the right one.
-
- Answer must be the index NUMBER of the correct answer from OPTIONS.
-
- Ideal for self testing & simulating exams
-
-
-File: gnosis.info, Node: y-or-n, Prev: MCQ (Multiple Choice Question), Up: Note Types
+File: gnosis.info, Node: y-or-n, Prev: Double, Up: Note Types
4.5 y-or-n
==========
@@ -319,16 +328,17 @@ The ‘gnosis-algorithm-ef’ is a list that consists of three items:
2. Easiness factor decrease value: Subtracted from the total easiness
factor upon a failed review.
- 3. Initial total easiness factor: Used to calculate the next interval.
+ 3. Total Easiness factor: Used to calculate the next interval.
- 4. How this is used:
+ How this is used:
Multiplies the last interval by the easiness factor after a
successful review.
- For example, if the last review was 6 days ago with an easiness
-factor of 2.0, the next interval would be calculated as 6 * 2.0, and the
-total easiness factor would be updated by adding the increase factor.
+ For example, upon a successful review, if the last review was 6 days
+ago with an easiness factor of 2.0, the next interval would be
+calculated as 6 * 2.0, and the next total easiness factor would be
+updated by adding the increase value 2.0 + <increase-value>.
Configuration example:
@@ -451,23 +461,23 @@ Node: Installation1796
Node: Using straightel2073
Node: Installing manually from source2585
Node: Adding notes3274
-Node: Note Types3639
-Node: Cloze3851
-Node: Basic Type4824
-Node: Double5102
-Node: MCQ (Multiple Choice Question)5448
-Node: y-or-n5857
-Node: Customization6283
-Node: Image size6468
-Node: Typos | String Comparison6754
-Node: Gnosis Algorithm7529
-Node: Initial Interval7741
-Node: Easiness Factor8248
-Node: Forgetting Factor9153
-Node: Editing notes9687
-Node: Sync between devices10079
-Node: Extending Gnosis11107
-Node: Creating Custom Note Types11562
+Node: Note Types3651
+Node: Cloze3863
+Node: MCQ (Multiple Choice Question)4856
+Node: Basic Type5429
+Node: Double5732
+Node: y-or-n6054
+Node: Customization6456
+Node: Image size6641
+Node: Typos | String Comparison6927
+Node: Gnosis Algorithm7702
+Node: Initial Interval7914
+Node: Easiness Factor8421
+Node: Forgetting Factor9369
+Node: Editing notes9903
+Node: Sync between devices10295
+Node: Extending Gnosis11323
+Node: Creating Custom Note Types11778

End Tag Table