summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Bavin <pondlife@pondlife.me>2007-06-07 12:16:39 +0000
committerSteve Bavin <pondlife@pondlife.me>2007-06-07 12:16:39 +0000
commitbb0b0829d444c09d5b6b6db97796e71ea5cfd939 (patch)
tree83753e422df7b91fb364558362b0b4d49ea5eb1b
parent3823486a5864796cd7fcba07521f4ca2ebab3885 (diff)
downloadrockbox-bb0b0829d444c09d5b6b6db97796e71ea5cfd939.tar.gz
rockbox-bb0b0829d444c09d5b6b6db97796e71ea5cfd939.zip
Attempt to clarify the voice options.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13589 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/configure_rockbox/voice.tex53
1 files changed, 30 insertions, 23 deletions
diff --git a/manual/configure_rockbox/voice.tex b/manual/configure_rockbox/voice.tex
index 86558a7078..8e12d73d41 100644
--- a/manual/configure_rockbox/voice.tex
+++ b/manual/configure_rockbox/voice.tex
@@ -3,15 +3,14 @@
3 3
4 \begin{description} 4 \begin{description}
5 \item[Voice Menus.] 5 \item[Voice Menus.]
6 This option turns on the Voice User Interface, which will read out menu 6 This option conttols the voicing of menus/settings as they are selected
7 items and settings as they are selected by the cursor. In order for this 7 by the cursor. In order for this to work, a voice file must be present
8 to work, a voice file must be present in the \fname{/.rockbox/langs/} 8 in the \fname{/.rockbox/langs/} directory on the \dap. Voice files are large
9 directory on the \dap. Voice files are large (1.5MB) and are not 9 and are not shipped with Rockbox by default.
10 shipped with Rockbox by default.
11 The voice file is the name of the language for which it is made, followed 10 The voice file is the name of the language for which it is made, followed
12 by the extension \fname{.voice}. So for English, the file name would be 11 by the extension \fname{.voice}. So for English, the file name would be
13 \fname{english.voice}. 12 \fname{english.voice}.
14 This option is on by default. It will do nothing unless the 13 This option is on by default, but will do nothing unless the
15 appropriate voice file is installed in the correct place on the \dap. 14 appropriate voice file is installed in the correct place on the \dap.
16 The Voice Menus have several limitations: 15 The Voice Menus have several limitations:
17 \begin{itemize} 16 \begin{itemize}
@@ -22,13 +21,12 @@
22 \end{itemize} 21 \end{itemize}
23 22
24 \item[Voice Directories.] 23 \item[Voice Directories.]
25 This option turns on the speaking of directory names. The \dap{} 24 This option controls voicing of directory names. A voice file must be present
26 is not powerful enough to produce these voices in real time, so a number 25 for this to work. Several options are available.
27 of options are available.
28 \begin{description} 26 \begin{description}
29 \item[Spell.] 27 \item[Spell.]
30 Speak the directory name by spelling it out letter by letter. Support 28 Speak the directory name by spelling it out letter by letter. Support
31 is provided only for the most common letters and punctuation. 29 is provided only for the most common letters, numbers and punctuation.
32 \item[Numbers.] 30 \item[Numbers.]
33 Each directory is assigned a number based upon its position in the 31 Each directory is assigned a number based upon its position in the
34 file list. They are then announced as ``Directory 1'', ``Directory 2'' 32 file list. They are then announced as ``Directory 1'', ``Directory 2''
@@ -36,35 +34,44 @@
36 \item[Off.] 34 \item[Off.]
37 No attempt will be made to speak directory names. 35 No attempt will be made to speak directory names.
38 \end{description} 36 \end{description}
37 You can also use pre-generated .talk clips to have directory names spoken
38 properly, but you must enable this explicitly (see below).
39 39
40 \item[Use Directory .talk Clips.] 40 \item[Use Directory .talk Clips.]
41 This option turns on the use of .talk clips for directories. .talk clips take 41 This option turns on the use of .talk clips for directories. When .talk clips
42 precedence over the method set under \setting{Voice Directories} above. 42 are used, they take precedence over the method set under \setting{Voice Directories}
43 above.
43 44
44 \begin{description} 45 \begin{description}
45 \item[On.] 46 \item[On.]
46 Use special pre-recorded MP3 files (\fname{\_dirname.talk}) in each 47 Use special pre-recorded MP3 files (\fname{\_dirname.talk}) in each
47 directory. These must be generated in advance, and are typically 48 directory. These must be generated in advance, and are typically
48 produced synthetically using a text to speech engine on a PC. 49 produced synthetically using a text-to-speech engine on a PC.
49 \item[Off.] 50 \item[Off.]
50 No checking is made for directory .talk clips; they are not used even if present. 51 No checking is made for directory .talk clips; they are not used even if present.
52 This can reduce disk activity.
51 \end{description} 53 \end{description}
52 54
53 \item[Voice Filenames.] 55 \item[Voice Filenames.]
54 This option turns on the speaking of filenames. The options provided 56 This option controls voicing of filenames. Again, a voice file must be present
55 are \setting{Spell}, \setting{Numbers}, and \setting{Off} which function 57 for this to work. The options provided are \setting{Spell}, \setting{Numbers},
56 the same as for \setting{Voice Directories}. 58 and \setting{Off} which function the same as for \setting{Voice Directories}.
59 You can also use .talk clips to have filenames spoken properly, but you must
60 enable this explicitly (see below).
57 61
58 \item[Use File .talk Clips.] 62 \item[Use File .talk Clips.]
59 This option turns on the use of .talk clips for files. 63 This option enables the use of .talk clips for files. When .talk clips are used,
64 they take precedence over the method set under \setting{Voice Filenames}
65 above.
60 \begin{description} 66 \begin{description}
61 \item[On.] 67 \item[On.]
62 Use special pre-recorded MP3 files (\fname{\_dirname.talk}) for each file. 68 Use special pre-recorded MP3 files for each file.
63 This functions as above except that the files are named with the same 69 This functions the same as for directories except that the .talk clip file
64 name as the music file (e.g. \fname{Punkadiddle.mp3} would require a 70 must have the same name as the music file with an extra .talk extension
65 file called \fname{Punkadiddle.mp3.talk}). 71 (e.g. \fname{Punkadiddle.mp3} would require a file called \fname{Punkadiddle.mp3.talk}).
66 \item[Off.] 72 \item[Off.]
67 No checking is made for file .talk clips; they are not used even if present. 73 No checking is made for file .talk clips; they are not used even if present.
74 This can reduce disk activity.
68 \end{description} 75 \end{description}
69 76
70 \end{description} 77 \end{description}