Added ManPage text for stored audio recordings

[sgc2.git] / ManPages / Creating_a_new_word_list.man

ManPagesTextFile
"Creating a new word list" "R.J.J.H. van Son" 20140901 0
<intro> "How to create a new word list to @@Reading an existing word list|use with SpeakGoodChinese@. "

<entry> "Creating a word list"
<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. "


<entry> "Very simple word lists"

<normal> "The easiest and simplest way to create a word list is to create a pure text file (%%.txt%, or DOS file). 
The file should have the name of the word list and the extention should be %%.txt%. 
Each line should countain a single pinyin word."

<normal> "##Example: %%SGC2example1.txt%#"
<code> "chi1"
<code> "ta1"
<code> "jin1tian1"
<code> "can1ting1"
<code> "huan1ying2"
<code> "zhong1guo2"
<code> "duo1shao3"
<code> "zhi3you3"

<entry> "Simple word lists with characters and translations"

<normal> "Characters and translations can be added to the simple, text based word list descibed above. Again, create a pure text (.txt, or DOS file) file with the .txt extention. Each line should start with a pinyin word. Next, follow the pinyin by a tab or ';' character and the characters that correspond to the pinyin, again a tab or ';' character and the translation in free text. Translations can be in any language. For instance, 吃 can be entered as %%to eat%, कालो, 食べる, ჭამა or any other transcription in UTF8."


<normal> "##Example: %%SGC2example2.txt%#"
<code> "chi1;吃;to eat"
<code> "ta1;他;he, she, it"
<code> "jin1tian1;今天;today"
<code> "can1ting1;餐厅;restaurant"
<code> "huan1ying2;欢迎;to welcome"
<code> "zhong1guo2;中国;China"
<code> "duo1shao3;多少;how many"
<code> "zhi3you3;只有;only"

<normal> "Audio files can be added in the same manner. Just add an 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."

<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."

<entry> "Word list tables"
<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 %%.tsv%."

<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."

<normal> "##Example: %%SGC2example3.tsv%#"
<code> "Pinyin          Character       Sound   Translation"
<code> "chi1            吃       -       to eat"
<code> "ta1             他       -       he, she, it"
<code> "jin1tian1               今天      -       today"
<code> "can1ting1               餐厅      -       restaurant"
<code> "huan1ying2              欢迎      -       to welcome"
<code> "zhong1guo2              中国      -       China"
<code> "duo1shao3               多少      -       how many"
<code> "zhi3you3                只有      -       only"

<entry> "Word lists with associated audio files"

<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. "

<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."

<normal> "It is possible to use %%SpeakGoodChinese% to record example audio files for wordlists and student evaluation. On the %%Settings page%, press the %%Save Audio% button and select a folder to store the recordings. A blue dot will be displayed in the lower right corner of the %%Main page% as long as recordings are stored. The recorded files have file-names constructed of the pinyin spelling of the word and the extention %%.wav%. Every recording will overwrite existing recordings of the same pinyin word. The storage of recordings can be terminated by pressing the %%Save Audio% button again. Select those recordings you consider good enough as examples and copy them to the target wordlist directory for inclusion in the distribution. When available, %%SpeakGoodChinese% will display the stored recordings for evaluation until a new one is recorded. "

<entry> "Word selection and Lessons"

<normal> "Students can select the words to practise on the Settings page. The wordlist table can contain a collumn with the label Lesson and a lesson number for each line. The words are sorted and displayed with lesson numbers in the word selection window. The student can select the lessons to study when starting."

<normal> "Example: SGC2example4.tsv"
<code> "Pinyin  Character       Sound   Translation     Lesson"
<code> "chi1    吃       -       to eat  1"
<code> "ta1     他       -       he, she, it     1"
<code> "jin1tian1       今天      -       today   1"
<code> "can1ting1       餐厅      -       restaurant      1"
<code> "huan1ying2      欢迎      -       to welcome      1"
<code> "zhong1guo2      中国      -       China   2"
<code> "duo1shao3       多少      -       how many        2"
<code> "zhi3you3        只有      -       only    2"

<normal> "The entries in the Lesson column do not have to be numbers. Any string is allowed, %%Lesson 2%, %%पाठ 2%, %%レッスン2% and %%第二课% are all valid lesson labels."

<entry> "Global installation of word lists"

<normal> "The wordlists a user installs are placed in her local settings directory:"
<list_item> "\bu MS Windows: %%C:\bsDocuments and Settings\bs<User name>\bsSpeakGoodChinese2\bswordlists%"
<list_item> "\bu Mac OSX: %%/Users/<User name>/Library/Preferences/SpeakGoodChinese2/wordlists%"
<list_item> "\bu Linux: %%/home/<User name>/.SpeakGoodChinese2/wordlists%"

<normal> "To install wordlists for all users, place them in:"
<list_item> "\bu MS Windows: %%C:\bsDocuments and Settings\bsAll Users\bsApplication Data\bsSpeakGoodChinese2\bswordlists%"
<list_item> "\bu Mac OSX: %%/Library/Preferences/SpeakGoodChinese2/wordlists%"
<list_item> "\bu Linux: %%/etc/SpeakGoodChinese2/wordlists%"


<entry> "Contents:"
<list_item> "\bu @@Reading an existing word list@"