summaryrefslogtreecommitdiff
path: root/docs/anki-integration.md
diff options
context:
space:
mode:
authorKuuuube <61125188+Kuuuube@users.noreply.github.com>2024-02-03 23:10:43 -0500
committerGitHub <noreply@github.com>2024-02-04 04:10:43 +0000
commitea53ab5c59b33a30ab3cfb92c3a8a7624ab7f3ae (patch)
tree8f224729cd49df7f1a5423779d94c33557b82d17 /docs/anki-integration.md
parentf7da8a97d87e7e4536a3de8994c8b621bbbc4a29 (diff)
Add documentation for new frequency handlebars (#621)
* Add documentation for new frequency handlebars * Roughly mark default meanings * Reword explanations * Reword explanation in other docs
Diffstat (limited to 'docs/anki-integration.md')
-rw-r--r--docs/anki-integration.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/anki-integration.md b/docs/anki-integration.md
index 151137d4..411e2109 100644
--- a/docs/anki-integration.md
+++ b/docs/anki-integration.md
@@ -36,6 +36,10 @@ Flashcard fields can be configured with the following steps:
| `{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. |
+ | `{frequency-harmonic-rank}` | The harmonic mean of frequency data for the current term. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based term usage. |
+ | `{frequency-harmonic-occurrence}` | The harmonic mean of frequency data for the current term. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term usage. |
+ | `{frequency-average-rank}` | The average of frequency data for the current term. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based term usage. |
+ | `{frequency-average-occurrence}` | The average of frequency data for the current term. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term usage. |
| `{furigana}` | Term expressed as kanji with furigana displayed above it (e.g. <ruby>日本語<rt>にほんご</rt></ruby>). |
| `{furigana-plain}` | Term expressed as kanji with furigana displayed next to it in brackets (e.g. 日本語[にほんご]). |
| `{glossary}` | List of definitions for the term (output format depends on whether running in _grouped_ mode). |
@@ -67,6 +71,10 @@ Flashcard fields can be configured with the following steps:
| `{dictionary}` | 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. |
+ | `{frequency-harmonic-occurrence}` | The harmonic mean of frequency data for the current kanji. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based kanji usage. |
+ | `{frequency-average-rank}` | The average of frequency data for the current kanji. Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based kanji usage. |
+ | `{frequency-average-occurrence}` | The average of frequency data for the current kanji. Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based kanji usage. |
| `{glossary}` | List of definitions for the kanji. |
| `{kunyomi}` | Kunyomi (Japanese reading) for the kanji expressed as katakana. |
| `{onyomi}` | Onyomi (Chinese reading) for the kanji expressed as hiragana. |