Skip to content

Commit e4fcee6

Browse files
committed
update format definition
1 parent 1f02d42 commit e4fcee6

1 file changed

Lines changed: 59 additions & 4 deletions

File tree

README.md

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,73 @@ $ hashcards drill $DIRNAME
4040

4141
## Format
4242

43-
A deck is a Markdown file. Blank lines separate flashcards. Question-answer cards use the slash character to separate the sides:
43+
This section describes the text format used by hashcards.
44+
45+
### Basic Cards
46+
47+
Question-answer flashcards are written like this:
4448

4549
```
46-
What is the order of a group? / The cardinality of its underlying set.
50+
Q: What is the order of a group?
51+
A: The cardinality of its underlying set.
4752
```
4853

49-
Cloze cards use square brackets to denote cloze deletions:
54+
Both the question and the answer can span multiple lines:
55+
56+
```
57+
Q: List the PGM minerals.
58+
A:
59+
60+
- ruthenium
61+
- rhodium
62+
- palladium
63+
- osmium
64+
- iridium
65+
- platinum
66+
```
67+
68+
### Cloze Cards
69+
70+
Cloze cards start with the `C:` tag, and use square brackets to denote cloze deletions:
5071

5172
```
52-
The [order] of a group is [the cardinality of its underlying set].
73+
C: The [order] of a group is [the cardinality of its underlying set].
5374
```
5475

76+
Again, cloze cards can span multiple lines:
77+
78+
```
79+
C:
80+
Better is the sight of the eyes than the wandering of the
81+
desire: this is also vanity and vexation of spirit.
82+
83+
— [Ecclesiastes] [6]:[9]
84+
```
85+
86+
### Term-Definition Cards
87+
88+
This is a special shorthand. This:
89+
90+
```
91+
T: lithification
92+
D: The process of turning loose sediment into rock.
93+
```
94+
95+
Is equivalent to writing this:
96+
97+
```
98+
Q: Define: lithification
99+
A: The process of turning loose sediment into rock.
100+
101+
Q: Term for:
102+
103+
The process of turning loose sediment into rock.
104+
105+
A: lithification
106+
```
107+
108+
The constraint here is that the term must be a single line of text.
109+
55110
## Prior Art
56111

57112
- [org-fc](https://github.com/l3kn/org-fc)

0 commit comments

Comments
 (0)