From e6590cad6c198a70b0524326dc8bbae085a0f46a Mon Sep 17 00:00:00 2001 From: Valdis Vitolins Date: Sun, 26 Nov 2017 23:28:17 +0200 Subject: [PATCH] Doc: improved structure and formating --- docs/dictionary.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/dictionary.md b/docs/dictionary.md index c07c7b57..43d64127 100644 --- a/docs/dictionary.md +++ b/docs/dictionary.md @@ -19,6 +19,7 @@ - [Letter Names](#letter-names) - [Numbers](#numbers) - [Character Substitution](#character-substitution) +- [(Re)definition of charater groups](#redefinition-of-charater-groups) ---------- @@ -198,9 +199,9 @@ translation rules and spoken with English phonemes. |-------------|-------------| | `_` | Beginning or end of a word (or a hyphen). | | `-` | Hyphen. | -| `A` | Any vowel1. | -| `C` | Any consonant 2. | -| `B H F G Y` | These may indicate other sets of characters3. | +| `A` | Any vowel[1](#redefinition-of-charater-groups). | +| `C` | Any consonant [1](#redefinition-of-charater-groups). | +| `B H F G Y` | These may indicate other sets of characters[1](#redefinition-of-charater-groups). | | `L` | Any of the sequence of characters defined as a letter grup. | | `D` | Any digit. | | `K` | Not a vowel (i.e. a consonant or word boundary or non-alphabetic character). | @@ -212,16 +213,6 @@ translation rules and spoken with English phonemes. | `@` | One syllable (i.e. at least one vowel or diphthong) | -1. The set of these vowel characters may be redefined for a particular language. -2. The set of these consonant characters may be redefined for a particular language. -3. The sets of letters indicated by `A`, `B`, `C`, `E`, `F` and `G` may be defined -differently for each language. - -* (Re)definition of letter groups is done [in tr_languages.c](../src/libespeak-ng/tr_languages.c), -calling `SetLetterBits()` function from (usually) `NewTranslator()` function. -Note, that letters should be stored as array of chars, thus multibyte -unicode letters should be transposed using `transpose_min` and `transpose_max` parameters -of particular Translator instance. Examples of rules: ``` @@ -522,3 +513,16 @@ version of the characters needs to be specified. e.g. û   ű cx  ĉ   // (Esperanto) allow "cx" as an alternative to c-circumflex fi   fi  // replace a single character ligature by two characters + +## (Re)definition of charater groups + +The set of these vowel characters in `A` group and consonants in `C` group may be +redefined for a particular language. Other sets of letters indicated by `B`, `E`, `F` and `G` +usually have specific meaning for each particular language. + +(Re)definition of letter groups is done in [tr_languages.c](../src/libespeak-ng/tr_languages.c) +file by calling `SetLetterBits()` function from (usually) `NewTranslator()` function. +Note, that letters should be stored as array of chars, thus multibyte +unicode letters should be transposed using `transpose_min` and `transpose_max` parameters +of particular `Translator` structure. +