README.html

<strong><i>2021 Project Status: Active development will resume on Saturday the 27th of February.</i></strong>

<a href="https://travis-ci.org/luoliyan/incremental-reading"><img src="https://travis-ci.org/luoliyan/incremental-reading.svg?branch=master" alt="Build Status" /></a>


<b>Note:</b> Version 4 of the add-on is only available for Anki 2.1+. Some features will be missing from the earlier versions.

<b><i>Introduction</i></b>

This is a rewrite of the <a href="https://github.com/aleksejrs/anki-2.0-vsa-and-ire">Incremental Reading add-on</a>, which aims to provide features that support incremental reading in Anki. The idea of working with long-form content within a spaced-repetition program appears to have originated with SuperMemo, which offers an elaborate implementation of the technique (see their <a href="https://www.supermemo.com/help/read.htm">help article</a> for more information). This add-on for Anki is comparatively bare-bones, providing a minimal set of tools for iterating over long texts and creating new flashcards from existing ones. For an overview of these features, see below.

<ul><li>Version 4: <a href="https://github.com/luoliyan/incremental-reading">GitHub</a>, <a href="https://github.com/luoliyan/incremental-reading/issues">issue tracker</a>, <a href="https://anki.tenderapp.com/discussions/add-ons/9054-incremental-reading-add-on-discussion-support">discussion board</a></li><li>Version 3: <a href="https://github.com/luoliyan/incremental-reading/tree/legacy">GitHub</a>, <a href="https://anki.tenderapp.com/discussions/add-ons/9054-incremental-reading-add-on-discussion-support">discussion board</a></li><li>Version 2: <a href="https://ankiweb.net/shared/info/355348508">AnkiWeb</a>, <a href="https://github.com/aleksejrs/anki-2.0-vsa-and-ire">GitHub</a>, <a href="https://luoliyan.github.io/incremental-reading">manual</a></li></ul>
<b><i>Main Features</i></b>

<ul><li>Import content from web feeds (RSS/Atom), webpages, or Pocket (<b>v4 only</b>)</li><li>Extract selected text into a new card by pressing <code><b>x</b></code></li><li>Highlight selected text by pressing <code><b>h</b></code></li><li>Remove selected text by pressing <code><b>z</b></code></li><li>Undo changes to the text by pressing <code><b>u</b></code></li><li>Apply rich text formatting while reading</li><li>Create custom shortcuts to quickly add cards</li><li>Maintain scroll position and zoom on a per-card basis</li><li>Rearrange cards in the built-in organiser</li><li>Control the scheduling of incremental reading cards</li><li>Limit the width of cards (useful on large screens) (<b>v4 only</b>)</li></ul>
<b>New to Version 4</b>

<ul><li>Compatible with Anki 2.1</li><li>Import single webpages (<code><b>Alt</b></code>+<code><b>3</b></code>)</li><li>Import web feeds (<code><b>Alt</b></code>+<code><b>4</b></code>)</li><li>Import Pocket articles (<code><b>Alt</b></code>+<code><b>5</b></code>)</li><li>Apply bold, italics, underline or strikethrough (<code><b>Ctrl</b></code>+<code><b>B</b></code>, <code><b>I</b></code>, <code><b>U</b></code>, or <code><b>S</b></code>)</li><li>Toggle formatting on and off (<code><b>Ctrl</b></code>+<code><b>Shift</b></code>+<code><b>O</b></code>)</li><li>Choose maximum width of cards (see options: <code><b>Alt</b></code>+<code><b>1</b></code>)</li><li>Control initial scheduling of extracts (see options: <code><b>Alt</b></code>+<code><b>1</b></code>)</li></ul>
<b>New to Version 3</b>

<ul><li>Remove unwanted text with a single key-press (<code><b>z</b></code>)</li><li>Multi-level undo, for reverting text changes (<code><b>u</b></code>)</li><li>New options to control how text is extracted:<ul><li>Open the full note editor for each extraction (slow), or simply a title entry box (fast)</li><li>Extract selected text as HTML (retain color and formatting) or plain text (remove all formatting)</li><li>Choose a destination deck for extracts</li></ul></li><li>New options for several aspects of zoom and scroll functionality:<ul><li><i>Zoom Step</i> (the amount that magnification changes when zooming in or out)</li><li><i>General Zoom</i> (the zoom level for the deck browser and overview screens)</li><li><i>Line Step</i> (the amount the page moves up or down when the Up or Down direction keys are used)</li><li><i>Page Step</i> (same as above, but with the <code><b>Page Up</b></code> and <code><b>Page Down</b></code> keys)</li></ul></li><li>Highlighting:<ul><li>Both the background color and text color used for highlighting can be customized</li><li>A drop-down list of available colors is provided</li><li>A preview is now displayed when selecting highlight colors</li><li>The colors applied to text extracted with <code><b>x</b></code> can now be set independently</li></ul></li><li>Quick Keys<ul><li>A list of all existing Quick Keys is now shown, to allow easy modification</li><li>Unwanted Quick Keys can be easily deleted</li><li>A plain text extraction option has also been added</li></ul></li><li>All options have been consolidated into a single tabbed dialog</li></ul>
<b><i>Screenshots</i></b>

<b>Note:</b> These are fairly outdated.

<img src="https://raw.githubusercontent.com/luoliyan/incremental-reading/master/screenshots/extraction-and-highlighting.png" alt="Screenshot #1" /><img src="https://raw.githubusercontent.com/luoliyan/incremental-reading/master/screenshots/highlighting-tab.png" alt="Screenshot #2" /><img src="https://raw.githubusercontent.com/luoliyan/incremental-reading/master/screenshots/quick-keys-tab.png" alt="Screenshot #3" />

<b><i>Installation</i></b>

You will first need to have Anki installed. Download the relevant installer <a href="http://ankisrs.net">here</a>.

To install through Anki, navigate to Tools → Add-ons → Get Add-ons..., and enter the code <code>935264945</code>. To install manually, download the GitHub repository (<a href="https://github.com/luoliyan/incremental-reading-for-anki/archive/master.zip">here</a>) and place the <code>ir</code> folder into your add-ons folder.

<b><i>Usage</i></b>

Experimentation should lead to a pretty quick understanding of how the add-on works. If in doubt, start with the following:

<ol><li>Create a new IR note with an article you want to study (the easiest way to do this is to import a webpage, by pressing <code><b>Alt</b></code>+<code><b>3</b></code> while on the deck overview screen)</li><li>Set up a shortcut for creating regular Anki cards from IR cards (press <code><b>Alt</b></code>+<code><b>1</b></code>, or go to the menu, then go to the Quick Keys tab)</li><li>Review the IR card that was created, and extract any text you find interesting (by selecting the text and pressing <code><b>x</b></code>)</li><li>Choose <i>Soon</i> or <i>Later</i> when you want to move to the next card (which will be a portion of text you extracted)</li><li>Whenever you want to create a regular Anki note, simply select the desired text and use the shortcut you created earlier</li></ol>
Outdated instructions can be found <a href="https://luoliyan.github.io/incremental-reading">here</a>. They were written for v2, but the basic behaviour of the add-on is still similar.

<b><i>Support</i></b>

If any issues are encountered, please post details to the <a href="https://anki.tenderapp.com/discussions/add-ons">Anki add-ons forum</a>. It’s best if you post in the existing thread (<a href="https://anki.tenderapp.com/discussions/add-ons/9054-incremental-reading-add-on-discussion-support">here</a>) so I receive an email notification. Otherwise, <a href="https://github.com/luoliyan/incremental-reading-for-anki/issues">note an issue</a> or make a pull request on GitHub.

Please include the following information in your post:

<ul><li>The version of Anki you are using (e.g., v2.1.0-beta5; can be found in Help → About...)</li><li>The version of IR you are using (this can be found in Read → About...)</li><li>The operating system you are using</li><li>Details of the problem</li><li>Steps needed to reproduce the problem</li></ul>
<b><i>License</i></b>

Multiple people have contributed to this add-on, and it’s somewhat unclear who to credit for which changes and which licenses to apply.

Tiago Barroso appears to have initiated the project, and he has <a href="https://groups.google.com/d/msg/anki-addons/xibqDVFqQwQ/-qpxKvxurPMJ">stated</a> that he releases all of his add-ons under the ISC license. Frank Kmiec later vastly expanded the add-on, but it’s unclear which license his changes were released under. Presuming he didn’t specify one, the <a href="https://ankiweb.net/account/terms">AnkiWeb terms and conditions</a> suggest they were automatically released under the AGPL v3. Aleksej’s changes to Frank’s version are <a href="https://github.com/aleksejrs/anki-2.0-vsa-and-ire">multi-licensed under the GPL and ISC licenses</a>.

For the sake of simplicity, my changes are also released under the ISC license. For each author, I have placed a copyright lines where appropriate, with what I believe are correct dates. If I have made a mistake in this respect, please let me know.

Frank Raiser released an Anki 1 add-on under a similar name, but it doesn’t appear to share any code with the current project and functions quite differently. For more information, see <a href="http://frankraiser.de/drupal/AnkiIR">Anki Incremental Reading</a>.