From 49af3aec80687f3ed121fb141714cb6f53961c57 Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Wed, 25 Apr 2018 07:46:58 +0100 Subject: [PATCH] docs: Reference all the documentation from index.md. --- README.md | 7 +++++-- docs/index.md | 27 ++++++++++++++++++++------- docs/languages.md | 14 +++++++------- docs/phonemes.md | 2 +- 4 files changed, 33 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c26a45cb..a09bdd81 100644 --- a/README.md +++ b/README.md @@ -333,8 +333,11 @@ To enable eSpeak, you need to: ## Documentation -The [main documentation](docs/index.md) for eSpeak NG provides more information -on using and creating voices/languages for eSpeak NG. +The [documentation](docs/index.md) for eSpeak NG provides: + +1. a user guide; +2. a guide for language and voice authors; and +3. details for developers. The [espeak-ng](src/espeak-ng.1.ronn) and [speak-ng](src/speak-ng.1.ronn) command-line documentation provide a reference of the different command-line diff --git a/docs/index.md b/docs/index.md index 34f6295a..4a3f0d72 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,13 +2,26 @@ - [Features](#features) - [History](#history) -- [Adding or Improving a Language](add_language.md) - - [Text to Phoneme Translation](dictionary.md) -- [Voice Files](voices.md) - - [MBROLA Voices](mbrola.md) - - [Phoneme Tables](phontab.md) -- [Intonation](intonation.md) -- [SSML and HTML Support](markup.md) +- User Guide + - [espeak-ng Command Line](../src/espeak-ng.1.ronn) + - [speak-ng Command Line](../src/speak-ng.1.ronn) + - [Supported Languages](languages.md) + - [SSML and HTML Support](markup.md) +- Creating and Editing Languages and Voices + - [Adding or Improving a Language](add_language.md) + - [Text to Phoneme Translation](dictionary.md) + - [Voice Files](voices.md) + - [MBROLA Voices](mbrola.md) + - [Phoneme Tables](phontab.md) + - [Intonation](intonation.md) +- Phonemes + - [Phoneme Features and the International Phonetic Alphabet](phonemes.md) + - [Kirshenbaum (ASCII-IPA) Transcription Scheme](phonemes/kirshenbaum.md) + - [X-SAMPA Transcription Scheme](phonemes/xsampa.md) + - [Conlang X-SAMPA Transcription Scheme](phonemes/cxs.md) + - [Phoneme Model](phoneme_model.md) + - Pronunciation Guides + - [English](languages/gmw/en.md) - [License](../COPYING) ---------- diff --git a/docs/languages.md b/docs/languages.md index 7a4c3ae0..514841c5 100644 --- a/docs/languages.md +++ b/docs/languages.md @@ -35,13 +35,13 @@ The 100 supported languages and accents are: | `zlw` | `cs` | West Slavic | Czech | | | `gmq` | `da` | North Germanic | Danish | | | `gmw` | `nl` | West Germanic | Dutch | | -| `gmw` | `en-US` | West Germanic | [English](languages/gmw/en.md) | American | -| `gmw` | `en` | West Germanic | [English](languages/gmw/en.md) | British | -| `gmw` | `en-029` | West Germanic | [English](languages/gmw/en.md) | Caribbean | -| `gmw` | `en-GB-x-gbclan` | West Germanic | [English](languages/gmw/en.md) | Lancastrian | -| `gmw` | `en-GB-x-rp` | West Germanic | [English](languages/gmw/en.md) | Received Pronunciation | -| `gmw` | `en-GB-scotland` | West Germanic | [English](languages/gmw/en.md) | Scottish | -| `gmw` | `en-GB-x-gbcwmd` | West Germanic | [English](languages/gmw/en.md) | West Midlands | +| `gmw` | `en-US` | West Germanic | English | American | +| `gmw` | `en` | West Germanic | English | British | +| `gmw` | `en-029` | West Germanic | English | Caribbean | +| `gmw` | `en-GB-x-gbclan` | West Germanic | English | Lancastrian | +| `gmw` | `en-GB-x-rp` | West Germanic | English | Received Pronunciation | +| `gmw` | `en-GB-scotland` | West Germanic | English | Scottish | +| `gmw` | `en-GB-x-gbcwmd` | West Germanic | English | West Midlands | | `art` | `eo` | Constructed | Esperanto | | | `urj` | `et` | Uralic | Estonian | | | `ira` | `fa` | Iranian | Persian | | diff --git a/docs/phonemes.md b/docs/phonemes.md index 4670822c..c28de5c5 100644 --- a/docs/phonemes.md +++ b/docs/phonemes.md @@ -1,4 +1,4 @@ -# Phonemes +# Phoneme Features and the International Phonetic Alphabet - [Phoneme Transcription Schemes](#phoneme-transcription-schemes) - [Consonants](#consonants)