cthulhu/help/C/preferences_braille.page

<page xmlns="http://projectmallard.org/1.0/" type="topic" id="preferences_braille">
  <info>
    <title type="sort">3. Braille</title>
    <title type="link">Braille</title>
    <desc>
      Configuring <app>Cthulhu</app>'s braille display support
    </desc>
    <link type="guide" xref="preferences#cthulhu" />
    <link type="next" xref="preferences_key_echo" />
    <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>Braille Preferences</title>
  <section id="braillesupport">
    <title>Enable Braille Support</title>
    <p>
      This check box toggles whether or not <app>Cthulhu</app> will make
      use of a braille display. If BrlTTY is not running, <app>Cthulhu</app>
      will recover gracefully and will not communicate with the braille
      display.
    </p>
    <p>
      Default value: not checked
    </p>
    <note style="tip">
      <p>
        If you configure BrlTTY later on, you need to restart <app>Cthulhu</app>
        in order to use braille.
      </p>
    </note>
  </section>
  <section id="braillewordwrap">
    <title>Enable word wrap</title>
    <p>
      If <gui>Enable word wrap</gui> is checked, <app>Cthulhu</app> will adjust the
      text so that only full words are shown on the braille display. If it is not
      checked, <app>Cthulhu</app> will use all of the cells on the display so that
      more text can be shown at once.
    </p>
    <p>
      Default value: not checked
    </p>
  </section>
  <section id="contractedbraille">
    <title>Enable Contracted Braille</title>
    <p>
      Cthulhu supports contracted braille via the liblouis project. Because many
      distros include liblouis, you will likely automatically have access to
      contracted braille support in <app>Cthulhu</app>.
    </p>
    <p>
      To enable contracted braille on a system where liblouis has been installed,
      be sure that the <gui>Enable Contracted Braille</gui> checkbox is checked.
      Then choose your desired translation table from the <gui>Contraction
      Table</gui> combo box.
    </p>
    <p>
      Default value: not checked
    </p>
  </section>
  <section id="rolenames">
    <title>Abbreviated Role Names</title>
    <p>
      This check box determines the manner in which role names are
      displayed and can be used to help conserve real estate on the
      braille display. For instance, if a slider had focus, the word
      "slider" would be displayed if abbreviated role names is not
      checked; if it were checked, "sldr" would be displayed instead.
    </p>
    <p>
      Default value: not checked
    </p>
  </section>
  <section id="eolindicator">
    <title>Disable end of line symbol</title>
    <p>
      Checking this checkbox tells <app>Cthulhu</app> to not present the
      "$l" string at the end of a line of text.
    </p>
    <p>
      Default value: not checked
    </p>
  </section>
  <section id="verbosity">
    <title>Verbosity</title>
    <p>
      This radio button group determines the amount of information that
      will be brailled in certain situations. For example, if it is set
      to verbose, keyboard shortcut and role name information is displayed.
      This information is not displayed in brief mode.
    </p>
    <p>
      Default value: <gui>Verbose</gui>
    </p>
  </section>
  <section id="selectionandhyperlink">
    <title>Selection and Hyperlink Indicators</title>
    <p>
      The <gui>Selection Indicator</gui> and <gui>Hyperlink Indicator</gui>
      radio button groups allow you to configure <app>Cthulhu</app>'s behavior
      when displaying selected text and hyperlinks. By default, when you
      encounter either, <app>Cthulhu</app> will "underline" that text on
      your braille display with Dots 7 and 8. If you would prefer, you
      can change the indicator to only be Dot 7, only be Dot 8, or not
      be present at all.
    </p>
    <p>
      Default value: <gui>Dots 7 and 8</gui>
    </p>
    <note style="tip">
      <title>Text Attribute Indicators</title>
      <p>
        You can also optionally have text attributes indicated in braille.
        Enabling this feature and choosing which attributes are of
        interest is done on the <link xref="preferences_text_attributes">
        <gui>Text Attributes</gui> page</link> of the preferences dialog.
      </p>
    </note>
  </section>
  <section id="flashMessageSettings">
    <title>Flash Message Settings</title>
    <p>
        Flash messages are similar in nature to notifications or announcements:
        They are shown on your refreshable braille display for a brief time,
        after which the original contents of the braille display are restored.
        <app>Cthulhu</app> has several settings you can use to control flash message
        presentation.
    </p>
    <section id="flashMessageSettings_enable">
      <title>Enable flash messages</title>
      <p>
        If <gui>Enable flash messages</gui> is checked, <app>Cthulhu</app> will
        present messages to you in braille. If you prefer to only have
        <app>Cthulhu</app>'s messages spoken, you should uncheck this checkbox.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="flashMessageSettings_detailed">
      <title>Messages are detailed</title>
      <p>
        If <gui>Messages are detailed</gui> is checked, <app>Cthulhu</app> will
        present detailed messages to you in braille. For instance, if you
        use <app>Cthulhu</app>'s command to change echo, <app>Cthulhu</app> might
        display "Echo set to word." If you would prefer shorter messages,
        such as simply "word," you should uncheck this checkbox.
      </p>
      <p>
        Default value: checked
      </p>
    </section>
    <section id="flashMessageSettings_persistent">
      <title>Messages are persistent</title>
      <p>
        As stated above, flash messages are only shown for a brief period of time.
        If you would prefer messages remain displayed until you perform an action
        which causes your display to be updated, you should check the <gui>Messages
        are persistent</gui> checkbox.
      </p>
      <p>
        Default value: not checked
      </p>
    </section>
    <section id="flashMessageSettings_duration">
      <title>Duration (secs)</title>
      <p>
        The amount of time <app>Cthulhu</app> will wait before removing the message and
        restoring the original contents of your display can be set in the <gui>
        Duration (secs)</gui> spin button. Note that the value of this
        setting will be ignored if you have enabled persistent flash messages.
      </p>
      <p>
        Default value: 5
      </p>
    </section>
  </section>
</page>