Skip to content

Commit

Permalink
Bump version to v1.12.6 (#1071)
Browse files Browse the repository at this point in the history
  • Loading branch information
st3v3nmw authored Sep 15, 2024
1 parent db385fb commit 8711c27
Show file tree
Hide file tree
Showing 16 changed files with 406 additions and 405 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
759 changes: 386 additions & 373 deletions docs/docs/changelog.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/docs/en/algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ This is the simplest "algorithm" possible. There are fixed intervals configured
For example, `hard` might be configured for an interval of 1 day.

Implementation of this technique has not yet occurred. For progress see:
[ [FEAT] user defined "Easy, Good, Hard" values instead of or in addition to the algorithm defined one. #741 ](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/741)
[ [FEAT] user defined "Easy, Good, Hard" values instead of or in addition to the algorithm defined one. #741 ](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/741)
4 changes: 2 additions & 2 deletions docs/docs/en/data-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When the card is reviewed, an HTML comment will be added after the card's text,
```

By default, the comment is stored on the line following the card text.
Alternatively, it can be stored on the same line by enabling the
Alternatively, it can be stored on the same line by enabling the
[Save scheduling comment on the same line as the flashcard's last line?](user-options.md#storage-of-scheduling-data) option.

Scheduling information for the note is kept at the beginning of the file, in YAML format within the frontmatter section.
Expand Down Expand Up @@ -60,4 +60,4 @@ This information is also kept in the `data.json` file.

!!! note

To minimise the space required for this, a copy of the card is not stored. Rather a small numeric hash code ("fingerprint") is kept.
To minimise the space required for this, a copy of the card is not stored. Rather a small numeric hash code ("fingerprint") is kept.
9 changes: 4 additions & 5 deletions docs/docs/en/flashcards/basic-cloze-cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The first female prime minister of Australia was ==Julia Gillard==

</div>



### Multiple Cloze Deletions
If the card text identifies multiple parts as cloze deletions, then multiple cards will be shown for review, each one occluding one deletion, while leaving the other deletions visible.
Expand All @@ -56,15 +56,15 @@ The first female ==prime minister== of Australia was ==Julia Gillard==

The first female prime minister of Australia was Julia Gillard

These two cards are considered sibling cards. See [sibling cards](flashcards-overview.md#sibling-cards) regarding the
These two cards are considered sibling cards. See [sibling cards](flashcards-overview.md#sibling-cards) regarding the
[Bury sibling cards until the next day](../user-options.md#flashcard-review) scheduling option.

## Cloze Delimiter

The cloze delimiter can be modified in [settings](../user-options.md#flashcard-review), e.g. to `**`, or curly braces `{{text in curly braces}}`.


<!--
<!--
## Cloze Hints
Hints can be included for any of the cloze deletions, using the `^[text of hint]` syntax. For example:
Expand All @@ -88,7 +88,7 @@ In the above examples, each card shown for review has one cloze deletion shown a
For example:
```
This is ==in group 1==[^1], this ==in group 2==[^2]
This is ==in group 1==[^1], this ==in group 2==[^2]
and this also ==in group 1==[^1]
```
Expand All @@ -107,4 +107,3 @@ and this also ==in group 1==[^1]

!!! warning
Anki style `{{c1:This text}} would {{c2:generate}} {{c1:2 cards}}` cloze deletions are not currently supported. This feature is being tracked [here](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/93/).

3 changes: 1 addition & 2 deletions docs/docs/en/flashcards/cards-with-blank-lines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Including Blank Lines in Flashcards

By default, [Multi-line Basic](qanda-cards.md#multi-line-basic), [Multi-line Bidirectional](qanda-cards.md#multi-line-bidirectional)
By default, [Multi-line Basic](qanda-cards.md#multi-line-basic), [Multi-line Bidirectional](qanda-cards.md#multi-line-bidirectional)
and [Cloze](basic-cloze-cards.md) type flashcards recognize a blank line as the end of the flashcard text.
This means that blank lines can not be included within the text.

Expand Down Expand Up @@ -57,4 +57,3 @@ And after `Show Answer` is clicked, the following is displayed:
### Blank Lines in Answer Side Only

Blank lines are only supported in the answer side of a multiline flashcard, and not in the question side.

1 change: 0 additions & 1 deletion docs/docs/en/flashcards/decks.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,3 @@ The plugin will automatically search for folders that contain flashcards & use t
e.g. `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](../user-options.md#tags--folders).

5 changes: 2 additions & 3 deletions docs/docs/en/flashcards/reviewing.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Although you may want to review or cram all cards across all decks, you often ma
2 | Reset | Reset the review schedule information - the review interval is set to 1 day, and the ease is set to the default value
3 | Info | Shows the scheduling information for the card
4 | Skip | Skip the current card without reviewing

### Context

If the parent note has heading(s), the flashcard will have a title containing the context.
Expand Down Expand Up @@ -106,11 +106,10 @@ Note that you can skip a card by simply pressing `S` (case doesn't matter).

## Cramming

You are shown every single card, even those that have recently been reviewed.
You are shown every single card, even those that have recently been reviewed.
By using the appropriate [command](../plugin-commands.md) have the choice of cramming cards:

Cards | Command
- | -
Within a single note | `Spaced Repetition: Cram flashcards in this note`
Within a deck (including all subdecks) | `Spaced Repetition: Select a deck to cram note`

14 changes: 5 additions & 9 deletions docs/docs/en/notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
## Getting started


Tag any markdown files for review with the `note review` tag, which by default is `#review`.
Tag any markdown files for review with the `note review` tag, which by default is `#review`.

The note will appear under `New` in the `Note Review Queue` in the right pane.

!!! note
When you tag a note with `#review` the note doesn't immediately appear in the review queue.
You will need to first click on the `Flashcard Review Icon` or the `Spaced Repetition Status Area`
for the queue to update

## Note Review Queue

![note-review-queue](https://github.com/user-attachments/assets/c0e1d09c-610f-4775-b532-ab78369b117a)
Expand All @@ -32,7 +32,7 @@ The note will appear under `New` in the `Note Review Queue` in the right pane.
By default, the Note Review Queue is displayed when the plugin starts. This can be changed with
the `Enable note review pane on startup` [setting](user-options.md#note-settings).

The Note Review Queue can also be shown by using the `Open Notes Review Queue in sidebar`
The Note Review Queue can also be shown by using the `Open Notes Review Queue in sidebar`
[command](plugin-commands.md).

## Reviewing
Expand All @@ -54,7 +54,7 @@ The note will then be scheduled appropriately by the [learning algorithm](algori
The `Easy`, `Good`, and `Hard` review result can also be selected from the plugin's [command list](plugin-commands.md).

This is less practical than the methods described above, but does enable the definition of keyboard shortcuts.
You can create custom hotkeys for the review result in `Settings -> HotKeys`.
You can create custom hotkeys for the review result in `Settings -> HotKeys`.

### Selecting a Note for Review

Expand All @@ -78,10 +78,6 @@ This default tag can be changed in the [settings](user-options.md#note-settings)

## Spaced Repetition Status Area

`Review: N note(s)` on the status bar at the bottom of the screen shows how many notes one has to review today (Today's notes + overdue notes).
`Review: N note(s)` 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.




1 change: 0 additions & 1 deletion docs/docs/en/plugin-commands.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Plugin Commands

![plugin-commands](https://github.com/user-attachments/assets/4838812c-121b-4bd1-82b3-46138b2ae67f)

1 change: 0 additions & 1 deletion docs/docs/en/user-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@
## UI Preferences

![settings-ui-preferences](https://github.com/user-attachments/assets/c0740fa0-02b5-4db9-9d81-94f0ae29ab6c)

3 changes: 1 addition & 2 deletions docs/docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@
hr {
border: none !important;
height: 4px;
background-color: #333;
background-color: #333;
}

.thin {
border: none !important;
height: 1px;
}

2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-spaced-repetition",
"name": "Spaced Repetition",
"version": "1.12.5",
"version": "1.12.6",
"minAppVersion": "0.15.4",
"description": "Fight the forgetting curve by reviewing flashcards & entire notes.",
"author": "Stephen Mwangi",
Expand Down
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ repo_name: st3v3nmw/obsidian-spaced-repetition
repo_url: https://github.com/st3v3nmw/obsidian-spaced-repetition/
edit_uri: ""
docs_dir: docs/docs
# use_directory_urls: false

theme:
name: material
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-spaced-repetition",
"version": "1.12.5",
"version": "1.12.6",
"description": "Fight the forgetting curve by reviewing flashcards & entire notes.",
"main": "main.js",
"scripts": {
Expand Down

0 comments on commit 8711c27

Please sign in to comment.