Skip to content

Commit a898746

Browse files
AAClauseAAClause
committed
Update README
1 parent 10ae8c7 commit a898746

File tree

1 file changed

+151
-99
lines changed

1 file changed

+151
-99
lines changed

‎README.md

+151-99
Original file line numberDiff line numberDiff line change
@@ -5,137 +5,189 @@
55
- Download [stable version](https://andreabc.net/projects/NVDA_addons/BrailleExtender/latest)
66
- Download [development version](https://andreabc.net/projects/NVDA_addons/BrailleExtender/latest?channel=dev)
77

8-
BrailleExtender is an [NVDA](http://nvda-project.org/) add-on that provides various features at braille level. Currently, the following features are implemented:
9-
10-
- reload two favorite braille display with shortcuts.
11-
- automatic review cursor tethering in terminal role like in PuTTY, Powershell, bash, cmd.
12-
- auto scroll.
13-
- switch between several input/output braille tables.
14-
- mark the text with special attributes through dot 7, dot 8 or both.
15-
- use two output braille tables simultaneously.
16-
- display tab signs as spaces.
17-
- reverse forward scroll and back scroll buttons.
18-
- say the current line during text scrolling either in review mode, or in focus mode or both.
19-
- translate text easily in Unicode braille and vice versa. E.g.: z <--> ⠵.
20-
- convert cell description to Unicode braille and vice versa. E.g.: 123 <--> ⠇.
21-
- lock braille keyboard.
22-
- launch an application/URL with gesture.
23-
- braille dictionaries.
24-
- type with one-hand from braille keyboard.
25-
- display undefined characters from braille tables (including emojis) using altenative representations.
26-
- enter any character from braille keyboard (including emojis).
27-
- skip blank lines during text scrolling.
28-
- and much more!
29-
30-
For some braille displays, it extends the braille display commands to provide:
31-
32-
- offer complete gesture maps including function keys, multimedia keys, quick navigation, etc.;
33-
- emulate modifier keys, and thus any keyboard shortcut;
34-
- offer several keyboard configurations concerning the possibility to input dots 7 and 8, enter and backspace;
35-
- add actions and quick navigation through a rotor.
36-
37-
Once the add-on is installed, read the documentation and go through the settings using the BrailleExtender submenu (located in the NVDA menu).
38-
39-
## Let's explore some common features
8+
BrailleExtender is a NVDA add-on that provides various features at braille
9+
level. Currently, the following features are implemented:
10+
11+
- reload two favorite braille display with shortcuts.
12+
- automatic review cursor tethering in terminal role like in PuTTY, Powershell, bash, cmd.
13+
- auto scroll.
14+
- switch between several input/output braille tables.
15+
- mark the text with special attributes through dot 7, dot 8 or both.
16+
- use two output braille tables simultaneously.
17+
- display tab signs as spaces.
18+
- reverse forward scroll and back scroll buttons.
19+
- say the current line during text scrolling either in review mode, or in focus mode or both.
20+
- translate text easily in Unicode braille and vice versa. E.g.: z <\--> ⠵.
21+
- convert cell description to Unicode braille and vice versa. E.g.: 123 <\--> ⠇.
22+
- lock braille keyboard.
23+
- launch an application/URL with gesture.
24+
- braille dictionaries.
25+
- type with one-hand from braille keyboard.
26+
- display undefined characters from braille tables (including emojis) using altenative representations.
27+
- enter any character from braille keyboard (including emojis).
28+
- skip blank lines during text scrolling.
29+
- Speech History Mode.
30+
- and much more!
31+
32+
For some braille displays, it extends the braille display commands to provide:
33+
34+
- offer complete gesture maps including function keys, multimedia keys, quick navigation, etc.;
35+
- emulate modifier keys, and thus any keyboard shortcut;
36+
- offer several keyboard configurations concerning the possibility to input dots 7 and 8, enter and backspace;
37+
- add actions and quick navigation through a rotor.
38+
39+
## Let's explore some features
40+
41+
### Speech History Mode
42+
43+
This mode allows to review the last announcements that have been spoken by
44+
NVDA.
45+
To enable this mode, use NVDA+Control+t command or equivalent gestures on your
46+
braille displays (like ⡞+space).
47+
In this mode, you can use:
48+
49+
- the first routing cursor to copy the current announcement to the Clipboard.
50+
- the last routing cursor to show the current announcement in a browseable message.
51+
- other routing cursors to navigate through history entries.
52+
53+
Please note that specific settings are available for this feature under the
54+
category "Speech History Mode".
4055

4156
### Representation of undefined characters
42-
The extension allows you to customize how an undefined character should be represented within a braille table. To do so, go to the — Representation of undefined characters — settings. You can choose between the following representations:
43-
44-
- Use braille table behavior (no description possible)
45-
- Dots 1-8 (⣿)
46-
- Dots 1-6 (⠿)
47-
- Empty cell (⠀)
48-
- Other dot pattern (e.g.: 6-123456)
49-
- Question mark (depending on output table)
50-
- Other sign/pattern (e.g.: ??)
51-
- Hexadecimal
52-
- Hexadecimal, HUC8
53-
- Hexadecimal, HUC6
54-
- Decimal
55-
- Octal
56-
- Binary
57-
58-
You can also combine this option with the “describe the character if possible” setting.
57+
58+
The extension allows you to customize how an undefined character should be
59+
represented within a braille table. To do so, go to the — Representation of
60+
undefined characters — settings. You can choose between the following
61+
representations:
62+
63+
- Use braille table behavior (no description possible)
64+
- Dots 1-8 (⣿)
65+
- Dots 1-6 (⠿)
66+
- Empty cell (⠀)
67+
- Other dot pattern (e.g.: 6-123456)
68+
- Question mark (depending on output table)
69+
- Other sign/pattern (e.g.: ??)
70+
- Hexadecimal
71+
- Hexadecimal, HUC8
72+
- Hexadecimal, HUC6
73+
- Decimal
74+
- Octal
75+
- Binary
76+
77+
You can also combine this option with the “describe the character if possible”
78+
setting.
5979

6080
Notes:
6181

62-
- To distinguish the undefined set of characters while maximizing space, the best combination is the usage of the HUC8 representation without checking the “Show punctuation/symbol name for undefined characters if available” option.
63-
- To learn more about the HUC representation, see <https://danielmayr.at/huc/>
64-
- Keep in mind that definitions in tables and those in your table dictionaries take precedence over character descriptions, which also take precedence over the chosen representation for undefined characters.
82+
- To distinguish the undefined set of characters while maximizing space, the best combination is the usage of the HUC8 representation without checking the “Show punctuation/symbol name for undefined characters if available” option.
83+
- To learn more about the HUC representation, see <https://danielmayr.at/huc/>
84+
- Keep in mind that definitions in tables and those in your table dictionaries take precedence over character descriptions, which also take precedence over the chosen representation for undefined characters.
6585

6686
### Getting Current Character Info
67-
This feature allows you to obtain various information regarding the character under the cursor using the current input braille table, such as:
68-
the HUC8 and HUC6 representations; the hexadecimal, decimal, octal or binary values; A description of the character if possible; the Unicode braille representation and the braille pattern dots.
6987

70-
Pressing the defined gesture associated to this function once shows you the information in a flash message and a double-press displays the same information in a virtual NVDA buffer.
88+
This feature allows you to obtain various information regarding the character
89+
under the cursor using the current input braille table, such as:
90+
the HUC8 and HUC6 representations; the hexadecimal, decimal, octal or binary
91+
values; A description of the character if possible; the Unicode braille
92+
representation and the braille pattern dots.
7193

72-
On supported displays the defined gesture is ⡉+space. No system gestures are defined by default.
94+
Pressing the defined gesture associated to this function once shows you the
95+
information in a flash message and a double-press displays the same
96+
information in a virtual NVDA buffer.
97+
On supported displays the defined gesture is ⡉+space. No system gestures are
98+
defined by default.
7399

74-
For example, for the '&' character, we will get the following information:
100+
For example, for the '.' character, we will get the following information:
75101

76-
> &: 0x26, 38, 0o46, 0b100110
77-
> and (AMPERSAND [Po])
78-
> ⢿ (1234568)
79-
> ⣥⣺⡧, ⠿⠺⠏⠏
102+
>
103+
> .: 0x2e, 46, 0o56, 0b101110
104+
> dot (FULL STOP [Po])
105+
> ⠲ (256)
106+
> ⣥⣺⢃, ⠿⠺⠏⠔
80107
81108
### Advanced braille input
82-
This feature allows you to enter any character from its HUC8 representation or its hexadecimal/decimal/octal/binary value. Moreover, it allows you to develop abbreviations. To use this function, enter the advanced input mode and then enter the desired pattern. Default gestures: NVDA+Windows+i or ⡊+space (on supported displays). Press the same gesture to exit this mode. Alternatively, an option allows you to automatically exit this mode after entering a single pattern.
83-
If you want to enter a character from its HUC8 representation, simply enter the HUC8 pattern. Since a HUC8 sequence must fit on 3 or 4 cells, the interpretation will be performed each time 3 or 4 dot combinations are entered. If you wish to enter a character from its hexadecimal, decimal, octal or binary value, do the following:
84-
85-
1. Enter ⠼
86-
2. Specify the basis as follows:
87-
- ⠭ or ⠓: for a hexadecimal value
88-
- ⠙: for a decimal value
89-
- ⠕: for an octal value
90-
- ⠃: for a binary value
91-
3. Enter the value of the character according to the previously selected basis.
92-
4. Press Space to validate.
93-
94-
For abbreviations, you must first add them in the dialog box — Advanced input mode dictionary —. Then, you just have to enter your abbreviation and press space to expand it. For example, you can define the following abbreviations: "⠎⠺" with "sandwich", "⠋⠛⠋⠗" to "🇫🇷".
95109

110+
This feature allows you to enter any character from its HUC8 representation or
111+
its hexadecimal/decimal/octal/binary value. Moreover, it allows you to develop
112+
abbreviations. To use this function, enter the advanced input mode and then
113+
enter the desired pattern. Default gestures: NVDA+Windows+i or ⡊+space (on
114+
supported displays). Press the same gesture to exit this mode. Alternatively,
115+
an option allows you to automatically exit this mode after entering a single
116+
pattern.
117+
118+
If you want to enter a character from its HUC8 representation, simply enter
119+
the HUC8 pattern. Since a HUC8 sequence must fit on 3 or 4 cells, the
120+
interpretation will be performed each time 3 or 4 dot combinations are
121+
entered. If you wish to enter a character from its hexadecimal, decimal, octal
122+
or binary value, do the following:
123+
124+
1. Enter ⠼
125+
2. Specify the basis as follows:
126+
- ⠭ or ⠓: for a hexadecimal value
127+
- ⠙: for a decimal value
128+
- ⠕: for an octal value
129+
- ⠃: for a binary value
130+
3. Enter the value of the character according to the previously selected basis.
131+
4. Press Space to validate.
132+
133+
For abbreviations, you must first add them in the dialog box — Advanced input
134+
mode dictionary —. Then, you just have to enter your abbreviation and press
135+
space to expand it. For example, you can define the following abbreviations:
136+
"⠎⠺" with "sandwich", "⠋⠛⠋⠗" to "🇫🇷".
96137

97138
Here are some examples of sequences to be entered for given characters:
98139

99-
| Character | HUC8 | Hexadecimal | Decimal | Octal | Binary |
100-
| ----------------- | ---- | ---------------- | ------- | ------- | ------------------ |
101-
| 👍 (thumbs up) | ⣭⢤⡙ | ⠭1f44d or ⠓1f44d | ⠙128077 | ⠕372115 | ⠃11111010001001101 |
102-
| 😀 (grinning face) | ⣭⡤⣺ | ⠭1f600 or ⠓1f600 | ⠙128512 | ⠕373000 | ⠃11111011000000000 |
103-
| 🍑 (peach) | ⣭⠤⠕ | ⠭1f351 or ⠓1f351 | ⠙127825 | ⠕371521 | ⠃11111001101010001 |
104-
| 🌊 (water wave) | ⣭⠤⠺ | ⠭1f30a or ⠓1f30a | ⠙127754 | ⠕371412 | ⠃11111001100001010 |
105-
140+
Character| HUC8| Hexadecimal| Decimal| Octal| Binary
141+
---|---|---|---|---|---
142+
👍 (thumbs up)| ⣭⢤⡙| ⠭1f44d or ⠓1f44d| ⠙128077| ⠕372115| ⠃11111010001001101
143+
😀 (grinning face)| ⣭⡤⣺| ⠭1f600 or ⠓1f600| ⠙128512| ⠕373000| ⠃11111011000000000
144+
🍑 (peach)| ⣭⠤⠕| ⠭1f351 or ⠓1f351| ⠙127825| ⠕371521| ⠃11111001101010001
145+
🌊 (water wave)| ⣭⠤⠺| ⠭1f30a or ⠓1f30a| ⠙127754| ⠕371412| ⠃11111001100001010
146+
106147
Note: the HUC6 input is currently not supported.
107148

108149
### One-hand mode
109150

110-
This feature allows you to compose a cell in several steps. This can be activated in the general settings of the extension's preferences or on the fly using NVDA+Windows+h gesture by default (⡂+space on supported displays). Three input methods are available.
151+
This feature allows you to compose a cell in several steps. This can be
152+
activated in the general settings of the extension's preferences or on the fly
153+
using NVDA+Windows+h gesture by default (⡂+space on supported displays). Three
154+
input methods are available.
111155

112156
#### Method #1: fill a cell in 2 stages on both sides
113-
With this method, type the left side dots, then the right side dots. If one side is empty, type the dots correspondig to the opposite side twice, or type the dots corresponding to the non-empty side in 2 steps.
114157

158+
With this method, type the left side dots, then the right side dots. If one
159+
side is empty, type the dots correspondig to the opposite side twice, or type
160+
the dots corresponding to the non-empty side in 2 steps.
115161
For example:
116162

117-
- For ⠛: press dots 1-2 then dots 4-5.
118-
- For ⠃: press dots 1-2 then dots 1-2, or dot 1 then dot 2.
119-
- For ⠘: press 4-5 then 4-5, or dot 4 then dot 5.
163+
- For ⠛: press dots 1-2 then dots 4-5.
164+
- For ⠃: press dots 1-2 then dots 1-2, or dot 1 then dot 2.
165+
- For ⠘: press 4-5 then 4-5, or dot 4 then dot 5.
120166

121167
#### Method #2: fill a cell in two stages on one side (Space = empty side)
122-
Using this method, you can compose a cell with one hand, regardless of which side of the Braille keyboard you choose. The first step allows you to enter dots 1-2-3-7 and the second one 4-5-6-8. If one side is empty, press space. An empty cell will be obtained by pressing the space key twice.
123168

169+
Using this method, you can compose a cell with one hand, regardless of which
170+
side of the Braille keyboard you choose. The first step allows you to enter
171+
dots 1-2-3-7 and the second one 4-5-6-8. If one side is empty, press space. An
172+
empty cell will be obtained by pressing the space key twice.
124173
For example:
125174

126-
- For ⠛: press dots 1-2 then dots 1-2, or dots 4-5 then dots 4-5.
127-
- For ⠃: press dots 1-2 then space, or 4-5 then space.
128-
- For ⠘: press space then 1-2, or space then dots 4-5.
129-
130-
#### Method #3: fill a cell dots by dots (each dot is a toggle, press Space to validate the character)
175+
- For ⠛: press dots 1-2 then dots 1-2, or dots 4-5 then dots 4-5.
176+
- For ⠃: press dots 1-2 then space, or 4-5 then space.
177+
- For ⠘: press space then 1-2, or space then dots 4-5.
131178

132-
In this mode, each dot is a toggle. You must press the space key as soon as the cell you have entered is the desired one to input the character. Thus, the more dots are contained in the cell, the more ways you have to enter the character.
179+
#### Method #3: fill a cell dots by dots (each dot is a toggle, press Space to
180+
validate the character)
133181

182+
In this mode, each dot is a toggle. You must press the space key as soon as
183+
the cell you have entered is the desired one to input the character. Thus, the
184+
more dots are contained in the cell, the more ways you have to enter the
185+
character.
134186
For example, for ⠛, you can compose the cell in the following ways:
135187

136-
- Dots 1-2, then dots 4-5, then space.
137-
- Dots 1-2-3, then dot 3 (to correct), then dots 4-5, then space.
138-
- Dot 1, then dots 2-4-5, then space.
139-
- Dots 1-2-4, then dot 5, then space.
140-
- Dot 2, then dot 1, then dot 5, then dot 4, and then space.
141-
- Etc.
188+
- Dots 1-2, then dots 4-5, then space.
189+
- Dots 1-2-3, then dot 3 (to correct), then dots 4-5, then space.
190+
- Dot 1, then dots 2-4-5, then space.
191+
- Dots 1-2-4, then dot 5, then space.
192+
- Dot 2, then dot 1, then dot 5, then dot 4, and then space.
193+
- Etc.

0 commit comments

Comments
 (0)