From 6be323d0335245c47392fd3671dd781b3e4b2d81 Mon Sep 17 00:00:00 2001 From: eeeickythump Date: Wed, 5 Sep 2012 10:46:16 +1200 Subject: Entries in 'org-drill-card-type-alist' can now take a fourth argument, 'drill-empty-p' (boolean). If true, items of this type are not skipped if their bodies are empty. Bugfixes related to cram mode. Cram mode displays a coloured 'C' in the mode line. Sped up testing whether items have empty bodies. Updated documentation. --- org-drill.html | 345 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 190 insertions(+), 155 deletions(-) (limited to 'org-drill.html') diff --git a/org-drill.html b/org-drill.html index 065fca3..10367c1 100644 --- a/org-drill.html +++ b/org-drill.html @@ -1,13 +1,13 @@ - + org-drill.el – flashcards and spaced repetition for org-mode + - + @@ -44,6 +44,12 @@ lang="en" xml:lang="en"> dt { font-weight: bold; } div.figure { padding: 0.5em; } div.figure p { text-align: center; } + div.inlinetask { + padding:10px; + border:2px solid gray; + margin:10px; + background: #ffffcc; + } textarea { overflow-x: auto; } .linenr { font-size:smaller } .code-highlighted {background-color:#ffff00;} @@ -79,62 +85,68 @@ lang="en" xml:lang="en"> -
+
+ +
+ +

org-drill.el – flashcards and spaced repetition for org-mode

+

Table of Contents

-

General

+

General

@@ -183,7 +195,7 @@ version. The repository is at:
-

Installation

+

Installation

@@ -205,13 +217,12 @@ to make sure that Org's "contrib/lisp" directory is in the emacs load-path. -
-

Demonstration

+

Demonstration

@@ -230,7 +241,7 @@ drill topics are written.
-

Writing the questions

+

Writing the questions

@@ -261,13 +272,13 @@ This will be adequate for some items, but usually you will want to write items where you have more control over what information is hidden from the user for recall purposes. For this reason, some other card types are defined, including:

@@ -283,9 +294,9 @@ invisible while items are being tested.
-
-

Simple topics

-
+
+

Simple topics

+
@@ -306,7 +317,6 @@ Tallinn. -

When this item is presented for review, the text beneath the main heading will be visible, but the contents of the subheading ("The Answer") will be hidden. @@ -316,9 +326,9 @@ be visible, but the contents of the subheading ("The Answer") will be hidden.

-
-

Cloze deletion

-
+
+

Cloze deletion

+
@@ -340,7 +350,6 @@ The capital city of Estonia is [Tallinn]. -

During review, the user will see:

@@ -360,15 +369,15 @@ When the user presses a key, the text "Tallinn" will become visible.
-
-

Clozed text hints

-
+
+

Clozed text hints

+

Clozed text can contain a "hint" about the answer. If the text surrounded -by single square brackets contains a `|' character (vertical bar), all text +by single square brackets contains `||' (two vertical bars), all text after that character is treated as a hint. During testing, the hint text will be visible when the rest of the text is hidden, and invisible when the rest of the text is visible. @@ -379,12 +388,11 @@ Example: -

Type 1 hypersensitivity reactions are mediated by [immunoglobulin E|molecule]
-and [mast cells|cell type].
+
Type 1 hypersensitivity reactions are mediated by [immunoglobulin E||molecule]
+and [mast cells||cell type].
 

 
 
-
 

 
 
Type 1 hypersensitivity reactions are mediated by
@@ -401,9 +409,9 @@ and
-
-

Two-sided cards

-
+
+

Two-sided cards

+

@@ -446,7 +454,6 @@ Who was that woman? -

In this example, the user will be shown the main text – "Translate this word" – and either 'la mujer', or 'the woman', at random. The section 'Example @@ -458,9 +465,9 @@ not one of the first two 'sides' of the topic.

-
-

Multi-sided cards

-
+
+

Multi-sided cards

+
@@ -490,7 +497,6 @@ the table -

The user will be shown the main text and either 'la mesa', or 'the table', or a picture of a table. @@ -500,9 +506,9 @@ The user will be shown the main text and either 'la mesa', or 'the table'

-
-

Multi-cloze cards

-
+
+

Multi-cloze cards

+
@@ -518,7 +524,6 @@ North Island and has a population of about 400,000. -

There is more than one fact in this statement – you could create a single 'simple' card with all the facts marked as cloze text, like so: @@ -527,11 +532,10 @@ There is more than one fact in this statement – you could create a single 

The capital city of [New Zealand] is [Wellington], which is located in
-the [North|North/South] Island and has a population of about [400,000].
+the [North||North/South] Island and has a population of about [400,000].
-

But this card will be difficult to remember. If you get just one of the 4 hidden facts wrong, you will fail the card. A card like this is likely to @@ -567,11 +571,10 @@ the North Island. * Fact The capital city of New Zealand is Wellington, which is located in -the [North|North/South] Island. +the [North||North/South] Island. -

However, this is really cumbersome. Multicloze card types exist for this situation. Multicloze cards behave like 'simple' cards, except that when there @@ -635,19 +638,18 @@ will be hidden. :END: The capital city of [New Zealand] is [Wellington], which is located in -the [North|North/South] Island and has a population of about [400,000]. +the [North||North/South] Island and has a population of about [400,000]. -

-
-

User-defined card types

-
+
+

User-defined card types

+
@@ -683,9 +685,9 @@ of all the card types discussed above.
-
-

Empty cards

-
+
+

Empty cards

+
@@ -703,8 +705,17 @@ unless they are empty as well.

If you have an item with an empty body, but still want it to be included in a -drill session, put a brief comment ('# …') in the item body. -

+drill session, you can either: +

    +
  1. Put a brief comment ('# …') in the item body. +
    2. +
  2. Change the entry for its card type in org-drill-card-type-alist so that + items of this type will always be tested, even if they have an empty body. + See the documentation for org-drill-card-type-alist for details. +
    3. +
+ +
@@ -712,16 +723,16 @@ drill session, put a brief comment ('# …') in the item body.
-

Running the drill session

+

Running the drill session

-Start a drill session with M-x org-drill. By default, this includes all +Start a drill session with M-x org-drill. By default, this tests all non-hidden topics in the current buffer. org-drill takes an optional argument, SCOPE, which allows it to take drill items from other -sources. See below for details. +sources. See below for details.

During a drill session, you will be presented with each item, then asked to @@ -776,7 +787,7 @@ session.

-

Multiple sequential drill sessions

+

Multiple sequential drill sessions

@@ -800,7 +811,7 @@ session without re-scanning (as if you had run org-drill-again).
-

Cram mode

+

Cram mode

@@ -810,18 +821,23 @@ There are some situations, such as before an exam, where you will want to revise all of your cards regardless of when they are next due for review.

-To do this, run a cram session with the org-drill-cram command (M-x org-drill-cram RET). This works the same as a normal drill session, except +To do this, run a cram session with the org-drill-cram command (M-x org-drill-cram). This works the same as a normal drill session, except that all items are considered due for review unless you reviewed them within the last 12 hours (you can change the number of hours by customising the variable org-drill-cram-hours).

+

+Cram sessions are not considered to be part of the normal learning process for +the tested items. Cramming will not affect when items are next due for +revision. +

-

Leeches

+

Leeches

@@ -873,7 +889,7 @@ See the SuperMemo website
-

Customisation

+

Customisation

@@ -887,9 +903,9 @@ settings by adding elisp code to your configuration file (.emacs).
-
-

Visual appearance of items during drill sessions

-
+
+

Visual appearance of items during drill sessions

+
@@ -904,7 +920,6 @@ buffers, add this to your .emacs: -

Item headings may contain information that "gives away" the answer to the item, either in the heading text or in tags. If you want item headings to be made @@ -918,14 +933,13 @@ invisible while each item is being tested, add: -

-
-

Duration of drill sessions

-
+
+

Duration of drill sessions

+
@@ -942,7 +956,6 @@ the following settings. -

If either of these variables is set to nil, then item count or elapsed time will not count as reasons to end the session. If both variables are nil, the @@ -953,9 +966,9 @@ session will not end until all outstanding items have been reviewed.

-
-

Saving buffers after drill sessions

-
+
+

Saving buffers after drill sessions

+
@@ -971,14 +984,13 @@ drill session. If you don't like this behaviour, use the following setting: -
-
-

Sources of items for drill sessions (scope)

-
+
+

Sources of items for drill sessions (scope)

+

@@ -1015,13 +1027,15 @@ the variable org-drill-scope. Possible values are: + +

-
-

Definition of old and overdue items

-
+
+

Definition of old and overdue items

+
@@ -1054,7 +1068,6 @@ than 1.0. -

After prioritising overdue items, Org-Drill next prioritises young items. These are items which were recently learned (or relearned in the case of @@ -1075,23 +1088,22 @@ of 10 days or less. To change this, use the following: -

-
-

Spaced repetition algorithm

-
+
+

Spaced repetition algorithm

+
-
-

Choice of algorithm

-
+
+

Choice of algorithm

+
@@ -1117,7 +1129,10 @@ SuperMemo algorithms. These are: -

If you want Org-Drill to use the SM2 algorithm, put the following in your + + +

+If you want Org-Drill to use the SM2 algorithm, put the following in your .emacs:

@@ -1128,14 +1143,13 @@ SuperMemo algorithms. These are: -
-
-

Random variation of repetition intervals

-
+
+

Random variation of repetition intervals

+
@@ -1144,7 +1158,7 @@ The intervals generated by the SM2 and SM5 algorithms are pretty deterministic. If you tend to add items in large, infrequent batches, the lack of variation in interval scheduling can lead to the problem of "lumpiness" -- one day a large batch of items are due for review, the next there is almost -nothing, a few days later another big pile of items is due. +nothing, a few days later another big pile of items is due, and so on.

This problem can be ameliorated by adding some random "noise" to the interval @@ -1164,14 +1178,13 @@ your .emacs: -

-
-

Adjustment for early or late review of items

-
+
+

Adjustment for early or late review of items

+
@@ -1187,7 +1200,6 @@ is also presented on the SuperMemo website. It can be enabled with: -

This will affect both early and late repetitions if the Simple8 algorithm is used. For the SM5 algorithm it will affect early repetitions only. It has no @@ -1198,9 +1210,35 @@ effect on the SM2 algorithm.

-
-

Adjusting item difficulty globally

-
+
+

Adjusting the first interval (SM5 algorithm only)

+
+ + + +

+In the SM5 algorithm, the initial interval after the first successful +presentation of an item is always 4 days. If you wish to change this for some +reason, you can do so with: +

+ + + +
(setq org-drill-sm5-initial-interval 5.0)
+
+ + +

+note that this will have no effect if you are not using the SM5 algorithm. +

+ +
+ +
+ +
+

Adjusting item difficulty globally

+
@@ -1247,15 +1285,14 @@ To alter the learn fraction, put the following in your .emacs: -
-
-

Per-file customisation settings

-
+
+

Per-file customisation settings

+

@@ -1274,7 +1311,6 @@ that file: -

You can achieve the same effect by including the settings in the 'mode line' (this must be the first line in the file), like so: @@ -1286,10 +1322,8 @@ You can achieve the same effect by including the settings in the 'mode line' -

-In either case you will need to save, close and re-open the file for the -changes to take effect. +In either case you will need to reload the file for the changes to take effect.

@@ -1298,7 +1332,7 @@ changes to take effect.
-

Coping with large collections

+

Coping with large collections

@@ -1309,23 +1343,25 @@ large. The file will be slow to load, and Emacs may have trouble syntax-highlighting the file contents correctly.

-The easiest steps to solve this problem are: +The easiest way to solve this problem is:

  1. Move your file into its own dedicated directory.
  2. Divide the file into two or more smaller files.
  3. Within each file, set org-drill-scope to 'directory'. See - per-file settings above for instructions about how to do this. + per-file settings above for instructions about how to do this.
+ +
-

Sharing, merging and synchronising item collections

+

Sharing, merging and synchronising item collections

@@ -1389,7 +1425,7 @@ procedure.
-

Incremental reading

+

Incremental reading

@@ -1446,7 +1482,6 @@ captured facts. -

Using these templates and org-protocol, you can set up buttons in your web browser to: @@ -1525,7 +1560,6 @@ Calmette-Guérin vaccine. -

You need to edit this fact so it makes sense independent of its context, as that is how it will be presented to you in future. The easiest way to turn the @@ -1550,20 +1584,21 @@ or give it different tags or properties, for example.

-

Author

+

Author

Org-Drill is written by Paul Sexton. -

+

+
-

Date: 2011-05-21 00:08:14 NZST

-

Org version 7.5 with Emacs version 23

+

Date: 2012-09-05T10:41+1200

+

Org version N/A with Emacs version 24

Validate XHTML 1.0 -
+
-- cgit v1.2.3