Chinese::Vocab

Chinese::Vocab is meant to make live easier for any Chinese language student who:

Prefers to learn vocabulary from Chinese sentences.
Needs to memorize a lot of words on a tight time schedule.
Uses the spaced repetition flashcard program Anki.

Chinese::Vocab addresses all of the above requirements by downloading sentences for each word and selecting the minimum required number of Chinese sentences (and English translations) to represent all words.

You can then export the sentences as well as additional tags provided by Chinese::Vocab to Anki.

Features

Downloads sentences for each word in a Chinese vocabulary list and selects the minimum required number of sentences to represent all words.
With the option key :compact set to true on initialization, all single character words that also appear in at least one multi character word are removed. The reason behind this option is to remove redundancy in meaning and focus on learning distinct words. Example: (["看", "看书"] => [看书])
Adds additional tags to every sentence that can be used in Anki:
Pinyin: By default the pinyin representation is added to each sentence. Example: "除了这张大钞以外，我没有其他零票了。" => "chú le zhè zhāng dà chāo yĭ wài ，wŏ méi yŏu qí tā líng piào le 。"
Number of target words: The number of words from the vocabulary that are covered by a sentence. Example: "除了这张大钞以外，我没有其他零票了。" => "3_words"
List of target words: A list of the words from the vocabulary that are covered by a sentence. Example: "除了这张大钞以外，我没有其他零票了。" => "[我, 他, 除了以外]"
Export data to csv for easy import from Anki.

Installation

$ gem install chinese_vocab

The Dictionaries

Chinese::Vocab uses the following online dictionaries to download the Chinese sentences:

Nciku: This is a fantastic English-Chinese Dictionary with tons of useful features and a great community.
Jukuu: This one is special. It searches the Internet for example sentences and thus is able to return results even for more esoteric technical terms. Search results are returned extremely quickly.

I highly recommend both sites for daily use, and suggest you bookmark them right away.

###Important Note of Caution In order to save precious bandwidth for these great sites, please do only use this gem when you really need the Chinese sentences for your study!

Real World Example (Using the Traditional HSK Word List)

Note: The number of required sentences to cover all words could be reduced by about 39%.

# Import words from source.
# First argument:  path to file
# Second argument: column number of word column (counting starts at 1)
words = Chinese::Vocab.parse_words('../old_hsk_level_8828_chars_1_word_edited.csv', 4)
# Sample output:
p words.take(6)
# => ["啊", "啊", "矮", "爱", "爱人", "安静"]


# Initialize an object.
# First argument:  word list as an array of strings.
# Options:
# :compact (defaults to false)
anki = Chinese::Vocab.new(words, :compact => true)


# Options:
# :source (defaults to :nciku)
# :size   (defaults to :short)
# :with_pinyin (defaults to true)
anki.min_sentences(:thread_count => 10)
# Sample output:
# [{:chinese=>"小红经常向别人夸示自己有多贤惠。",
#   :pinyin=>"xiăo hóng jīng cháng xiàng bié rén kuā shì zì jĭ yŏu duō xián huì 。",
#   :english=>"Xiaohong always boasts that she is genial and prudent.",
#   :target_words=>["别人", "经常", "自己", "贤惠"]},
#  {:chinese=>"一年一度的圣诞节购买礼物的热潮.",
#   :pinyin=>"yī nián yī dù de shèng dàn jié gòu măi lĭ wù de rè cháo yī",
#   :english=>"the annual Christmas gift-buying jag",
#   :target_words=>["礼物", "购买", "圣诞节", "热潮", "一度"]}]

# Save data to csv.
# First parameter: path to file
# Options:
# Any supported option of Ruby's CSV libary
anki.to_csv('in_the_wild_test.csv')
# Sample output: 2 sentences (csv rows) of 4431 sentences total
# (Note that we started out with 7248 sentences):

# 小红经常向别人夸示自己有多贤惠。,
# xiăo hóng jīng cháng xiàng bié rén kuā shì zì jĭ yŏu duō xián huì 。,
# Xiaohong always boasts that she is genial and prudent.,
# 4_words,"[别人, 经常, 自己, 贤惠]"
#
# 一年一度的圣诞节购买礼物的热潮.,
# yī nián yī dù de shèng dàn jié gòu măi lĭ wù de rè cháo yī,
# the annual Christmas gift-buying jag,
# 5_words,"[一度, 圣诞节, 热潮, 礼物, 购买]"




#### Additional methods

# List all words
p anki.words.take(6)
# => ["啊", "啊", "矮", "爱", "爱人", "安静"]

p anki.words.size
# => 7251

p anki.stored_sentences.take(2)
# [{:chinese=>"小红经常向别人夸示自己有多贤惠。",
#   :pinyin=>"xiăo hóng jīng cháng xiàng bié rén kuā shì zì jĭ yŏu duō xián huì 。",
#   :english=>"Xiaohong always boasts that she is genial and prudent.",
#   :target_words=>["别人", "经常", "自己", "贤惠"]},
#  {:chinese=>"一年一度的圣诞节购买礼物的热潮.",
#   :pinyin=>"yī nián yī dù de shèng dàn jié gòu măi lĭ wù de rè cháo yī",
#   :english=>"the annual Christmas gift-buying jag",
#   :target_words=>["礼物", "购买", "圣诞节", "热潮", "一度"]}]

# Words not found on neither online dictionary.
p anki.not_found
# ["来回来去", "来看来讲", "深美"]

# Number of unique characters in the selected sentences
p anki.sentences_unique_chars.size
# => 3232

Documentation

parse_words - How to read in the Chinese words and correctly set the column number, Options:
The supported options of Ruby's CSV library as well as the :encoding parameter. Note: :encoding is always set to utf-8 and :skip_blanks to true internally.
initialize - How to write composite expressions such as "除了。。以外", Options:
:compress (Boolean): Whether or not to remove all single character words that also appear in at least one multi character word. Example: (["看", "看书"] => [看书]). The reason behind this option is to remove redundancy in meaning and focus on learning distinct words.
words - Learn how words are edited internally.
min_sentences - Options:
:source (Symbol): The online dictionary to download the sentences from, either :nciku or :jukuu. Defaults to :nciku. Note: Despite the download source chosen (by using the default or setting the :source options), if a word was not found on the first site, the second site is used as an alternative.
:with_pinyin (Boolean): Whether or not to return the pinyin representation of a sentence. Defaults to true.
:size (Symbol): The size of the sentence to return from a possible set of several sentences. Supports the values :short, :average, and :long. Defaults to :short.
:thread_count (Integer): The number of threads used to download the sentences. Defaults to 8.
sentences_unique_chars - List of unique Chinese characters (single character words) are found in the selected sentences.
to_csv - Options:
All supported options of Ruby's CSV library.