The main functionality of this package is supplied via the 2 exported functions: to_zhuyin and to_pinyin, for converting between the zhuyin and pinyin phonetic systems for Mandarin Chinese. Non-zhuyin/non-pinyin characters are preserved in the output, even if they are an incomplete part of what would be a valid zhuyin/pinyin sequence.
For multi-character strings, it is best to have a space (or any non-pinyin/non-zhuyin character) between Chinese characters.
julia> to_zhuyin("bian lian")
"ㄅㄧㄢ ㄌㄧㄢ"
For example, here is an ambiguous case (gives different results with and without a separator).
julia> to_zhuyin("cha nan")
"ㄔㄚ ㄋㄢ"
julia> to_zhuyin("chan an")
"ㄔㄢ ㄢ"
julia> to_zhuyin("chanan")
"ㄔㄢㄢ"
Conversion will greedily match from the left.
to_zhuyin
to_pinyin