From 136a7840742b105dee3ff07aa73585057e5ddd5e Mon Sep 17 00:00:00 2001 From: Quentin Christensen Date: Wed, 15 May 2024 13:57:41 +1000 Subject: [PATCH 1/8] add-ons in quick start guide Updated PR 16486 against md file rather than t2t file. --- user_docs/en/userGuide.md | 67 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index 6b0c4d22f6d..fcf2b5837cc 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -280,6 +280,73 @@ To open NVDA's menu, press `NVDA+n`. To open NVDA's general settings dialog directly, press `NVDA+control+g`. Many settings screens have keystrokes to open them directly, such as `NVDA+control+s` for synthesizer, or `NVDA+control+v` for other voice options. +### Add-ons {#Addons} +Add-ons are programs which provide new or changed functionality for NVDA. +Add-ons are developed by the NVDA community, or external companies and are unaffiliated with NV Access. +As with any software, it is important to trust the developer of an add-on before using it. +Please refer to [Installing Add-ons](#AddonStoreInstalling) for ways to verify add-ons prior to installation. + +The first time the add-on store is opened, NVDA displays a warning about add-ons. +Add-ons are not vetted by NV Access and may have unrestricted functionality and access to information. +Press `spacebar` if you have read the warning and do not need to see it next time. +Press `tab` to reach the "OK" button, then `enter` to accept the warning and proceed to the Add-on Store. +The "[Add-ons and the Add-on Store](#AddonsManager)" section of the user guide contains information about every feature of the add-on store. + +The Add-on Store is available from the Tools menu. +Press `NVDA+n` to open the NVDA menu, then `t` for tools, then `a` for add-on store. +When the add-on store opens, it shows "Available add-ons" if no add-ons are installed. +When add-ons are installed, the Add-on Store opens to the "Installed add-ons" tab. + +#### Available add-ons {#AvailableAddons} +When the window first opens, add-ons may take a few seconds to load. +NVDA will read the name of the first add-on once the list of add-ons finishes loading. +Available add-ons are listed alphabetically in a grid. +To browse the list and find out about a specific add-on: +1. Use the `arrow keys` or press the first letter of an add-on name to move around the list. +1. Press `tab` once to move to a description of the currently selected add-on. +1. Use the [reading keys](#ReadingText) or `arrow keys` to read the full description. +1. Press `tab` to the "Actions" button, which can be used to install the add-on, among other actions. +1. Press `tab` to "Other Details", which lists details such as the publisher, version and homepage. +1. To return to the list of add-ons, press `alt+a`, or `shift+tab` back to the "Available add-ons" list. + +#### Searching for add-ons {#SearchingForAddons} +As well as browsing all available add-ons, it is possible to filter the add-ons shown. +To search, press `alt+s` to jump to the "search" field and type the text to search for. +The search field can contain information including the add-on ID, display name, publisher, author or description. +The list changes while typing the search terms. +Once done, press `tab` to go to the filtered list of add-ons and browse the results. + ++++ Installing add-ons +++[InstallingAddons] +To install an add-on: +1. With the focus on an add-on you would like to install, press `enter`. +1. The actions menu opens with a list of actions including: "Install", "Home page", "License", "Source code", "Community reviews". +1. To install the add-on, press `i` or `down arrow` to "install" and press `enter`. +1. The focus returns to the add-on in the list and NVDA will read the details about the add-on. +1. The "Status" information reported by NVDA changes from "Available" to "Downloading". +1. Once the add-on has finished downloading, it will change to "Downloaded. Pending install". +1. Repeat with any other add-ons you would like to install at the same time. +1. Once finished, press `tab` until the focus is on the "Close" button, then press `enter`. +1. A dialog appears advising that changes were made, and you must restart NVDA. +1. Press `enter` to restart NVDA. + +#### Managing installed add-ons {#ManagingInstalledAddons} +Press `control+tab` to move between the tabs or sections of the Add-on Store. +The tabs include: "Installed add-ons", "Updatable add-ons", "Available add-ons" and "Installed incompatible add-ons". +Each of the tabs are set out similar to each other, as a list of add-ons, a panel for more details on the selected add-on, and the ability to perform actions for the add-on. +The actions menu of installed add-ons includes "Disable", and "Remove" rather than "Install". +Disabling an add-on stops NVDA from loading it, but leaves it installed. +To re-enable a disabled add-on, activate "Enable" from the actions menu. +After enabling, disabling, or removing add-ons, NVDA will prompt to restart when closing the add-on store. +Note that in this dialog `escape` works the same as the close button. +Any changes you had made in the dialog have already happened, but they don't take effect until NVDA restarts. + +### Updating add-ons {#UpdatingAddons} +When there is an update to an add-on you have installed, it will be listed in the "Updatable add-ons" tab. +Press `control+tab` to get to this tab from anywhere in the add-on store. +The status of the add-on will be listed as "Update available". +The table will list the currently installed version and the available version. +Press `enter` on the add-on to open the actions list; choose "Update". + ### Community {#Community} NVDA has a vibrant user community. From 8c1841e5c89da2a73e7fe7171e47edc401e3eed3 Mon Sep 17 00:00:00 2001 From: Quentin Christensen Date: Wed, 15 May 2024 14:02:55 +1000 Subject: [PATCH 2/8] Update user_docs/en/userGuide.md I knew I'd miss one! --- user_docs/en/userGuide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index fcf2b5837cc..63032b6653f 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -316,7 +316,8 @@ The search field can contain information including the add-on ID, display name, The list changes while typing the search terms. Once done, press `tab` to go to the filtered list of add-ons and browse the results. -+++ Installing add-ons +++[InstallingAddons] +#### Installing add-ons {#InstallingAddons} + To install an add-on: 1. With the focus on an add-on you would like to install, press `enter`. 1. The actions menu opens with a list of actions including: "Install", "Home page", "License", "Source code", "Community reviews". From 41b8e27661455646405bff1353fe5ff69d9cb4b9 Mon Sep 17 00:00:00 2001 From: Sean Budd Date: Thu, 16 May 2024 12:07:59 +1000 Subject: [PATCH 3/8] Apply suggestions from code review --- user_docs/en/userGuide.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index 63032b6653f..413b5579a3f 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -286,15 +286,15 @@ Add-ons are developed by the NVDA community, or external companies and are unaff As with any software, it is important to trust the developer of an add-on before using it. Please refer to [Installing Add-ons](#AddonStoreInstalling) for ways to verify add-ons prior to installation. -The first time the add-on store is opened, NVDA displays a warning about add-ons. +The first time the Add-on Store is opened, NVDA displays a warning about add-ons. Add-ons are not vetted by NV Access and may have unrestricted functionality and access to information. Press `spacebar` if you have read the warning and do not need to see it next time. Press `tab` to reach the "OK" button, then `enter` to accept the warning and proceed to the Add-on Store. -The "[Add-ons and the Add-on Store](#AddonsManager)" section of the user guide contains information about every feature of the add-on store. +The "[Add-ons and the Add-on Store](#AddonsManager)" section of the User Guide contains information about every feature of the Add-on Store. The Add-on Store is available from the Tools menu. -Press `NVDA+n` to open the NVDA menu, then `t` for tools, then `a` for add-on store. -When the add-on store opens, it shows "Available add-ons" if no add-ons are installed. +Press `NVDA+n` to open the NVDA menu, then `t` for tools, then `a` for Add-on Store. +When the Add-on Store opens, it shows "Available add-ons" if no add-ons are installed. When add-ons are installed, the Add-on Store opens to the "Installed add-ons" tab. #### Available add-ons {#AvailableAddons} @@ -321,7 +321,7 @@ Once done, press `tab` to go to the filtered list of add-ons and browse the resu To install an add-on: 1. With the focus on an add-on you would like to install, press `enter`. 1. The actions menu opens with a list of actions including: "Install", "Home page", "License", "Source code", "Community reviews". -1. To install the add-on, press `i` or `down arrow` to "install" and press `enter`. +1. To install the add-on, press `i` or `downArrow` to "install" and press `enter`. 1. The focus returns to the add-on in the list and NVDA will read the details about the add-on. 1. The "Status" information reported by NVDA changes from "Available" to "Downloading". 1. Once the add-on has finished downloading, it will change to "Downloaded. Pending install". @@ -334,7 +334,7 @@ To install an add-on: Press `control+tab` to move between the tabs or sections of the Add-on Store. The tabs include: "Installed add-ons", "Updatable add-ons", "Available add-ons" and "Installed incompatible add-ons". Each of the tabs are set out similar to each other, as a list of add-ons, a panel for more details on the selected add-on, and the ability to perform actions for the add-on. -The actions menu of installed add-ons includes "Disable", and "Remove" rather than "Install". +The actions menu of installed add-ons includes "Disable" and "Remove" rather than "Install". Disabling an add-on stops NVDA from loading it, but leaves it installed. To re-enable a disabled add-on, activate "Enable" from the actions menu. After enabling, disabling, or removing add-ons, NVDA will prompt to restart when closing the add-on store. @@ -343,7 +343,7 @@ Any changes you had made in the dialog have already happened, but they don't tak ### Updating add-ons {#UpdatingAddons} When there is an update to an add-on you have installed, it will be listed in the "Updatable add-ons" tab. -Press `control+tab` to get to this tab from anywhere in the add-on store. +Press `control+tab` to get to this tab from anywhere in the Add-on Store. The status of the add-on will be listed as "Update available". The table will list the currently installed version and the available version. Press `enter` on the add-on to open the actions list; choose "Update". From 720c126d23103a3feca0d539384fb326339f49f1 Mon Sep 17 00:00:00 2001 From: Quentin Christensen Date: Mon, 20 May 2024 15:17:33 +1000 Subject: [PATCH 4/8] Update user_docs/en/userGuide.md Looks good Co-authored-by: Sean Budd --- user_docs/en/userGuide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index 413b5579a3f..767267234c2 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -327,7 +327,9 @@ To install an add-on: 1. Once the add-on has finished downloading, it will change to "Downloaded. Pending install". 1. Repeat with any other add-ons you would like to install at the same time. 1. Once finished, press `tab` until the focus is on the "Close" button, then press `enter`. -1. A dialog appears advising that changes were made, and you must restart NVDA. +1. The downloaded add-ons will start the installation process once the Add-on Store is closed. +Add-ons may create dialogs during the installation process that you will need to respond to. +1. When the add-ons have been installed, a dialog appears advising that changes were made, and you must restart NVDA for the add-on installation to complete. 1. Press `enter` to restart NVDA. #### Managing installed add-ons {#ManagingInstalledAddons} From a2ea9c6f8b7d0ed60dc03057347072c31754402f Mon Sep 17 00:00:00 2001 From: Quentin Christensen Date: Mon, 20 May 2024 15:22:49 +1000 Subject: [PATCH 5/8] Update user_docs/en/userGuide.md Co-authored-by: Sean Budd --- user_docs/en/userGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index 767267234c2..0f3da35cb1c 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -339,7 +339,7 @@ Each of the tabs are set out similar to each other, as a list of add-ons, a pane The actions menu of installed add-ons includes "Disable" and "Remove" rather than "Install". Disabling an add-on stops NVDA from loading it, but leaves it installed. To re-enable a disabled add-on, activate "Enable" from the actions menu. -After enabling, disabling, or removing add-ons, NVDA will prompt to restart when closing the add-on store. +After enabling, disabling, or removing add-ons, you will be prompted to restart NVDA when closing the Add-on Store. Note that in this dialog `escape` works the same as the close button. Any changes you had made in the dialog have already happened, but they don't take effect until NVDA restarts. From 38b5453ccdc0c648b4ce88e41b8cd52fa3233f47 Mon Sep 17 00:00:00 2001 From: Quentin Christensen Date: Thu, 23 May 2024 19:13:42 +1000 Subject: [PATCH 6/8] Update user_docs/en/userGuide.md Co-authored-by: Cyrille Bougot --- user_docs/en/userGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index 0f3da35cb1c..498ec1d420d 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -340,8 +340,8 @@ The actions menu of installed add-ons includes "Disable" and "Remove" rather tha Disabling an add-on stops NVDA from loading it, but leaves it installed. To re-enable a disabled add-on, activate "Enable" from the actions menu. After enabling, disabling, or removing add-ons, you will be prompted to restart NVDA when closing the Add-on Store. -Note that in this dialog `escape` works the same as the close button. -Any changes you had made in the dialog have already happened, but they don't take effect until NVDA restarts. +These changes will only take effect once NVDA is restarted. +Note that in this dialog escape works the same as the close button. ### Updating add-ons {#UpdatingAddons} When there is an update to an add-on you have installed, it will be listed in the "Updatable add-ons" tab. From 9619c6289e500fc575c6308c77a1b97bc566ee48 Mon Sep 17 00:00:00 2001 From: Sean Budd Date: Fri, 24 May 2024 10:01:36 +1000 Subject: [PATCH 7/8] Apply suggestions from code review --- user_docs/en/userGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index 498ec1d420d..e577ef8d27f 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -341,7 +341,7 @@ Disabling an add-on stops NVDA from loading it, but leaves it installed. To re-enable a disabled add-on, activate "Enable" from the actions menu. After enabling, disabling, or removing add-ons, you will be prompted to restart NVDA when closing the Add-on Store. These changes will only take effect once NVDA is restarted. -Note that in this dialog escape works the same as the close button. +Note that in this dialog `escape` works the same as the Close button. ### Updating add-ons {#UpdatingAddons} When there is an update to an add-on you have installed, it will be listed in the "Updatable add-ons" tab. From 26ac5e14ce175a1e0b25c9108eadda41aa088adf Mon Sep 17 00:00:00 2001 From: Quentin Christensen Date: Fri, 24 May 2024 10:10:44 +1000 Subject: [PATCH 8/8] Update user_docs/en/userGuide.md --- user_docs/en/userGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md index e577ef8d27f..10a755e15ac 100644 --- a/user_docs/en/userGuide.md +++ b/user_docs/en/userGuide.md @@ -320,7 +320,7 @@ Once done, press `tab` to go to the filtered list of add-ons and browse the resu To install an add-on: 1. With the focus on an add-on you would like to install, press `enter`. -1. The actions menu opens with a list of actions including: "Install", "Home page", "License", "Source code", "Community reviews". +1. The actions menu opens with a list of actions; the first action is "Install". 1. To install the add-on, press `i` or `downArrow` to "install" and press `enter`. 1. The focus returns to the add-on in the list and NVDA will read the details about the add-on. 1. The "Status" information reported by NVDA changes from "Available" to "Downloading".