Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated user guide with missing key commands and details to log file and app modules #15460

Merged
merged 31 commits into from Oct 16, 2023
Merged
Changes from 28 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
c5b8235
Updated user guide with missing key commands and details to log file …
Adriani90 Sep 17, 2023
5cbd648
Revisited the changes and structured the commands as table to be cons…
Adriani90 Sep 17, 2023
c890e0c
Addressed review comments
Adriani90 Sep 17, 2023
7841b1f
Update user_docs/en/userGuide.t2t
Adriani90 Sep 17, 2023
68724a8
Update user_docs/en/userGuide.t2t
Adriani90 Sep 17, 2023
b4205e9
Update userGuide.t2t
Adriani90 Sep 17, 2023
77a773f
Update user_docs/en/userGuide.t2t
Adriani90 Sep 20, 2023
332103e
Update user_docs/en/userGuide.t2t
Adriani90 Sep 20, 2023
5e6c855
Update user_docs/en/userGuide.t2t
Adriani90 Sep 20, 2023
2f27e61
Update user_docs/en/userGuide.t2t
Adriani90 Sep 20, 2023
263abd5
Update user_docs/en/userGuide.t2t
Adriani90 Sep 20, 2023
441c38c
Update user_docs/en/userGuide.t2t
Adriani90 Sep 20, 2023
97edf27
Update user_docs/en/userGuide.t2t
Adriani90 Sep 21, 2023
3e42107
Update userGuide.t2t
Adriani90 Sep 21, 2023
d5287bc
Update user_docs/en/userGuide.t2t
Adriani90 Sep 21, 2023
accde65
Update userGuide.t2t
Adriani90 Sep 21, 2023
f2e16d3
Update user_docs/en/userGuide.t2t
Adriani90 Sep 21, 2023
8bf44b9
Update user_docs/en/userGuide.t2t
Adriani90 Sep 21, 2023
154c83a
Update user_docs/en/userGuide.t2t
Adriani90 Sep 21, 2023
4814701
Update userGuide.t2t
Adriani90 Sep 21, 2023
c151a97
Update userGuide.t2t
Adriani90 Sep 21, 2023
71b0235
Update userGuide.t2t
Adriani90 Sep 21, 2023
c2c71d3
Update userGuide.t2t
Adriani90 Sep 21, 2023
e96a42f
Update user_docs/en/userGuide.t2t
Adriani90 Sep 22, 2023
79091ec
Update user_docs/en/userGuide.t2t
Adriani90 Sep 22, 2023
eea53d4
Update user_docs/en/userGuide.t2t
Adriani90 Sep 22, 2023
0db0ab2
Update user_docs/en/userGuide.t2t
Adriani90 Sep 22, 2023
519d880
Update userGuide.t2t
Adriani90 Sep 22, 2023
ae17d21
Update user_docs/en/userGuide.t2t
Adriani90 Sep 22, 2023
de32b5c
Update user_docs/en/userGuide.t2t
Adriani90 Sep 22, 2023
60781ca
Update user_docs/en/userGuide.t2t
Adriani90 Oct 12, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 21 additions & 4 deletions user_docs/en/userGuide.t2t
Expand Up @@ -2784,11 +2784,21 @@ You can browse installed incompatible add-ons using the [incompatible add-ons ta
+ Extra Tools +[ExtraTools]

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is very clear and well phrased. Thanks @Adriani90 and @seanbudd. Do not modify anymore!

++ Log Viewer ++[LogViewer]
The log viewer, found under Tools in the NVDA menu, allows you to view all the logging output that has occurred up until now from when you last started NVDA.
Adriani90 marked this conversation as resolved.
Show resolved Hide resolved
Using NVDA+F1 will open the log viewer and display developer information about the current navigator object.
The log viewer, found under Tools in the NVDA menu, allows you to view the logging output that has occurred since the current session of NVDA was started.
Adriani90 marked this conversation as resolved.
Show resolved Hide resolved

Apart from reading the content, you can also Save a copy of the log file, or refresh the viewer so that it shows the most recent output since the Log viewer was opened.
These actions are available under the viewer's Log menu.
Apart from reading the content, you can also Save a copy of the log file, or refresh the viewer so that it loads new log output generated after the Log viewer was opened.
These actions are available under the Log submenu in the log viewer.
Adriani90 marked this conversation as resolved.
Show resolved Hide resolved

The file which is displayed when you open the log viewer is saved on your computer at the file location ``%temp%\nvda.log``.
A new log file is created each time NVDA is started.
When this happens, the previous NVDA session's log file is moved to ``%temp%\nvda-old.log``.

You can also copy a fragment of the current log file to the clipboard without opening the log viewer.
%kc:beginInclude
|| Name | Key | Description |
| Open log viewer | ``NVDA+f1`` | Opens the log viewer and displays developer information about the current navigator object. |
| Copy a fragment of the log to the clipboard | ``NVDA+control+shift+f1`` | When this command is pressed once, it sets a starting point for the log content that should be captured. When pressed a second time, it copies the log content since the start point to your clipboard. |
Adriani90 marked this conversation as resolved.
Show resolved Hide resolved
%kc:endInclude

++ Speech Viewer ++[SpeechViewer]
For sighted software developers or people demoing NVDA to sighted audiences, a floating window is available that allows you to view all the text that NVDA is currently speaking.
Expand Down Expand Up @@ -2866,6 +2876,13 @@ Specifically, following issues can be solved by running this tool:
++ Reload plugins ++[ReloadPlugins]
This item, once activated, reloads app modules and global plugins without restarting NVDA, which can be useful for developers.
Adriani90 marked this conversation as resolved.
Show resolved Hide resolved

The following NVDA key commands may also be useful:
%kc:beginInclude
|| Name | Key | Description |
| Reload plugins | ``NVDA+control+f3`` | Reloads NVDA's global plugins and app modules. |
| Report loaded app module and executable | ``NVDA+control+f1`` | Report the name of the app module, if any, and the name of the executable associated with the application which has the keyboard focus. |
%kc:endInclude

+ Supported Speech Synthesizers +[SupportedSpeechSynths]
This section contains information about the speech synthesizers supported by NVDA.
For an even more extensive list of free and commercial synthesizers that you can purchase and download for use with NVDA, please see the [extra voices page https://github.com/nvaccess/nvda/wiki/ExtraVoices].
Expand Down