Fieldref
This page is dedicated showing how to edit the note fields to change the card to your liking.
Note
If you want to edit the user interface for all cards, see the UI Customization page.
Definitions¶
Binary Field:
A field that checks whether it is filled or not with any value, say 1.
The default is implied by the name of the field, and a value of "true" means that the field is filled.
For example, the IsSentenceCard field will turn the card into a sentence card if filled.
If it is not filled, then the card will be a word card.
To fill a field automatically, see
here.
PA: Short for "Pitch Accent".
Quick Jump¶
The table below provides quick links to most of the fields found with the card, as well as some general info on each field. Fields without links are assumed to be either obvious (and do not require documentation), or not meant to be edited.
Click here to reveal the field list
Note
Auto-filled represents fields that should be automatically filled out from Yomitan
and Anki add-ons.
| Field | Auto-Filled | Binary Field | Notes |
|---|---|---|---|
| Key | |||
| Word | |||
| WordReading | |||
| PAOverride | |||
| PAOverrideText | |||
| AJTWordPitch | |||
| PrimaryDefinition | |||
| PrimaryDefinitionPicture | |||
| Sentence | |||
| SentenceReading | |||
| AltDisplayWord | |||
| AltDisplaySentence | Originally AltDisplay before 0.12.0.0 |
||
| AltDisplayPASentenceCard | |||
| AltDisplayAudioCard | |||
| AdditionalNotes | |||
| Hint | |||
| HintNotHidden | |||
| IsSentenceCard | |||
| IsTargetedSentenceCard | |||
| IsClickCard | |||
| IsHoverCard | |||
| IsHintCard | |||
| IsSentenceFirstCard | |||
| IsAudioCard | |||
| PAShowInfo | |||
| PATestOnlyWord | |||
| PADoNotTest | |||
| PASeparateWordCard | |||
| PASeparateSentenceCard | |||
| SeparateAudioCard | Originally SeparateClozeDeletionCard before 0.12.0.0 |
||
| SeparateSentenceAudioCard | Currently doesn't do anything | ||
| Picture | |||
| WordAudio | |||
| SentenceAudio | |||
| PAGraphs | |||
| PAPositions | |||
| FrequenciesStylized | |||
| FrequencySort | |||
| PASilence | |||
| WordReadingHiragana | |||
| YomichanWordTags | |||
| SecondaryDefinition | |||
| ExtraDefinitions | |||
| UtilityDictionaries | |||
| CardCache | |||
| Comment |
Modifying the Front Side (Tested Content)¶
The front side is exactly the content that we want to test ourselves on. Naturally, since we can test ourselves on many aspects of the word, there are many ways to change this tested content.
Card types¶
Main Page: Card Types
The default card type is a vocab card, where the tested content is simply the word.
To change the card to a sentence card, fill the IsSentenceCard binary field.
AltDisplay: Changing the Displayed Content¶
Vocab cards show the Word field and sentence cards show the Sentence fields by default.
However, you can modify what is exactly shown in the front by using the AltDisplay field.
AltDisplay field.
AltDisplay: Furigana¶
One nice feature is that the AltDisplay has hoverable furigana text enabled by default.
In other words, you can use furigana in the field.
I personally use this to insert furigana for certain names, since I'm usually not
testing myself on how to read a name.
For example, the card below has the following HTML:
AltDisplay: Final Notes¶
-
The example with adding a newline to
AltDisplayis somewhat contrived. More realistically, you would want to add the newline to theSentencefield.If you are using AJT Furigana, I recommend deleting the text within the
SentenceReadingfield before editing theSentencefield, so the furigana can be automatically generated with the newly formattedSentencefield. -
If you are using a vocab card, you can use
AltDisplayto show something that differs from theWordfield. -
On Hybrid Card types, the
AltDisplayfield only affects the sentence, and not the front displayed word.
Modifying the Back Side¶
The main two fields that one can add text to is
PrimaryDefinition and AdditionalNotes.
Bolding anything in these sections will highlight the word in a light yellow (or blue in light mode) tint,
to make the bolded text stand out more.
PrimaryDefinition field¶
The PrimaryDefinition field contains the main content, and should be the main field to edit
if one wants to put down more notes about the card.
AdditionalNotes field¶
The AdditionalNotes field is useful if you want to write down even more notes,
but keep it in a collapsible field to reduce vertical space.
Here are some suggestions on how you can use this field:
- Recording the source where the scene came from
- Adding custom notes on the scene's context
- Recording the sentences surrounding the mined sentence
In general, this field should be used for any info that is not crucial to understanding the tested content.
Modifying Images & Pitch Accent¶
As there are plenty of ways to modify images and pitch accent, they are discussed in their respective pages:
- Images (
PictureandPrimaryDefinitionPicture) - Pitch Accent (
PAOverrideandPAOverrideText)
Modifying Pitch Accent Sentence Cards¶
The field AltDisplayPASentenceCard exists to customize the display of the
PA sentence card, if it exists.
It works similarly to AltDisplay, and takes priority over AltDisplay
in the PA sentence card.
Other Fields¶
Key field¶
This contains the tested word. In other words, this contains the exact same content as the field below, but this field is specifically not used in the card template. This is to allow the user to modify the key if duplicates arise, while still being able to test the word.
For example, if I were to test different usages of 上,
I can change this key value to 上 (preposition), 上 (grammar),
etc. and add a new card.
It is expected that this Key field is unique;
a warning will appear on cards that have a duplicate key.
Comment field¶
Similarly to the Key field, this field will not be used in any card template.
In other words, this is a place where you can write down notes without affecting the card itself.
FrequencySort field¶
By default, this note type comes with a FrequencySort field,
which is the equivalent of Marv's Frequency field in
this guide.
Visit the aformentioned link (and scroll down to Usage)
to see how to sort and review your cards by frequency.
Note
I personally use this field by re-ordering only some of the most common words in my deck, and then separating it with a step of 1. This ensures that every card in the deck will eventually be reached.