Skip to content

Commit c64e806

Browse files
authored
Merge e8f9470 into 32a8613
2 parents 32a8613 + e8f9470 commit c64e806

File tree

4 files changed

+72
-341
lines changed

4 files changed

+72
-341
lines changed

projectDocs/dev/developerGuide/developerGuide.t2t

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,13 @@ The fields are as follows:
116116
In most cases, this is just the character or characters of the symbol.
117117
However, it can also be the identifier of a complex symbol.
118118
Certain characters cannot be typed into the file, so the following special sequences can be used:
119-
- \0: null
120-
- \t: tab
121-
- \n: line feed
122-
- \r: carriage return
123-
- \f: form feed
124-
- \#: # character (needed because # at the start of a line denotes a comment)
119+
- \0: null
120+
- \t: tab
121+
- \n: line feed
122+
- \r: carriage return
123+
- \f: form feed
124+
- \#: # character (needed because # at the start of a line denotes a comment)
125+
-
125126
- replacement: The text which should be spoken for the symbol.
126127
If the symbol is a complex symbol, \1, \2, etc. can be used to refer to the groups matches, which will be inlined in the replacement, allowing for simpler rules.
127128
This also means that to get a \ character in the replacement, one has to type \\.
@@ -133,12 +134,12 @@ The default is to inherit the value or "all" if there is nothing to inherit.
133134
- preserve: Whether the symbol itself should be preserved to facilitate correct pronunciation by the synthesiser.
134135
For example, symbols which cause pauses or inflection (such as the comma in English) should be preserved.
135136
This field should be one of the following:
136-
- never: Never preserve the symbol.
137-
- always: Always preserve the symbol.
138-
- norep: Only preserve the symbol if it is not being replaced; i.e. the user has set symbol level lower than the level of this symbol.
139-
- -: Use the default.
140-
-
141-
The default is to inherit the value or "never" if there is nothing to inherit.
137+
- never: Never preserve the symbol.
138+
- always: Always preserve the symbol.
139+
- norep: Only preserve the symbol if it is not being replaced; i.e. the user has set symbol level lower than the level of this symbol.
140+
- -: Use the default.
141+
- The default is to inherit the value or "never" if there is nothing to inherit.
142+
-
142143
-
143144
Finally, a display name for the symbol can be provided in a comment after a tab at the end of the line.
144145
This will be shown to users when editing the symbol information and is especially useful for translators to define translated names for English complex symbols.

user_docs/en/changes.t2t

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2205,7 +2205,7 @@ Highlights of this release include auto detection of Freedom Scientific braille
22052205

22062206
== Changes for Developers ==
22072207
- You can now set the "disableBrowseModeByDefault" property on app modules to leave browse mode off by default. (#8846)
2208-
- The extended window style of a window is now exposed using the `extendedWindowStyle` property on Window objects and their derivatives. (#9136)
2208+
- The extended window style of a window is now exposed using the ``extendedWindowStyle`` property on Window objects and their derivatives. (#9136)
22092209
- Updated comtypes package to 1.1.7. (#9440, #8522)
22102210
- When using the report module info command, the order of information has changed to present the module first. (#7338)
22112211
- Added an example to demonstrate using nvdaControllerClient.dll from C#. (#9600)
@@ -2235,7 +2235,7 @@ Please refer to the list of changes further down for more details on this and ho
22352235
- New braille tables: Afrikaans, Arabic 8 dot computer braille, Arabic grade 2, Spanish grade 2. (#4435, #9186)
22362236
- Added an option to NVDA's mouse settings to make NVDA handle situations where the mouse is controlled by another application. (#8452)
22372237
- This will allow NVDA to track the mouse when a system is controlled remotely using TeamViewer or other remote control software.
2238-
- Added the `--enable-start-on-logon` command line parameter to allow configuring whether silent installations of NVDA set NVDA to start at Windows logon or not. Specify true to start at logon or false to not start at logon. If the --enable-start-on-logon argument is not specified at all then NVDA will default to starting at logon, unless it was already configured not to by a previous installation. (#8574)
2238+
- Added the ``--enable-start-on-logon`` command line parameter to allow configuring whether silent installations of NVDA set NVDA to start at Windows logon or not. Specify true to start at logon or false to not start at logon. If the --enable-start-on-logon argument is not specified at all then NVDA will default to starting at logon, unless it was already configured not to by a previous installation. (#8574)
22392239
- It is possible to turn NVDA's logging features off by setting logging level to "disabled" from General settings panel. (#8516)
22402240
- The presence of formulae in LibreOffice and Apache OpenOffice spreadsheets is now reported. (#860)
22412241
- In Mozilla Firefox and Google Chrome, browse mode now reports the selected item in list boxes and trees.
@@ -2254,7 +2254,7 @@ Please refer to the list of changes further down for more details on this and ho
22542254
- This version of NVDA will allow installing and loading of add-ons that do not yet contain Minimum and Last Tested NVDA version information, but upgrading to future versions of NVDA (E.g. 2019.2) may automatically cause these older add-ons to be disabled.
22552255
- The move mouse to navigator object command is now available in Microsoft Word as well as for UIA controls, particularly Microsoft Edge. (#7916, #8371)
22562256
- Reporting of text under the mouse has been improved within Microsoft Edge and other UIA applications. (#8370)
2257-
- When NVDA is started with the `--portable-path` command line parameter, the provided path is automatically filled in when trying to create a portable copy of NVDA using the NVDA menu. (#8623)
2257+
- When NVDA is started with the ``--portable-path`` command line parameter, the provided path is automatically filled in when trying to create a portable copy of NVDA using the NVDA menu. (#8623)
22582258
- Updated the path to the Norwegian braille table to reflect the standard from the year 2015. (#9170)
22592259
- When navigating by paragraph (control+up or down arrows) or navigating by table cell (control+alt+arrows), the existence of spelling errors will no longer be announced, even if NVDA is configured to announce these automatically. This is because paragraphs and table cells can be quite large, and detecting spelling errors in some applications can be very costly. (#9217)
22602260
- NVDA no longer automatically loads custom appModules, globalPlugins and braille and synth drivers from the NVDA user configuration directory. This code should be instead packaged as an add-on with correct version information, ensuring that incompatible code is not run with current versions of NVDA. (#9238)
@@ -2759,10 +2759,10 @@ Highlights of this release include full support for audio ducking in the Windows
27592759
- If you want normalized identifiers, there is now an InputGesture.normalizedIdentifiers property which normalizes the identifiers returned by the identifiers property .
27602760
- The InputGesture.logIdentifier property is now deprecated. Callers should use InputGesture.identifiers[0] instead. (#6945)
27612761
- Removed some deprecated code:
2762-
- `speech.REASON_*` constants: `controlTypes.REASON_*` should be used instead. (#6846)
2763-
- `i18nName` for synth settings: `displayName` and `displayNameWithAccelerator` should be used instead. (#6846, #5185)
2764-
- `config.validateConfig`. (#6846, #667)
2765-
- `config.save`: `config.conf.save` should be used instead. (#6846, #667)
2762+
- ``speech.REASON_*`` constants: ``controlTypes.REASON_*`` should be used instead. (#6846)
2763+
- ``i18nName`` for synth settings: ``displayName`` and ``displayNameWithAccelerator`` should be used instead. (#6846, #5185)
2764+
- ``config.validateConfig``. (#6846, #667)
2765+
- ``config.save``: ``config.conf.save`` should be used instead. (#6846, #667)
27662766
- The list of completions in the autocomplete context menu of the Python Console no longer shows any object path leading up to the final symbol being completed. (#7023)
27672767
- There is now a unit testing framework for NVDA. (#7026)
27682768
- Unit tests and infrastructure are located in the tests/unit directory. See the docstring in the tests\unit\__init__.py file for details.

user_docs/en/userGuide.t2t

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1452,10 +1452,9 @@ The available logging levels are:
14521452
- Info: NVDA will log basic information such as startup messages and information useful for developers.
14531453
- Debug warning: Warning messages that are not caused by severe errors will be logged.
14541454
- Input/output: Input from keyboard and braille displays, as well as speech and braille output will be logged.
1455-
- If you are concerned about privacy, do not set the logging level to this option.
1455+
If you are concerned about privacy, do not set the logging level to this option.
14561456
- Debug: In addition to info, warning, and input/output messages, additional debug messages will be logged.
1457-
- Just like input/output, if you are concerned about privacy, you should not set the logging level to this option.
1458-
-
1457+
Just like input/output, if you are concerned about privacy, you should not set the logging level to this option.
14591458
-
14601459

14611460
==== Start NVDA after I sign in ====[GeneralSettingsStartAfterLogOn]
@@ -2263,44 +2262,48 @@ For example, if you check the report font name checkbox, each time you arrow ont
22632262
The document formatting options are organized into groups.
22642263
You can configure reporting of:
22652264
- Font
2266-
- Font name
2267-
- Font size
2268-
- Font attributes
2269-
- Superscripts and subscripts
2270-
- Emphasis
2271-
- Highlighted (Marked) text
2272-
- Style
2273-
- Colours
2265+
- Font name
2266+
- Font size
2267+
- Font attributes
2268+
- Superscripts and subscripts
2269+
- Emphasis
2270+
- Highlighted (Marked) text
2271+
- Style
2272+
- Colours
2273+
-
22742274
- Document information
2275-
- Comments
2276-
- Bookmarks
2277-
- Editor revisions
2278-
- Spelling errors
2275+
- Comments
2276+
- Bookmarks
2277+
- Editor revisions
2278+
- Spelling errors
2279+
-
22792280
- Pages and spacing
2280-
- Page numbers
2281-
- Line numbers
2282-
- Line indentation reporting [(Off, Speech, Tones, Both Speech and Tones) #DocumentFormattingSettingsLineIndentation]
2283-
- Ignore blank lines for line indentation reporting
2284-
- Paragraph indentation (e.g. hanging indent, first line indent)
2285-
- Line spacing (single, double, etc.)
2286-
- Alignment
2281+
- Page numbers
2282+
- Line numbers
2283+
- Line indentation reporting [(Off, Speech, Tones, Both Speech and Tones) #DocumentFormattingSettingsLineIndentation]
2284+
- Ignore blank lines for line indentation reporting
2285+
- Paragraph indentation (e.g. hanging indent, first line indent)
2286+
- Line spacing (single, double, etc.)
2287+
- Alignment
2288+
-
22872289
- Table information
2288-
- Tables
2289-
- Row/column headers (Off, Rows, Columns, Rows and columns)
2290-
- Cell coordinates
2291-
- Cell borders (Off, Styles, Both Colours and Styles)
2290+
- Tables
2291+
- Row/column headers (Off, Rows, Columns, Rows and columns)
2292+
- Cell coordinates
2293+
- Cell borders (Off, Styles, Both Colours and Styles)
2294+
-
22922295
- Elements
2293-
- Headings
2294-
- Links
2295-
- Graphics
2296-
- Lists
2297-
- Block quotes
2298-
- Groupings
2299-
- Landmarks
2300-
- Articles
2301-
- Frames
2302-
- Clickable
2303-
-
2296+
- Headings
2297+
- Links
2298+
- Graphics
2299+
- Lists
2300+
- Block quotes
2301+
- Groupings
2302+
- Landmarks
2303+
- Articles
2304+
- Frames
2305+
- Clickable
2306+
-
23042307
-
23052308

23062309
To toggle these settings from anywhere, please assign custom gestures using the [Input Gestures dialog #InputGestures].
@@ -2635,11 +2638,11 @@ You can also set the level to character; in this case the symbol will not be spo
26352638
This is useful if the symbol causes the synthesizer to pause or change the inflection of the voice.
26362639
For example, a comma causes the synthesizer to pause.
26372640
There are three options:
2638-
- never: Never send the actual symbol to the synthesizer.
2639-
- always: Always send the actual symbol to the synthesizer.
2640-
- only below symbols' level: Send the actual symbol only if the configured speech symbol level is lower than the level set for this symbol.
2641-
For example, you might use this so that a symbol will have its replacement spoken at higher levels without pausing, while still being indicated with a pause at lower levels.
2642-
-
2641+
- never: Never send the actual symbol to the synthesizer.
2642+
- always: Always send the actual symbol to the synthesizer.
2643+
- only below symbols' level: Send the actual symbol only if the configured speech symbol level is lower than the level set for this symbol.
2644+
For example, you might use this so that a symbol will have its replacement spoken at higher levels without pausing, while still being indicated with a pause at lower levels.
2645+
-
26432646
-
26442647

26452648
You can add new symbols by pressing the Add button.
@@ -2678,11 +2681,11 @@ Then, press the key on the keyboard you wish to emulate.
26782681
After that, the key will be available from the Emulated system keyboard keys category and you will be able to assign an input gesture to it as described above.
26792682

26802683
Note:
2681-
- Emulated keys must have gestures assigned in order to persist when saving / closing the dialog.
2682-
- An input gesture with modifier keys may not be able to be mapped to an emulated gesture without modifier
2683-
keys. For instance, setting the emulated input 'a' and configuring an input gesture of 'ctrl+m', may result
2684-
in the application receiving 'ctrl+a'.
2685-
-
2684+
- Emulated keys must have gestures assigned in order to persist when saving / closing the dialog.
2685+
- An input gesture with modifier keys may not be able to be mapped to an emulated gesture without modifier keys.
2686+
For instance, setting the emulated input ``a`` and configuring an input gesture of ``ctrl+m``, may result
2687+
in the application receiving ``ctrl+a``.
2688+
-
26862689

26872690
When you are finished making changes, press the OK button to save them or the Cancel button to discard them.
26882691

@@ -3066,10 +3069,10 @@ These voices can also be used with NVDA.
30663069
To use these voices, you will need to install two components:
30673070
- [Microsoft Speech Platform - Runtime (Version 11), x86 https://www.microsoft.com/download/en/details.aspx?id=27225]
30683071
- [Microsoft Speech Platform - Runtime Languages (Version 11) https://www.microsoft.com/download/en/details.aspx?id=27224]
3069-
- This page includes many files for both speech recognition and text-to-speech.
3072+
- This page includes many files for both speech recognition and text-to-speech.
30703073
Choose the files containing the TTS data for the desired languages/voices.
30713074
For example, the file MSSpeech_TTS_en-US_ZiraPro.msi is a U.S. English voice.
3072-
-
3075+
-
30733076
-
30743077

30753078
++ Windows OneCore Voices ++[OneCore]

0 commit comments

Comments
 (0)