Explain `pwc` cards in documentation.md
dkl9

dkl9 commited on 2024-1 11:04:49
Showing 1 changed files, with 13 additions and 4 deletions.

... ...
@@ -7,7 +7,7 @@ Any time you run Memoire, it will operate on a deck.
7 7
 A deck is stored as a [Recfile]( https://www.gnu.org/software/recutils/manual/The-Rec-Format.html ).
8 8
 A deck consists of a list of cards, each card corresponding to a record.
9 9
 A card consists of a note and some associated fields, and may be expanded to a list of prompts generated from the note.
10
-For now, there are two types of cards: basic multi-cloze and sequential.
10
+For now, there are three types of cards: basic multi-cloze, pairwise cloze, and sequential.
11 11
 
12 12
 From a basic multi-cloze card, there is a prompt for each cloze deletion (indicated with curly brackets around the deletion), which shows the entire note except that deletion.
13 13
 For example, if the note is
... ...
@@ -17,6 +17,14 @@ bio organelles: matter enters the {Golgi apparatus} on the {cis face} and exits
17 17
 then Memoire will construct four prompts from the card, one omitting "Golgi apparatus", one omitting "cis face", one omitting "in a vesicle", and one omitting "trans face".
18 18
 Each prompt has the deletion re-inserted as the answer.
19 19
 
20
+From a pairwise cloze card, the note is broken into clauses, separated by double-semicolons.
21
+There is a prompt for each ordered pair of distinct clauses for which the second clause has a cloze deletion.
22
+For example, if the note is
23
+```memoire
24
+words zh:;; hanzi 面包;; pronounced {miànbāo};; means {bread} (en)
25
+```
26
+then Memoire will construct four prompts for the card, two asking for pronunciation (omitting "miànbāo"), two asking for meaning (omitting "bread").
27
+
20 28
 From a sequential card, there is a prompt for each clause (indicated with a double-semicolon separator), which shows the part of the note before that clause.
21 29
 For example, if the note is
22 30
 ```memoire
... ...
@@ -25,7 +33,7 @@ quotes: A.N. Whitehead on automatic thought processes: ;;Civilization advances b
25 33
 then Memoire will construct four prompts from the card.
26 34
 One of those will show "quotes: A.N. Whitehead on automatic thought processes: Civilization advances by extending ", and append "the number of important operations " as the answer.
27 35
 
28
-You may be able to include images in cards (of either type) with `IMG[path/to/image]` syntax, where the path is relative to the directory containing your deck file.
36
+You may be able to include images in cards (of any type) with `IMG[path/to/image]` syntax, where the path is relative to the directory containing your deck file.
29 37
 For example, if the note is
30 38
 ```memoire
31 39
 machines: what is this thing? IMG[img/velomobile.jpg] {velomobile}
... ...
@@ -56,10 +64,11 @@ The notes must be separated by blank lines.
56 64
 Each note can have multiple lines.
57 65
 There must be an extra blank line at the end of the input.
58 66
 
59
-This feature auto-detects the type of card (multi-cloze or sequential) from the content of the note.
67
+This feature auto-detects the type of card (multi-cloze, pairwise cloze, or sequential) from the content of the note.
68
+If the note is formatted plausibly like pairwise cloze, it's saved as pairwise cloze.
60 69
 If there are braces, it's saved as multi-cloze.
61 70
 If there are double-semicolons, it's saved as sequential.
62
-If both are present, the procedure favours multi-cloze.
71
+If both are present (and it was not detected as pairwise cloze), the procedure favours multi-cloze.
63 72
 
64 73
 ## Correcting cards
65 74
 `src/main.lua c N` (where `N` is an integer) opens the note for card N from the deck in a text editor.
66 75