diff --git a/doc/index.docbook b/doc/index.docbook
index 2e6e3c4..0d4c269 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,1056 +1,900 @@
KMouth'>
-
-
]>
The &kmouth; HandbookGunnarSchmi Dtgunnar@schmi-dt.de20022003Gunnar Schmi Dt&FDLNotice;
- 2013-06-23
- 1.1.1 (&kde; 4.11)
+ 2018-01-04
+ 1.2.0 (Applications 17.12)
&kmouth; is an application that enables persons that cannot speak to let their
computers speak.
KDEkdeaccesibilityKMouthtext-to-speech conversionmutual personsIntroduction
&kmouth; is a program that enables persons that cannot speak to let their
computers speak. It includes a history of spoken sentences from which the
user can select sentences to be re-spoken.
Note that &kmouth; does not include any speech synthesizers. Instead it requires
a speech synthesizer installed in the system.
Using &kmouth;The First Time Setup
During the first use of &kmouth;, a wizard is displayed in which you
can configure it.
Text-to-Speech ConfigurationText-to-Speech Configuration
With the first page of the wizard you specify
the command that shall be used for the text-to-speech conversion.
For more details look into the description
of the configuration dialog.
Initial Phrase BookInitial Phrase Book
With the second page you select which standard phrase books you need.
From the phrase books you can select often used phrases so that
you do not need to type them in. Of course &kmouth; also has an edit
dialog for the case that you later want to edit your phrase books.
Word CompletionWord Completion
With the third page you define the dictionary
for a word completion. &kmouth; will parse the &kde; documentation of
the chosen language in order to detect the regularity of individual
words. Optionally you can compare the word list to an OpenOffice.org
dictionary in order to only add correctly spelled words to the word
completion.
The Main Window
The main window of &kmouth; is fairly simple. It consists basically of an
edit field into which you type your sentences (the lower white field in
the screen shot) and a history of spoken sentences (the upper white field
in the screen shot).
The main window of &kmouth;The main window of &kmouth;
Assuming that you have correctly configured
&kmouth; you can use the edit field for entering sentences you
want to hear. Once a sentence got spoken it will be appended to the
history. From the history you can select sentences to be re-spoken.
From the phrase books (located in the line below the tool bar) you can
select often used phrases.
The Configuration Dialog
By using the menu entry
SettingsConfigure &kmouth;...
you open the configuration dialog of &kmouth;. This dialog consists of
the pages General Options with the two tabs Preferences
and Text-to-Speech, the page Word Completion and
the page Jovie Speech Service.
The Preferences tabThe Preferences tabScreen shot
The Preferences tab contains options that alter the behavior of
&kmouth; in certain situations.
- With the first combo box, Selection of phrases in the phrase book:,
+ With the first combo box Selection of phrases in the phrase book
you specify which action is triggered by typing the shortcut of a
phrase or by selecting a phrase in the Phrase Book
menu or in the phrase book bar.
By selecting Speak Immediately the
selected phrase gets immediately spoken and is entered into
the history. If you select Insert Into Edit
Field the selected phrase is just inserted into the
edit field.
With the second combo box, Closing the phrase book
- edit window:, you specify whether the phrase book
+ edit window, you specify whether the phrase book
gets saved if you just close the phrase book edit window.
By selecting Save Phrase Book the phrase
book gets saved. If you select Discard
changes the changes are discarded and the phrase
book is not saved. If you select Ask Whether to
Save &kmouth; will ask you whether it shall save
the phrase book.
The Text-to-Speech tabThe Text-to-Speech tabScreen shot
+
+ By selecting Use default speech system you tell &kmouth;
+ first to try to use the system speech service prior to calling the speech
+ synthesizer directly. If this succeeds the other configuration entries on
+ this tab are ignored. The system speech service is a &Qt; library which
+ wraps speech-dispatcher on &Linux;, and native speech systems on other platforms.
+ On a Debian based system you need the packages speech-dispatcher, libqt5texttospeech5
+ and one of the speech-dispatcher modules, usually espeak.
+ Use the commandline tool spd-conf (Debian package python3-speechd)
+ to adjust settings like rate, pitch, volume, voice type and language &etc; for the default speech system.
+ Additionally spd-conf will let you choose between all installed
+ speech-dispatcher modules, &ie; espeak,
+ festival, flite,
+ mbrola &etc;
+
+
Into the edit field of the Text-to-Speech tab you enter the command
for calling the speech synthesizer. With the combo box below the edit
field you specify the character encoding that is used for passing the
text to the speech synthesizer.
&kmouth; knows two ways of passing the text: If the command expects the
text as standard input you select the check box.
The other way is to pass the text as a parameter:
Before calling the command &kmouth; replaces certain placeholders with
actual content:
PlaceholderReplaced with%tThe actual text that should be spoken%fThe name of a temporary file that contains the text
that should be spoken%lThe language code associated with the current word completion
dictionary%%A percent sign
Of course the command for speaking texts is dependent on which speech
synthesizer you use. Please look into the documentation of your speech
- synthesizer for the command for speaking texts. You can find examples
- for the command in the appendix.
-
-
- By selecting Use Jovie speech service if possible you tell &kmouth;
- first to try to send the text to the Jovie speech service. If this succeeds the
- other configuration entries on this tab are ignored. The Jovie speech
- service is a &kde; daemon which gives &kde; applications a standardized
- interface for speech synthesis and is currently developed in Git. It
- is safe to select this option even if Jovie is not installed.
+ synthesizer for the command for speaking texts.
The Word Completion pageThe Word Completion pageScreen shot
The Word Completion page contains a list
of dictionaries used for the word completion. (&kmouth; will
display a combo box next to the edit field in the main window
if this list contains more than one dictionary. You can use this
combo box in order to select the dictionary that actually gets
used for the word completion.)
With the buttons on the right side of the page you can add and
delete dictionaries, change the order of the dictionaries or export
dictionaries to a file. With the edit field and the combo box below
the list you can change the name and the language associated with
the dictionary.
When you add a new dictionary you may choose between several sources:
Create a new dictionary from the &kde; documentation
If you use this source &kmouth; will ask you for the intended
language and afterwards parse the &kde; documentation. The
frequentness of the individual words is detect by simply counting
the occurrences of each word. Optionally you can compare the word
list to an OpenOffice.org dictionary in order to only add correctly
spelled words to the new dictionary.
Create a new dictionary from a file
If you use this source &kmouth; will ask you for the intended
file. You may either select an &XML; file, a standard text file or
a file containing a word completion dictionary created by either
&kmouth; or GOK (the GNOME On-screen Keyboard). If you select a
standard text file or an &XML; file the frequentness of the individual
words is detected by simply counting the occurrences of each word.
Optionally you can compare the word list to an OpenOffice.org
dictionary in order to only add correctly spelled words to the new
dictionary.
Create a new dictionary from a folder
If you use this source &kmouth; will ask you for the intended folder.
&kmouth; will open all files in that folder and its subfolders.
Each file is either loaded as a completion dictionary, as an &XML; file
or as a standard text file. In the latter two cases the occurrences of
each individual word in the file is counted. Optionally you can compare
the word list to an OpenOffice.org dictionary in order to only add
correctly spelled words to the new dictionary.
Merge dictionaries
You can use this option in order to merge the available dictionaries.
&kmouth; will ask you which dictionaries should be merged and how the
individual dictionaries should be weighted.
Create an empty word list
You can use this option in order to create a blank dictionary without
any entries. As &kmouth; automatically adds newly typed words to the
dictionaries it will learn your vocabulary with the time.
-
- The Jovie Speech Service page
- The configuration of the &kde; Speech Service is described in detail in the
- Jovie Handbook.
- The Phrase Book Edit Window
By using the menu entry
Phrase BooksEdit...
you open the phrase book edit window.
The phrase book edit windowScreenshot
The main area of the phrase book edit window is divided into two parts.
Within the upper part the phrase books are displayed in some tree
structure.
Within the lower part you may modify a selected item. If you have
selected a phrase you can modify the contents of the phrase as well
as its shortcut. If you have selected a phrase book you can only
change its name.
Actions like adding new phrases and phrase books and deleting selected
phrases and phrase books can be done by selecting them in either the
menu bar, the toolbar or a pop up menu.
You can change the order of the phrase books and phrases by dragging
them to their new places or by using the arrow keys while the
&Alt; key is pressed.
Command ReferenceCommands Within The Main WindowThe File Menu&Ctrl;OFileOpen as History...Opens a text file into as history of spoken sentences.&Ctrl;SFileSave History As...Saves the history into a text file.&Ctrl;PFilePrint History...Prints the history.&Ctrl;QFileQuitQuits &kmouth;The Edit Menu&Ctrl;XEditCut
Cuts the selected section and puts it to the clipboard. If there
is some text selected in the edit field it is placed in the
clipboard. Otherwise the selected sentences in the history (if
any) are placed in the clipboard.
&Ctrl;CEditCopy
Copies the selected section to the clipboard. If there is some
text selected in the edit field it is copied to the clipboard.
Otherwise the selected sentences in the history (if any) are
copied to the clipboard.
&Ctrl;VEditPaste
Pastes the clipboard contents at the current cursor position into
the edit field.
EditSpeak
Speaks the currently active sentence(s). If there is some text in
the edit field it is spoken. Otherwise the selected sentences in
the history (if any) are spoken.
The Phrase Books MenuPhrase BooksEdit...
Opens the phrase book edit window.
&kmouth; has the common &kde; Settings and Help
menu items, for more information read the sections about the Settings Menu and Help Menu
of the &kde; Fundamentals.
-
-
- The pop up menu of history entries
-
-
-
- Speak
-
-
- The selected sentences are spoken.
-
-
-
-
- Delete
-
-
- The selected sentences are removed from the history.
-
-
-
-
- Cut
-
-
- The selected sentences are deleted and placed on the clipboard.
-
-
-
-
- Copy
-
-
- The selected sentences are copied to the clipboard.
-
-
-
-
- Select All Entries
-
-
- All history entries are selected.
-
-
-
-
- Deselect All Entries
-
-
- All history entries are deselected.
-
-
-
-
- &Ctrl;O
- Open as History...
-
-
- Opens a text file into as history of spoken sentences.
-
-
-
-
-&Ctrl;S
- Save History As...
-
-
- Saves the history into a text file.
-
-
-
- Commands within the phrase book edit windowThe File MenuFileNew PhraseAdds a new phrase.FileNew Phrase BookAdds a new phrase book.&Ctrl;SFileSaveSaves the phrase book.FileImport...Imports a file and adds its contents to the phrase bookFileImport Standard Phrase BookImports a standard phrase book and adds its contents to the phrase bookFileExport...Exports the currently selected phrase(s) or phrase book(s) to a file
-
-
-
- &Ctrl;P
-
- File
- Print...
-
- Prints the currently selected phrase(s) or phrase book(s)
- &Ctrl;WFileCloseCloses the windowThe Edit Menu&Ctrl;XEditCut
Cuts the selected items and puts it to the clipboard.
&Ctrl;CEditCopy
Copies the selected items to the clipboard.
&Ctrl;VEditPaste
Pastes the clipboard contents into the phrase book.
EditDelete
Deletes the selected items.
The Help MenuThe items in this menu are the same as in the main window.The Pop up MenuNew PhraseAdds a new phrase.New Phrase BookAdds a new phrase book.Import...Imports a file and adds its contents to the phrase bookImport Standard Phrase BookImports a standard phrase book and adds its contents to the phrase bookExport...Exports the currently selected phrase(s) or phrase book(s) to a file&Ctrl;XCut
Cuts the selected items and puts it to the clipboard.
&Ctrl;CCopy
Copies the selected items to the clipboard.
&Ctrl;VPaste
Pastes the clipboard contents at this position into the phrase book.
Delete
Deletes the selected items.
-
- Questions and Answers
-
- &reporting.bugs;
- &updating.documentation;
-
-
-
-
- I do not hear anything.
-
-
-
- Most likely you did not configure correctly (or at all) the
- text-to-speech command. Use
-
- SettingsConfigure &kmouth;...
- , open the page General Options
- and enter the command for speaking texts on the tab Text-to-Speech.
- (See section about the configuration
- dialog for the speech synthesizer for more details.)
-
-
-
-
-
-
Credits and License
- &kappname;
+ &kmouth;
Program copyright 2002-2004 Gunnar Schmi Dt gunnar@schmi-dt.de
Documentation copyright 2002-2004 Gunnar Schmi Dt gunnar@schmi-dt.de
&underFDL;
&underGPL;
+
diff --git a/doc/man-kmouth.1.docbook b/doc/man-kmouth.1.docbook
index 7c28447..3e02c81 100644
--- a/doc/man-kmouth.1.docbook
+++ b/doc/man-kmouth.1.docbook
@@ -1,78 +1,77 @@
]>
&kde; User's Manual&Lauri.Watts; &Lauri.Watts.mail;
-2010-09-15
-K Desktop Environment
+2018-01-03
+Applications 17.12
+KDE Applicationskmouth1kmouthA type-and-say front end for speech synthesizerskmouthfilename
-&kde; Generic Options
-&Qt; Generic OptionsDescription&kmouth; is an application that enables persons that cannot speak to
-let their computers speak.It includes a history of spoken sentences from
+let their computers speak. It includes a history of spoken sentences from
which the user can select sentences to be re-spoken.Note that &kmouth; does not include speech synthesizer. Instead it
requires a speech synthesizer installed in the system.OptionsThe history file to open.See Alsoespeak(1), festival(1), mbrola(1), freetts(1)More detailed user documentation is available from help:/kmouth
(either enter this &URL; into &konqueror;, or run
khelpcenterhelp:/kmouth).There is also further information available at the &kde; Accessibility project web
site.Authors&kmouth; was written by
GunnarSchmi
Dtkmouth@schmi-dt.de.