Add documentation for new frequency handlebars (#621)

* Add documentation for new frequency handlebars

* Roughly mark default meanings

* Reword explanations

* Reword explanation in other docs

2 files changed, 42 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.                                                            |
diff --git a/ext/settings.html b/ext/settings.html
index f59041db..e1561409 100644
--- a/ext/settings.html
+++ b/ext/settings.html
@@ -3395,6 +3395,40 @@
                     <td>Title of the web page that the term or kanji appeared in.</td>
                 </tr>
                 <tr>
+                    <td><code class="anki-field-marker">{frequencies}</code></td>
+                    <td>
+                        Frequency information for the term or kanji.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code class="anki-field-marker">{frequency-harmonic-rank}</code></td>
+                    <td>
+                        The harmonic mean of frequency data for the current term or kanji.<br>
+                        Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based term or kanji usage.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code class="anki-field-marker">{frequency-harmonic-occurrence}</code></td>
+                    <td>
+                        The harmonic mean of frequency data for the current term or kanji.<br>
+                        Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term or kanji usage.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code class="anki-field-marker">{frequency-average-rank}</code></td>
+                    <td>
+                        The average of frequency data for the current term or kanji.<br>
+                        Defaults to rank 9999999 when frequency data is not found, indicating extremely low rank-based term or kanji usage.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code class="anki-field-marker">{frequency-average-occurrence}</code></td>
+                    <td>
+                        The average of frequency data for the current term or kanji.<br>
+                        Defaults to 0 occurrences when frequency data is not found, the lowest possible occurrence-based term or kanji usage.
+                    </td>
+                </tr>
+                <tr>
                     <td><code class="anki-field-marker">{screenshot}</code></td>
                     <td>Screenshot of the web page taken at the time the term or kanji was added.</td>
                 </tr>