ManPages/Creating_a_new_word_list.man

   1 ManPagesTextFile
   2 "Creating a new word list" "R.J.J.H. van Son" 20140901 0
   3 <intro> "How to create a new word list to @@Reading an existing word list|use with SpeakGoodChinese@. "
   4
   5 <entry> "Creating a word list"
   6 <normal> "Word lists can be created by any text editor that can produce plain text files (%%.txt%) and by spreadsheet or database programs that can export to %%tab-separated-value% (%%.tsv%) tables. "
   7
   8
   9 <entry> "Very simple word lists"
  10
  11 <normal> "The easiest and simplest way to create a word list is to create a pure text file (%%.txt%, or DOS file).
  12 The file should have the name of the word list and the extention should be %%.txt%.
  13 Each line should countain a single pinyin word."
  14
  15 <normal> "##Example: %%SGC2example1.txt%#"
  16 <code> "chi1"
  17 <code> "ta1"
  18 <code> "jin1tian1"
  19 <code> "can1ting1"
  20 <code> "huan1ying2"
  21 <code> "zhong1guo2"
  22 <code> "duo1shao3"
  23 <code> "zhi3you3"
  24
  25 <entry> "Simple word lists with characters and translations"
  26
  27 <normal> "Characters and translations can be added to the simple, text based word list descibed above.
  28 Again, create a pure text (%%.txt%, or DOS file) file with the %%txt% extention. Each line should start with a pinyin word.
  29 Next, follow the pinyin by a tab or ';' character and the characters that correspond to the pinyin, again a tab
  30 or ';' character and the translation in free text."
  31
  32 <normal> "##Example: %%SGC2example2.txt%#"
  33 <code> "chi1;吃;to eat"
  34 <code> "ta1;他;he, she, it"
  35 <code> "jin1tian1;今天;today"
  36 <code> "can1ting1;餐厅;restaurant"
  37 <code> "huan1ying2;欢迎;to welcome"
  38 <code> "zhong1guo2;中国;China"
  39 <code> "duo1shao3;多少;how many"
  40 <code> "zhi3you3;只有;only"
  41
  42 <normal> "Audio files can be added in the same manner. Just add and item with the extention of an audio file to the line (between tabs or ';' characters). For instance, chi1.mp3 will be interpreted as an audio example."
  43
  44 <normal> "These simple word lists do not contain information about the order and nature of the items. There can be errors in distinguishing characters, translations, and audio examples."
  45
  46 <entry> "Word list tables"
  47
  48 <normal> "Simple word lists based on text files can lead to errors in the values of the items. Large lists with both characters and translations should be constructed as tab-separated-values (%%.tsv%) tables. These can be exported (%%Save as%) from a spreadsheet or database program. The file extention of such a file should be %%.Table% or %%.txt%."
  49
  50 <normal> "A SpeakGoodChinese wordlist table is a tab-separated-values table that starts with a header line which contains the column headers %%Pinyin, Character, Sound, Translation%. Then the column values are written on a line with tabs separating them."
  51
  52 <normal> "##Example: %%SGC2example3.tsv%#"
  53 <code> "Pinyin          Character       Sound   Translation"
  54 <code> "chi1            吃       -       to eat"
  55 <code> "ta1             他       -       he, she, it"
  56 <code> "jin1tian1               今天      -       today"
  57 <code> "can1ting1               餐厅      -       restaurant"
  58 <code> "huan1ying2              欢迎      -       to welcome"
  59 <code> "zhong1guo2              中国      -       China"
  60 <code> "duo1shao3               多少      -       how many"
  61 <code> "zhi3you3                只有      -       only"
  62
  63 <entry> "Word lists with associated audio files"
  64
  65 <normal> "These word list distributions are simple ZIP files with the name <list name>.sgc. They contain a list of all the words in pinyin with the name %%wordlist.txt% or %%wordlist.Table%, as discussed above. Except that the name of the word list file itself should be either %%wordlist.txt% or %%wordlist.Table%. Other names are not allowed. The sound files should be named <pinyin word>.ext, where <pinyin word> is the pinyin transcription, eg, %%sheng1zi4%, and %%.ext% the sound extension type (eg, %%.wav%). Note that SpeakGoodChinese uses Praat to process the sound files. So only those sound files recognized by Praat can be used (see Praat: ##[Read from file...]#). SpeakGoodChinese will use WAV (%%.wav%), Flac (%%.flac%), MP3 (%%.mp3%), and Speex (%%.spx%) files as examples if they are present. "
  66
  67 <normal> "Don't forget to include a %%LICENSE.txt% file with the copyright and licensing information. If you use one of the Creative Commons licenses or the GNU GPL, we might be willing to put your list on our web-site."
  68
  69 <entry> "Contents:"
  70 <list_item> "\bu @@Reading an existing word list@"