doc/kmouth/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3   <!ENTITY kmouth '<application>KMouth</application>'>
   4   <!ENTITY kappname "&kmouth;">
   5   <!ENTITY package "kdeaccessibility">
   6   <!ENTITY % addindex "IGNORE">
   7   <!ENTITY % English "INCLUDE"><!-- change language only here -->
   8 ]>
   9
  10 <book lang="&language;">
  11 <bookinfo>
  12   <title>The &kmouth; Handbook</title>
  13
  14   <authorgroup>
  15     <author>
  16       <firstname>Gunnar</firstname>
  17       <surname>Schmi Dt</surname>
  18       <affiliation>
  19         <address><email>gunnar@schmi-dt.de</email></address>
  20       </affiliation>
  21     </author>
  22   <!-- TRANS:ROLES_OF_TRANSLATORS -->
  23   </authorgroup>
  24
  25
  26   <copyright>
  27     <year>2002</year><year>2003</year>
  28     <holder>Gunnar Schmi Dt</holder>
  29   </copyright>
  30   <!-- Translators: put here the copyright notice of the translation -->
  31   <legalnotice>&FDLNotice;</legalnotice>
  32
  33
  34   <date>2006-05-20</date>
  35   <releaseinfo>1.1.1</releaseinfo>
  36
  37   <abstract>
  38     <para>
  39       &kmouth; is an application that enables persons that cannot speak to let their
  40       computers speak.
  41     </para>
  42   </abstract>
  43
  44   <keywordset>
  45     <keyword>KDE</keyword>
  46     <keyword>kdeutils</keyword>
  47     <keyword>KMouth</keyword>
  48     <keyword>text-to-speech conversion</keyword>
  49     <keyword>mutual persons</keyword>
  50   </keywordset>
  51 </bookinfo>
  52
  53 <chapter id="introduction">
  54   <title>Introduction</title>
  55
  56   <para>
  57     &kmouth; is a program that enables persons that cannot speak to let their
  58     computers speak. It includes a history of spoken sentences from which the
  59     user can select sentences to be re-spoken.
  60   </para>
  61   <para>
  62     Note that &kmouth; does not include speech synthesizer. Instead it requires
  63     a speech synthesizer installed in the system.
  64   </para>
  65   <para>
  66     Please report any problems and feature requests to the author of &kmouth;.
  67   </para>
  68 </chapter>
  69
  70 <chapter id="using-kmouth">
  71   <title>Using &kmouth;</title>
  72   <sect1 id="Wizard">
  73     <title>The first start</title>
  74     <para>
  75       During the first start of &kmouth;, a wizard is displayed into which you
  76       can enter some basic configuration.
  77     </para>
  78     <para>
  79       <screenshot>
  80         <screeninfo>The wizard</screeninfo>
  81         <mediaobject>
  82           <imageobject>
  83             <imagedata fileref="kmouthwizard.png" format="PNG"/>
  84           </imageobject>
  85           <imageobject>
  86             <imagedata fileref="kmouthwizard.eps" format="EPS"/>
  87           </imageobject>
  88           <textobject>
  89             <phrase>The wizard</phrase>
  90           </textobject>
  91         </mediaobject>
  92       </screenshot>
  93     </para>
  94     <para>
  95       With the first page of the wizard (the left screen shot) you specify
  96       the command that shall later be used for the text-to-speech conversion.
  97       For more details look into the <link linkend="tts-config">description
  98       of the configuration dialog.</link>
  99     </para>
 100     <para>
 101       With the second page you select which standard phrase books you need.
 102       From the phrase books you later can select often used phrases so that
 103       you do not need to type them in. Of course &kmouth; also has an edit
 104       dialog for the case that you later want to edit your phrase books.
 105     </para>
 106     <para>
 107       With the third page (the right screen shot) you define the dictionary
 108       for a word completion. &kmouth; will parse the &kde; documentation of
 109       the chosen language in order to detect the frequentness of individual
 110       words. Optionally you can compare the word list to an OpenOffice.org
 111       dictionary in order to only add correctly spelled words to the word
 112       completion.
 113     </para>
 114   </sect1>
 115   <sect1 id="main-window">
 116     <title>The Main Window</title>
 117     <para>
 118       The main window of &kmouth; is fairly simple. It consists basically of an
 119       edit field into which you type your sentences (the lower white field in
 120       the screen shot) and a history of spoken sentences (the upper white field
 121       in the screen shot).
 122     </para>
 123     <para>
 124       <screenshot>
 125         <screeninfo>The main window of &kmouth;</screeninfo>
 126         <mediaobject>
 127           <imageobject>
 128             <imagedata fileref="kmouthmain.png" format="PNG"/>
 129           </imageobject>
 130           <imageobject>
 131             <imagedata fileref="kmouthmain.eps" format="EPS"/>
 132           </imageobject>
 133           <textobject>
 134             <phrase>Screen shot</phrase>
 135           </textobject>
 136         </mediaobject>
 137       </screenshot>
 138     </para>
 139     <para>
 140       Assuming that you have correctly <link linkend="config-dialog">configured
 141       &kmouth;</link> you can use the edit field for entering sentences you
 142       want to hear. Once a sentence got spoken it will be appended to the
 143       history. From the history you can select sentences to be re-spoken.
 144     </para>
 145     <para>
 146       From the phrase books (located in the line below the tool bar) you can
 147       select often used phrases.
 148     </para>
 149   </sect1>
 150   <sect1 id="config-dialog">
 151     <title>The Configuration Dialog</title>
 152     <para>
 153       By using the menu entry
 154       <menuchoice>
 155         <guimenu>Settings</guimenu><guimenuitem>Configure &kmouth;...</guimenuitem>
 156       </menuchoice>
 157       you open the configuration dialog of &kmouth;. This dialog consists of
 158       the pages <guilabel>General Options</guilabel> with the two tabs <guilabel>Text-to-Speech</guilabel>
 159       and <guilabel>Preferences</guilabel>, the page <guilabel>Word Completion</guilabel> and
 160        the page <guilabel>KTTSD Speech Service</guilabel>
 161     </para>
 162     <sect2 id="tts-config">
 163       <title>The <guilabel>Text-to-Speech</guilabel> tab</title>
 164       <para>
 165         <screenshot>
 166           <screeninfo>The <guilabel>Text-to-Speech</guilabel> tab</screeninfo>
 167           <mediaobject>
 168             <imageobject>
 169               <imagedata fileref="kmouthctts.png" format="PNG"/>
 170             </imageobject>
 171             <imageobject>
 172               <imagedata fileref="kmouthctts.eps" format="EPS"/>
 173             </imageobject>
 174             <textobject>
 175               <phrase>Screen shot</phrase>
 176             </textobject>
 177           </mediaobject>
 178         </screenshot>
 179       </para>
 180       <para>
 181         Into the edit field of the <guilabel>Text-to-Speech</guilabel> tab you enter the command
 182         for calling the speech synthesizer. With the combo box below the edit
 183         field you specify the character encoding that is used for passing the
 184         text to the speech synthesizer.
 185       </para>
 186       <para>
 187         &kmouth; knows two ways of passing the text: If the command expects the
 188         text as standard input you select the check box.
 189       </para>
 190       <para>
 191         The other way is to pass the text as a parameter:
 192         Before calling the command &kmouth; replaces certain placeholders with
 193         actual content:
 194         <informaltable frame="topbot">
 195          <tgroup cols="2">
 196           <thead>
 197           <row><entry>Placeholder</entry><entry>Replaced with</entry></row>
 198           </thead>
 199             <tbody>
 200               <row><entry><token>%t</token></entry>
 201                    <entry>The actual text that should be spoken</entry>
 202               </row>
 203               <row><entry><token>%f</token></entry>
 204                    <entry>The name of a temporary file that contains the text
 205                           that should be spoken</entry>
 206               </row>
 207               <row><entry><token>%l</token></entry>
 208                    <entry>The language code associated with the current word completion
 209                           dictionary</entry>
 210               </row>
 211               <row><entry><token>%%</token></entry><entry>A percent sign</entry></row>
 212            </tbody>
 213           </tgroup>
 214         </informaltable>
 215       </para>
 216       <para>
 217         Off course the command for speaking texts is dependent on which speech
 218         synthesizer you use. Please look into the documentation of your speech
 219         synthesizer for the command for speaking texts. You can find examples
 220         for the command in the <link linkend="tts">appendix</link>.
 221       </para>
 222       <para>
 223         By selecting <guilabel>Use KTTSD speech service if possible</guilabel> you tell &kmouth;
 224         first to try to send the text to the KTTSD speech service. If this succeeds the
 225         other configuration entries on this tab are ignored. The KTTSD speech
 226         service is a &kde; daemon which gives &kde; applications a standardized
 227         interface for speech synthesis and is currently developed in <acronym>SVN</acronym>. It
 228         is safe to select this option even if KTTSD is not installed.
 229       </para>
 230     </sect2>
 231     <sect2 id="preferences">
 232       <title>The <guilabel>Preferences</guilabel> tab</title>
 233       <para>
 234         <screenshot>
 235           <screeninfo>The <guilabel>Preferences</guilabel> tab</screeninfo>
 236           <mediaobject>
 237             <imageobject>
 238               <imagedata fileref="kmouthcpref.png" format="PNG"/>
 239             </imageobject>
 240             <imageobject>
 241               <imagedata fileref="kmouthcpref.eps" format="EPS"/>
 242             </imageobject>
 243             <textobject>
 244               <phrase>Screen shot</phrase>
 245             </textobject>
 246           </mediaobject>
 247         </screenshot>
 248       </para>
 249       <para>
 250         The <guilabel>Preferences</guilabel> tab contains options that alter the behavior of
 251         &kmouth; in certain situations.
 252       </para>
 253       <para>
 254         With the first combo box, <guilabel>Selection of phrases in the phrase book:</guilabel>,
 255         you specify which action is triggered by typing the shortcut of a
 256         phrase or by selecting a phrase in the <guimenu>Phrase Book</guimenu>
 257         menu or in the phrase book bar.
 258       </para>
 259       <para>
 260         By selecting <guilabel>Speak Immediately</guilabel> the
 261         selected phrase gets immediately spoken and is entered into
 262         the history. If you select <guilabel>Insert Into Edit
 263         Field</guilabel> the selected phrase is just inserted into the
 264         edit field.
 265       </para>
 266       <para>
 267         With the second combo box, <guilabel>Closing the phrase book
 268         edit window:</guilabel>, you specify whether the phrase book
 269         gets saved if you just close the phrase book edit window.
 270       </para>
 271       <para>
 272         By selecting <guilabel>Save Phrase Book</guilabel> the phrase
 273         book gets saved. If you select <guilabel>Discard
 274         changes</guilabel> the changes are discarded and the phrase
 275         book is not saved. If you select <guilabel>Ask Whether to
 276         Save</guilabel> &kmouth; will ask you whether it shall save
 277         the phrase book.
 278       </para>
 279     </sect2>
 280     <sect2 id="completion-config">
 281       <title>The <guilabel>Word Completion</guilabel> page</title>
 282       <para>
 283         <screenshot>
 284           <screeninfo>The <guilabel>Word Completion</guilabel> page</screeninfo>
 285           <mediaobject>
 286             <imageobject>
 287               <imagedata fileref="kmouthcwcp.png" format="PNG"/>
 288             </imageobject>
 289             <imageobject>
 290               <imagedata fileref="kmouthcwcp.eps" format="EPS"/>
 291             </imageobject>
 292             <textobject>
 293               <phrase>Screen shot</phrase>
 294             </textobject>
 295           </mediaobject>
 296         </screenshot>
 297       </para>
 298       <para>
 299         The <guilabel>Word Completion</guilabel> page contains a list
 300         of dictionaries used for the word completion. (&kmouth; will
 301         display a combo box next to the edit field in the main window
 302         if this list contains more than one dictionary. You can use this
 303         combo box in order to select the dictionary that actually gets
 304         used for the word completion.)
 305       </para>
 306       <para>
 307         With the buttons on the right side of the page you can add and
 308         delete dictionaries, change the order of the dictionaries or export
 309         dictionaries to a file. With the edit field and the combo box below
 310         the list you can change the name and the language associated with
 311         the dictionary.
 312       </para>
 313       <para>
 314         When you add a new dictionary you may choose between several sources:
 315       </para>
 316       <itemizedlist>
 317         <listitem>
 318           <para>Create a new dictionary from the &kde; documentation</para>
 319           <para>
 320             If you use this source &kmouth; will ask you for the intended
 321             language and afterwards parse the &kde; documentation. The
 322             frequentness of the individual words is detect by simply counting
 323             the occurrences of each word. Optionally you can compare the word
 324             list to an OpenOffice.org dictionary in order to only add correctly
 325             spelled words to the new dictionary.
 326           </para>
 327         </listitem>
 328         <listitem>
 329           <para>Create a new dictionary from a file</para>
 330           <para>
 331             If you use this source &kmouth; will ask you for the intended
 332             file. You may either select an &XML; file, a standard text file or
 333             a file containing a word completion dictionary created by either
 334             &kmouth; or GOK (the GNOME On-screen Keyboard). If you select a
 335             standard text file or an &XML; file the frequentness of the individual
 336             words is detected by simply counting the occurrences of each word.
 337             Optionally you can compare the word list to an OpenOffice.org
 338             dictionary in order to only add correctly spelled words to the new
 339             dictionary.
 340           </para>
 341         </listitem>
 342         <listitem>
 343           <para>Create a new dictionary from a folder</para>
 344           <para>
 345             If you use this source &kmouth; will ask you for the intended folder.
 346             &kmouth; will open all files in that folder and its subdirectories.
 347             Each file is either loaded as a completion dictionary, as an &XML; file
 348             or as a standard text file. In the latter two cases the occurrences of
 349             each individual word in the file is counted. Optionally you can compare
 350             the word list to an OpenOffice.org dictionary in order to only add
 351             correctly spelled words to the new dictionary.
 352           </para>
 353         </listitem>
 354         <listitem>
 355           <para>Merge dictionaries</para>
 356           <para>
 357             You can use this option in order to merge the available dictionaries.
 358             &kmouth; will ask you which dictionaries should be merged and how the
 359             individual dictionaries should be weighted.
 360           </para>
 361         </listitem>
 362         <listitem>
 363           <para>Create an empty word list</para>
 364           <para>
 365             You can use this option in order to create a blank dictionary without
 366             any entries. As &kmouth; automatically adds newly typed words to the
 367             dictionaries it will learn your vocabulary with the time.
 368           </para>
 369         </listitem>
 370       </itemizedlist>
 371     </sect2>
 372     <sect2 id="kttsd-speech-service-config">
 373       <title>The <guilabel>KTTSD Speech Service</guilabel> page</title>
 374       <para>The configuration of the &kde; Speech Service is described in detail in the
 375         <ulink url="help:kttsd">KTTS Handbook</ulink>.</para>
 376     </sect2>
 377   </sect1>
 378   <sect1 id="phrasebook-editor">
 379     <title>The Phrase Book Edit Window</title>
 380     <para>
 381       By using the menu entry
 382       <menuchoice>
 383         <guimenu>Phrase Books</guimenu><guimenuitem>Edit...</guimenuitem>
 384       </menuchoice>
 385       you open the phrase book edit window.
 386     </para>
 387     <para>
 388       <screenshot>
 389         <screeninfo>The phrase book edit window</screeninfo>
 390         <mediaobject>
 391           <imageobject>
 392             <imagedata fileref="kmouthedit.png" format="PNG"/>
 393           </imageobject>
 394           <imageobject>
 395             <imagedata fileref="kmouthedit.eps" format="EPS"/>
 396           </imageobject>
 397           <textobject>
 398             <phrase>Screens hot</phrase>
 399           </textobject>
 400         </mediaobject>
 401       </screenshot>
 402     </para>
 403     <para>
 404       The main area of the phrase book edit window is divided into two parts.
 405       Within the upper part the phrase books are displayed in some tree
 406       structure.
 407     </para>
 408     <para>
 409       Within the lower part you may modify a selected item. If you have
 410       selected a phrase you can modify the contents of the phrase as well
 411       as its shortcut. If you have selected a phrase book you can only
 412       change its name.
 413     </para>
 414     <para>
 415       Actions like adding new phrases and phrase books and deleting selected
 416       phrases and phrase books can be done by selecting them in either the
 417       menu bar, the toolbar or a pop up menu.
 418     </para>
 419     <para>
 420       You can change the order of the phrase books and phrases by dragging
 421       them to their new places or by using the arrow keys while the
 422       &Alt; key is pressed.
 423     </para>
 424   </sect1>
 425
 426 </chapter>
 427
 428 <chapter id="commands">
 429   <title>Command Reference</title>
 430
 431   <sect1 id="main-commands">
 432     <title>Commands Within The Main Window</title>
 433     <sect2 id="file-menu">
 434       <title>The <guimenu>File</guimenu> Menu</title>
 435         <variablelist>
 436           <varlistentry>
 437             <term><menuchoice>
 438               <shortcut>
 439                 <keycombo>&Ctrl;<keycap>O</keycap></keycombo>
 440               </shortcut>
 441               <guimenu>File</guimenu>
 442               <guimenuitem>Open as History...</guimenuitem>
 443             </menuchoice></term>
 444             <listitem><para><action>Opens a text file into as history of spoken sentences.</action></para></listitem>
 445           </varlistentry>
 446           <varlistentry>
 447             <term><menuchoice>
 448               <shortcut>
 449                 <keycombo>&Ctrl;<keycap>S</keycap></keycombo>
 450               </shortcut>
 451               <guimenu>File</guimenu>
 452               <guimenuitem>Save History As...</guimenuitem>
 453             </menuchoice></term>
 454             <listitem><para><action>Saves the history into a text file.</action></para></listitem>
 455           </varlistentry>
 456           <varlistentry>
 457             <term><menuchoice>
 458               <shortcut>
 459                 <keycombo>&Ctrl;<keycap>P</keycap></keycombo>
 460               </shortcut>
 461               <guimenu>File</guimenu>
 462               <guimenuitem>Print History...</guimenuitem>
 463             </menuchoice></term>
 464             <listitem><para><action>Prints the history.</action></para></listitem>
 465           </varlistentry>
 466           <varlistentry>
 467             <term><menuchoice>
 468               <shortcut>
 469                 <keycombo>&Ctrl;<keycap>Q</keycap></keycombo>
 470               </shortcut>
 471               <guimenu>File</guimenu>
 472               <guimenuitem>Quit</guimenuitem>
 473             </menuchoice></term>
 474             <listitem><para><action>Quits &kmouth;</action></para></listitem>
 475           </varlistentry>
 476         </variablelist>
 477     </sect2>
 478
 479     <sect2 id="edit-menu">
 480       <title>The <guimenu>Edit</guimenu> Menu</title>
 481         <variablelist>
 482           <varlistentry>
 483             <term><menuchoice>
 484               <shortcut>
 485                 <keycombo>&Ctrl;<keycap>X</keycap></keycombo>
 486               </shortcut>
 487               <guimenu>Edit</guimenu>
 488               <guimenuitem>Cut</guimenuitem>
 489             </menuchoice></term>
 490             <listitem><para><action>
 491               Cuts the selected section and puts it to the clipboard. If there
 492               is some text selected in the edit field it is placed it on the
 493               clipboard. Otherwise the selected sentences in the history (if
 494               any) are placed on the clipboard.
 495             </action></para></listitem>
 496           </varlistentry>
 497           <varlistentry>
 498             <term><menuchoice>
 499               <shortcut>
 500                 <keycombo>&Ctrl;<keycap>C</keycap></keycombo>
 501               </shortcut>
 502               <guimenu>Edit</guimenu>
 503               <guimenuitem>Copy</guimenuitem>
 504             </menuchoice></term>
 505             <listitem><para><action>
 506               Copies the selected section to the clipboard. If there is some
 507               text selected in the edit field it is copied to the clipboard.
 508               Otherwise the selected sentences in the history (if any) are
 509               copied to the clipboard.
 510             </action></para></listitem>
 511           </varlistentry>
 512           <varlistentry>
 513             <term><menuchoice>
 514               <shortcut>
 515                 <keycombo>&Ctrl;<keycap>V</keycap></keycombo>
 516               </shortcut>
 517               <guimenu>Edit</guimenu>
 518               <guimenuitem>Paste</guimenuitem>
 519             </menuchoice></term>
 520             <listitem><para><action>
 521               Pastes the clipboard contents at the current cursor position into
 522               the edit field.
 523             </action></para></listitem>
 524           </varlistentry>
 525           <varlistentry>
 526             <term><menuchoice>
 527               <guimenu>Edit</guimenu>
 528               <guimenuitem>Speak</guimenuitem>
 529             </menuchoice></term>
 530             <listitem><para><action>
 531               Speaks the currently active sentence(s). If there is some text in
 532               the edit field it is spoken. Otherwise the selected sentences in
 533               the history (if any) are spoken.
 534             </action></para></listitem>
 535           </varlistentry>
 536         </variablelist>
 537     </sect2>
 538
 539     <sect2 id="phrasebooks-menu">
 540       <title>The <guimenu>Phrase Books</guimenu> Menu</title>
 541         <variablelist>
 542           <varlistentry>
 543             <term><menuchoice>
 544               <guimenu>Phrase Books</guimenu>
 545               <guimenuitem>Edit...</guimenuitem>
 546             </menuchoice></term>
 547             <listitem><para>
 548               Opens the <link linkend="phrasebook-editor">phrase book edit window</link>.
 549             </para></listitem>
 550           </varlistentry>
 551         </variablelist>
 552     </sect2>
 553
 554     <sect2 id="settings-menu">
 555       <title>The <guimenu>Settings</guimenu> Menu</title>
 556         <variablelist>
 557           <varlistentry>
 558             <term><menuchoice>
 559               <shortcut>
 560                 <keycombo>&Ctrl;<keycap>M</keycap></keycombo>
 561               </shortcut>
 562                <guimenu>Settings</guimenu>
 563               <guimenuitem>Show Menubar</guimenuitem>
 564             </menuchoice></term>
 565             <listitem><para><action>
 566                 When checked, this displays the menubar. When unchecked the
 567                 menubar is hidden.
 568             </action></para></listitem>
 569           </varlistentry>
 570           <varlistentry>
 571             <term><menuchoice>
 572               <guimenu>Settings</guimenu>
 573               <guimenuitem>Show Toolbar</guimenuitem>
 574             </menuchoice></term>
 575             <listitem><para>
 576               <action>
 577                 When checked, this displays a movable toolbar containing
 578                 buttons used to initiate frequently used commands. The toolbar
 579                 is most commonly located at the top of the editor just under
 580                 the menu. When unchecked the toolbar is hidden.
 581               </action>
 582               Clicking on the striated grip and dragging allows the user to move
 583               the bar.
 584             </para></listitem>
 585           </varlistentry>
 586           <varlistentry>
 587             <term><menuchoice>
 588               <guimenu>Settings</guimenu>
 589               <guimenuitem>Show Statusbar</guimenuitem>
 590             </menuchoice></term>
 591             <listitem><para><action>
 592               When checked, this displays a small bar at the bottom of the
 593               main window containing information about the status of
 594               &kmouth;. When unchecked the status bar is hidden.
 595             </action></para></listitem>
 596           </varlistentry>
 597           <varlistentry>
 598             <term><menuchoice>
 599               <guimenu>Settings</guimenu>
 600               <guimenuitem>Show Phrasebook Bar</guimenuitem>
 601             </menuchoice></term>
 602             <listitem><para>
 603               <action>
 604                 When checked, this displays a movable phrasebook bar containing
 605                 buttons for the phrasebook entries. The phrasebook bar
 606                 is most commonly located at the top of the editor just under
 607                 the toolbar. When unchecked the phrasebook bar is hidden.
 608               </action>
 609               Clicking on the striated grip and dragging allows the user to move
 610               the bar.
 611             </para></listitem>
 612           </varlistentry>
 613           <varlistentry>
 614             <term><menuchoice>
 615               <guimenu>Settings</guimenu>
 616               <guimenuitem>Configure KMouth...</guimenuitem>
 617             </menuchoice></term>
 618             <listitem><para>
 619               Opens the <link linkend="config-dialog">configuration dialog for
 620               the speech synthesizer</link> and other &kmouth; settings.
 621             </para></listitem>
 622           </varlistentry>
 623         </variablelist>
 624     </sect2>
 625
 626     <sect2 id="help-menu">
 627       <title>The <guimenu>Help</guimenu> Menu</title>
 628       &help.menu.documentation;
 629     </sect2>
 630
 631     <sect2 id="popup-menu">
 632       <title>The pop up menu of history entries</title>
 633         <variablelist>
 634           <varlistentry>
 635             <term><menuchoice>
 636               <guimenuitem>Speak</guimenuitem>
 637             </menuchoice></term>
 638             <listitem><para><action>
 639               The selected sentences are spoken.
 640             </action></para></listitem>
 641           </varlistentry>
 642           <varlistentry>
 643             <term><menuchoice>
 644               <guimenuitem>Delete</guimenuitem>
 645             </menuchoice></term>
 646             <listitem><para><action>
 647               The selected sentences are removed from the history.
 648             </action></para></listitem>
 649           </varlistentry>
 650           <varlistentry>
 651             <term><menuchoice>
 652               <guimenuitem>Cut</guimenuitem>
 653             </menuchoice></term>
 654             <listitem><para><action>
 655               The selected sentences are deleted and placed on the clipboard.
 656             </action></para></listitem>
 657           </varlistentry>
 658           <varlistentry>
 659             <term><menuchoice>
 660               <guimenuitem>Copy</guimenuitem>
 661             </menuchoice></term>
 662             <listitem><para><action>
 663               The selected sentences are copied to the clipboard.
 664             </action></para></listitem>
 665           </varlistentry>
 666           <varlistentry>
 667             <term><menuchoice>
 668               <guimenuitem>Select All Entries</guimenuitem>
 669             </menuchoice></term>
 670             <listitem><para><action>
 671               All history entries are selected.
 672             </action></para></listitem>
 673           </varlistentry>
 674           <varlistentry>
 675             <term><menuchoice>
 676               <guimenuitem>Deselect All Entries</guimenuitem>
 677             </menuchoice></term>
 678             <listitem><para><action>
 679               All history entries are deselected.
 680             </action></para></listitem>
 681           </varlistentry>
 682           <varlistentry>
 683             <term><menuchoice>
 684               <shortcut><keycombo>&Ctrl;<keycap>O</keycap></keycombo></shortcut>
 685               <guimenuitem>Open as History...</guimenuitem>
 686             </menuchoice></term>
 687             <listitem><para><action>
 688               Opens a text file into as history of spoken sentences.
 689             </action></para></listitem>
 690           </varlistentry>
 691           <varlistentry>
 692             <term><menuchoice>
 693 <shortcut><keycombo>&Ctrl;<keycap>S</keycap></keycombo></shortcut>
 694               <guimenuitem>Save History As...</guimenuitem>
 695             </menuchoice></term>
 696             <listitem><para><action>
 697               Saves the history into a text file.
 698             </action></para></listitem>
 699           </varlistentry>
 700         </variablelist>
 701     </sect2>
 702   </sect1>
 703
 704   <sect1 id="pb-editor-commands">
 705     <title>Commands within the phrase book edit window</title>
 706     <sect2 id="pbe-file-menu">
 707       <title>The <guimenu>File</guimenu> Menu</title>
 708         <variablelist>
 709           <varlistentry>
 710             <term><menuchoice>
 711               <guimenu>File</guimenu>
 712               <guimenuitem>New Phrase</guimenuitem>
 713             </menuchoice></term>
 714             <listitem><para><action>Adds a new phrase.</action></para></listitem>
 715           </varlistentry>
 716           <varlistentry>
 717             <term><menuchoice>
 718               <guimenu>File</guimenu>
 719               <guimenuitem>New Phrase Book</guimenuitem>
 720             </menuchoice></term>
 721             <listitem><para><action>Adds a new phrase book.</action></para></listitem>
 722           </varlistentry>
 723           <varlistentry>
 724             <term><menuchoice>
 725               <shortcut>
 726                 <keycombo>&Ctrl;<keycap>S</keycap></keycombo>
 727               </shortcut>
 728               <guimenu>File</guimenu>
 729               <guimenuitem>Save</guimenuitem>
 730             </menuchoice></term>
 731             <listitem><para><action>Saves the phrase book.</action></para></listitem>
 732           </varlistentry>
 733           <varlistentry>
 734             <term><menuchoice>
 735               <guimenu>File</guimenu>
 736               <guimenuitem>Import...</guimenuitem>
 737             </menuchoice></term>
 738             <listitem><para><action>Imports a file and adds its contents to the phrase book</action></para></listitem>
 739           </varlistentry>
 740           <varlistentry>
 741             <term><menuchoice>
 742               <guimenu>File</guimenu>
 743               <guimenuitem>Import Standard Phrase Book</guimenuitem>
 744             </menuchoice></term>
 745             <listitem><para><action>Imports a standard phrase book and adds its contents to the phrase book</action></para></listitem>
 746           </varlistentry>
 747           <varlistentry>
 748             <term><menuchoice>
 749               <guimenu>File</guimenu>
 750               <guimenuitem>Export...</guimenuitem>
 751             </menuchoice></term>
 752             <listitem><para><action>Exports the currently selected phrase(s) or phrase book(s) to a file</action></para></listitem>
 753           </varlistentry>
 754           <varlistentry>
 755             <term><menuchoice>
 756               <shortcut>
 757                 <keycombo>&Ctrl;<keycap>P</keycap></keycombo>
 758               </shortcut>
 759               <guimenu>File</guimenu>
 760               <guimenuitem>Print...</guimenuitem>
 761             </menuchoice></term>
 762             <listitem><para><action>Prints the currently selected phrase(s) or phrase book(s)</action></para></listitem>
 763           </varlistentry>
 764           <varlistentry>
 765             <term><menuchoice>
 766               <shortcut>
 767                 <keycombo>&Ctrl;<keycap>W</keycap></keycombo>
 768               </shortcut>
 769               <guimenu>File</guimenu>
 770               <guimenuitem>Close</guimenuitem>
 771             </menuchoice></term>
 772             <listitem><para><action>Closes the window</action></para></listitem>
 773           </varlistentry>
 774         </variablelist>
 775     </sect2>
 776
 777     <sect2 id="pbe-edit-menu">
 778       <title>The <guimenu>Edit</guimenu> Menu</title>
 779         <variablelist>
 780           <varlistentry>
 781             <term><menuchoice>
 782               <shortcut>
 783                 <keycombo>&Ctrl;<keycap>X</keycap></keycombo>
 784               </shortcut>
 785               <guimenu>Edit</guimenu>
 786               <guimenuitem>Cut</guimenuitem>
 787             </menuchoice></term>
 788             <listitem><para><action>
 789               Cuts the selected items and puts it to the clipboard.
 790             </action></para></listitem>
 791           </varlistentry>
 792           <varlistentry>
 793             <term><menuchoice>
 794               <shortcut>
 795                 <keycombo>&Ctrl;<keycap>C</keycap></keycombo>
 796               </shortcut>
 797               <guimenu>Edit</guimenu>
 798               <guimenuitem>Copy</guimenuitem>
 799             </menuchoice></term>
 800             <listitem><para><action>
 801               Copies the selected items to the clipboard.
 802             </action></para></listitem>
 803           </varlistentry>
 804           <varlistentry>
 805             <term><menuchoice>
 806               <shortcut>
 807                 <keycombo>&Ctrl;<keycap>V</keycap></keycombo>
 808               </shortcut>
 809               <guimenu>Edit</guimenu>
 810               <guimenuitem>Paste</guimenuitem>
 811             </menuchoice></term>
 812             <listitem><para><action>
 813               Pastes the clipboard contents into the phrase book.
 814             </action></para></listitem>
 815           </varlistentry>
 816           <varlistentry>
 817             <term><menuchoice>
 818               <guimenu>Edit</guimenu>
 819               <guimenuitem>Delete</guimenuitem>
 820             </menuchoice></term>
 821             <listitem><para><action>
 822               Deletes the selected items.
 823             </action></para></listitem>
 824           </varlistentry>
 825         </variablelist>
 826     </sect2>
 827
 828     <sect2 id="pbe-help-menu">
 829       <title>The <guimenu>Help</guimenu> Menu</title>
 830       &help.menu.documentation;
 831     </sect2>
 832
 833     <sect2 id="pbe-popup-menu">
 834       <title>The Pop up Menu</title>
 835         <variablelist>
 836           <varlistentry>
 837             <term><menuchoice>
 838               <guimenuitem>New Phrase</guimenuitem>
 839             </menuchoice></term>
 840             <listitem><para><action>Adds a new phrase.</action></para></listitem>
 841           </varlistentry>
 842           <varlistentry>
 843             <term><menuchoice>
 844               <guimenuitem>New Phrase Book</guimenuitem>
 845             </menuchoice></term>
 846             <listitem><para><action>Adds a new phrase book.</action></para></listitem>
 847           </varlistentry>
 848           <varlistentry>
 849             <term><menuchoice>
 850               <guimenuitem>Import...</guimenuitem>
 851             </menuchoice></term>
 852             <listitem><para><action>Imports a file and adds its contents to the phrase book</action></para></listitem>
 853           </varlistentry>
 854           <varlistentry>
 855             <term><menuchoice>
 856               <guimenuitem>Import Standard Phrase Book</guimenuitem>
 857             </menuchoice></term>
 858             <listitem><para><action>Imports a standard phrase book and adds its contents to the phrase book</action></para></listitem>
 859           </varlistentry>
 860           <varlistentry>
 861             <term><menuchoice>
 862               <guimenuitem>Export...</guimenuitem>
 863             </menuchoice></term>
 864             <listitem><para><action>Exports the currently selected phrase(s) or phrase book(s) to a file</action></para></listitem>
 865           </varlistentry>
 866           <varlistentry>
 867             <term><menuchoice>
 868               <shortcut>
 869                 <keycombo>&Ctrl;<keycap>X</keycap></keycombo>
 870               </shortcut>
 871                <guimenuitem>Cut</guimenuitem>
 872             </menuchoice></term>
 873             <listitem><para><action>
 874               Cuts the selected items and puts it to the clipboard.
 875             </action></para></listitem>
 876           </varlistentry>
 877           <varlistentry>
 878             <term><menuchoice>
 879               <shortcut>
 880                 <keycombo>&Ctrl;<keycap>C</keycap></keycombo>
 881               </shortcut>
 882               <guimenuitem>Copy</guimenuitem>
 883             </menuchoice></term>
 884             <listitem><para><action>
 885               Copies the selected items to the clipboard.
 886             </action></para></listitem>
 887           </varlistentry>
 888           <varlistentry>
 889             <term><menuchoice>
 890               <shortcut>
 891                 <keycombo>&Ctrl;<keycap>V</keycap></keycombo>
 892               </shortcut>
 893               <guimenuitem>Paste</guimenuitem>
 894             </menuchoice></term>
 895             <listitem><para><action>
 896               Pastes the clipboard contents at this position into the phrase book.
 897             </action></para></listitem>
 898           </varlistentry>
 899           <varlistentry>
 900             <term><menuchoice>
 901               <guimenuitem>Delete</guimenuitem>
 902             </menuchoice></term>
 903             <listitem><para><action>
 904               Deletes the selected items.
 905             </action></para></listitem>
 906           </varlistentry>
 907         </variablelist>
 908     </sect2>
 909   </sect1>
 910
 911 </chapter>
 912
 913 <chapter id="faq">
 914   <title>Questions and Answers</title>
 915
 916   &reporting.bugs;
 917   &updating.documentation;
 918
 919   <qandaset id="faqlist">
 920     <qandaentry>
 921       <question>
 922         <para>I do not hear anything.</para>
 923       </question>
 924       <answer>
 925         <para>
 926           Most likely you did not configure correctly (or not at all?) the
 927           text-to-speech command. Use
 928           <menuchoice>
 929             <guimenu>Settings</guimenu><guimenuitem>Configure &kmouth;...</guimenuitem>
 930           </menuchoice>, open the page <guilabel>General Options</guilabel>
 931           and enter the command for speaking texts on the tab <guilabel>Text-to-Speech</guilabel>.
 932           (See section about the <link linkend="tts-config">configuration
 933           dialog for the speech synthesizer</link> for more details.)
 934         </para>
 935       </answer>
 936     </qandaentry>
 937   </qandaset>
 938 </chapter>
 939
 940 <chapter id="credits">
 941   <title>Credits and License</title>
 942
 943   <para>
 944     &kappname;
 945   </para>
 946   <para>
 947     Program copyright 2002-2004 Gunnar Schmi Dt<email>gunnar@schmi-dt.de</email>
 948   </para>
 949   <para>
 950     Documentation copyright 2002-2004 Gunnar Schmi Dt <email>gunnar@schmi-dt.de</email>
 951   </para>
 952
 953   <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 954
 955   &underFDL;
 956   &underGPL;
 957 </chapter>
 958
 959 <appendix id="tts">
 960   <title>Examples for the text-to-speech configuration</title>
 961   <qandaset id="ttslist">
 962     <qandaentry>
 963       <question>
 964         <para>Festival</para>
 965       </question>
 966       <answer>
 967         <para>
 968           Festival is a text-to-speech system written from the University of
 969           Edinburgh. It currently supports English, Spanish and Welsh speech.
 970           Its license allows to use and distribute Festival free of charge
 971           without restrictions.
 972         </para>
 973         <para>
 974           In order to create the command line example for the text-to-speech
 975           configuration we assume that Festival is installed in the directory
 976           <filename class="directory">/usr/local/festival/</filename>. The
 977           command for speaking texts then is as follows:
 978         </para>
 979         <para>
 980           <screen><userinput><command>/usr/local/festival/bin/festival</command> <option>--tts</option></userinput></screen>
 981         </para>
 982         <para>
 983           The option <guilabel>Send the data as standard input</guilabel> must
 984           be enabled.
 985         </para>
 986       </answer>
 987     </qandaentry>
 988     <qandaentry>
 989       <question>
 990         <para>FreeTTS</para>
 991       </question>
 992       <answer>
 993         <para>
 994           FreeTTS is a speech synthesizer written entirely in the &Java;™
 995           programming language. It currently only has support for English
 996           pronounciation. Its license allows to use and distribute FreeTTS
 997           free of charge without restrictions.
 998         </para>
 999         <para>
1000           In order to create the command line example for the text-to-speech
1001           configuration we assume that FreeTTS is installed in the directory
1002           <filename class="directory">/usr/local/freetts/</filename>. The
1003           command for speaking texts then one of the following three examples:
1004         </para>
1005         <para>
1006           <screen><userinput><command>java</command> <option>-jar /usr/local/freetts/lib/freetts.jar</option> <option>-text %t</option></userinput></screen>
1007         </para>
1008         <para>
1009           <screen><userinput><command>java</command> <option>-jar /usr/local/freetts/lib/freetts.jar</option> <option>-file %f</option></userinput></screen>
1010         </para>
1011         <para>
1012           <screen><userinput><command>java</command> <option>-jar /usr/local/freetts/lib/freetts.jar</option></userinput></screen>
1013         </para>
1014         <para>
1015           For the third example the option <guilabel>Send the data as standard
1016           input</guilabel> must be enabled. (This one is the preferred example
1017           for the use with FreeTTS.)
1018         </para>
1019       </answer>
1020     </qandaentry>
1021     <qandaentry>
1022       <question>
1023         <para>MBROLA</para>
1024       </question>
1025       <answer>
1026         <para>
1027           MBROLA is a speech synthesizer for a large number of languages. It
1028           converts a list of phonemes to a wave file, so you need some other
1029           tool to convert the text into a list of phonemes. The license of
1030           MBROLA allows to use and MBROLA free of charge for non-commercial,
1031           non-military applications.
1032         </para>
1033         <para>
1034           For our example we will use Hadifax in order to convert German texts
1035           into a list of phonemes suitable for MBROLA. We will assume that
1036           Hadifax and MBROLA are installed to
1037           <filename class="directory">/usr/local/hadifax/</filename> and
1038           <filename class="directory">/usr/local/mbrola/</filename>.
1039         </para>
1040         <para>
1041           Unfortunately Hadifax tends to swallow the last character of the text,
1042           so we may want to add an additional character to the text. The complete
1043           command is therefore more complex than the previous examples:
1044         </para>
1045         <para>
1046           <screen><userinput>(<command>cat</command> <option>-</option>; <command>echo</command> <option>&quot; &quot;</option>) | <command>/usr/local/hadifax/txt2pho</command> <option>-f</option>
1047           | <command>/usr/local/mbrola/mbrola</command> <option>-e</option>
1048           <option>/usr/local/mbrola/de1/de1 - /tmp/tmp.wav</option>;
1049           <command>artsplay</command> <option>/tmp/tmp.wav</option>; <command>rm</command> <option>/tmp/tmp.wav</option></userinput></screen>
1050         </para>
1051         <para>
1052           All parts of this command need to be written into one line. The option
1053           <guilabel>Send the data as standard input</guilabel> must be enabled.
1054         </para>
1055       </answer>
1056     </qandaentry>
1057     <qandaentry>
1058       <question>
1059         <para>The &kde; Text-to-Speech Daemon</para>
1060       </question>
1061       <answer>
1062         <para>
1063           The &kde; Text-to-Speech Daemon (KTTSD) is a &kde; wide text-to-speech service
1064           which gives &kde; applications a standardized interface for speech synthesis
1065           and is currently developed in <acronym>SVN</acronym>. It uses plug-ins in
1066           order to support various text-to-speech systems.
1067         </para>
1068         <para>
1069           As the configuration of the speech synthesizer is done in KTTSD the only
1070           &kmouth;-specific option you need to activate is <guilabel>Use KTTSD speech
1071           service if possible</guilabel>.
1072         </para>
1073         <para>
1074           Of course you need to configure KTTSD. You may do this with the configuration
1075           page <guilabel>KTTSD Speech Service</guilabel> that is added to the configuration
1076           dialog of &kmouth; if KTTSD is installed.
1077         </para>
1078       </answer>
1079     </qandaentry>
1080   </qandaset>
1081 </appendix>
1082
1083 <appendix id="installation">
1084   <title>Installation</title>
1085
1086   <sect1 id="getting-kmouth">
1087     <title>How to obtain &kmouth;</title>
1088
1089   &install.intro.documentation;
1090
1091   </sect1>
1092
1093   <sect1 id="requirements">
1094     <title>Requirements</title>
1095
1096     <para>
1097       In order to successfully use &kmouth;, you need a speech synthesizer
1098       (and of course &kde; 3.x). &kmouth; uses about 15 MB of memory to
1099       run (plus the amount of memory needed by your speech synthesizer),
1100       but this may vary depending on your platform and configuration.
1101     </para>
1102   </sect1>
1103
1104
1105   <sect1 id="compilation">
1106   <title>Compilation and Installation</title>
1107
1108   &install.compile.documentation;
1109
1110   </sect1>
1111 </appendix>
1112
1113 </book>
1114 <!--
1115 Local Variables:
1116 mode: sgml
1117 sgml-minimize-attributes:nil
1118 sgml-general-insert-case:lower
1119 sgml-indent-step:0
1120 sgml-indent-data:nil
1121 End:
1122 -->