diff --git a/docs/add_language.md b/docs/add_language.md index ebdc34f2..221261c4 100644 --- a/docs/add_language.md +++ b/docs/add_language.md @@ -104,7 +104,7 @@ To add new language, you have to create or edit following files: | dictsource/fr_list |create | | dictsource/fr_rules |create | | dictsource/fr_extrc |create (optional) | -| espeak-data/voices/roa/fr |create | +| espeak-ng-data/voices/roa/fr |create | where: @@ -152,10 +152,10 @@ to make it call your new, e.g. `ph_french` file: ### Voice File -E.g. `espeak-data/voices/roa/fr` is the voice file for French. +E.g. `espeak-ng-data/voices/roa/fr` is the voice file for French. This gives the language name and may set some options. -Each language needs a voice file in `espeak-data/voices` grouped by the +Each language needs a voice file in `espeak-ng-data/voices` grouped by the [language family](#language-family). The filename of the default voice for a language should be the same as the language code (e.g. `fr` for French). @@ -167,7 +167,7 @@ name and language code, eg: language fr This language code specifies which phoneme table and dictionary to use -(i.e. `phonemetable fr` and `espeak-data/fr_dict`) to be used. If +(i.e. `phonemetable fr` and `espeak-ng-data/fr_dict`) to be used. If needed, these can be overridden by `phonemes` and `dictionary` attributes in the voice file. For example you may want to start the implementation of a new language by using the phoneme table of an @@ -245,14 +245,14 @@ Details of the contents of the dictionary files are given in [Dictionary](dictionary.md). The `fr_rules` and `fr_list` files are compiled to produce the -`espeak-data/fr_dict` file, which eSpeak uses when it is speaking. +`espeak-ng-data/fr_dict` file, which eSpeak uses when it is speaking. Once the language's phonemes have been defined, then pronunciation dictionary data can be produced in order to translate the language's source text into phonemes. This consists of two source files: `fr_rules` (the spelling to phoneme rules) and `fr_list` (an exceptions list, and attributes of certain words). The corresponding -compiled data file is `espeak-data/fr_dict` which is produced from +compiled data file is `espeak-ng-data/fr_dict` which is produced from the `fr_rules` and `fr_list` sources by the command: espeak-ng --compile=fr @@ -276,7 +276,7 @@ The function `SetTranslator()` at the start of the source code file options. For a new language, you would add its language code and the required options in `SetTranslator()`. However, this may not be necessary during testing because most of the options can also be set in the voice -file in espeak-data/voices (see [Voice Files](voices.md)). +file in espeak-ng-data/voices (see [Voice Files](voices.md)). ## Compiling Rules File for Debugging diff --git a/docs/dictionary.md b/docs/dictionary.md index 14837e42..8ef22d09 100644 --- a/docs/dictionary.md +++ b/docs/dictionary.md @@ -36,8 +36,8 @@ There are two separate methods for translating words into phonemes: various other properties. The source files are: `_list` (e.g. `en_list`) and optionally `_extra` (e.g. `en_extra`). -These files are compiled into the file `_dict`  in the espeak-data -directory (e.g. `espeak-data/en_dict`). +These files are compiled into the file `_dict`  in the espeak-ng-data +directory (e.g. `espeak-ng-data/en_dict`). ## Phoneme names diff --git a/docs/intonation.md b/docs/intonation.md index ae329f14..859f4b8e 100644 --- a/docs/intonation.md +++ b/docs/intonation.md @@ -26,7 +26,7 @@ must be compiled for use by eSpeak NG by using: ## Clauses The tunes which are used for a language can be specified by using a -`tunes` statement in a voice file in `espeak-data/voices`. e.g.: +`tunes` statement in a voice file in `espeak-ng-data/voices`. e.g.: tunes   s1  c1  q1  e1 diff --git a/docs/mbrola.md b/docs/mbrola.md index 0ca6614e..6df2bea2 100644 --- a/docs/mbrola.md +++ b/docs/mbrola.md @@ -31,11 +31,11 @@ The eSpeak NG voices which use Mbrola are named as: where `xxx` is the name of a Mbrola voice (e.g. `mb-en1` for the Mbrola `en1` English voice). These voice files are in eSpeak NG's directory -`espeak-data/voices/mbrola`. +`espeak-ng-data/voices/mbrola`. The installation instructions below use the Mbrola voice "en1" as an example. You can use other mbrola voices for which there is an -equivalent eSpeak NG voice in `espeak-data/voices/mbrola`. +equivalent eSpeak NG voice in `espeak-ng-data/voices/mbrola`. There are some additional eSpeak NG Mbrola voices which speak English text using a Mbrola voice for a different language. These contain the name of @@ -57,7 +57,7 @@ The SAPI5 version of eSpeak NG uses the mbrola.dll. [http://www.tcts.fpms.ac.be/synthesis/mbrola/mbrcopybin.html](http://www.tcts.fpms.ac.be/synthesis/mbrola/mbrcopybin.html). 4. Unpack the archive, and copy the `en1` data file (not the whole "en1" directory) into - `C:/Program Files/eSpeak/espeak-data/mbrola`. + `C:/Program Files/eSpeak/espeak-ng-data/mbrola`. 4. Use the voice `espeak-MB-EN1` from the list of SAPI5 voices. @@ -76,7 +76,7 @@ directly, rather than passing phoneme data to it using a pipe. 4. Unpack the archive, and copy the `en1` data file (not the whole "en1" directory) to `/usr/share/mbrola/en1`. - __NOTE:__ eSpeak will look for mbrola voices firstly in `espeak-data/mbrola` and then in `/usr/share/mbrola`. + __NOTE:__ eSpeak will look for mbrola voices firstly in `espeak-ng-data/mbrola` and then in `/usr/share/mbrola`. ## Usage @@ -94,7 +94,7 @@ or ## Mbrola Voice Files -eSpeak NG's voice files for Mbrola voices are in directory `espeak-data/voices/mbrola`. +eSpeak NG's voice files for Mbrola voices are in directory `espeak-ng-data/voices/mbrola`. They contain a line: `mbrola ` e.g. @@ -105,7 +105,7 @@ e.g. * \ is a translation file to convert between eSpeak phonemes and the equivalent Mbrola phonemes. -These are kept in: `espeak-data/mbrola_ph` +These are kept in: `espeak-ng-data/mbrola_ph` ## Mbrola Phoneme Translation Data diff --git a/docs/voices.md b/docs/voices.md index 8a198d97..0c031940 100644 --- a/docs/voices.md +++ b/docs/voices.md @@ -40,7 +40,7 @@ A Voice file specifies a language (and possibly a language variant or dialect) together with various attributes that affect the characteristics of the voice quality and how the language is spoken. -Voice files are located in the `espeak-data/voices` directory, and are +Voice files are located in the `espeak-ng-data/voices` directory, and are grouped by the [ISO 639-5](https://en.wikipedia.org/wiki/ISO_639-5) language family of the language being specified in the voice files. See also Wikipedia's @@ -221,7 +221,7 @@ adjustment applies only to voiced sounds such as vowels and sonorant consonants (such as `[n]` and `[l]`). Unvoiced sounds such as `[s]` are unaffected. -This `tone` statement can also appear in `espeak-data/config`, in which case +This `tone` statement can also appear in `espeak-ng-data/config`, in which case it applies to all voices which don't have their own `tone` statement. ### flutter @@ -399,7 +399,7 @@ vowels in stressed and unstressed syllables. Eight integer parameters. These are added to the voice's corresponding `stressLength` values. They are used in the voice variant files in -`espeak-data/voices/!v` to give some variety. Negative values may be used. +`espeak-ng-data/voices/!v` to give some variety. Negative values may be used. ### stressAmp @@ -431,7 +431,7 @@ The ISO 8859 character set number. (not all are implemented). Used for some languages to detect if additional language data is installed. If the size of the compiled dictionary data for the language -(the file `espeak-data/*_dict`) is less than this size then a +(the file `espeak-ng-data/*_dict`) is less than this size then a warning is given. ### alphabet2