Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for new frequency handlebars #621

Merged
merged 4 commits into from
Feb 4, 2024
+42 −0
Merged

Add documentation for new frequency handlebars #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e6c441
Add documentation for new frequency handlebars
Kuuuube Feb 3, 2024
a3aabd6
Roughly mark default meanings
Kuuuube Feb 3, 2024
9c58e8b
Reword explanations
Kuuuube Feb 3, 2024
cb40faa
Reword explanation in other docs
Kuuuube Feb 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/anki-integration.md
View file
Open in desktop
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
Open in desktop
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
Loading