From be6ce54a248afad1bc521ef50d20244db8e52d97 Mon Sep 17 00:00:00 2001 From: Rob van Son Date: Mon, 1 Sep 2014 15:59:34 +0200 Subject: [PATCH] Added ManPages, still not button to read them --- ManPages/Creating_a_new_word_list.man | 70 ++++++++++++++++++++++++++++++ ManPages/Reading_an_existing_word_list.man | 16 +++++++ ManPages/SpeakGoodChinese_2.man | 14 ++++++ praat_module/makePraat.sh | 1 - 4 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 ManPages/Creating_a_new_word_list.man create mode 100644 ManPages/Reading_an_existing_word_list.man create mode 100644 ManPages/SpeakGoodChinese_2.man diff --git a/ManPages/Creating_a_new_word_list.man b/ManPages/Creating_a_new_word_list.man new file mode 100644 index 0000000..61526a9 --- /dev/null +++ b/ManPages/Creating_a_new_word_list.man @@ -0,0 +1,70 @@ +ManPagesTextFile +"Creating a new word list" "R.J.J.H. van Son" 20140901 0 + "How to create a new word list to @@Reading an existing word list|use with SpeakGoodChinese@. " + + "Creating a word list" + "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. " + + + "Very simple word lists" + + "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." + + "##Example: %%SGC2example1.txt%#" + "chi1" + "ta1" + "jin1tian1" + "can1ting1" + "huan1ying2" + "zhong1guo2" + "duo1shao3" + "zhi3you3" + + "Simple word lists with characters and translations" + + "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." + + "##Example: %%SGC2example2.txt%#" + "chi1;吃;to eat" + "ta1;他;he, she, it" + "jin1tian1;今天;today" + "can1ting1;餐厅;restaurant" + "huan1ying2;欢迎;to welcome" + "zhong1guo2;中国;China" + "duo1shao3;多少;how many" + "zhi3you3;只有;only" + + "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." + + "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." + + "Word list tables" + + "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%." + + "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." + + "##Example: %%SGC2example3.tsv%#" + "Pinyin Character Sound Translation" + "chi1 吃 - to eat" + "ta1 他 - he, she, it" + "jin1tian1 今天 - today" + "can1ting1 餐厅 - restaurant" + "huan1ying2 欢迎 - to welcome" + "zhong1guo2 中国 - China" + "duo1shao3 多少 - how many" + "zhi3you3 只有 - only" + + "Word lists with associated audio files" + + "These word list distributions are simple ZIP files with the 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 .ext, where 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. " + + "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." + + "Contents:" + "\bu @@Reading an existing word list@" diff --git a/ManPages/Reading_an_existing_word_list.man b/ManPages/Reading_an_existing_word_list.man new file mode 100644 index 0000000..15ca184 --- /dev/null +++ b/ManPages/Reading_an_existing_word_list.man @@ -0,0 +1,16 @@ +ManPagesTextFile +"Reading an existing word list" "R.J.J.H. van Son" 20140901 0 + "New word lists can be downloaded or @@Creating a new word list|created@. " + + "Reading a word list" + "Go to the %%Settings page%. At the lower left hand side, there is a button with the label %%Open List%. +After you click on this button, you can select the file with the word list. " + + "Currently, on OSX and Linux the wordlists should have the .sgc extension for SpeakGoodChinese. If your browser renames the extension to %%.zip%, you should rename the files again to have the extension %%.sgc%. Wordlists with the %%.zip% extensions will be loaded, but this feature is still experimental." + + "On Windows, you should unpack the word lists (.sgc or .zip) into a map with the name of the wordlist. Then you can install them using either by name or by opening an audio file (e.g., %%name.wav%), %%wordlist.txt%, or %%wordlist.Table% inside the map. (this will work on Mac and Linux too) " + + "Plain text wordlists (e.g., %%name.txt%) or full tables (e.g., %%name.Table% or %%name.tsv%) can directly be opened using the %%Open List% button on the %%Settings% page." + + "Contents:" + "\bu @@Creating a new word list@" diff --git a/ManPages/SpeakGoodChinese_2.man b/ManPages/SpeakGoodChinese_2.man new file mode 100644 index 0000000..2d6a829 --- /dev/null +++ b/ManPages/SpeakGoodChinese_2.man @@ -0,0 +1,14 @@ +ManPagesTextFile +"SpeakGoodChinese 2" "R.J.J.H. van Son" 20140901 0 + "Speak Good Chinese/说好中文: A tool to train Mandarin pronunciation" + + "SpeakGoodChinese" + "Speak Good Chinese is a cross-platform application based on %%Praat% technology that allows you or your students to train their Mandarin pronunciation. " + "SpeakGoodChinese 2.0 can use word lists in plain pinyin text form, and with Chinese characters, translations, and audio examples. +The integrated eSpeak Mandarin Speech Synthesizer will generate example pronunciations when live audio examples are not available. +See the Wordlists entry below for examples. SpeakGoodChinese 2.0 can be extended with standard speech synthesis applications. +SpeakGoodChinese 2.0 integrates the free (FOSS) eSpeak Mandarin speech synthesis, but can also use other speech synthesis applications. " + + "Contents:" + "\bu @@Reading an existing word list@" + "\bu @@Creating a new word list@" diff --git a/praat_module/makePraat.sh b/praat_module/makePraat.sh index ec9fb67..d247f1c 100755 --- a/praat_module/makePraat.sh +++ b/praat_module/makePraat.sh @@ -124,4 +124,3 @@ if [[ -n `which md5sum` ]] ; then md5sum ${CURRENTWORKINGDIR}/${TARGETNAME}.zip > ${CURRENTWORKINGDIR}/${TARGETNAME}.zip.md5 fi - -- 2.11.4.GIT