aboutsummaryrefslogtreecommitdiff
path: root/README.org
Commit message (Collapse)AuthorAgeFilesLines
* docs: fix README default-scheduler marker (simple8, not SM5)Craig Jennings14 days1-1/+1
|
* feat: add statistics dashboard CSV export and docsCraig Jennings14 days1-0/+1
| | | | | | | | org-drill-statistics-export-csv, bound to e in the dashboard and now implemented, writes three files into a chosen directory honoring the active scope and range: sessions.csv (one row per recorded session), cards.csv (one row per drill card in scope with its scheduling properties and computed status), and daily.csv (per-day reviews, passes, fails, pass percent, and duration). Fields are quoted per RFC 4180 by a small csv-quote helper, since csv-mode isn't a dependency. This is the dashboard's last piece, step 3 of the spec. The row builders for the three views are pure and unit-tested with deterministic fixtures, and csv-quote covers the comma, quote, and newline cases. I documented the dashboard and the export in org-drill.org (a new section with the keymap, the CSV columns, and the settings table) and added a feature bullet to the README. I also removed the now-redundant declare-function forward reference for export-csv. It named this file as the source, so once the real defun landed the byte-compiler counted the function twice and warned.
* docs: revert intro paragraph; drop personal email mention from historyCraig Jennings2026-05-051-2/+2
| | | | | | | | | | | | Two README fixes: - Restored the original three-sentence intro paragraph. Misread an earlier instruction and removed the wrong second sentence. - Removed the line about emailing phillord and a possible maintainer takeover from the History section. That's a personal outreach detail that doesn't belong in a public README. Rephrased the surrounding paragraph to focus on what's happening in this fork rather than the maintainer-handoff plans.
* docs: tighten README intro and link org-drill.org referencesCraig Jennings2026-05-051-3/+3
| | | | | | | | | Removed the second sentence of the intro paragraph and rephrased the remaining text into a compact two-sentence opener focused on what org-drill is and how scheduling works. Both occurrences of org-drill.org in the README are now relative file: links so a reader on GitHub can click through to the manual.
* docs: rewrite README as a slim modernized front-doorCraig Jennings2026-05-051-0/+227
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Replaced the 1049-line README.md (which inlined the entire user manual) with a ~227-line README.org that's the standard 'GitHub front page' for an Emacs package. The deep manual lives where it already does — in org-drill.org, which is also a runnable demo deck. Sections, in order: - Title + nav links - Five badges: made-for-emacs, MELPA, MELPA Stable, GitHub Actions CI, Coveralls. CI and coverage badges are aspirational until the GitHub Actions TODO lands; their URLs are correct so they auto-populate when CI is set up. - Maintenance status: explains the fork, lists recently-fixed upstream issues, points at the GitHub mirror and Issues. - Features: bullet list of capabilities - Installation: MELPA, package-vc-install, use-package :vc, Straight, manual. Drops the stale 'tick drill in org-modules' + Org contrib references. - Quick Start: 60-second flow from install to first drill - In-Session Keys: cheat sheet table for both the question and rating phases (closes the existing #A TODO for the cheat sheet) - Configuration: most-used defcustoms with comments - Development: make-target table - History: contrib → phillord → cjennings handoff story - License pointer Closes three #A TODOs: README modernization, stale install instructions, in-session keybinding cheat sheet. Added assets/made-for-emacs-badge.svg (copied from emacs-wttrin).
* Removed old doc files (renamed).2.3.2eeeickythump2011-05-211-911/+0
|
* - New card types: show2cloze, hide1_firstmore, show1_firstless, ↵eeeickythump2011-05-201-1/+47
| | | | | | | | | | | | | | | | | | | show1_lastmore. See docs for details. - 'conjugate' card type can now show a hint (VERB_INFINITIVE_HINT) - New command: org-drill-again: run another drill session using leftover items from the last session, i.e. don't rescan the item collection. - If org-drill-resume is called and there is nothing to resume, offer to call org-drill-again - Automatically prompt to save all modified buffers when a drill session finishes (turn off with 'org-drill-save-buffers-after-drill-sessions-p') - Politely skip cards with unknown card types - When suspending a drill session, print a message describing the key that runs org-drill-resume (it it's bound to a key) - org-drill-merge-buffers: can now optionally be prevented from copying unmatched items from SRC into DEST - org-drill-merge-buffers: fixed a bug where it prompted for certain property values if they were not set in the item being processed - org-drill-merge-buffers: ensure that *all* items in DEST are stripped of their scheduling data
* New file-safe user variable: org-drill-scope. Allows customisation of the ↵eeeickythump2011-05-121-18/+58
| | | | | | | | | | | | | | | | 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.
* - All drill items now receive unique IDs (using the org-id module). This allows2.3eeeickythump2011-05-101-16/+61
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | various clever tricks such as 'synching' the item collections of two people. At the beginning of a drill session, IDs are assigned automatically to all drill items that do not possess them. This is slow if you have a large collection, but it only happens once. - New command 'org-drill-merge-buffers'. Called from buffer A, and given buffer B, imports all the user-specific scheduling data from B into A, overwriting any such information in A. Matching items are identified by their ID. Any items in B that do not exist in A are copied to A. A scenario where this could be useful: * Tim decides to learn Swedish using an item collection (org file) made publically available by Jane. (Before publishing it Jane used 'org-drill-strip-all-data' to remove her personal scheduling data from the collection.) A few weeks later, Jane updates her collection, adding new items and revising some old ones. Tim downloads the new collection and imports his progress from his copy of the old collection, using 'org-drill-merge-buffers'. He can then discard his old copy. Any items HE added to HIS copy of the old collection will not be lost -- they will be appended to his copy of the new collection. - Instead of overdue items being reviewed in a completely random order, they are now ordered by the number of days overdue, so that the most overdue items are seen first. When two items are the same number of days overdue, then the order is random. - slightly adjusted how 'random noise' is applied to intervals, to give wider spread - we now use the port of the Common Lisp random number generator, in cl.el, instead of emacs' builtin RNG - Random number generator is now reseeded using system time at the beginning of each drill session. - Hints inside clozed text areas are now invisible during drill sessions if the clozed text is not itself being hidden, ie if your card contains [Moscow|Russian city] you will only see [Moscow] in the answer. - The '...' is now shown after the hint text rather than before it, i.e. '[Russian city...]'. You can override this by actually including '...' in the hint itself. - The minibuffer prompt now displays the card 'type' for testing purposes, as a single letter: N=new, Y=young, o=old, !=overdue, F=failed - New card type: hide2cloze (hides exactly 2 randomly chosen areas of clozed text)
* - Added new example card types, more useful than 'spanish_verb':2.2eeeickythump2011-04-301-12/+40
| | | | | | | | | | | | | | | | | | | | | | | - 'conjugate': retrieves properties VERB_INFINITIVE and VERB_TRANSLATION from parent item, and uses its own property VERB_TENSE to prompt the student 'Translate the verb INFINITIVE and conjugate for the TENSE tense' or 'Give the verb meaning TRANSLATION and conjugate for the TENSE tense' - 'translate_number': using third party library spell-number.el, prompt the student to translate a random number to or from a non-English language (the library can handle numerous languages) - examples of both in spanish.org - org-drill-card-type-alist can now take a second function name, for controlling how the ANSWER is displayed - items can have weights (DRILL_CARD_WEIGHT). The interval is divided by the weight when scheduling, so eg an item with a weight of 2.0 will be tested twice as often as a normal item. - New command: org-drill-tree. Same as org-drill using 'tree' argument. - New command: org-drill-strip-data: deletes all scheduling data from every item in scope. Intended for use if you wish to share your item library with someone else. - Fixed bug in simple8 algorithm where items failed on their first review were not having intervals reset - Ensure all markers are freed before starting a new drill session.
* - 'multicloze' card type renamed to 'hide1cloze' (though 'multicloze' iseeeickythump2011-04-221-6/+13
| | | | | | | | | | | | | | still recognised as a synonym, for backwards compatibility) - new card type 'show1cloze' -- like hide1cloze, but only reveals one of the areas of clozed text in the item. - when 'revealing' an item during a drill session, do not show contents of any subheadings which are themselves tagged as drill items. This means you can have drill items inside drill items, without giving their answers away when you review the parent item. - better ensure visibility state of the org buffer is restored after the drill session. - syntax highlighting of [clozed text] now works if other faces are applied inside the clozed text area, eg [the *largest* city]
* - More robust handling of the situation where we resume a drill session but2.1.1eeeickythump2011-04-151-0/+6
| | | | | | | some items have been moved or deleted. We now check for this and discard offending markers, rather than failing outright. - Final report now shows number of items that will become due tomorrow. - Fixed a rounding bug which affected deciding whether items are 'overdue'.
* - Can now resume drill sessions after exiting with (e)dit or (q)uit commands!2.1eeeickythump2011-04-131-56/+111
| | | | | | | | | | | | Use 'M-x org-drill-resume'. - Finessed the prioritisation of items during drill sessions. - We now present failed and OVERDUE items first. Overdue status is defined in days and has some leeway, defined by a new variable 'org-drill-overdue-interval-factor'. - Next we present YOUNG items (learned or relearned recently, so have short intervals). The definition of 'young' is via the variable 'org-drill-days-before-old'. - Finally we present a random mix of OLD items and NEW items. - Final report gives info about counts of pending overdue, young, and old items. - Timer shows '++:++' if > 1 hour passes while reviewing an item.
* Many changes:2.0eeeickythump2011-04-081-106/+234
| | | | | | | | | | | | | | | | | | | | - Item drill data is stored in a clearer format, each value has its own property, the old 'org-learn' LEARN_DATA property has been dropped. Items that contain LEARN_DATA are silently rolled over to the new format. - For SM5, matrix of optimal factors is now correctly *global* rather than per-item, and is saved between drill sessions as an emacs customization variable. - We store interval data as floating point numbers rather than rounding to the nearest integer. - New experimental algorithm: 'simple8', based on SuperMemo SM8. - New options: - org-drill-forgetting-index: define the percentage of items that it is "acceptable" to fail. A warning message is shown after the drill session if more items than this were failed. - org-drill-learn-fraction: governs how fast time intervals increase with each successful repetition of an item. - org-drill-adjust-intervals-for-early-and-late-repetitions-p: if true, alter next scheduled date if an item is reviewed earlier or later than it was supposed to be. - Almost all variables have been declared safe for file-local reassignment. - We now ignore org-learn-always-reschedule, regarding it as always true. - Post-session report now shows a count of dormant items (those not yet due for review).
* - New option: org-drill-hide-item-headings-p. If non-nil, item headings will ↵eeeickythump2011-04-041-1/+9
| | | | | | | | | be made invisible while each item is being tested. - OF matrix entries are rounded to 3 decimal places. - Item E-factors are not modified if the item is "failed" (in accordance with Dr Wozniak's description of the SM5 algorithm).
* - Hide comments (#...) in items during drill sessions.eeeickythump2011-03-271-12/+20
| | | | | - Fix bug where if a subheading was more than 1 level deeper than the tested item, and had no parent heading other than the item's heading, it would not be hidden during testing.
* * Documentation added for multicloze cards and cram mode.1.4eeeickythump2010-09-171-16/+103
| | | | * Multicloze card example added in 'spanish.org'.
* Separate counts of pending new, old, and failed items are displayed in ↵1.3eeeickythump2010-09-041-1/+1
| | | | | | | | | custom colours during review and in the final report. A timer (MM:SS) is displayed as part of the review prompt. Order-of-magnitude speed boost when scanning entries to prepare a drill session. Recycle markers at the end of each drill session.
* Allow editing and tag-editing when prompted for recall quality.eeeickythump2010-09-021-1/+0
| | | | | | | | Allow tag-editing when reviewing items. Any linked image files are displayed inline during review. Don't hide org links [[...][...]] when hiding cloze text, azs they may contain inline images which we want to keep visible. Close property drawers during review. Provide visual feedback (progress bar in minibuffer) when scanning items in preparation for a drill session.
* Added implementation of SM2 algorithm.1.1eeeickythump2010-08-261-85/+129
| | | | | | | | | | Add option 'org-drill-spaced-repetition-algorithm': choose either SM2 or SM5 algorithm. Add option 'org-drill-add-random-noise-to-intervals-p': randomly vary repetition intervals slightly, to avoid clumping. Fixed a bug in org-learn's SM5 algorithm (intervals much too long). Use overlays to display cloze deletions as '[...]' during reviews. Cloze text can contain hints, which will visible during review. Add option 'org-drill-failure-quality': customise which quality is regarded as unambiguous failure (1 or 2). Expanded documentation, and added section on 'incremental reading', with example setup.
* Added README with more detailed documentation.1.0eeeickythump2010-08-221-0/+410
Items which are failed during session are presented again before the session ends. Items which were failures at the last review session are presented first in the next session. Added recognition of leech items, based on excessive number of failures. Leeches can be skipped or warned about. When reviewing an item, the prompt shows the number of items remaining. When the session finishes, the minibuffer shows a brief report givisng statistics about total time spent reviewing, number of cards that still need review, etc. Fixed the regexp for cloze-deleted text. Optional face for cloze text in org mode buffers. New card type: twosided.