New file-safe user variable: org-drill-scope. Allows customisation of the scope of drill sessions

(ie where items are sourced from). The variable can take the value 'directory', meaning items
will be sourced from all org files in the same directory as the current file. This is useful
for splitting up a monolithic item collection into smaller files, while still including all
those files in drill sessions.

The values of the SCOPE argument to org-drill have changed slightly. Possible values are the same
as those for 'org-drill-scope'.
- 'file' now means current file/buffer, respecting restrictions (default, same as old 'nil')
- 'file-no-restriction' means current file, ignoring (overriding) restrictions (same as old 'file')
- new value 'directory' (see above)
- other values have the same meaning as before.

1 files changed, 128 insertions, 61 deletions

diff --git a/README.html b/README.html
index 32c9908..5dba098 100755
--- a/README.html
+++ b/README.html
@@ -7,7 +7,7 @@ lang="en" xml:lang="en">
 <title>Org-Drill</title>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
 <meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2011-05-10 16:51:44 "/>
+<meta name="generated" content="2011-05-12 10:29:29 "/>
 <meta name="author" content="Paul Sexton"/>
 <meta name="description" content=""/>
 <meta name="keywords" content=""/>
@@ -109,20 +109,22 @@ lang="en" xml:lang="en">
 <ul>
 <li><a href="#sec-8_1">Visual appearance of items during drill sessions </a></li>
 <li><a href="#sec-8_2">Duration of drill sessions </a></li>
-<li><a href="#sec-8_3">Definition of old and overdue items </a></li>
-<li><a href="#sec-8_4">Spaced repetition algorithm </a>
+<li><a href="#sec-8_3">Sources of items for drill sessions (scope) </a></li>
+<li><a href="#sec-8_4">Definition of old and overdue items </a></li>
+<li><a href="#sec-8_5">Spaced repetition algorithm </a>
 <ul>
-<li><a href="#sec-8_4_1">Choice of algorithm </a></li>
-<li><a href="#sec-8_4_2">Random variation of repetition intervals </a></li>
-<li><a href="#sec-8_4_3">Adjustment for early or late review of items </a></li>
-<li><a href="#sec-8_4_4">Adjusting item difficulty globally </a></li>
+<li><a href="#sec-8_5_1">Choice of algorithm </a></li>
+<li><a href="#sec-8_5_2">Random variation of repetition intervals </a></li>
+<li><a href="#sec-8_5_3">Adjustment for early or late review of items </a></li>
+<li><a href="#sec-8_5_4">Adjusting item difficulty globally </a></li>
 </ul>
 </li>
-<li><a href="#sec-8_5">Per-file customisation settings </a></li>
+<li><a href="#sec-8_6">Per-file customisation settings </a></li>
 </ul>
 </li>
-<li><a href="#sec-9">Sharing, merging and synchronising item collections </a></li>
-<li><a href="#sec-10">Incremental reading </a></li>
+<li><a href="#sec-9">Coping with large collections </a></li>
+<li><a href="#sec-10">Sharing, merging and synchronising item collections </a></li>
+<li><a href="#sec-11">Incremental reading </a></li>
 </ul>
 </div>
 </div>
@@ -621,7 +623,7 @@ functions at the end of org-drill.el &ndash; these include:
 <li><code>org-drill-present-verb-conjugation</code>, which implements the 'conjugate'
   card type. This asks the user to conjugate a verb in a particular tense. It
   demonstrates how the appearance of an entry can be completely altered during
-  a drill session, both during testing and during the display fo the answer.
+  a drill session, both during testing and during the display of the answer.
 </li>
 <li><code>org-drill-present-translate-number</code>, which uses a third-party emacs lisp
   library (<a href="http://www.emacswiki.org/emacs/spell-number.el">spell-number.el</a>) to prompt the user to translate random numbers
@@ -681,29 +683,8 @@ drill session, put a brief comment ('# &hellip;')  in the item body.
 Start a drill session with <code>M-x org-drill</code>. By default, this includes all
 non-hidden topics in the current buffer. <code>org-drill</code> takes an optional
 argument, SCOPE, which allows it to take drill items from other
-sources. Possible values for SCOPE are:
+sources. See <a href="#sec-8_3">below</a> for details.
 </p>
-<dl>
-<dt>tree</dt><dd>The subtree starting with the entry at the cursor. (Alternatively you
-          can use <code>M-x org=drill-tree</code> to run the drill session &ndash; this will
-          behave the same as <code>org-drill</code> if 'tree' was used as the value of
-          SCOPE.)
-</dd>
-<dt>file</dt><dd>The current buffer, including both hidden and non-hidden items.
-</dd>
-<dt>file-with-archives</dt><dd>The current buffer, and any archives associated with it.
-</dd>
-<dt>agenda</dt><dd>All agenda files.
-</dd>
-<dt>agenda-with-archives</dt><dd>All agenda files with any archive files associated
-     with them.
-</dd>
-<dt>(file1 file2 &hellip;)</dt><dd>A list of filenames. All files in the list will be
-     scanned.
-</dd>
-</dl>
-
-
 <p>
 During a drill session, you will be presented with each item, then asked to
 rate your recall of it by pressing a key between 0 and 5. The meaning of these
@@ -911,10 +892,53 @@ session will not end until <i>all</i> outstanding items have been reviewed.
 </div>
 
 <div id="outline-container-8_3" class="outline-3">
-<h3 id="sec-8_3">Definition of old and overdue items </h3>
+<h3 id="sec-8_3"><a name="scope" id="scope"></a>Sources of items for drill sessions (scope) </h3>
 <div class="outline-text-3" id="text-8_3">
 
 
+<p>
+By default, Org-Drill gathers drill items from the current buffer only,
+ignoring any non-visible items. There may be times when you want Org-Drill to
+gather drill items from other sources. You can do this by changing the value of
+the variable <code>org-drill-scope</code>. Possible values are:
+</p>
+<dl>
+<dt>file</dt><dd>The current buffer, ignoring hidden items. This is the default.
+</dd>
+<dt>tree</dt><dd>The subtree starting with the entry at the cursor. (Alternatively you
+          can use <code>M-x org=drill-tree</code> to run the drill session &ndash; this will
+          behave the same as <code>org-drill</code> if 'tree' was used as the value of
+          SCOPE.)
+</dd>
+<dt>file-no-restriction</dt><dd>The current buffer, including both hidden and
+     non-hidden items.
+</dd>
+<dt>file-with-archives</dt><dd>The current buffer, and any archives associated with it.
+</dd>
+<dt>agenda</dt><dd>All agenda files.
+</dd>
+<dt>agenda-with-archives</dt><dd>All agenda files with any archive files associated
+     with them.
+</dd>
+<dt>directory</dt><dd>All files with the extension '.org' in the same directory as the
+               current file. (The current file will also be included if its
+               extension is .org)
+</dd>
+<dt>(file1 file2 &hellip;)</dt><dd>A list of filenames. All files in the list will be
+     scanned.
+</dd>
+</dl>
+
+
+</div>
+
+</div>
+
+<div id="outline-container-8_4" class="outline-3">
+<h3 id="sec-8_4">Definition of old and overdue items </h3>
+<div class="outline-text-3" id="text-8_4">
+
+
 
 <p>
 Org-Drill prioritises <i>overdue</i> items in each drill session, presenting them
@@ -971,18 +995,18 @@ of 10 days or less. To change this, use the following:
 
 </div>
 
-<div id="outline-container-8_4" class="outline-3">
-<h3 id="sec-8_4">Spaced repetition algorithm </h3>
-<div class="outline-text-3" id="text-8_4">
+<div id="outline-container-8_5" class="outline-3">
+<h3 id="sec-8_5">Spaced repetition algorithm </h3>
+<div class="outline-text-3" id="text-8_5">
 
 
 
 
 </div>
 
-<div id="outline-container-8_4_1" class="outline-4">
-<h4 id="sec-8_4_1">Choice of algorithm </h4>
-<div class="outline-text-4" id="text-8_4_1">
+<div id="outline-container-8_5_1" class="outline-4">
+<h4 id="sec-8_5_1">Choice of algorithm </h4>
+<div class="outline-text-4" id="text-8_5_1">
 
 
 
@@ -1024,9 +1048,9 @@ SuperMemo algorithms. These are:
 
 </div>
 
-<div id="outline-container-8_4_2" class="outline-4">
-<h4 id="sec-8_4_2">Random variation of repetition intervals </h4>
-<div class="outline-text-4" id="text-8_4_2">
+<div id="outline-container-8_5_2" class="outline-4">
+<h4 id="sec-8_5_2">Random variation of repetition intervals </h4>
+<div class="outline-text-4" id="text-8_5_2">
 
 
 
@@ -1060,9 +1084,9 @@ your <code>.emacs</code>:
 
 </div>
 
-<div id="outline-container-8_4_3" class="outline-4">
-<h4 id="sec-8_4_3">Adjustment for early or late review of items </h4>
-<div class="outline-text-4" id="text-8_4_3">
+<div id="outline-container-8_5_3" class="outline-4">
+<h4 id="sec-8_5_3">Adjustment for early or late review of items </h4>
+<div class="outline-text-4" id="text-8_5_3">
 
 
 
@@ -1089,9 +1113,9 @@ effect on the SM2 algorithm.
 
 </div>
 
-<div id="outline-container-8_4_4" class="outline-4">
-<h4 id="sec-8_4_4">Adjusting item difficulty globally </h4>
-<div class="outline-text-4" id="text-8_4_4">
+<div id="outline-container-8_5_4" class="outline-4">
+<h4 id="sec-8_5_4">Adjusting item difficulty globally </h4>
+<div class="outline-text-4" id="text-8_5_4">
 
 
 
@@ -1144,16 +1168,16 @@ To alter the learn fraction, put the following in your .emacs:
 
 </div>
 
-<div id="outline-container-8_5" class="outline-3">
-<h3 id="sec-8_5">Per-file customisation settings </h3>
-<div class="outline-text-3" id="text-8_5">
-
+<div id="outline-container-8_6" class="outline-3">
+<h3 id="sec-8_6"><a name="per-file-settings" id="per-file-settings"></a>Per-file customisation settings </h3>
+<div class="outline-text-3" id="text-8_6">
 
 
 <p>
-Most of the above settings are safe as file-local variables. This means you can
-include a commented section like this at the end of your .org file to apply
-special settings when running a Drill session using that file:
+Most of Org-Drill's customisation settings are safe as file-local
+variables. This means you can include a commented section like this at the end
+of your .org file to apply special settings when running a Drill session using
+that file:
 </p>
 
 
@@ -1166,6 +1190,22 @@ special settings when running a Drill session using that file:
 
 
 
+<p>
+You can achieve the same effect by including the settings in the 'mode line'
+(this must be the <b>first line</b> in the file), like so:
+</p>
+
+
+
+<pre class="example"># -*- org-drill-maximum-items-per-session: 50; org-drill-spaced-repetition-algorithm: simple8 -*-
+</pre>
+
+
+
+<p>
+In either case you will need to save, close and re-open the file for the
+changes to take effect.
+</p>
 
 </div>
 </div>
@@ -1173,12 +1213,39 @@ special settings when running a Drill session using that file:
 </div>
 
 <div id="outline-container-9" class="outline-2">
-<h2 id="sec-9">Sharing, merging and synchronising item collections </h2>
+<h2 id="sec-9">Coping with large collections </h2>
 <div class="outline-text-2" id="text-9">
 
 
 
 <p>
+If you keep all your items in a single file, it may eventually very large. The
+file will be slow to load, and Emacs may have trouble syntax-highlighting the
+file contents correctly.
+</p>
+<p>
+The easiest steps to solve this problem are:
+</p><ol>
+<li>Move your file into its own dedicated directory.
+</li>
+<li>Divide the file into two or more smaller files.
+</li>
+<li>Within each file, set <code>org-drill-scope</code> to 'directory'. See
+   <a href="#sec-8_6">per-file settings</a> above for instructions about how to do this.
+</li>
+</ol>
+
+</div>
+
+</div>
+
+<div id="outline-container-10" class="outline-2">
+<h2 id="sec-10">Sharing, merging and synchronising item collections </h2>
+<div class="outline-text-2" id="text-10">
+
+
+
+<p>
 Every drill item is automatically given a persistent unique "ID" the first time
 it is seen by Org-Drill. This means that if two different people subsequently
 edit or reschedule that item, Org-Drill can still tell that it is the same
@@ -1236,9 +1303,9 @@ procedure.
 
 </div>
 
-<div id="outline-container-10" class="outline-2">
-<h2 id="sec-10">Incremental reading </h2>
-<div class="outline-text-2" id="text-10">
+<div id="outline-container-11" class="outline-2">
+<h2 id="sec-11">Incremental reading </h2>
+<div class="outline-text-2" id="text-11">
 
 
 
@@ -1396,7 +1463,7 @@ or give it different tags or properties, for example.
 </div>
 </div>
 <div id="postamble">
-<p class="date">Date: 2011-05-10 16:51:44 </p>
+<p class="date">Date: 2011-05-12 10:29:29 </p>
 <p class="author">Author: Paul Sexton</p>
 <p class="creator">Org version 7.5 with Emacs version 23</p>
 <a href="http://validator.w3.org/check?uri=referer">Validate XHTML 1.0</a>