Skip to content

Commit

Permalink
Update Docs (#66)
Browse files Browse the repository at this point in the history
* Update anki docs

* Update dictionaries docs

* Update supported languages
  • Loading branch information
MarvNC authored Oct 21, 2024
1 parent 7089f87 commit 249e944
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/anki.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ Flashcard fields can be configured with the following steps:
| `{cloze-prefix}` | Fragment of the containing `{sentence}` starting at the beginning of `{sentence}` until the beginning of `{cloze-body}`. |
| `{cloze-suffix}` | Fragment of the containing `{sentence}` starting at the end of `{cloze-body}` until the end of `{sentence}`. |
| `{conjugation}` | Conjugation path from the raw inflected term to the source term. |
| `{dictionary}` | Name of the dictionary from which the card is being created (unavailable in _grouped_ mode). |
| `{dictionary}` | Original name of the dictionary from which the card is being created (unavailable in _grouped_ mode). |
| `{dictionary-alias}` | Display name of the dictionary from which the card is being created (unavailable in _grouped_ mode). |
| `{document-title}` | Title of the web page that the term appeared in. |
| `{expression}` | Term expressed as kanji (will be displayed in kana if kanji is not available). |
| `{frequencies}` | Frequency information for the term. |
Expand Down Expand Up @@ -86,7 +87,8 @@ Flashcard fields can be configured with the following steps:
| `{cloze-body}` | Raw, inflected parent term as it appeared before being reduced to dictionary form by Yomitan. |
| `{cloze-prefix}` | Fragment of the containing `{sentence}` starting at the beginning of `{sentence}` until the beginning of `{cloze-body}`. |
| `{cloze-suffix}` | Fragment of the containing `{sentence}` starting at the end of `{cloze-body}` until the end of `{sentence}`. |
| `{dictionary}` | Name of the dictionary from which the card is being created. |
| `{dictionary}` | Original name of the dictionary from which the card is being created. |
| `{dictionary-alias}` | Display name of the dictionary from which the card is being created. |
| `{document-title}` | Title of the web page that the kanji appeared in. |
| `{frequencies}` | Frequency information for the kanji. |
| `{frequency-harmonic-rank}` | The harmonic mean of frequency data for the current kanji. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based kanji usage. |
Expand Down
2 changes: 1 addition & 1 deletion docs/dictionaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Be aware that non-English dictionaries generally contain fewer entries than thei
- [JMnedict](https://github.com/yomidevs/jmdict-yomitan#jmnedict-for-yomitan) - Lists readings of person/place/organization names and other proper nouns.
- [KANJIDIC](https://github.com/yomidevs/jmdict-yomitan#kanjidic-for-yomitan) - An English dictionary listing readings, meanings, and other info about kanji characters.
- [BCCWJ Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#bccwj-suw-luw-combined) - A frequency dictionary based on the Balanced Corpus of Contemporary Written Japanese.
- [JPDB Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#jpdb-v21-frequency) - A frequency dictionary based on the corpus from the online Japanese dictionary and SRS system at [jpdb.io](https://jpdb.io).
- [JPDB Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#jpdb-v22-frequency) - A frequency dictionary based on the corpus from the online Japanese dictionary and SRS system at https://jpdb.io.

??? note "EPWING Dictionaries"

Expand Down
1 change: 1 addition & 0 deletions docs/supported-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ These are the languages currently supported by Yomitan:
| Arabic | ar |
| Cantonese | yue |
| Chinese | zh |
| Danish | da |
| Dutch | nl |
| English | en |
| Finnish | fi |
Expand Down

0 comments on commit 249e944

Please sign in to comment.