Warning
+Note that this hasn't been updated in a while, +please see the code.
+(It's the same as that used for flashcards - apart from the PageRanks)
+if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_easelink_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64)) (cater for uncertainty)20 and the interval changes to old_interval * new_ease / 100 * 1.3 (the 1.3 is the easy bonus)old_interval * old_ease / 10020 and the interval changes to old_interval * 0.50.5 can be modified in settingsminimum ease = 1308 or more days:interval += random_choice({-fuzz, 0, +fuzz})fuzz = ceil(0.05 * interval)All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+Generated by auto-changelog.
#784#782++30 October 2023
+
#780#775b9c354d++23 October 2023
+
#772#699#763++9 October 2023
+
#756#751#71944e9bb61f69f961ef0663++5 May 2023
+
#679#678#671#667zh-cn.ts and zh-tw.ts #676#665#664#643#656#657#637++6 February 2023
+
#622#621#620#619#618#616#611#593#592#591#515#589#587e33ec932bf13a9fef51b6++ +8 January 2023
+
++ +2 January 2023
+
++2 January 2023
+
#574#573#572#566#565#564#563#562#561#560#559#532++12 December 2022
+
#546#545#544++12 December 2022
+
#543#542#541#539#540#536#535#531#518#523#480#510d8c0e9ec6bb8f0++24 July 2022
+
#474#469#473#472#464#425#419#402#413#417#416#273c386dc3bce5c229d34c56++21 February 2022
+
ve done the translation to Russian. [#403`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/403)#391#3641f0f46ce35c0128ac56ae++2 January 2022
+
3b0446a223639607e1de4++1 January 2022
+
#358#355#356#357#353#350#352#351#316#315#345#344#341#340#323#318#326#299#300#302#297#298#291#290#292#28566766a83623efc0e12388++29 August 2021
+
#281#280#277#276#271#275#268#265#264#263177bc7876b94d126d9dbd++19 August 2021
+
#258#252#251#245#236#234#2321d4bcdcd9181f5069619c++8 August 2021
+
#230#229#228#227#226#225c3e6c0d17d74963808ce0++4 August 2021
+
#223#222#220#219#217#215#214#210#18805d32179798c6982651b4++20 June 2021
+
#170#169#168#166#165856d4233f2d97ec906afe++ +13 June 2021
+
++ +12 June 2021
+
++ +11 June 2021
+
++10 June 2021
+
#150#1494d4f3d4c7eb5cfe4a897c++7 June 2021
+
#143#142#141#140#137a65ca7f3ffe4f00541e77++ +6 June 2021
+
++6 June 2021
+
#131#130#128#126#127#125#124#123#11632141750af6c12492f9a8++31 May 2021
+
#107#106#105fe9b37f83ef968++ +21 May 2021
+
++21 May 2021
+
#97#95#94#89#858b84184a4197c34098f10++ +16 May 2021
+
++16 May 2021
+
#77#75#74#73#72#71#69#68d793c423b3ca00ead217d++8 May 2021
+
#57b7cb3cd0a59d8faccbf0c++8 May 2021
+
#55#54#51#50#47f633e720c1944e503ec0f++2 May 2021
+
953147eaafd4ef335bb6f++1 May 2021
+
#42c389a2f65fe74b3da32ac++1 May 2021
+
#41#40#39#38#37ef29e14d12cb0e12344cc++ +20 April 2021
+
++19 April 2021
+
06cda883f52456d6686c7++19 April 2021
+
#23#22#21df30fb8efb8d78ad8b22c++15 April 2021
+
#1851ea4ec78b83ad0ac4cb1++14 April 2021
+
3be20cee1bb32f3609e72++ +14 April 2021
+
++13 April 2021
+
#11852479f327f5cd43fb6ce++ +13 April 2021
+
++12 April 2021
+
#6#5#3348bdffdf0188012f1622++11 April 2021
+
6c19778++ +11 April 2021
+
++ + + + + + + +9 April 2021
+
First off, thanks for wanting to contribute to the Spaced Repetition plugin!
+To help translate the plugin to your language:
+src/lang/locale/en.ts to the proper file in src/lang/locale/ (i.e. fr.ts for French, or sw.ts for Swahili). The locale codes are IETF language tags.Sample en.ts file:
// English
+
+export default {
+ EASY: "Easy",
+ SHOW_ANSWER: "Show Answer",
+ DAYS_STR_IVL: "${interval} days",
+ CHECK_ALGORITHM_WIKI:
+ 'For more information, check the <a href="${algo_url}">algorithm implementation</a>.',
+};
+Equivalent sw.ts file:
// Swahili
+
+export default {
+ EASY: "Rahisi",
+ SHOW_ANSWER: "Onyesha Jibu",
+ DAYS_STR_IVL: "Siku ${interval}",
+ CHECK_ALGORITHM_WIKI:
+ 'Kwa habari zaidi, angalia <a href="${algo_url}">utekelezaji wa algorithm</a>.',
+};
+A part of that last one is uhh, Google translated, I have a working understanding of Swahili but not enough to write computerese lol.
+Please note that:
+${} isn't translated. This is used to replace variables in code. For instance, if interval = 4, it becomes 4 days in English & Siku 4 in Swahili. Quite nifty if you ask me.pnpm dev to test the changes inside Obsidian.You could create symbolic links between the build files and the Obsidian vault, example:
+# remove existing files in the Obsidian vault
+rm ~/notes/.obsidian/plugins/obsidian-spaced-repetition/main.js ~/notes/.obsidian/plugins/obsidian-spaced-repetition/manifest.json ~/notes/.obsidian/plugins/obsidian-spaced-repetition/styles.css
+# use absolute paths
+ln -s /home/stephen/obsidian-spaced-repetition/build/main.js /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
+ln -s /home/stephen/obsidian-spaced-repetition/manifest.json /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
+ln -s /home/stephen/obsidian-spaced-repetition/styles.css /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
+Document the "user-facing" changes e.g. new feature, UI change, etc.
+tests/.pnpm test[Unreleased] section of the changelog (docs/changelog.md).Added for new features.Changed for changes in existing functionality.Deprecated for soon-to-be removed features.Removed for now removed features.Fixed for any bug fixes.Security in case of vulnerabilities.Make flashcard text selectable [@st3v3nmw](https://github.com/st3v3nmw)pnpm lintpnpm formatThe documentation consists of Markdown files which MkDocs converts to static web pages. +Specifically, this project uses MkDocs Material.
+These files reside in docs/ in the respective language's folder. For instance, English docs are located in docs/en/.
The docs are served on https://www.stephenmwangi.com/obsidian-spaced-repetition/.
+For small changes, you can simply open an pull request for merging (against the master branch).
+The changes will be live once a new release is made.
For larger diffs, it's important that you check how your docs look like as explained below.
+python3 -m venv venv. venv/bin/activatepip install -r requirements.txt. venv/bin/activatemkdocs servedocs/ if it doesn't exist. Use the language codes provided here.mkdocs.yml - plugins.i18n.languages).en) folder into the new folder.Example using v1.9.2:
git switch -c release-v1.9.2manifest.json and package.json (following Semantic Versioning).MAJOR.MINOR.PATCH, increment the:MAJOR version when you make incompatible API changesMINOR version when you add functionality in a backwards compatible mannerPATCH version when you make backwards compatible bug fixesminAppVersion and versions.json to reflect this.pnpm changelog to update the CHANGELOG.Commit and push the changes:
+ +Open and merge the PR into master.
master and pull the changes: git switch master && git pullgit tag 1.9.2git push --tags. Check the Obsidian Tasks project which has excellent contribution guidelines. ↩
+Warning
+Note that this hasn't been updated in a while, +please see the code.
+(It's the same as that used for flashcards - apart from the PageRanks)
+if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_easelink_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64)) (cater for uncertainty)20 and the interval changes to old_interval * new_ease / 100 * 1.3 (the 1.3 is the easy bonus)old_interval * old_ease / 10020 and the interval changes to old_interval * 0.50.5 can be modified in settingsminimum ease = 1308 or more days:interval += random_choice({-fuzz, 0, +fuzz})fuzz = ceil(0.05 * interval)All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+Generated by auto-changelog.
#784#782++30 October 2023
+
#780#775b9c354d++23 October 2023
+
#772#699#763++9 October 2023
+
#756#751#71944e9bb61f69f961ef0663++5 May 2023
+
#679#678#671#667zh-cn.ts and zh-tw.ts #676#665#664#643#656#657#637++6 February 2023
+
#622#621#620#619#618#616#611#593#592#591#515#589#587e33ec932bf13a9fef51b6++ +8 January 2023
+
++ +2 January 2023
+
++2 January 2023
+
#574#573#572#566#565#564#563#562#561#560#559#532++12 December 2022
+
#546#545#544++12 December 2022
+
#543#542#541#539#540#536#535#531#518#523#480#510d8c0e9ec6bb8f0++24 July 2022
+
#474#469#473#472#464#425#419#402#413#417#416#273c386dc3bce5c229d34c56++21 February 2022
+
ve done the translation to Russian. [#403`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/403)#391#3641f0f46ce35c0128ac56ae++2 January 2022
+
3b0446a223639607e1de4++1 January 2022
+
#358#355#356#357#353#350#352#351#316#315#345#344#341#340#323#318#326#299#300#302#297#298#291#290#292#28566766a83623efc0e12388++29 August 2021
+
#281#280#277#276#271#275#268#265#264#263177bc7876b94d126d9dbd++19 August 2021
+
#258#252#251#245#236#234#2321d4bcdcd9181f5069619c++8 August 2021
+
#230#229#228#227#226#225c3e6c0d17d74963808ce0++4 August 2021
+
#223#222#220#219#217#215#214#210#18805d32179798c6982651b4++20 June 2021
+
#170#169#168#166#165856d4233f2d97ec906afe++ +13 June 2021
+
++ +12 June 2021
+
++ +11 June 2021
+
++10 June 2021
+
#150#1494d4f3d4c7eb5cfe4a897c++7 June 2021
+
#143#142#141#140#137a65ca7f3ffe4f00541e77++ +6 June 2021
+
++6 June 2021
+
#131#130#128#126#127#125#124#123#11632141750af6c12492f9a8++31 May 2021
+
#107#106#105fe9b37f83ef968++ +21 May 2021
+
++21 May 2021
+
#97#95#94#89#858b84184a4197c34098f10++ +16 May 2021
+
++16 May 2021
+
#77#75#74#73#72#71#69#68d793c423b3ca00ead217d++8 May 2021
+
#57b7cb3cd0a59d8faccbf0c++8 May 2021
+
#55#54#51#50#47f633e720c1944e503ec0f++2 May 2021
+
953147eaafd4ef335bb6f++1 May 2021
+
#42c389a2f65fe74b3da32ac++1 May 2021
+
#41#40#39#38#37ef29e14d12cb0e12344cc++ +20 April 2021
+
++19 April 2021
+
06cda883f52456d6686c7++19 April 2021
+
#23#22#21df30fb8efb8d78ad8b22c++15 April 2021
+
#1851ea4ec78b83ad0ac4cb1++14 April 2021
+
3be20cee1bb32f3609e72++ +14 April 2021
+
++13 April 2021
+
#11852479f327f5cd43fb6ce++ +13 April 2021
+
++12 April 2021
+
#6#5#3348bdffdf0188012f1622++11 April 2021
+
6c19778++ +11 April 2021
+
++ + + + + + + +9 April 2021
+
First off, thanks for wanting to contribute to the Spaced Repetition plugin!
+To help translate the plugin to your language:
+src/lang/locale/en.ts to the proper file in src/lang/locale/ (i.e. fr.ts for French, or sw.ts for Swahili). The locale codes are IETF language tags.Sample en.ts file:
// English
+
+export default {
+ EASY: "Easy",
+ SHOW_ANSWER: "Show Answer",
+ DAYS_STR_IVL: "${interval} days",
+ CHECK_ALGORITHM_WIKI:
+ 'For more information, check the <a href="${algo_url}">algorithm implementation</a>.',
+};
+Equivalent sw.ts file:
// Swahili
+
+export default {
+ EASY: "Rahisi",
+ SHOW_ANSWER: "Onyesha Jibu",
+ DAYS_STR_IVL: "Siku ${interval}",
+ CHECK_ALGORITHM_WIKI:
+ 'Kwa habari zaidi, angalia <a href="${algo_url}">utekelezaji wa algorithm</a>.',
+};
+A part of that last one is uhh, Google translated, I have a working understanding of Swahili but not enough to write computerese lol.
+Please note that:
+${} isn't translated. This is used to replace variables in code. For instance, if interval = 4, it becomes 4 days in English & Siku 4 in Swahili. Quite nifty if you ask me.pnpm dev to test the changes inside Obsidian.You could create symbolic links between the build files and the Obsidian vault, example:
+# remove existing files in the Obsidian vault
+rm ~/notes/.obsidian/plugins/obsidian-spaced-repetition/main.js ~/notes/.obsidian/plugins/obsidian-spaced-repetition/manifest.json ~/notes/.obsidian/plugins/obsidian-spaced-repetition/styles.css
+# use absolute paths
+ln -s /home/stephen/obsidian-spaced-repetition/build/main.js /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
+ln -s /home/stephen/obsidian-spaced-repetition/manifest.json /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
+ln -s /home/stephen/obsidian-spaced-repetition/styles.css /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
+Document the "user-facing" changes e.g. new feature, UI change, etc.
+tests/.pnpm test[Unreleased] section of the changelog (docs/changelog.md).Added for new features.Changed for changes in existing functionality.Deprecated for soon-to-be removed features.Removed for now removed features.Fixed for any bug fixes.Security in case of vulnerabilities.Make flashcard text selectable [@st3v3nmw](https://github.com/st3v3nmw)pnpm lintpnpm formatThe documentation consists of Markdown files which MkDocs converts to static web pages. +Specifically, this project uses MkDocs Material.
+These files reside in docs/ in the respective language's folder. For instance, English docs are located in docs/en/.
The docs are served on https://www.stephenmwangi.com/obsidian-spaced-repetition/.
+For small changes, you can simply open an pull request for merging (against the master branch).
+The changes will be live once a new release is made.
For larger diffs, it's important that you check how your docs look like as explained below.
+python3 -m venv venv. venv/bin/activatepip install -r requirements.txt. venv/bin/activatemkdocs servedocs/ if it doesn't exist. Use the language codes provided here.mkdocs.yml - plugins.i18n.languages).en) folder into the new folder.Example using v1.9.2:
git switch -c release-v1.9.2manifest.json and package.json (following Semantic Versioning).MAJOR.MINOR.PATCH, increment the:MAJOR version when you make incompatible API changesMINOR version when you add functionality in a backwards compatible mannerPATCH version when you make backwards compatible bug fixesminAppVersion and versions.json to reflect this.pnpm changelog to update the CHANGELOG.Commit and push the changes:
+ +Open and merge the PR into master.
master and pull the changes: git switch master && git pullgit tag 1.9.2git push --tags. Check the Obsidian Tasks project which has excellent contribution guidelines. ↩
+Piotr Wozniak's 20 rules of knowledge formulation is a great introduction on proper flashcard creation.
+The prompt and the answer are separated by :: (this can be configured in settings).
Creates two cards side1:::side2 & the reversed version side2:::side1.
The prompt and the answer are separated by ::: (this can be configured in settings).
Note: In the first review, the plugin will show non-reversed card and reversed card. +If Bury sibling cards until the next day? turn on, only non-reversed card will appear.
+The front and the back of the card are separated by ? (this can be configured in settings).
These can also span over multiple lines as long as both sides "touch" the ?:
As per the definition
+of "multiline" the prompt
+can be on multiple lines
+?
+same goes for
+the answer
+Creates two cards side1??side2 & the reversed version side2??side1.
The front and the back of the card are separated by ?? (this can be configured in settings).
These can also span over multiple lines as long as both sides "touch" the ??:
As per the definition
+of "multiline" the prompt
+can be on multiple lines
+??
+same goes for
+the answer
+Note: The behaviour is same as single line reversed.
+You can easily add cloze deletion cards using ==highlights==, **bolded text**, or {{text in curly braces}}.
These can be turned on or off in settings.
+Anki style {{c1:This text}} would {{c2:generate}} {{c1:2 cards}} cloze deletions are not currently supported. This feature is being tracked here.
The green and blue counts on the right of each deck name represent due and new cards respectively.
+#flashcards is the default).Note that #flashcards will match nested tags like #flashcards/subdeck/subdeck.
The plugin will automatically search for folders that contain flashcards & use their paths to create decks & sub-decks i.e. Folder/sub-folder/sub-sub-folder ⇔ Deck/sub-deck/sub-sub-deck.
This is an alternative to the tagging option and can be enabled in settings.
+Once done creating cards, click on the flashcards button on the left ribbon to start reviewing the flashcards. After a card is reviewed, a HTML comment is added containing the next review day, the interval, and the card's ease.
+ +Wrapping in a HTML comment makes the scheduling information not visible in the notes preview. For single-line cards, you can choose whether you want the HTML comment on the same line or on a separate line in the settings. Putting them on the same line prevents breaking of list structures in the preview or after auto-formatting.
+Note that you can skip a card by simply pressing S (case doesn't matter).
Tip
+If you're experiencing issues with the size of the modal on mobile devices, +go to settings and set the Flashcard Height Percentage and Flashcard Width Percentage +to 100% to maximize it.
+To review faster, use the following keyboard shortcuts:
+Space/Enter => Show answer0 => Reset card's progress (Sorta like Again in Anki)1 => Review as Hard2 or Space => Review as Good3 => Review as EasyIf the parent note has heading(s), the flashcard will have a title containing the context.
+Taking the following note:
+#flashcards
+
+# Trivia
+
+## Capitals
+
+### Africa
+
+Kenya::Nairobi
+
+### North America
+
+Canada::Ottawa
+The flashcard for Kenya::Nairobi will have Trivia > Capitals > Africa as the context/title whereas the flashcard for Canada::Ottawa will have Trivia > Capitals > North America as the context/title.
To delete a card, simply delete the scheduling information & the card text.
+You can wrap flashcards in HTML comments e.g. <!--Card text <!--SR:2021-08-20,13,290--> --> to prevent it from showing up in your review queues. You can always remove the wrapping comment later.
Currently, the only supported method is "cramming" all cards in a note using the Cram flashcards in this note command. Will work on a per-deck across-all-notes method.
+The statistics section can be accessed using the View Statistics command.
Stats on the number of cards due in the future.
+
Stats on delays until cards are shown again.
+Stats on card eases.
+Stats on card types: New, Young, Mature (Have intervals more than 1 month).
+ + + + + + +
Fight the forgetting curve & note aging by reviewing flashcards & notes using spaced repetition on Obsidian.md
+You can easily install the plugin from Obsidian's community plugin section in the Obsidian app (Search for Spaced Repetition).
Create an obsidian-spaced-repetition folder under .obsidian/plugins in your vault. Add the main.js, manifest.json, and the styles.css files from the latest release to the folder.
MIT License
+Copyright (c) 2021 - 2023 Stephen Mwangi
+Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.
+ + + + + + +Tag any notes that you'd like to review as #review. This default tag can be changed in the settings. (You can also use multiple tags)
All "new" notes are listed under New on the right pane (Review Queue). Like so:
Open the file & review it. Once done, choose either the Review: Easy, Review: Good, or the Review: Hard option on the file menu (the three dots). The Easy, Good, or Hard depend on how well you comprehend the material being reviewed.
Alternatively, you can right click on the file and access the same options:
+
The note will then be scheduled appropriately:
+
Commands to open a note for review, and making review responses are provided. You can create custom hotkeys for them in Settings -> HotKeys. This allows for much faster review.
Available settings are:
+Review: N due on the status bar at the bottom of the screen shows how many notes one has to review today (Today's notes + overdue notes). Clicking on that opens one of the notes for review.
Alternatively, one can use the Open a note for review command.
This was introduced here by @aviskase.
Here are the YouTube videos:
+Andy Matuschak uses spaced repetition system for working on writing inbox.
+In short, there are four possible actions (where x < y):
x) == mark as goodhardy) == mark as easyPiotr Wozniak's 20 rules of knowledge formulation is a great introduction on proper flashcard creation.
+The prompt and the answer are separated by :: (this can be configured in settings).
Creates two cards side1:::side2 & the reversed version side2:::side1.
The prompt and the answer are separated by ::: (this can be configured in settings).
Note: In the first review, the plugin will show non-reversed card and reversed card. +If Bury sibling cards until the next day? turn on, only non-reversed card will appear.
+The front and the back of the card are separated by ? (this can be configured in settings).
These can also span over multiple lines as long as both sides "touch" the ?:
As per the definition
+of "multiline" the prompt
+can be on multiple lines
+?
+same goes for
+the answer
+Creates two cards side1??side2 & the reversed version side2??side1.
The front and the back of the card are separated by ?? (this can be configured in settings).
These can also span over multiple lines as long as both sides "touch" the ??:
As per the definition
+of "multiline" the prompt
+can be on multiple lines
+??
+same goes for
+the answer
+Note: The behaviour is same as single line reversed.
+You can easily add cloze deletion cards using ==highlights==, **bolded text**, or {{text in curly braces}}.
These can be turned on or off in settings.
+Anki style {{c1:This text}} would {{c2:generate}} {{c1:2 cards}} cloze deletions are not currently supported. This feature is being tracked here.
The green and blue counts on the right of each deck name represent due and new cards respectively.
+#flashcards is the default).Note that #flashcards will match nested tags like #flashcards/subdeck/subdeck.
The plugin will automatically search for folders that contain flashcards & use their paths to create decks & sub-decks i.e. Folder/sub-folder/sub-sub-folder ⇔ Deck/sub-deck/sub-sub-deck.
This is an alternative to the tagging option and can be enabled in settings.
+Once done creating cards, click on the flashcards button on the left ribbon to start reviewing the flashcards. After a card is reviewed, a HTML comment is added containing the next review day, the interval, and the card's ease.
+ +Wrapping in a HTML comment makes the scheduling information not visible in the notes preview. For single-line cards, you can choose whether you want the HTML comment on the same line or on a separate line in the settings. Putting them on the same line prevents breaking of list structures in the preview or after auto-formatting.
+Note that you can skip a card by simply pressing S (case doesn't matter).
Tip
+If you're experiencing issues with the size of the modal on mobile devices, +go to settings and set the Flashcard Height Percentage and Flashcard Width Percentage +to 100% to maximize it.
+To review faster, use the following keyboard shortcuts:
+Space/Enter => Show answer0 => Reset card's progress (Sorta like Again in Anki)1 => Review as Hard2 or Space => Review as Good3 => Review as EasyIf the parent note has heading(s), the flashcard will have a title containing the context.
+Taking the following note:
+#flashcards
+
+# Trivia
+
+## Capitals
+
+### Africa
+
+Kenya::Nairobi
+
+### North America
+
+Canada::Ottawa
+The flashcard for Kenya::Nairobi will have Trivia > Capitals > Africa as the context/title whereas the flashcard for Canada::Ottawa will have Trivia > Capitals > North America as the context/title.
To delete a card, simply delete the scheduling information & the card text.
+You can wrap flashcards in HTML comments e.g. <!--Card text <!--SR:2021-08-20,13,290--> --> to prevent it from showing up in your review queues. You can always remove the wrapping comment later.
Currently, the only supported method is "cramming" all cards in a note using the Cram flashcards in this note command. Will work on a per-deck across-all-notes method.
+The statistics section can be accessed using the View Statistics command.
Stats on the number of cards due in the future.
+
Stats on delays until cards are shown again.
+Stats on card eases.
+Stats on card types: New, Young, Mature (Have intervals more than 1 month).
+ + + + + + +
Fight the forgetting curve & note aging by reviewing flashcards & notes using spaced repetition on Obsidian.md
+You can easily install the plugin from Obsidian's community plugin section in the Obsidian app (Search for Spaced Repetition).
Create an obsidian-spaced-repetition folder under .obsidian/plugins in your vault. Add the main.js, manifest.json, and the styles.css files from the latest release to the folder.
MIT License
+Copyright (c) 2021 - 2023 Stephen Mwangi
+Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.
+ + + + + + +Tag any notes that you'd like to review as #review. This default tag can be changed in the settings. (You can also use multiple tags)
All "new" notes are listed under New on the right pane (Review Queue). Like so:
Open the file & review it. Once done, choose either the Review: Easy, Review: Good, or the Review: Hard option on the file menu (the three dots). The Easy, Good, or Hard depend on how well you comprehend the material being reviewed.
Alternatively, you can right click on the file and access the same options:
+
The note will then be scheduled appropriately:
+
Commands to open a note for review, and making review responses are provided. You can create custom hotkeys for them in Settings -> HotKeys. This allows for much faster review.
Available settings are:
+Review: N due on the status bar at the bottom of the screen shows how many notes one has to review today (Today's notes + overdue notes). Clicking on that opens one of the notes for review.
Alternatively, one can use the Open a note for review command.
This was introduced here by @aviskase.
Here are the YouTube videos:
+Andy Matuschak uses spaced repetition system for working on writing inbox.
+In short, there are four possible actions (where x < y):
x) == mark as goodhardy) == mark as easyAll notable changes to this project will be documented in this file. Dates are displayed in UTC.
Generated by auto-changelog.
#784#78230 October 2023
#780#775b9c354d23 October 2023
#772#699#7639 October 2023
#756#751#71944e9bb61f69f961ef06635 May 2023
#679#678#671#667zh-cn.ts and zh-tw.ts #676#665#664#643#656#657#6376 February 2023
#622#621#620#619#618#616#611#593#592#591#515#589#587e33ec932bf13a9fef51b68 January 2023
#588#5862 January 2023
#576#5752 January 2023
#574#573#572#566#565#564#563#562#561#560#559#53212 December 2022
#546#545#54412 December 2022
#543#542#541#539#540#536#535#531#518#523#480#510d8c0e9ec6bb8f024 July 2022
#474#469#473#472#464#425#419#402#413#417#416#273c386dc3bce5c229d34c5621 February 2022
ve done the translation to Russian. [#403`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/403)#391#3641f0f46ce35c0128ac56ae2 January 2022
3b0446a223639607e1de41 January 2022
#358#355#356#357#353#350#352#351#316#315#345#344#341#340#323#318#326#299#300#302#297#298#291#290#292#28566766a83623efc0e1238829 August 2021
#281#280#277#276#271#275#268#265#264#263177bc7876b94d126d9dbd19 August 2021
#258#252#251#245#236#234#2321d4bcdcd9181f5069619c8 August 2021
#230#229#228#227#226#225c3e6c0d17d74963808ce04 August 2021
#223#222#220#219#217#215#214#210#18805d32179798c6982651b420 June 2021
#170#169#168#166#165856d4233f2d97ec906afe13 June 2021
b47915aad2f3ec12 June 2021
#155cdb57d4cee6503ab52d3611 June 2021
356fd31317f71610 June 2021
#150#1494d4f3d4c7eb5cfe4a897c7 June 2021
#143#142#141#140#137a65ca7f3ffe4f00541e776 June 2021
#132b309a276 June 2021
#131#130#128#126#127#125#124#123#11632141750af6c12492f9a831 May 2021
#107#106#105fe9b37f83ef96821 May 2021
#98390aa72f5d635c21 May 2021
#97#95#94#89#858b84184a4197c34098f1016 May 2021
0cde9602e46d7716 May 2021
#77#75#74#73#72#71#69#68d793c423b3ca00ead217d8 May 2021
#57b7cb3cd0a59d8faccbf0c8 May 2021
#55#54#51#50#47f633e720c1944e503ec0f2 May 2021
953147eaafd4ef335bb6f1 May 2021
#42c389a2f65fe74b3da32ac1 May 2021
#41#40#39#38#37ef29e14d12cb0e12344cc20 April 2021
a5ededecb779feb6c531719 April 2021
06cda883f52456d6686c719 April 2021
#23#22#21df30fb8efb8d78ad8b22c15 April 2021
#1851ea4ec78b83ad0ac4cb114 April 2021
3be20cee1bb32f3609e7214 April 2021
ee0eb3f5217c27372552713 April 2021
#11852479f327f5cd43fb6ce13 April 2021
#99364374c4632c165c4e4b12 April 2021
#6#5#3348bdffdf0188012f162211 April 2021
6c1977811 April 2021
f67301e3a4c5e0acb5d4a9 April 2021
6bf72b157ca3a95e68d8bMIT License
Copyright (c) 2021 - 2023 Stephen Mwangi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"},{"location":"","title":"Obsidian Spaced Repetition","text":"Fight the forgetting curve & note aging by reviewing flashcards & notes using spaced repetition on Obsidian.md
You can easily install the plugin from Obsidian's community plugin section in the Obsidian app (Search for Spaced Repetition).
Create an obsidian-spaced-repetition folder under .obsidian/plugins in your vault. Add the main.js, manifest.json, and the styles.css files from the latest release to the folder.
Warning
Note that this hasn't been updated in a while, please see the code.
(It's the same as that used for flashcards - apart from the PageRanks)
if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_easelink_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64)) (cater for uncertainty)20 and the interval changes to old_interval * new_ease / 100 * 1.3 (the 1.3 is the easy bonus)old_interval * old_ease / 10020 and the interval changes to old_interval * 0.50.5 can be modified in settingsminimum ease = 1308 or more days:interval += random_choice({-fuzz, 0, +fuzz})fuzz = ceil(0.05 * interval)First off, thanks for wanting to contribute to the Spaced Repetition plugin!
"},{"location":"contributing/#bug-reports-feature-requests","title":"Bug Reports & Feature Requests","text":"To help translate the plugin to your language:
src/lang/locale/en.ts to the proper file in src/lang/locale/ (i.e. fr.ts for French, or sw.ts for Swahili). The locale codes are IETF language tags.Sample en.ts file:
// English\nexport default {\nEASY: \"Easy\",\nSHOW_ANSWER: \"Show Answer\",\nDAYS_STR_IVL: \"${interval} days\",\nCHECK_ALGORITHM_WIKI:\n'For more information, check the <a href=\"${algo_url}\">algorithm implementation</a>.',\n};\nEquivalent sw.ts file:
// Swahili\nexport default {\nEASY: \"Rahisi\",\nSHOW_ANSWER: \"Onyesha Jibu\",\nDAYS_STR_IVL: \"Siku ${interval}\",\nCHECK_ALGORITHM_WIKI:\n'Kwa habari zaidi, angalia <a href=\"${algo_url}\">utekelezaji wa algorithm</a>.',\n};\nA part of that last one is uhh, Google translated, I have a working understanding of Swahili but not enough to write computerese lol.
Please note that:
${} isn't translated. This is used to replace variables in code. For instance, if interval = 4, it becomes 4 days in English & Siku 4 in Swahili. Quite nifty if you ask me.pnpm dev to test the changes inside Obsidian.You could create symbolic links between the build files and the Obsidian vault, example:
# remove existing files in the Obsidian vault\nrm ~/notes/.obsidian/plugins/obsidian-spaced-repetition/main.js ~/notes/.obsidian/plugins/obsidian-spaced-repetition/manifest.json ~/notes/.obsidian/plugins/obsidian-spaced-repetition/styles.css\n# use absolute paths\nln -s /home/stephen/obsidian-spaced-repetition/build/main.js /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition\nln -s /home/stephen/obsidian-spaced-repetition/manifest.json /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition\nln -s /home/stephen/obsidian-spaced-repetition/styles.css /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition\nDocument the \"user-facing\" changes e.g. new feature, UI change, etc.
tests/.pnpm test[Unreleased] section of the changelog (docs/changelog.md).Added for new features.Changed for changes in existing functionality.Deprecated for soon-to-be removed features.Removed for now removed features.Fixed for any bug fixes.Security in case of vulnerabilities.Make flashcard text selectable [@st3v3nmw](https://github.com/st3v3nmw)pnpm lintpnpm formatThe documentation consists of Markdown files which MkDocs converts to static web pages. Specifically, this project uses MkDocs Material.
These files reside in docs/ in the respective language's folder. For instance, English docs are located in docs/en/.
The docs are served on https://www.stephenmwangi.com/obsidian-spaced-repetition/.
For small changes, you can simply open an pull request for merging (against the master branch). The changes will be live once a new release is made.
For larger diffs, it's important that you check how your docs look like as explained below.
"},{"location":"contributing/#viewing-docs-locally","title":"Viewing Docs Locally","text":""},{"location":"contributing/#initial-setup","title":"Initial Setup","text":"python3 -m venv venv. venv/bin/activatepip install -r requirements.txt. venv/bin/activatemkdocs servedocs/ if it doesn't exist. Use the language codes provided here.mkdocs.yml - plugins.i18n.languages).en) folder into the new folder.Example using v1.9.2:
git switch -c release-v1.9.2manifest.json and package.json (following Semantic Versioning).MAJOR.MINOR.PATCH, increment the:MAJOR version when you make incompatible API changesMINOR version when you add functionality in a backwards compatible mannerPATCH version when you make backwards compatible bug fixesminAppVersion and versions.json to reflect this.pnpm changelog to update the CHANGELOG.Commit and push the changes:
git add .\ngit commit -m \"Bump version to v1.9.2\"\ngit push --set-upstream origin release-v1.9.2\nOpen and merge the PR into master.
master and pull the changes: git switch master && git pullgit tag 1.9.2git push --tags. You're all set! This GitHub action should pick it up, create a release, publish it, and update the live documentation.Check the Obsidian Tasks project which has excellent contribution guidelines.\u00a0\u21a9
Piotr Wozniak's 20 rules of knowledge formulation is a great introduction on proper flashcard creation.
"},{"location":"flashcards/#single-line-basic-remnote-style","title":"Single-line Basic (Remnote style)","text":"The prompt and the answer are separated by :: (this can be configured in settings).
the question goes on this side::answer goes here!\nCreates two cards side1:::side2 & the reversed version side2:::side1.
The prompt and the answer are separated by ::: (this can be configured in settings).
the question goes on this side:::answer goes here!\nNote: In the first review, the plugin will show non-reversed card and reversed card. If Bury sibling cards until the next day? turn on, only non-reversed card will appear.
"},{"location":"flashcards/#multi-line-basic","title":"Multi-line Basic","text":"The front and the back of the card are separated by ? (this can be configured in settings).
Front of multiline\n?\nBackside of multiline card\nThese can also span over multiple lines as long as both sides \"touch\" the ?:
As per the definition\nof \"multiline\" the prompt\ncan be on multiple lines\n?\nsame goes for\nthe answer\nCreates two cards side1??side2 & the reversed version side2??side1.
The front and the back of the card are separated by ?? (this can be configured in settings).
Front of multiline\n??\nBackside of multiline card\nThese can also span over multiple lines as long as both sides \"touch\" the ??:
As per the definition\nof \"multiline\" the prompt\ncan be on multiple lines\n??\nsame goes for\nthe answer\nNote: The behaviour is same as single line reversed.
"},{"location":"flashcards/#cloze-cards","title":"Cloze cards","text":"You can easily add cloze deletion cards using ==highlights==, **bolded text**, or {{text in curly braces}}.
These can be turned on or off in settings.
Anki style {{c1:This text}} would {{c2:generate}} {{c1:2 cards}} cloze deletions are not currently supported. This feature is being tracked here.
The green and blue counts on the right of each deck name represent due and new cards respectively.
"},{"location":"flashcards/#using-obsidian-tags","title":"Using Obsidian Tags","text":"#flashcards is the default).Note that #flashcards will match nested tags like #flashcards/subdeck/subdeck.
The plugin will automatically search for folders that contain flashcards & use their paths to create decks & sub-decks i.e. Folder/sub-folder/sub-sub-folder \u21d4 Deck/sub-deck/sub-sub-deck.
This is an alternative to the tagging option and can be enabled in settings.
"},{"location":"flashcards/#reviewing","title":"Reviewing","text":"Once done creating cards, click on the flashcards button on the left ribbon to start reviewing the flashcards. After a card is reviewed, a HTML comment is added containing the next review day, the interval, and the card's ease.
<!--SR:!2021-08-20,13,290-->\nWrapping in a HTML comment makes the scheduling information not visible in the notes preview. For single-line cards, you can choose whether you want the HTML comment on the same line or on a separate line in the settings. Putting them on the same line prevents breaking of list structures in the preview or after auto-formatting.
Note that you can skip a card by simply pressing S (case doesn't matter).
Tip
If you're experiencing issues with the size of the modal on mobile devices, go to settings and set the Flashcard Height Percentage and Flashcard Width Percentage to 100% to maximize it.
"},{"location":"flashcards/#faster-review","title":"Faster Review","text":"To review faster, use the following keyboard shortcuts:
Space/Enter => Show answer0 => Reset card's progress (Sorta like Again in Anki)1 => Review as Hard2 or Space => Review as Good3 => Review as EasyIf the parent note has heading(s), the flashcard will have a title containing the context.
Taking the following note:
#flashcards\n# Trivia\n## Capitals\n### Africa\nKenya::Nairobi\n\n### North America\nCanada::Ottawa\nThe flashcard for Kenya::Nairobi will have Trivia > Capitals > Africa as the context/title whereas the flashcard for Canada::Ottawa will have Trivia > Capitals > North America as the context/title.
To delete a card, simply delete the scheduling information & the card text.
"},{"location":"flashcards/#ignoring-cards","title":"Ignoring cards","text":"You can wrap flashcards in HTML comments e.g. <!--Card text <!--SR:2021-08-20,13,290--> --> to prevent it from showing up in your review queues. You can always remove the wrapping comment later.
Currently, the only supported method is \"cramming\" all cards in a note using the Cram flashcards in this note command. Will work on a per-deck across-all-notes method.
"},{"location":"flashcards/#statistics","title":"Statistics","text":"The statistics section can be accessed using the View Statistics command.
Stats on the number of cards due in the future.
"},{"location":"flashcards/#intervals","title":"Intervals","text":"Stats on delays until cards are shown again.
"},{"location":"flashcards/#eases","title":"Eases","text":"Stats on card eases.
"},{"location":"flashcards/#card-types","title":"Card Types","text":"Stats on card types: New, Young, Mature (Have intervals more than 1 month).
"},{"location":"notes/","title":"Notes","text":"Tag any notes that you'd like to review as #review. This default tag can be changed in the settings. (You can also use multiple tags)
All \"new\" notes are listed under New on the right pane (Review Queue). Like so:
Open the file & review it. Once done, choose either the Review: Easy, Review: Good, or the Review: Hard option on the file menu (the three dots). The Easy, Good, or Hard depend on how well you comprehend the material being reviewed.
Alternatively, you can right click on the file and access the same options:
The note will then be scheduled appropriately:
"},{"location":"notes/#faster-review","title":"Faster Review","text":"Commands to open a note for review, and making review responses are provided. You can create custom hotkeys for them in Settings -> HotKeys. This allows for much faster review.
Available settings are:
Review: N due on the status bar at the bottom of the screen shows how many notes one has to review today (Today's notes + overdue notes). Clicking on that opens one of the notes for review.
Alternatively, one can use the Open a note for review command.
This was introduced here by @aviskase.
Here are the YouTube videos:
Andy Matuschak uses spaced repetition system for working on writing inbox.
In short, there are four possible actions (where x < y):
x) == mark as goodhardy) == mark as easy