Skip to content

Commit

Permalink
Add documentation for new frequency handlebars (#621)
Browse files Browse the repository at this point in the history 
* Add documentation for new frequency handlebars

* Roughly mark default meanings

* Reword explanations

* Reword explanation in other docs
  • Loading branch information
@Kuuuube
Kuuuube authored Feb 4, 2024
1 parent f7da8a9 commit ea53ab5
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/anki-integration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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). |
Expand Down Expand Up @@ -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. |
Expand Down
34 changes: 34 additions & 0 deletions ext/settings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3394,6 +3394,40 @@ <h1>Yomitan Settings</h1>
<td><code class="anki-field-marker">{document-title}</code></td>
<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>
Expand Down

0 comments on commit ea53ab5

Please sign in to comment.