| 1 |
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="preferences_braille"> |
| 2 |
<info> |
| 3 |
<title type="sort">3. Braille</title> |
| 4 |
<title type="link">Braille</title> |
| 5 |
<desc> |
| 6 |
Configuring <app>Orca</app>'s braille display support |
| 7 |
</desc> |
| 8 |
<link type="guide" xref="preferences#orca" /> |
| 9 |
<link type="next" xref="preferences_key_echo" /> |
| 10 |
<credit type="author"> |
| 11 |
<name>Joanmarie Diggs</name> |
| 12 |
<email>[email protected]</email> |
| 13 |
</credit> |
| 14 |
<license> |
| 15 |
<p>Creative Commons Share Alike 3.0</p> |
| 16 |
</license> |
| 17 |
</info> |
| 18 |
<title>Braille Preferences</title> |
| 19 |
<section id="braillesupport"> |
| 20 |
<title>Enable Braille Support</title> |
| 21 |
<p> |
| 22 |
This check box toggles whether or not <app>Orca</app> will make |
| 23 |
use of a braille display. If BrlTTY is not running, <app>Orca</app> |
| 24 |
will recover gracefully and will not communicate with the braille |
| 25 |
display. |
| 26 |
</p> |
| 27 |
<p> |
| 28 |
Default value: not checked |
| 29 |
</p> |
| 30 |
<note style="tip"> |
| 31 |
<p> |
| 32 |
If you configure BrlTTY later on, you need to restart <app>Orca</app> |
| 33 |
in order to use braille. |
| 34 |
</p> |
| 35 |
</note> |
| 36 |
</section> |
| 37 |
<section id="braillewordwrap"> |
| 38 |
<title>Enable word wrap</title> |
| 39 |
<p> |
| 40 |
If <gui>Enable word wrap</gui> is checked, <app>Orca</app> will adjust the |
| 41 |
text so that only full words are shown on the braille display. If it is not |
| 42 |
checked, <app>Orca</app> will use all of the cells on the display so that |
| 43 |
more text can be shown at once. |
| 44 |
</p> |
| 45 |
<p> |
| 46 |
Default value: not checked |
| 47 |
</p> |
| 48 |
</section> |
| 49 |
<section id="contractedbraille"> |
| 50 |
<title>Enable Contracted Braille</title> |
| 51 |
<p> |
| 52 |
Orca supports contracted braille via the liblouis project. Because many |
| 53 |
distros include liblouis, you will likely automatically have access to |
| 54 |
contracted braille support in <app>Orca</app>. |
| 55 |
</p> |
| 56 |
<p> |
| 57 |
To enable contracted braille on a system where liblouis has been installed, |
| 58 |
be sure that the <gui>Enable Contracted Braille</gui> checkbox is checked. |
| 59 |
Then choose your desired translation table from the <gui>Contraction |
| 60 |
Table</gui> combo box. |
| 61 |
</p> |
| 62 |
<p> |
| 63 |
Default value: not checked |
| 64 |
</p> |
| 65 |
</section> |
| 66 |
<section id="rolenames"> |
| 67 |
<title>Abbreviated Role Names</title> |
| 68 |
<p> |
| 69 |
This check box determines the manner in which role names are |
| 70 |
displayed and can be used to help conserve real estate on the |
| 71 |
braille display. For instance, if a slider had focus, the word |
| 72 |
"slider" would be displayed if abbreviated role names is not |
| 73 |
checked; if it were checked, "sldr" would be displayed instead. |
| 74 |
</p> |
| 75 |
<p> |
| 76 |
Default value: not checked |
| 77 |
</p> |
| 78 |
</section> |
| 79 |
<section id="eolindicator"> |
| 80 |
<title>Disable end of line symbol</title> |
| 81 |
<p> |
| 82 |
Checking this checkbox tells <app>Orca</app> to not present the |
| 83 |
"$l" string at the end of a line of text. |
| 84 |
</p> |
| 85 |
<p> |
| 86 |
Default value: not checked |
| 87 |
</p> |
| 88 |
</section> |
| 89 |
<section id="verbosity"> |
| 90 |
<title>Verbosity</title> |
| 91 |
<p> |
| 92 |
This radio button group determines the amount of information that |
| 93 |
will be brailled in certain situations. For example, if it is set |
| 94 |
to verbose, keyboard shortcut and role name information is displayed. |
| 95 |
This information is not displayed in brief mode. |
| 96 |
</p> |
| 97 |
<p> |
| 98 |
Default value: <gui>Verbose</gui> |
| 99 |
</p> |
| 100 |
</section> |
| 101 |
<section id="selectionandhyperlink"> |
| 102 |
<title>Selection and Hyperlink Indicators</title> |
| 103 |
<p> |
| 104 |
The <gui>Selection Indicator</gui> and <gui>Hyperlink Indicator</gui> |
| 105 |
radio button groups allow you to configure <app>Orca</app>'s behavior |
| 106 |
when displaying selected text and hyperlinks. By default, when you |
| 107 |
encounter either, <app>Orca</app> will "underline" that text on |
| 108 |
your braille display with Dots 7 and 8. If you would prefer, you |
| 109 |
can change the indicator to only be Dot 7, only be Dot 8, or not |
| 110 |
be present at all. |
| 111 |
</p> |
| 112 |
<p> |
| 113 |
Default value: <gui>Dots 7 and 8</gui> |
| 114 |
</p> |
| 115 |
<note style="tip"> |
| 116 |
<title>Text Attribute Indicators</title> |
| 117 |
<p> |
| 118 |
You can also optionally have text attributes indicated in braille. |
| 119 |
Enabling this feature and choosing which attributes are of |
| 120 |
interest is done on the <link xref="preferences_text_attributes"> |
| 121 |
<gui>Text Attributes</gui> page</link> of the preferences dialog. |
| 122 |
</p> |
| 123 |
</note> |
| 124 |
</section> |
| 125 |
<section id="flashMessageSettings"> |
| 126 |
<title>Flash Message Settings</title> |
| 127 |
<p> |
| 128 |
Flash messages are similar in nature to notifications or announcements: |
| 129 |
They are shown on your refreshable braille display for a brief time, |
| 130 |
after which the original contents of the braille display are restored. |
| 131 |
<app>Orca</app> has several settings you can use to control flash message |
| 132 |
presentation. |
| 133 |
</p> |
| 134 |
<section id="flashMessageSettings_enable"> |
| 135 |
<title>Enable flash messages</title> |
| 136 |
<p> |
| 137 |
If <gui>Enable flash messages</gui> is checked, <app>Orca</app> will |
| 138 |
present messages to you in braille. If you prefer to only have |
| 139 |
<app>Orca</app>'s messages spoken, you should uncheck this checkbox. |
| 140 |
</p> |
| 141 |
<p> |
| 142 |
Default value: checked |
| 143 |
</p> |
| 144 |
</section> |
| 145 |
<section id="flashMessageSettings_detailed"> |
| 146 |
<title>Messages are detailed</title> |
| 147 |
<p> |
| 148 |
If <gui>Messages are detailed</gui> is checked, <app>Orca</app> will |
| 149 |
present detailed messages to you in braille. For instance, if you |
| 150 |
use <app>Orca</app>'s command to change echo, <app>Orca</app> might |
| 151 |
display "Echo set to word." If you would prefer shorter messages, |
| 152 |
such as simply "word," you should uncheck this checkbox. |
| 153 |
</p> |
| 154 |
<p> |
| 155 |
Default value: checked |
| 156 |
</p> |
| 157 |
</section> |
| 158 |
<section id="flashMessageSettings_persistent"> |
| 159 |
<title>Messages are persistent</title> |
| 160 |
<p> |
| 161 |
As stated above, flash messages are only shown for a brief period of time. |
| 162 |
If you would prefer messages remain displayed until you perform an action |
| 163 |
which causes your display to be updated, you should check the <gui>Messages |
| 164 |
are persistent</gui> checkbox. |
| 165 |
</p> |
| 166 |
<p> |
| 167 |
Default value: not checked |
| 168 |
</p> |
| 169 |
</section> |
| 170 |
<section id="flashMessageSettings_duration"> |
| 171 |
<title>Duration (secs)</title> |
| 172 |
<p> |
| 173 |
The amount of time <app>Orca</app> will wait before removing the message and |
| 174 |
restoring the original contents of your display can be set in the <gui> |
| 175 |
Duration (secs)</gui> spin button. Note that the value of this |
| 176 |
setting will be ignored if you have enabled persistent flash messages. |
| 177 |
</p> |
| 178 |
<p> |
| 179 |
Default value: 5 |
| 180 |
</p> |
| 181 |
</section> |
| 182 |
</section> |
| 183 |
</page> |