Installation: Deck Setup

This guide takes you through setting up a deck for use with the Pinyin Toolkit. There are three key ingredients to the setup:

1. You should have a model with the “Mandarin” tag
2. Your facts need fields with names we can guess if you want those fields to be filled out for you by the Toolkit
3. You need cards with templates that use the new fields if you’re going to get any benefit from them. For example, if you want the audio to play when you turn over a card, you need to modify the template for the answer part of the card to include the special string “%(Audio)s” (without quotes), which will be substituted for the contents of the Audio field

The currently known field names are something like this:

Field	Feature	Recognised Names
Expression	Everything!	“Expression”, “Hanzi”, “Chinese”, “汉字”, “中文”
Reading	Reading (pinyin) generation	“Reading”, “Pinyin”, “PY”, “拼音”
Meaning	Dictionary meaning lookup	“Definition”, “English”, “German”, “French”, “意思”, “翻译”, “英语”, “法语”, “德语”
Audio	Audio tag generation	“Audio”, “Sound”, “Spoken”, “声音”
Colored Characters	Colorized character generation	“Color”, “Colour”, “Colored Hanzi”, “彩色”
Measure Word	Measure word generation	“MW”, “Measure Word”, “Measure Words”, “Classifier”, “Classifiers”, “量词”
Measure Word Audio	Measure word audio example generation	“MW Audio”, “量词 Sound”, etc
Simplified	Simplified character generation	“Simplified”, “Simp”, “Simplified Chinese”, “简体字”, “简体”
Traditional	Traditional character generation	“Traditional”, “Trad”, “Traditional Chinese”, “HK”, ‘繁体字’, ‘繁体’, “繁體字”, “繁體”

Extras

You can download the Kanji stroke order font to get limited stroke-order support.