cthulhu/help/C/preferences_key_echo.page

<page xmlns="http://projectmallard.org/1.0/" type="topic" id="preferences_key_echo">
  <info>
    <title type="link">Echo</title>
    <title type="sort">4. Echo</title>
    <desc>
      Configuring what is spoken as you type
    </desc>
    <link type="guide" xref="preferences#cthulhu" />
    <link type="next" xref="preferences_key_bindings" />
    <credit type="author">
      <name>Joanmarie Diggs</name>
      <email>joanied@gnome.org</email>
    </credit>
    <license>
      <p>Creative Commons Share Alike 3.0</p>
    </license>
  </info>
  <title>Echo Preferences</title>
  <section id="keyecho">
    <title>Enable key echo</title>
    <p>
      Cthulhu's key echo setting controls what happens each time you press
      a key. To enable key echo, check the "Enable key echo" checkbox.
      Doing so causes additional checkboxes to become available through
      which you can choose exactly which keys should and should not be
      echoed to best suit your needs.
    </p>
    <p>
      Default value: checked
    </p>  
    <section id="keyecho_enable_alphanumeric">
      <title>Enable alphabetic keys</title>
      <p>
        This option controls whether or not keys like <key>a</key>,
        <key>b</key>, and <key>c</key> should be spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_numeric">
      <title>Enable numeric keys</title>
      <p>
        This option controls whether or not keys like <key>1</key>,
        <key>2</key>, and <key>3</key> should be spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_punctuation">
      <title>Enable punctuation keys</title>
      <p>
        This option controls whether or not keys like <key>%</key>,
        <key>;</key>, and <key>?</key> should be spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_space">
      <title>Enable space</title>
      <p>
        This option controls whether or not <key>Space</key> should be
        spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_modifier">
      <title>Enable modifier keys</title>
      <p>
        This option controls whether or not <key>Shift</key>, <key>Ctrl</key>,
        <key>Alt</key> and <key>Meta</key> should be spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_function">
      <title>Enable function keys</title>
      <p>
        This option controls whether or not <key>F1</key> through <key>F12</key>
        should be spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_action">
      <title>Enable action keys</title>
      <p>
        This option controls whether or not <key>BackSpace</key>, <key>Delete
        </key>, <key>Return</key>, <key>Esc</key>, <key>Tab</key>, <key>Page
        Up</key>, <key>Page Down</key>, <key>Home</key>, and <key>End</key>
        should be spoken when pressed.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="keyecho_enable_navigation">
      <title>Enable navigation keys</title>
      <p>
        This option controls whether or not <key>Left</key>, <key>Right</key>,
        <key>Up</key>, and <key>Down</key> should be spoken when pressed. This
        option also applies to any key combination in which <key>Cthulhu
        Modifier</key> is being held down, for instance when flat review is
        being used.
      </p>
      <p>
        Default value: not checked
      </p>
    </section>
    <section id="keyecho_enable_diacritical">
      <title>Enable non-spacing diacritical keys</title>
      <p>
        This option controls whether or not "dead keys" used to generate
        accented letters should be spoken when pressed.
      </p>
      <p>
        Default value: not checked
      </p>
    </section>
  </section>
  <section id="characterecho">
    <title>Enable echo by character</title>
    <p>
      Enabling this option causes Cthulhu to echo the character
      you just typed.
    </p>
    <p>
      While echo by character seems quite similar to the key echo of
      alphabetic, numeric, and punctuation keys, there are important differences,
      especially with respect to accented letters and other symbols for which
      there is no dedicated key:
    </p>
    <list>
      <item>
        <p>
          Key echo causes <app>Cthulhu</app> to announce what you just <em>
          pressed</em>.
        </p>
      </item>
      <item>
        <p>
          Character echo causes <app>Cthulhu</app> to announce what was just
          <em>inserted</em>.
        </p>
      </item>
    </list>
    <p>
      Thus to have accented characters spoken as you type them, you should
      enable character echo.
    </p>
    <p>
      Default value: not checked
    </p>
    <note style="tip">
      <title>Enabling both key echo and character echo</title>
      <p>
        If you like key echo and you frequently type accented characters,
        consider enabling both. <app>Cthulhu</app>'s character echo logic
        attempts to filter out characters which were spoken as a result
        of key echo, thus minimizing the likelihood of "double speaking"
        as you type.
      </p>
    </note>
  </section>
  <section id="wordandsentenceecho">
    <title>Enable echo by word and Enable echo by sentence</title>
    <p>
      Checking the <gui>Enable echo by word</gui> checkbox causes
      <app>Cthulhu</app> to echo the word you just typed. Similarly,
      checking the <gui>Enable echo by sentence</gui> checkbox causes
      <app>Cthulhu</app> to echo the sentence you just typed.
    </p>
    <p>
      Default value: not checked
    </p>
  </section>
</page>