Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Newdea committed Feb 14, 2024
1 parent d0dd77f commit 9504ee0
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ This is a modified version of [obsidian-spaced-repetition](https://github.com/st
- show floatbar for reviewing response when reviewing note by click statusbar or review command or sidebar, and can set whether showing the interval or not;
- Reviewing a Notes directly [#635];
- when using fsrs, output `ob-revlog.csv`, to optimize the algorithm parameters using [optimizer](https://github.com/open-spaced-repetition/fsrs-optimizer) for better review;
- Statistics: add note view statistics,and today review statistics.
- Statistics: add note view statistics,and today review statistics;
- Postpone notes/cards;
- postpone to review after x days;
- reschedule all scheduled items;

## Maintainers Wanted

Expand Down
5 changes: 4 additions & 1 deletion docs/README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
5. 算法可以切换:默认的 Anki 优化算法、Anki 算法、[Fsrs 算法](https://github.com/open-spaced-repetition/fsrs.js)
6. 使用 Fsrs 算法时,可根据标签输出重复日志文件 `ob_revlog.csv`,以使用[optimizer](https://github.com/open-spaced-repetition/fsrs-optimizer) 优化算法参数,达到更好的复习效果;
7. 数据表中新增笔记复习情况、当天复习情况;
8. 其他待发现的小改动;
8. 延后笔记/卡片;
9. 修改笔记/卡片在x天后复习;
10. 重排所有已排程的复习项;
11. 其他待发现的小改动;

**注意**
没有使用过 obsidian-spaced-repetition 插件的可以直接用,正在使用 obsidian-spaced-repetition 插件的话,建议试用前先备份 :yum:
Expand Down
13 changes: 13 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,19 @@ Centralized (CRAM) review/normal review of cards within the current/all notes (i

Centralized Review (CRAM) mode, no review data is updated.

#### Postpone
Postpone notes/cards (with current retention greater than 65%) from before today(excluded)

*If you are not satisfied with the new schedule, simply restart Obsidian to restore the previous schedule. The new schedule is not saved until after reviewing a note/card.*

#### Postpone after x days
Review the specified notes/cards after x days without judging their current review time and retention rate.
*It is recommended that you only modify individual notes or cards within notes, not a large number of them, to avoid reviewing too much content on that day.*

#### Reschedule
Recalculates the next review time for all **already scheduled** notes/cards based on the parameters in the settings and before the notes/cards.
*If you are not satisfied with the new schedule, simply restart Obsidian to restore the previous schedule. The new schedule is not saved until after reviewing a note/card.*

#### View data statistics

Via command line, `SR view statistics`
Expand Down
14 changes: 14 additions & 0 deletions docs/使用教程.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,20 @@

集中复习(CRAM)模式,不更新复习数据。

#### 延后Postpone
对今天之前(不包含今天)的笔记/卡片(当前保留率大于65%)进行延后
*明日复明日,明日何其多*
*如果对新排程不满意,直接重启Obsidian即可恢复之前的排程。在复习个笔记/卡片后新排程才会保存*

#### 改到x天后复习
对指定的笔记/卡片修改到x天后进行复习,不判断其当前复习时间及保留率。
*建议只是修改个别的笔记或笔记内卡片,不要做大批量修改,避免那天复习内容过多*

#### 重排Reschedule
根据设置中及笔记/卡片前的参数,重新计算所有**已经有排程**的笔记/卡片 的下次复习时间。
*这个基本用不到*
*如果对新排程不满意,直接重启Obsidian即可恢复之前的排程。在复习个笔记/卡片后新排程才会保存*

#### 查看数据统计

通过命令行,`SR 查看数据`
Expand Down

0 comments on commit 9504ee0

Please sign in to comment.