edit_behavior.py customization for Chinese study

edit_behavior.py

# -*- coding: utf-8 -*-
# Welcome to the Chinese Support Add-on's field edition ruleset.
# Here, you can tweak the note editor helper's behavior to your liking.
#
# If you messed things up, you can safely delete file 
# addons/chinese/edit_behavior.py from your Anki directory.
# It will be recreated the next time you restart Anki.
#
# You can read about all available functions at:
# https://github.com/ttempe/chinese-support-addon/wiki/Edit-behavior
# Also, see the Python tutorial at http://docs.python.org/2/tutorial

from edit_functions import *
from collections import OrderedDict

anki1_model_names    = ["Chinese", "chinese", "Mandarin Vocab"] #"Mandarin" is used by the Pinyin Toolkit port by Chris Hatch
Hanzi_fields         = ["Expression", "Hanzi", "Chinese",  u"汉字", u"中文"]
Color_fields         = ["Color", "Colour", "Colored Hanzi", u"彩色"]
Transcription_fields = ["Reading", "Pinyin", "PY", u"拼音"]
Meaning_fields       = ["Meaning", "Definition", "English", "German", \
"French", u"意思", u"翻译", u"英语", u"法语", u"德语", u"法文", u"英文", u"德文"]
Sound_fields         = ["Audio", "Sound", "Spoken", u"声音"]
Simplified_fields    = ["Simplified", "Simp", "简体"]
Traditional_fields   = ["Traditional", "Trad", "繁体"]
Mean_Word_fields     = ["Mean Word", "MW", "Mean", "Classifier", "量词"]
Alternate_fields     = ["Also writted", "Alt", "Alternate"]
Ruby_fields          = ["Ruby"]
Silhouette_fields    = ["Silhouette"]
Example_fields       = ["Example"]
BR                   = u"<br />"

def twinge(method, field):
    return BR.join(map(method, field.split(BR)))

def update_fields(field, updated_field, model_name, model_type):
    if model_name == 'Chinese (rich)':
        dirty_fields = set([updated_field])

        if dirty_fields.intersection(Hanzi_fields):
            h = get_any(Hanzi_fields, field)

            s = twinge(sound, h)
            set_all(Sound_fields, field, to = s)
            dirty_fields.update(Sound_fields)

            if h:
                if get_any(Meaning_fields, field) == '':
                    m = twinge(translate, h)
                    set_all(Meaning_fields, field, to = m)
                    dirty_fields.update(Meaning_fields)

                if get_any(Transcription_fields, field) == '':
                    t = twinge(transcribe, h)
                    set_all(Transcription_fields, field, to = t)
                    dirty_fields.update(Transcription_fields)
            else:
                set_all(Meaning_fields, field, to = '')
                dirty_fields.update(Meaning_fields)

                set_all(Transcription_fields, field, to = '')
                dirty_fields.update(Transcription_fields)

        if dirty_fields.intersection(Transcription_fields):
            t = get_any(Transcription_fields, field)

            t = twinge(accentuate_pinyin, t)
            t = twinge(lambda x: hide(x, no_tone(x)), t) # Makes searching easier.
            set_all(Transcription_fields, field, to = t)

        if dirty_fields.intersection(Transcription_fields) or \
                dirty_fields.intersection(Example_fields):
            h = get_any(Hanzi_fields, field)
            t = get_any(Transcription_fields, field)

            zht = zip(h.split(BR), t.split(BR))
            cht = OrderedDict(
                (h, colorize_fuse(h, t, ruby = True))
                for h, t in zht
            )

            r = BR.join(cht.values())
            e = get_any(Example_fields, field)
            if e and h:
                r = reduce(lambda e, (h, ch): e.replace(h, ch), cht.items(), e)

            set_all(Ruby_fields, field, to = r)
            dirty_fields.update(Ruby_fields)

    #1st case : the new Ruby-based model
    elif model_type == "Chinese Ruby":
        if updated_field == "Hanzi":
            #Update the ruby
            h = colorize(ruby(accentuate_pinyin(field["Hanzi"])))
            #Add the toneless transcription and hanzi, hidden, 
            #to make them searchable
            h = hide_ruby(h)
            field["Hanzi"] = h
            if field["Hanzi"] == "":
                field["Meaning"] = ""
            elif field["Meaning"] == "":
                field["Meaning"] = translate( field["Hanzi"] )
        elif updated_field[0:5] == "Hanzi":#Field name starts with "Hanzi"
            zfield[updated_field] = \
                colorize( ruby( accentuate_pinyin( field[updated_field] ) ) )

    #2nd case : use the old Anki1 Pinyin-toolkit rule1s if the deck is
    #called "Chinese" or was created as "Chinese (compatibility)" from
    #Anki2.
    #Note that we accept multiple field names for each field, to ensure
    #Anki1 compatibility.
    else:

        #Fields to update after the Hanzi field has been modified:
        if updated_field in Hanzi_fields:

            #Update Meaning field only if empty.
            m = ""
            if get_any(Meaning_fields, field)  == "" :
                m = translate(field[updated_field])
                #If there's no mean word field, then add it here
                if not has_field(Mean_Word_fields, field):
                    mw = get_mean_word(field[updated_field])
                    if mw:
                        m += "<br>Cl: "+mw
                #If there's no alt spelling field, then add it here
                if not has_field(Alternate_fields, field):
                    mw = get_alternate_spellings(field[updated_field])
                    if mw:
                        m += "<br>Also written: "+mw
                set_all(Meaning_fields, field, to = m)
            
            #Update Mean word field only if empty.
            if get_any(Mean_Word_fields, field)  == "" :
                m = get_mean_word(field[updated_field])
                set_all(Mean_Word_fields, field, to = m)
                
            #Update alt spelling field only if empty.
            if get_any(Alternate_fields, field)  == "" :
                m = get_alternate_spellings(field[updated_field])
                set_all(Alternate_fields, field, to = m)

            #Update Silhouette
            m = silhouette(get_any(Hanzi_fields,field))
            set_all(Silhouette_fields, field, to = m)
                

            #Update transcription field with default transcription (Pinyin?)
            #Only if it's empty
            if get_any(Transcription_fields, field)  == "" :
                t = colorize( transcribe( no_sound( field[updated_field] ) ) )
                #Hide the unaccented transcription in the field, 
                #to make searching easier
                t = hide(t, no_tone(t))
                set_all(Transcription_fields, field, to = t )

            #Erase other fields if the updated field was emptied
            if field[updated_field]=="":
                set_all(Meaning_fields, field, to="")
                set_all(Transcription_fields, field, to="")
                set_all(Sound_fields, field, to="")
                set_all(Simplified_fields, field, to="")
                set_all(Traditional_fields, field, to="")
                set_all(Mean_Word_fields, field, to="")
                set_all(Alternate_fields, field, to="")
                set_all(Ruby_fields, field, to="")
                set_all(Silhouette_fields, field, to="")

            #Update Color field from the Hanzi field, 
            #Take the tone info from the Transcription field
            h = no_sound( field[updated_field])
            t = no_sound( no_color(get_any(Transcription_fields, field) ) )
            c = colorize_fuse( h, t )
            set_all(Color_fields, field, to = c )

            #Update Sound field from Hanzi field if non-empty
            #(only if field actually exists, as it implies downloading 
            #a soundfile from Internet)
            if has_field(Sound_fields, field) and \
                    get_any(Sound_fields, field)=="":
                set_all(Sound_fields, field, to = sound(field[updated_field]))
				
            #Update simplified/traditional fields 
            #If it's the same, leave empty, so as to make this feature unobtrusive to simplified chinese users
            s = simplify(field[updated_field])
            if s <> field[updated_field]:
                set_all(Simplified_fields, field, to = s )
            else:
                set_all(Simplified_fields, field, to = "" )
            t = traditional(field[updated_field])
            if t <> field[updated_field]:
                set_all(Traditional_fields, field, to = t )
            else:
                set_all(Traditional_fields, field, to = "" )

            #Update ruby field
            m = colorize_fuse(get_any(Hanzi_fields, field), get_any(Transcription_fields, field), ruby=True)
            set_all(Ruby_fields, field, to = m)

        #If the transcription was modified, update the Color field
        elif updated_field in Transcription_fields:
            t = colorize( accentuate_pinyin( separate_pinyin(no_color(field[updated_field] ) )))
            t = hide(t, no_tone(t))
            field[updated_field] = t
            h = no_sound( get_any( Hanzi_fields, field) )
            t = no_sound( no_color( field[updated_field] ) )
            set_all(Color_fields, field, to = colorize_fuse( h, t ) ) 

            #Update ruby field
            m = colorize_fuse(get_any(Hanzi_fields, field), get_any(Transcription_fields, field), ruby=True)
            set_all(Ruby_fields, field, to = m)

                    
    return field

recall_back_template.html

<div class=tags>{{Deck}} {{#Tags}} -- {{/Tags}}{{Tags}}</div>

<div class=chinese>{{Ruby}}</div>
<div class=comment>{{Translation}}</div>
<div>{{Meaning}}</div>

<!-- {{Sound}} -->

recall_front_template.html

<div class=tags>{{Deck}} {{#Tags}} -- {{/Tags}}{{Tags}}</div>

<div class=chinese>{{Meaning}}</div>

recognition_back_template.html

<div class=tags>{{Deck}} {{#Tags}} -- {{/Tags}}{{Tags}}</div>

<div class=chinese>{{Ruby}}</div>
<div class=comment>{{Translation}}</div>
<div>{{Meaning}}</div>

<!-- {{Sound}} -->

recognition_front_template.html

<div class=tags>{{Deck}} {{#Tags}} -- {{/Tags}}{{Tags}}</div>

<div class=chinese>{{Example}}{{^Example}}{{Hanzi}}{{/Example}}</div>
{{#Example}}<div class=comment>{{Hanzi}}</div>{{/Example}}

styling.css

.card {
 font-family: arial;
 font-size: 20px;
 text-align: center;
 color: black;
 background-color: white;
}
.card { word-wrap: break-word; }
.win .chinese { font-family: "MS Mincho", "ＭＳ 明朝"; }
.mac .chinese { }
.linux .chinese { font-family: "Kochi Mincho", "東風明朝"; }
.mobile .chinese { font-family: "Hiragino Mincho ProN"; }
.question {
background-color: rgb(255, 239, 213);
border-style:dotted;
border-width:1pt;
margin-top:15pt;
margin-bottom:30pt;
padding-top:15px;
padding-bottom:15px;}
.chinese { font-size: 30px;}
.comment {font-size: 15px; color:grey;}
.tags {color:gray;text-align:right;font-size:10pt;}
.note {color:gray;font-size:12pt;margin-top:20pt;}

.tone1 {color: red;}
.tone2 {color: orange;}
.tone3 {color: green;}
.tone4 {color: blue;}
.tone5 {color: gray;}